GitMCP

Transforma qualquer projeto do GitHub em um hub de documentação, permitindo que ferramentas de IA acessem documentação e código atualizados.

GitHub

8.4k

Experimente este MCPPatrocinado

Documentação

GitMCP

O que é GitMCP • Recursos • Começando • Como Funciona • Badge • Exemplos • FAQ • Privacidade • Contribuindo • Licença

🤔 O que é GitMCP?

Pare de alucinar e comece a codar com vibração!

GitMCP é um servidor Model Context Protocol (MCP) remoto, gratuito e de código aberto que transforma qualquer projeto GitHub (repositórios ou páginas GitHub) em um hub de documentação. Ele permite que ferramentas de IA como Cursor acessem documentação e código atualizados, mesmo que o LLM nunca os tenha visto, eliminando alucinações de código de forma integrada.

O GitMCP suporta duas variações -

Repositório Específico (gitmcp.io/{owner}/{repo} ou {owner}.gitmcp.io/{repo}): Use estas quando você trabalha principalmente com um número seleto de bibliotecas. Isso garante que seu assistente de IA sempre aponte para o projeto correto, aumentando a segurança e a relevância ao impedir o acesso a repositórios não intencionais.
Servidor Genérico (gitmcp.io/docs): Use este para máxima flexibilidade quando você precisa alternar entre diferentes repositórios com frequência. O assistente de IA solicitará (ou decidirá com base no contexto) qual repositório acessar para cada solicitação. Esteja ciente de que isso depende da identificação correta do repositório de destino a cada vez.

Com o GitMCP:

Assistentes de IA acessam a documentação e o código mais recentes diretamente da fonte.
Obtenha uso preciso de API e exemplos de código confiáveis.
Trabalhe efetivamente até mesmo com bibliotecas de nicho, novas ou em rápida mudança.
Alucinações significativamente reduzidas e melhor precisão do código.

Por exemplo, esta comparação lado a lado mostra o resultado para o mesmo prompt de uma única tentativa no Cursor ao criar uma cena three.js -

https://github.com/user-attachments/assets/fbf1b4a7-f9f0-4c0e-831c-4d64faae2c45

✨ Recursos

😎 Documentação Mais Recente em QUALQUER Projeto GitHub: Dê ao seu assistente de IA acesso contínuo à documentação e ao código do projeto GitHub. Os recursos integrados de pesquisa inteligente ajudam a encontrar exatamente o que a IA precisa sem usar muitos tokens!
🧠 Sem Mais Alucinações: Com o GitMCP, seu assistente de IA pode fornecer respostas precisas e relevantes para suas perguntas.
☁️ Zero Configuração: O GitMCP roda na nuvem. Basta adicionar a URL do GitMCP escolhida como um servidor MCP no seu IDE — sem downloads, instalações, cadastros ou alterações necessárias.
💬 Chat Integrado: Comece rapidamente conversando diretamente com a documentação do repositório através do nosso chat no navegador!
✅ Aberto, Gratuito e Privado: O GitMCP é de código aberto e totalmente gratuito. Ele não coleta informações pessoais nem armazena consultas. Você pode até mesmo hospedá-lo você mesmo!

🚀 Começando

Usar o GitMCP é fácil! Basta seguir estes passos:

Passo 1: Escolha o tipo de servidor que você deseja

Escolha um destes formatos de URL dependendo do que você deseja conectar:

Para repositórios GitHub: gitmcp.io/{owner}/{repo}
Para sites GitHub Pages: {owner}.gitmcp.io/{repo}
Para uma ferramenta genérica que suporta qualquer repositório (dinâmico): gitmcp.io/docs

Substitua {owner} pelo nome de usuário ou organização do GitHub, e {repo} pelo nome do repositório.

Para sua conveniência, você também pode usar a ferramenta de conversão na página inicial para formatar a URL do GitHub em uma URL MCP!

Passo 2: Conecte seu assistente de IA

Selecione seu assistente de IA nas opções abaixo e siga as instruções de configuração:

