# Github Copilot App Modernization MCP Server NPM Package

All Github Copilot app modernization MCP tools in a single server. This MCP Server implements the [MCP specification](https://modelcontextprotocol.io). This MCP Server can be used alone or with the GitHub Copilot in [Copilot CLI](https://github.com/features/copilot/cli), [Coding Agent](https://docs.github.com/en/copilot/concepts/agents/coding-agent/about-coding-agent), or other MCP-compatible clients.

## Table of Contents
- [Overview](#overview)
- [Installation](#installation)
- [Usage](#usage)
    - [Getting Started](#getting-started)
    - [What can you do with the Github Copilot App Modernization MCP Server?](#what-can-you-do-with-the-azure-mcp-server)
    - [Complete List of Supported Azure Services](#complete-list-of-supported-azure-services)
- [Support and Reference](#support-and-reference)
    - [Documentation](#documentation)
    - [Feedback and Support](#feedback-and-support)
    - [Security](#security)
    - [Permissions and Risk](#permissions-and-risk)
    - [Data Collection](#data-collection)
    - [Compliance Responsibility](#compliance-responsibility)
    - [Third Party Components](#third-party-components)
    - [Export Control](#export-control)
    - [No Warranty / Limitation of Liability](#no-warranty--limitation-of-liability)
    - [Contributing](#contributing)
    - [Code of Conduct](#code-of-conduct)

# Overview

**Github Copilot App Modernization MCP Server** provides AI-powered agents that analyze and upgrade Java and .NET applications, and migrate them to Azure. These agents handle complex, time-consuming tasks like version upgrades, dependency analysis, and cloud-platform-specific code transformations. You can modernize applications efficiently while maintaining code quality and build integrity.

# Installation
- To use Github Copilot App Modernization MCP Server from node one must have Node.js (LTS) installed and available on your system PATH — this provides both `npm` and `npx`. We recommend Node.js 18 LTS or later. To verify your installation run: `node --version`, `npm --version`, and `npx --version`.
-  Configure the `mcp.json` file with the following:

    ```json
    {
        "mcpServers": {
            "ghcp-appmod-mcp-server": {
            "command": "npx",
            "args": [
                "-y",
                "@microsoft/github-copilot-app-modernization-mcp-server@latest"
                ]
            }
        }
    }
    ```
**Note:** When manually configuring Visual Studio and Visual Studio Code, use `servers` instead of `mcpServers` as the root object.

# Usage

## Getting Started

1. Install [Copilot CLI](https://github.com/features/copilot/cli).
1. Follow the [instructions](https://docs.github.com/en/copilot/how-tos/use-copilot-agents/use-copilot-cli#add-an-mcp-server) to add the Github Copilot App Modernization MCP Server to your Copilot CLI configuration:
    - Server Name: `ghcp-appmod-mcp-server`
    - Server Type: `Local`
    - Command: `npx -y @microsoft/github-copilot-app-modernization-mcp-server@latest`
    - Leave other fields as default and press <kbd>ctrl</kbd> + <kbd>s</kbd> to save.
    - Enter <kbd>q</kbd> to exit the configuration editor.
1. After the server name appears in the `Configured MCP servers` list, try a prompt that tells the agent to use the Github Copilot App Modernization MCP Server, such as `upgrade this project to Java 21 and spring boot 3.2.12`
    - The agent should be able to use the Github Copilot App Modernization MCP Server tools to complete your query
1. Check out the [documentation](https://learn.microsoft.com/en-us/azure/developer/github-copilot-app-modernization/overview) and review the [FAQ](https://learn.microsoft.com/en-us/azure/developer/java/migration/migrate-github-copilot-app-modernization-for-java-faq) for commonly asked questions
1. We're building this in the open. Your feedback is much appreciated, and will help us shape the future of the Github Copilot App Modernization MCP Server
    - 👉 [Open an issue in the public repository](https://aka.ms/ghcp-appmod/feedback)

## What can you do with the Github Copilot App Modernization MCP Server?

TBD - Coming soon!

# Support and Reference

## Documentation

- See our [official documentation on learn.microsoft.com](https://learn.microsoft.com/en-us/azure/developer/github-copilot-app-modernization/overview) to learn how to use the Github Copilot App Modernization MCP Server to modernize your Java applications through natural language commands from AI agents and other types of clients.

## Feedback and Support

- Check the [FAQ](https://learn.microsoft.com/en-us/azure/developer/java/migration/migrate-github-copilot-app-modernization-for-java-faq) for common questions and issues with the Github Copilot App Modernization MCP Server.
- We're building this in the open. Your feedback is much appreciated, and will help us shape the future of the Github Copilot App Modernization MCP Server.
    - 👉 [Open an issue](https://aka.ms/ghcp-appmod/feedback) in the public GitHub repository — we’d love to hear from you!

## Security

TBD - Coming soon!

## Permissions and Risk

TBD - Coming soon!

## Data Collection

The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described in the repository. There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft's [privacy statement](https://www.microsoft.com/privacy/privacystatement). You can learn more about data collection and use in the help documentation and our privacy statement. Your use of the software operates as your consent to these practices.

### Telemetry Configuration

Telemetry collection is on by default.

To opt out, set the environment variable `APPMOD_MCP_COLLECT_TELEMETRY` to `false` in your environment.

## Compliance Responsibility

This MCP server may interact with clients and services outside Microsoft compliance boundaries. You are responsible for ensuring that any integration complies with applicable organizational, regulatory, and contractual requirements.

## Third Party Components

This MCP server may use or depend on third party components. You are responsible for reviewing and complying with the licenses and security posture of any third-party components.

## Export Control

Use of this software must comply with all applicable export laws and regulations, including U.S. Export Administration Regulations and local jurisdiction requirements.

## No Warranty / Limitation of Liability

This software is provided “as is” without warranties or conditions of any kind, either express or implied. Microsoft shall not be liable for any damages arising from use, misuse, or misconfiguration of this software.

## Contributing

TBD - Coming soon!

## Disclaimer
Unless otherwise permitted under applicable license(s), users may not decompile, modify, repackage, or redistribute any assets, prompts, or internal tools provided as part of this product without prior written consent from Microsoft.