Detalhes do Projeto GitMCP

🚀 Visão Geral do Projeto

GitMCP é um servidor gratuito e de código aberto do Model Context Protocol (MCP) remoto, capaz de transformar qualquer projeto GitHub (repositório ou GitHub Pages) em um centro de documentação. Ele permite que ferramentas de IA como o Cursor acessem a documentação e o código mais recentes, mesmo que o LLM nunca tenha encontrado esse conteúdo, eliminando perfeitamente as alucinações de código.

Recursos Principais

• 😎 Documentação Atualizada de Qualquer Projeto GitHub: Fornece aos assistentes de IA acesso contínuo à documentação e ao código do projeto GitHub, com uma função de busca inteligente integrada para ajudar a encontrar exatamente o que a IA precisa.
• 🧠 Elimina Alucinações: Com o GitMCP, os assistentes de IA podem fornecer respostas precisas e relevantes.
• ☁️ Zero Configuração: O GitMCP é executado na nuvem; basta adicionar a URL do GitMCP como um servidor MCP em sua IDE.
• 💬 Chat Incorporado: Converse diretamente com a documentação do repositório através do chat no navegador.
• ✅ Aberto, Gratuito e Privado: Totalmente de código aberto e gratuito para usar, não coleta informações pessoais nem armazena consultas, e suporta auto-hospedagem.

🛠️ Como Funciona

O GitMCP usa o padrão Model Context Protocol (MCP) para conectar assistentes de IA a repositórios GitHub, permitindo que ferramentas de IA solicitem informações adicionais de fontes externas.

Fluxo de Trabalho:

1. Forneça a URL do GitMCP ao assistente de IA (por exemplo: gitmcp.io/microsoft/typescript).
2. O GitMCP expõe ferramentas como obtenção de documentação, busca inteligente e busca de código.
3. Faça perguntas relacionadas à documentação/código ao assistente de IA.
4. O assistente de IA envia uma solicitação ao GitMCP para usar suas ferramentas (requer sua aprovação).
5. O GitMCP executa a solicitação da IA e retorna os dados necessários.
6. O assistente de IA recebe as informações e gera uma resposta mais precisa e fundamentada, sem alucinações.

📋 Formatos de Documentação Suportados

O GitMCP atualmente suporta os seguintes documentos em ordem de prioridade:

1. llms.txt - Versão otimizada para IA da documentação do projeto.
2. README.md
3. Outros documentos no diretório /root.

🔧 Como Configurar

Escolha do Formato da URL

Escolha um dos seguintes formatos de URL, dependendo do conteúdo ao qual você deseja se conectar:

• Repositório GitHub: gitmcp.io/{owner}/{repo}
• Site GitHub Pages: {owner}.gitmcp.io/{repo}
• Ferramenta Universal (suporta qualquer repositório, dinâmico): gitmcp.io/docs

Exemplos de Configuração de Ferramentas de IA

Configuração do Cursor

Atualize o arquivo ~/.cursor/mcp.json:

{
  "mcpServers": {
    "gitmcp": {
      "url": "https://gitmcp.io/{owner}/{repo}"
    }
  }
}

Configuração do Claude Desktop

Substitua a configuração em Configurações > Desenvolvedor > Editar Configuração:

{
  "mcpServers": {
    "gitmcp": {
      "command": "npx",
      "args": [
        "mcp-remote",
        "https://gitmcp.io/{owner}/{repo}"
      ]
    }
  }
}

Configuração do Windsurf

Atualize o arquivo ~/.codeium/windsurf/mcp_config.json:

{
  "mcpServers": {
    "gitmcp": {
      "serverUrl": "https://gitmcp.io/{owner}/{repo}"
    }
  }
}

🔨 Ferramentas Disponíveis

1. Obter Documentação (fetch_documentation)

Obtém a documentação principal de um repositório GitHub, fornecendo uma visão geral do projeto para a IA, recuperando documentos relevantes (como llms.txt).