Conectando o Cursor

Atualize seu arquivo de configuração do Cursor em ~/.cursor/mcp.json:

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

Conectando o Claude Desktop

No Claude Desktop, vá para Configurações > Desenvolvedor > Editar Config

Substitua a configuração por:

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

Conectando o Windsurf

Atualize seu arquivo de configuração do Windsurf em ~/.codeium/windsurf/mcp_config.json:

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

Conectando o VSCode

Atualize seu arquivo de configuração do VSCode em .vscode/mcp.json:

{
  "servers": {
    "gitmcp": {
      "type": "sse",
      "url": "https://gitmcp.io/{owner}/{repo}"
    }
  }
}

Conectando o Cline

Atualize seu arquivo de configuração do Cline em ~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json:

{
  "mcpServers": {
    "gitmcp": {
      "url": "https://gitmcp.io/{owner}/{repo}",
      "disabled": false,
      "autoApprove": []
    }
  }
}

Conectando o Highlight AI

Abra o Highlight AI e clique no ícone de plugins (símbolo @) na barra lateral
Clique em Plugins Instalados no topo da barra lateral
Selecione Plugin Personalizado
Clique em Adicionar um plugin usando uma URL SSE personalizada

Nome do plugin: gitmcp URL SSE: https://gitmcp.io/{owner}/{repo}

Para mais detalhes sobre como adicionar servidores MCP personalizados ao HighlightAI, consulte a documentação.

Conectando o Augment Code

Abra as configurações do Augment Code
Navegue até a seção MCP
Adicione um novo servidor MCP com os seguintes detalhes:

Nomeie o servidor MCP: git-mcp Docs

Use este comando:

npx mcp-remote https://gitmcp.io/{owner}/{repo}

Ou use a seguinte configuração:

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

Conectando o Msty AI

Abra o Msty Studio
Vá para Ferramentas > Importar Ferramentas da Área de Transferência JSON
Cole a seguinte configuração:

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

Para mais detalhes sobre como configurar servidores MCP no Augment Code, visite a documentação do Augment Code.

Nota: Lembre-se de substituir {owner} e {repo} pelo nome de usuário/organização e nome do repositório reais do GitHub. Você também pode usar o endpoint dinâmico https://gitmcp.io/docs para permitir que sua IA acesse qualquer repositório sob demanda.

⚙ Como Funciona

O GitMCP conecta seu assistente de IA a repositórios GitHub usando o Model Context Protocol (MCP), um padrão que permite que ferramentas de IA solicitem informações adicionais de fontes externas.

O que acontece quando você usa o GitMCP:

Você fornece a URL do GitMCP ao seu assistente de IA (por exemplo, gitmcp.io/microsoft/typescript). O GitMCP expõe ferramentas como busca de documentação, pesquisa inteligente, busca de código, etc.
Pergunte ao assistente de IA sobre questões relacionadas a documentação/código.
Sua IA envia solicitações ao GitMCP para usar suas ferramentas (com sua aprovação).
O GitMCP executa a solicitação da IA e retorna os dados solicitados.
Sua IA recebe as informações e gera uma resposta mais precisa e fundamentada, sem alucinações.

Documentação Suportada

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

llms.txt
Versão otimizada para IA da documentação do projeto
README.md/raiz

💡 Exemplos

Aqui estão alguns exemplos de como usar o GitMCP com diferentes assistentes de IA e repositórios:

Exemplo 1: Usando o Windsurf com um repositório específico

Para o repositório GitHub https://github.com/microsoft/playwright-mcp, adicione https://gitmcp.io/microsoft/playwright-mcp como um servidor MCP no Windsurf.

Prompt para o Claude:

"Como uso o Playwright MCP"

O Windsurf puxará a documentação relevante do GitMCP para implementar o recurso de memória corretamente.

Exemplo 2: Usando o Cursor com um site GitHub Pages

