GitHub Mapper

GitHub Mapper MCP Server

GitHub Mapper é um servidor Model Context Protocol (MCP) que fornece ferramentas para mapear e analisar repositórios do GitHub. Ele permite que os usuários definam um Token de Acesso Pessoal do GitHub e obtenham informações detalhadas sobre um repositório específico, incluindo sua estrutura e estatísticas resumidas.

Recursos

• Definir Token de Acesso Pessoal do GitHub para autenticação
• Mapear e analisar a estrutura de repositórios do GitHub
• Recuperar informações resumidas do repositório (estrelas, forks, linguagem, etc.)
• Fornecer uma estrutura detalhada de arquivos do repositório

Pré-requisitos

• Node.js (v18.0.0 ou posterior recomendado)
• npm (vem com Node.js)
• Um Token de Acesso Pessoal do GitHub com permissões apropriadas

Instalação

Instalando via Smithery

Para instalar o GitHub Mapper para Claude Desktop automaticamente via Smithery:

npx -y @smithery/cli install github-mapper-mcp-server --client claude

Instalação Manual

1. Clone o repositório:

   git clone https://github.com/your-username/github-mapper-mcp-server.git
   cd github-mapper-mcp-server
   

2. Instale as dependências:

   npm install
   

3. Compile o projeto:

   npm run build
   

Uso

1. Inicie o servidor:

   npm start
   

2. O servidor será executado em stdio, permitindo que ele se comunique com clientes MCP.

Ferramentas Disponíveis

1. set-github-token

Define o Token de Acesso Pessoal do GitHub para autenticação.

• Crie seu Token de Acesso Pessoal aqui. Escolha Tokens (clássico). Escopos: repo

Exemplo, no seu IDE ou Claude Desktop:

Please set-github-token to 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

2. map-github-repo

Mapeia a estrutura de um repositório do GitHub e fornece informações resumidas.

Exemplo:

Please map-github-repo https://github.com/dazeb/MCP-Github-Mapper

Instalação manual no cliente MCP Cline ou Roo-Cline:

{
  "mcpServers": {
    "github-mapper": {
      "command": "node",
      "args": ["/home/user/Documents/Cline/MCP/github-mapper/build/index.js"]
    }
  }
}

Exemplo de Saída

Repository Analysis Summary:

Name: Hello-World
Description: My first repository on GitHub!
Stars: 1234
Forks: 567
Primary Language: JavaScript
Created: 2023-01-01
Last Updated: 2023-06-15

Repository Structure:

{
  "src": {
    "components": {
      "Header.js": null,
      "Footer.js": null
    },
    "pages": {
      "index.js": null,
      "about.js": null
    },
    "styles": {
      "global.css": null
    }
  },
  "public": {
    "images": {
      "logo.png": null
    },
    "favicon.ico": null
  },
  "package.json": null,
  "README.md": null
}

Imagens

Executando evals

O pacote evals carrega um cliente mcp que então executa o arquivo index.ts, então não há necessidade de recompilar entre os testes. Você pode carregar variáveis de ambiente prefixando o comando npx. A documentação completa pode ser encontrada aqui.

OPENAI_API_KEY=your-key  npx mcp-eval src/evals/evals.ts src/index.ts

Tratamento de Erros

• Se o token do GitHub não estiver definido, você receberá uma mensagem de erro solicitando que use a ferramenta set-github-token primeiro.
• URLs inválidas do GitHub ou caminhos de repositório resultarão em mensagens de erro apropriadas.

Contribuindo

Contribuições são bem-vindas! Sinta-se à vontade para enviar um Pull Request.

Licença

Este projeto é licenciado sob a Licença MIT.