Como estender o agente de codificação do Copilot com o MCP (Model Context Protocol)

Observação

O Agente de codificação do Copilot está em versão prévia pública e está sujeito a alterações. Durante a versão prévia, o uso do recurso está sujeito a Termos de licença de pré-lançamento do GitHub.

Pré-requisito

Antes de configurar um servidor MCP para Agente de codificação do Copilot, leia MCP (Protocolo de Contexto de Modelo) e Agente de codificação do Copilot para garantir que você entenda os conceitos relacionados a servidores MCP e o Agente de codificação do Copilot.

Introdução

Como administrador de repositório, você pode configurar servidores MCP para uso em seu repositório. Isso é feito por meio de uma configuração formatada em JSON que especifica os detalhes dos servidores MCP que você deseja usar. Insira a configuração JSON diretamente nas configurações do repositório em GitHub.com.

Aviso

Depois de configurar um servidor MCP, o Copilot poderá usar as ferramentas fornecidas pelo servidor de maneira autônoma, sem solicitar sua aprovação antes de usá-las.

Adicionar uma configuração do MCP ao seu repositório

Os administradores do repositório podem configurar servidores MCP seguindo estas etapas:

Em GitHub, acesse a página principal do repositório.
Abaixo do nome do repositório, clique em Configurações. Caso não consiga ver a guia "Configurações", selecione o menu suspenso , clique em Configurações.
Na seção "Código e automação" da barra lateral, clique em Copilot e em Agente de codificação.
Adicione sua configuração na seção MCP configuration.

As seções a seguir neste artigo explicam como escrever a configuração JSON que você precisa inserir aqui.
Clique em Save (Salvar).

Sua configuração será validada para garantir a sintaxe adequada.
Se o servidor MCP exigir uma chave ou segredo, adicione um segredo ao seu ambiente Copilot. Apenas os segredos com nomes que tenham o prefixo COPILOT_MCP_ estarão disponíveis para a configuração do MCP. Confira Como configurar um ambiente do Copilot para o Agente de codificação do Copilot.

Escrever uma configuração JSON para servidores MCP

Você configura servidores MCP usando um formato JSON especial. O JSON deve conter um objeto mcpServers, em que a chave é o nome do servidor MCP (por exemplo, sentry) e o valor é um objeto com a configuração desse servidor MCP.

JSON

{
  "mcpServers": {
    "MCP SERVER 1": {
      "command": "VALUE",
      "args": [ VALUES ],
      ...
    },
    "MCP SERVER 2": {
      "command": "VALUE",
      "args": [ VALUES ],
      ...
    },
    ...
  }
}

{
  "mcpServers": {
    "MCP SERVER 1": {
      "command": "VALUE",
      "args": [ VALUES ],
      ...
    },
    "MCP SERVER 2": {
      "command": "VALUE",
      "args": [ VALUES ],
      ...
    },
    ...
  }
}

O objeto de configuração pode conter as seguintes chaves:

Chaves necessárias para servidores MCP locais e remotos

tools (string[]): as ferramentas do servidor MCP para habilitar. Você pode encontrar uma lista de ferramentas na documentação do servidor ou em seu código. É altamente recomendável permitir a lista de ferramentas específicas somente leitura, pois o agente poderá usar essas ferramentas de maneira autônoma e não solicitará aprovação primeiro. Você também pode habilitar todas as ferramentas incluindo * na matriz.
type (string): o Agente de codificação do Copilot aceita "local", "http" ou "sse".

Chaves específicas do MCP local

command (string): obrigatório. O comando a ser executado para iniciar o servidor MCP.
args (string[]): obrigatório. Os argumentos a serem passados a command.
env (object): opcional. As variáveis de ambiente a serem passadas para o servidor. Esse objeto deve mapear o nome da variável de ambiente que deve ser exposta ao servidor MCP para qualquer um dos seguintes:
- O nome de um segredo do GitHub Actions que você configurou, começando com COPILOT_MCP_.
- Um valor da cadeia de caracteres.

Chaves específicas do MCP remoto

