GitHub Repository

Fornece acesso ao conteúdo de um repositório do GitHub.

Documentação

MCP GitHub Repository Server

Um servidor MCP (Model Context Protocol) que fornece acesso ao conteúdo de repositórios do GitHub. Este servidor permite que assistentes de IA naveguem e leiam arquivos de repositórios GitHub especificados.

Demonstração

demo

Recursos

Recursos

  • Acesse qualquer arquivo em um repositório GitHub via URI
  • Liste o conteúdo do repositório e navegue pelos diretórios
  • Suporte para acesso a arquivos específicos de branch
  • O conteúdo dos arquivos é servido como texto simples

URIs de Recursos

  • Formato da URL base: https://api.github.com/repos/{owner}/{repo}/contents/{path}
  • Suporta arquivos e diretórios
  • Arquivos são servidos com o tipo MIME text/plain
  • Diretórios são servidos com o tipo MIME application/x-directory

Configuração

O servidor requer as seguintes variáveis de ambiente:

GITHUB_PERSONAL_ACCESS_TOKEN=your_github_token
GITHUB_OWNER=repository_owner
GITHUB_REPO=repository_name
GITHUB_BRANCH=branch_name  # Optional

Desenvolvimento

Instale as dependências:

npm install

Compile o servidor:

npm run build

Para desenvolvimento com recompilação automática:

npm run watch

Instalação

Para usar com o Claude Desktop, adicione a configuração do servidor:

Localização da Configuração

  • MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json
  • Windows: %APPDATA%/Claude/claude_desktop_config.json
{
  "mcpServers": {
    "mcp-server-github-repo": {
      "command": "/path/to/mcp-server-github-repo/build/index.js"
    }
  }
}

Implementação da API

O servidor implementa três endpoints principais do MCP:

  1. ListResources - Lista arquivos e diretórios no repositório
  2. ReadResource - Recupera o conteúdo de um arquivo específico

Autenticação

O servidor usa o Token de Acesso Pessoal do GitHub para autenticação. Certifique-se de que seu token tenha as permissões adequadas para acessar o conteúdo do repositório.

Tratamento de Erros

O servidor inclui tratamento de erros para:

  • Variáveis de ambiente ausentes
  • Erros da API do GitHub
  • Caminhos inválidos (por exemplo, tentar ler um diretório como arquivo)
  • Falhas de autenticação

Depuração

Como os servidores MCP se comunicam via stdio, a depuração pode ser desafiadora. Use o MCP Inspector para depuração:

npm run inspector

Isso fornecerá uma URL para acessar ferramentas de depuração no seu navegador.

Notas de Segurança

  • Mantenha seu Token de Acesso Pessoal do GitHub seguro
  • Considere usar tokens com as permissões mínimas necessárias
  • Esteja ciente das limitações de tamanho do repositório ao acessar repositórios grandes

Licença

MIT