Para o site GitHub Pages langchain-ai.github.io/langgraph, adicione https://langchain-ai.gitmcp.io/langgraph como um servidor MCP no Cursor.

Prompt para o Cursor:

"Adicione memória ao meu agente LangGraph"

O Cursor puxará a documentação e o código relevantes do GitMCP para implementar corretamente o recurso de memória.

Exemplo 3: Usando o Claude Desktop com o endpoint dinâmico

Você não precisa escolher repositórios específicos. O endpoint genérico gitmcp.io/docs permite que a IA escolha o projeto GitHub na hora!

Prompt para qualquer assistente de IA:

"Quero aprender sobre o modelo de reconhecimento de fala OpenAI Whisper. Explique como ele funciona."

O Claude puxará os dados do GitMCP e responderá à pergunta.

🛠️ Ferramentas

O GitMCP fornece aos assistentes de IA várias ferramentas valiosas para ajudá-los a acessar, entender e consultar repositórios GitHub.

`fetch_<repo-name>_documentation`

Esta ferramenta obtém a documentação principal de um repositório GitHub. Ela funciona recuperando a documentação relevante (por exemplo, llms.txt). Isso dá à IA uma boa visão geral do que o projeto se trata.

Quando é útil: Para perguntas gerais sobre o propósito, recursos ou como começar de um projeto.

`search_<repo-name>_documentation`

Esta ferramenta permite que a IA pesquise na documentação de um repositório fornecendo uma consulta de pesquisa específica. Em vez de carregar toda a documentação (que pode ser muito grande), ela usa pesquisa inteligente para encontrar apenas as partes relevantes.

Quando é útil: Para perguntas específicas sobre recursos, funções ou conceitos particulares dentro de um projeto.

`fetch_url_content`

Esta ferramenta ajuda a IA a obter informações de links mencionados na documentação. Ela recupera o conteúdo desses links e o converte em um formato que a IA pode ler facilmente.

Quando é útil: Quando a documentação referencia informações externas que ajudariam a responder sua pergunta.

`search_<repo-name>_code`

Esta ferramenta pesquisa no código real do repositório usando a busca de código do GitHub. Ela ajuda a IA a encontrar exemplos de código específicos ou detalhes de implementação.

Quando é útil: Quando você quer exemplos de como algo é implementado ou precisa de detalhes técnicos não cobertos na documentação.

Nota: Ao usar o endpoint dinâmico (gitmcp.io/docs), essas ferramentas são nomeadas de forma ligeiramente diferente (fetch_generic_documentation, search_generic_code e search_generic_documentation) e precisam de informações adicionais sobre qual repositório acessar.

📊 Badge

O GitMCP tem um badge para o README do seu repositório. Ele permite que os usuários acessem rapidamente sua documentação através do IDE ou navegador (usando o chat integrado). Ele também mostra quantas vezes sua documentação foi acessada através do GitMCP.

Exemplo (idosal/git-mcp):

Adicionando o Badge ao Seu Repositório

Adicione o seguinte ao seu README.md:

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

Substitua OWNER pelo seu nome de usuário ou organização do GitHub, e REPO pelo nome do seu repositório.

Como Contamos Visualizações

Incremento para cada chamada de ferramenta no repositório específico.

Personalizando o Badge

Você pode personalizar a aparência do badge com parâmetros:

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

Entre em contato se precisar de ajuda!

❓ FAQ

O que é o Model Context Protocol?

O Model Context Protocol é um padrão que permite que assistentes de IA solicitem e recebam contexto adicional de fontes externas de forma estruturada, melhorando sua compreensão e desempenho.

O GitMCP funciona com qualquer assistente de IA?

Sim, o GitMCP é compatível com qualquer assistente de IA que suporte o Model Context Protocol, incluindo ferramentas como Cursor, VSCode, Claude, etc.

O GitMCP é compatível com todos os projetos GitHub?