url (string): obrigatório. A URL do servidor MCP.
headers (object): opcional. Os cabeçalhos a serem anexados às solicitações ao servidor. Esse objeto deve mapear o nome das chaves de cabeçalho para um dos seguintes:
- O nome de um segredo do GitHub Actions que você configurou, começando com COPILOT_MCP_, precedido por um $
- Um valor de cadeia de caracteres

Configurações de exemplo

Exemplo: Sentry

O servidor MCP do Sentry dá ao Copilot acesso autenticado a exceções registradas no Sentry.

JavaScript

// If you copy and paste this example, you will need to remove the comments prefixed with `//`, which are not valid JSON.
{
  "mcpServers": {
    "sentry": {
      "type": "local",
      "command": "npx",
      // We can use the $SENTRY_HOST environment variable which is passed to
      // the server because of the `env` value below.
      "args": ["@sentry/mcp-server@latest", "--host=$SENTRY_HOST"],
      "tools": ["get_issue_details", "get_issue_summary"],
      "env": {
        // We can specify an environment variable value as a string...
        "SENTRY_HOST": "https://contoso.sentry.io",
        // or refer to a GitHub Actions secret with a name starting with
        // `COPILOT_MCP_`
        "SENTRY_ACCESS_TOKEN": "COPILOT_MCP_SENTRY_ACCESS_TOKEN"
      }
    }
  }
}

// If you copy and paste this example, you will need to remove the comments prefixed with `//`, which are not valid JSON.
{
  "mcpServers": {
    "sentry": {
      "type": "local",
      "command": "npx",
      // We can use the $SENTRY_HOST environment variable which is passed to
      // the server because of the `env` value below.
      "args": ["@sentry/mcp-server@latest", "--host=$SENTRY_HOST"],
      "tools": ["get_issue_details", "get_issue_summary"],
      "env": {
        // We can specify an environment variable value as a string...
        "SENTRY_HOST": "https://contoso.sentry.io",
        // or refer to a GitHub Actions secret with a name starting with
        // `COPILOT_MCP_`
        "SENTRY_ACCESS_TOKEN": "COPILOT_MCP_SENTRY_ACCESS_TOKEN"
      }
    }
  }
}

Exemplo: Notion

O servidor MCP do Notion dá ao Copilot acesso autenticado a anotações e outros conteúdos do Notion.

JavaScript

// If you copy and paste this example, you will need to remove the comments prefixed with `//`, which are not valid JSON.
{
  "mcpServers": {
    "notionApi": {
      "type": "local",
      "command": "docker",
      "args": [
        "run",
        "--rm",
        "-i",
        "-e",
        // We can use the $NOTION_API_KEY environment variable which is passed to
        // the server because of the `env` value below.
        "OPENAPI_MCP_HEADERS={\"Authorization\": \"Bearer $NOTION_API_KEY\", \"Notion-Version\": \"2022-06-28\"}",
       "mcp/notion"
      ],
      "env": {
        // The value of the `COPILOT_MCP_NOTION_API_KEY` secret will be passed to the
        // server command as an environment variable called `NOTION_API_KEY`
        "NOTION_API_KEY": "COPILOT_MCP_NOTION_API_KEY"
      },
      "tools": ["*"]
    }
  }
}

// If you copy and paste this example, you will need to remove the comments prefixed with `//`, which are not valid JSON.
{
  "mcpServers": {
    "notionApi": {
      "type": "local",
      "command": "docker",
      "args": [
        "run",
        "--rm",
        "-i",
        "-e",
        // We can use the $NOTION_API_KEY environment variable which is passed to
        // the server because of the `env` value below.
        "OPENAPI_MCP_HEADERS={\"Authorization\": \"Bearer $NOTION_API_KEY\", \"Notion-Version\": \"2022-06-28\"}",
       "mcp/notion"
      ],
      "env": {
        // The value of the `COPILOT_MCP_NOTION_API_KEY` secret will be passed to the
        // server command as an environment variable called `NOTION_API_KEY`
        "NOTION_API_KEY": "COPILOT_MCP_NOTION_API_KEY"
      },
      "tools": ["*"]
    }
  }
}