Cenários de Uso: Perguntas gerais sobre o propósito, funcionalidades ou guias de início rápido do projeto.

2. Buscar Documentação (search_documentation)

Permite que a IA pesquise na documentação do repositório usando uma consulta de busca específica, utilizando uma busca inteligente para encontrar seções relevantes em vez de carregar toda a documentação.

Cenários de Uso: Perguntas específicas sobre uma funcionalidade, função ou conceito dentro do projeto.

3. Obter Conteúdo de Link (fetch_link_content)

Ajuda a IA a obter informações de links mencionados na documentação, recuperando o conteúdo desses links e convertendo-o para um formato legível pela IA.

Cenários de Uso: Quando a documentação faz referência a informações externas que podem ajudar a responder a uma pergunta.

4. Buscar Código (search_code)

Usa a função de busca de código do GitHub para pesquisar no código real do repositório, ajudando a IA a encontrar exemplos de código específicos ou detalhes de implementação.

Cenários de Uso: Quando são necessários exemplos de implementação ou detalhes técnicos não cobertos pela documentação.

📊 Integração de Emblemas (Badges)

O GitMCP oferece emblemas de repositório, permitindo que os usuários acessem rapidamente a documentação via IDE ou navegador, e exibindo o número de vezes que a documentação foi acessada via GitMCP.

Adicionar Emblema

Adicione o seguinte código ao seu README.md:

[![GitMCP](https://img.shields.io/endpoint?url=https://gitmcp.io/badge/OWNER/REPO)](https://gitmcp.io/OWNER/REPO)

Parâmetros de Personalização do Emblema

Parâmetro	Descrição	Valor Padrão	Exemplo
color	Cor do valor do emblema	aquamarine	?color=green
label	Rótulo do emblema	GitMCP	Documentation

🛡️ Privacidade e Segurança

• Compromisso com a Privacidade: O GitMCP tem uma profunda preocupação com a privacidade do usuário, não requer autenticação e não pode acessar ou armazenar nenhuma informação de identificação pessoal.
• Consultas Não Armazenadas: Nenhuma consulta enviada pelo proxy é armazenada.
• Transparência de Código Aberto: Como um projeto de código aberto, pode ser implantado independentemente em seu ambiente.
• Acesso Sob Demanda: Acessa apenas conteúdo publicamente disponível e somente quando o usuário consulta.
• Conformidade com Regras: Antes de acessar sites GitHub Pages, verifica as regras do robots.txt e segue as instruções definidas pelo proprietário do site.

🚦 Limitações de Uso

O GitMCP acessa o conteúdo apenas quando consultado, não rastreia repositórios automaticamente. Para sites GitHub Pages, ele verifica e segue as regras do robots.txt, permitindo que os proprietários do site optem por não participar. O GitMCP não armazena permanentemente dados sobre projetos GitHub ou seu conteúdo.

💻 Desenvolvimento e Contribuição

Execução Local

# Clonar o repositório
git clone https://github.com/idosal/git-mcp.git
cd git-mcp

# Instalar dependências
pnpm install

# Executar para desenvolvimento local
npm run dev # ou pnpm dev

Ferramenta Inspetor MCP

# Instalar a ferramenta inspetor MCP
npx @modelcontextprotocol/inspector

Na interface do inspetor:

• Defina o tipo de transporte como SSE.
• Insira a URL do GitMCP (por exemplo: http://localhost:5173/docs).
• Clique em "Conectar".

📄 Licença

Este projeto é licenciado sob a Licença Apache 2.0.

⚠️ Isenção de Responsabilidade

O GitMCP é fornecido "como está", sem garantias de qualquer tipo. Embora nos esforcemos para garantir a confiabilidade e segurança do serviço, não nos responsabilizamos por quaisquer danos ou problemas que possam surgir do uso. Os projetos GitHub acessados através do GitMCP estão sujeitos aos termos e condições de seus respectivos proprietários. O GitMCP não é afiliado ao GitHub ou a qualquer ferramenta de IA mencionada.