Absolutamente! O GitMCP funciona com qualquer repositório GitHub público sem exigir modificações. Ele prioriza o arquivo llms.txt e recorre ao README.md ou outras páginas se o primeiro não estiver disponível. Atualizações futuras visam suportar métodos adicionais de documentação e até mesmo gerar conteúdo dinamicamente.

O GitMCP custa dinheiro?

Não, o GitMCP é um serviço gratuito para a comunidade, sem custos associados.

🔒 Privacidade

O GitMCP está profundamente comprometido com a privacidade de seus usuários. O serviço não tem acesso nem armazena nenhuma informação pessoalmente identificável, pois não requer autenticação. Além disso, ele não armazena nenhuma consulta enviada pelos agentes. Além disso, como o GitMCP é um projeto de código aberto, ele pode ser implantado de forma independente no seu ambiente. O GitMCP acessa apenas conteúdo que já está disponível publicamente e somente quando consultado por um usuário. O GitMCP não faz scraping automático de repositórios. Antes de acessar qualquer site do GitHub Pages, o código verifica as regras de robots.txt e segue as diretrizes definidas pelos proprietários dos sites, permitindo que eles optem por não participar. Observe que o GitMCP não armazena permanentemente dados sobre os projetos do GitHub ou seu conteúdo.

👥 Contribuindo

Aceitamos contribuições, feedback e ideias! Por favor, revise nossas diretrizes de contribuição.

Configuração de Desenvolvimento Local

Clone o repositório

git clone https://github.com/idosal/git-mcp.git
cd git-mcp

Instale as dependências
```
pnpm install
```
Execute localmente para desenvolvimento
```
npm run dev
# or
pnpm dev
```

Usando o MCP Inspector para Testes

Instale a ferramenta MCP Inspector:
```
npx @modelcontextprotocol/inspector
```
Na interface do inspector:
- Defina o Tipo de Transporte como SSE
- Insira sua URL do GitMCP (ex.: http://localhost:5173/docs)
- Clique em "Conectar"

📄 Licença

Este projeto está licenciado sob a Apache License 2.0.

Aviso Legal

O GitMCP é fornecido "como está", sem garantia de qualquer tipo. Embora nos esforcemos para garantir a confiabilidade e a segurança do nosso serviço, não somos responsáveis por quaisquer danos ou problemas que possam surgir do seu uso. Os projetos do GitHub acessados por meio do GitMCP estão sujeitos aos termos e condições de seus respectivos proprietários. O GitMCP não é afiliado ao GitHub nem a nenhuma das ferramentas de IA mencionadas.

GitMCP

Documentação

GitMCP

🤔 O que é GitMCP?

✨ Recursos

🚀 Começando

Passo 1: Escolha o tipo de servidor que você deseja

Passo 2: Conecte seu assistente de IA

Conectando o Cursor

Conectando o Claude Desktop

Conectando o Windsurf

Conectando o VSCode

Conectando o Cline

Conectando o Highlight AI

Conectando o Augment Code

Conectando o Msty AI

⚙ Como Funciona

Documentação Suportada

💡 Exemplos

Exemplo 1: Usando o Windsurf com um repositório específico

Exemplo 2: Usando o Cursor com um site GitHub Pages

Exemplo 3: Usando o Claude Desktop com o endpoint dinâmico

🛠️ Ferramentas

fetch_<repo-name>_documentation

search_<repo-name>_documentation

fetch_url_content

search_<repo-name>_code

📊 Badge

Adicionando o Badge ao Seu Repositório

Como Contamos Visualizações

Personalizando o Badge

❓ FAQ

O que é o Model Context Protocol?

O GitMCP funciona com qualquer assistente de IA?

O GitMCP é compatível com todos os projetos GitHub?

O GitMCP custa dinheiro?

🔒 Privacidade

👥 Contribuindo

Configuração de Desenvolvimento Local

Usando o MCP Inspector para Testes

📄 Licença

Aviso Legal

Histórico de Estrelas

`fetch_<repo-name>_documentation`

`search_<repo-name>_documentation`

`fetch_url_content`

`search_<repo-name>_code`