Exemplo: AKS (Serviço

O servidor MCP do Azure cria uma conexão perfeita entre o Copilot e os principais serviços do Azure, como o Azure Cosmos DB e a plataforma de Armazenamento do Azure.

Para usar o MCP do Azure com Agente de codificação do Copilot, atualize o arquivo copilot-setup-steps.yml do repositório para incluir uma etapa de fluxo de trabalho de logon do Azure.

Configure o OIDC em um aplicativo do Microsoft Entra, confiando em GitHub. Confira Usar a ação de logon do Azure com OpenID Connect.
Adicione um arquivo de fluxo de trabalho .github/workflows/copilot-setup-steps.yml Actions em seu repositório se ainda não tiver um.

Adicione uma etapa de logon do Azure ao trabalho de fluxo de trabalho do copilot-setup-steps.

YAML

on:
  workflow_dispatch:
permissions:
  id-token: write
  contents: read
jobs:
  copilot-setup-steps:
    runs-on: ubuntu-latest
    permissions:
      id-token: write
      contents: read
    environment: copilot
    steps:
      - name: Azure login
        uses: azure/login@a457da9ea143d694b1b9c7c869ebb04ebe844ef5
        with:
          client-id: ${{ secrets.AZURE_CLIENT_ID }}
          tenant-id: ${{ secrets.AZURE_TENANT_ID }}
          subscription-id: ${{ secrets.AZURE_SUBSCRIPTION_ID }}

on:
  workflow_dispatch:
permissions:
  id-token: write
  contents: read
jobs:
  copilot-setup-steps:
    runs-on: ubuntu-latest
    permissions:
      id-token: write
      contents: read
    environment: copilot
    steps:
      - name: Azure login
        uses: azure/login@a457da9ea143d694b1b9c7c869ebb04ebe844ef5
        with:
          client-id: ${{ secrets.AZURE_CLIENT_ID }}
          tenant-id: ${{ secrets.AZURE_TENANT_ID }}
          subscription-id: ${{ secrets.AZURE_SUBSCRIPTION_ID }}

Essa configuração garante que a ação azure/login seja executada quando o Agente de codificação do Copilot é executado.

No ambiente Copilot do seu repositório, adicione segredos para AZURE_CLIENT_ID, AZURE_TENANT_ID e AZURE_SUBSCRIPTION_ID.
Configure o servidor MCP do Azure adicionando um objeto azure à configuração do MCP.

JSON

 {
   "mcpServers": {
     "Azure": {
      "type": "local",
      "command": "npx",
      "args": [
        "-y",
        "@azure/mcp@latest",
        "server",
        "start"
       ],
      "tools": ["*"]
     }
   }
 }

 {
   "mcpServers": {
     "Azure": {
      "type": "local",
      "command": "npx",
      "args": [
        "-y",
        "@azure/mcp@latest",
        "server",
        "start"
       ],
      "tools": ["*"]
     }
   }
 }

Exemplo: Cloudflare

O servidor MCP Cloudflare cria conexões entre seus serviços do Cloudflare, incluindo documentação de processamento e análise de dados.

JSON

{
  "mcpServers": {
    "cloudflare": {
      "type": "sse",
      "url": "https://docs.mcp.cloudflare.com/sse",
      "tools": ["*"]
    }
  }
}

{
  "mcpServers": {
    "cloudflare": {
      "type": "sse",
      "url": "https://docs.mcp.cloudflare.com/sse",
      "tools": ["*"]
    }
  }
}

Como reutilizar a configuração do MCP do Visual Studio Code

Se você já tiver configurado servidores MCP no VS Code, poderá aproveitar uma configuração semelhante para Agente de codificação do Copilot.

Dependendo de como os dados do VS Code estão configurados, você poderá encontrar as configurações do MCP no arquivo .vscode/mcp.json do repositório ou no arquivo settings.json privado do computador.

Para adaptar a configuração de dados Agente de codificação do Copilot, você precisará:

Adicione uma chave tools para cada servidor MCP, especificando quais ferramentas estarão disponíveis para Copilot.
Se você tiver configurou o inputs, alterne para usar env diretamente.
Se você tiver configurado um envFile, alterne para usar env diretamente.
Atualize todas as referências a inputs em sua configuração do args para se referir a variáveis de ambiente de env em vez disso.

Para obter mais informações sobre o MCP no VS Code, confira os documentos do VS Code.

Como configurar um ambiente do Copilot para o Agente de codificação do Copilot

Alguns servidores MCP exigirão chaves ou segredos. Para aproveitar esses servidores no Agente de codificação do Copilot, adicione segredos a um ambiente para Copilot. Isso garante que os segredos sejam reconhecidos corretamente e passados para o servidor MCP aplicável que você configurou.

Você deve ser um administrador de repositório para configurar um ambiente Copilot para seu repositório.

Em GitHub, acesse a página principal do repositório.
Abaixo do nome do repositório, clique em Configurações. Caso não consiga ver a guia "Configurações", selecione o menu suspenso , clique em Configurações.
Na barra lateral esquerda, clique em Ambientes.
Clique em Novo ambiente.
Chame o novo ambiente de copilot e clique em Configure environment.
Em "Environment secrets", clique em Add environment secret.
Dê ao segredo um nome que comece com COPILOT_MCP_, adicione o valor do segredo e clique em Add secret.

Como validar a configuração do MCP

Depois de definir a configuração do MCP, teste-a para verificar se está configurada corretamente.

Crie um issue no repositório e atribua-o a Copilot.
Aguarde alguns segundos e Copilot deixará uma reação 👀 sobre o issue.
Aguarde mais alguns segundos e Copilot criará uma pull request, que será exibida na linha do tempo do issue.
Clique na pull request criada na linha do tempo e aguarde até que um evento de linha do tempo "Copilot iniciou o trabalho" seja exibido.
Clique em View session para abrir os logs do Agente de codificação do Copilot.
Clique no botão de reticências (...) na parte superior direita do visualizador de log e clique em Copilot na barra lateral.
Clique na etapa Start MCP Servers para expandir os logs.
Se os servidores MCP tiverem sido iniciados com êxito, você verá suas ferramentas listadas na parte inferior dos logs.

Se os servidores MCP exigirem dependências que não estejam instaladas no executor GitHub Actions por padrão, como uv e pipx, ou que precisem de etapas especiais de instalação, talvez seja necessário criar um arquivo de fluxo de trabalho de Ações copilot-setup-steps.yml para instalá-las. Para saber mais, confira Como personalizar o ambiente de desenvolvimento para o agente de codificação do Copilot.

Como personalizar o servidor MCP do GitHub predefinido

O servidor MCP GitHub está habilitado por padrão e se conecta ao GitHub com um token com escopo especial que só tem acesso somente leitura ao repositório atual.

Se você quiser permitir que o Copilot acesse dados fora do repositório atual, poderá fornecer a ele um personal access token com acesso mais amplo.

Crie um personal access token com as permissões apropriadas. É recomendável usar um fine-grained personal access token, em que você pode limitar o acesso do token a permissões somente leitura em repositórios específicos. Para obter mais informações sobre o personal access tokens, confira Gerenciar seus tokens de acesso pessoal.
Em GitHub, acesse a página principal do repositório.
Abaixo do nome do repositório, clique em Configurações. Caso não consiga ver a guia "Configurações", selecione o menu suspenso , clique em Configurações.
Na seção "Código e automação" da barra lateral, clique em Copilot e em Agente de codificação.
Adicione sua configuração na seção MCP configuration.
Clique em Save (Salvar).
Na barra lateral esquerda, clique em Ambientes.
Clique no ambiente copilot.
Em "Environment secrets", clique em Add environment secret.
Chame o segredo COPILOT_MCP_GITHUB_PERSONAL_ACCESS_TOKEN, insira seu personal access token no campo "Value" e clique em Add secret.

Para obter informações sobre como usar o servidor de MCP do GitHub em outros ambientes, consulte Como usar o Servidor de MCP do GitHub.

Como estender o agente de codificação do Copilot com o MCP (Model Context Protocol)

Neste artigo

Pré-requisito

Introdução

Adicionar uma configuração do MCP ao seu repositório

Escrever uma configuração JSON para servidores MCP

Configurações de exemplo

Exemplo: Sentry

Exemplo: Notion

Exemplo: AKS (Serviço

Exemplo: Cloudflare

Como reutilizar a configuração do MCP do Visual Studio Code

Como configurar um ambiente do Copilot para o Agente de codificação do Copilot

Como validar a configuração do MCP

Como personalizar o servidor MCP do GitHub predefinido

Próximas etapas