GitMCP

GitMCP

GitMCP 是什么 • 功能 • 快速开始 • 工作原理 • 徽章 • 示例 • 常见问题 • 隐私 • 贡献 • 许可证

🤔 GitMCP 是什么？

告别凭感觉臆想，开始凭感觉编程！

GitMCP 是一个免费、开源的远程 模型上下文协议（MCP） 服务，可将任意 GitHub 项目（代码仓库或 GitHub Pages）变成文档中心。它让 Cursor 等 AI 工具能够访问最新的文档和代码，即使大模型从未接触过这些内容也不例外，从而轻松消除代码幻觉。

GitMCP 提供两种模式 -

• 特定代码仓库（gitmcp.io/{owner}/{repo} 或 {owner}.gitmcp.io/{repo}）： 如果你主要使用少数几个库，请使用此模式。这样可以确保 AI 助手始终针对正确的项目，避免访问意料之外的代码仓库，从而提升安全性和相关性。
• 通用服务（gitmcp.io/docs）： 如果你需要频繁切换不同的代码仓库，请使用此模式以获得最大的灵活性。AI 助手会针对每个请求询问你要访问哪个代码仓库（也可能根据上下文自行判断）。请注意，这种模式依赖于每次都能正确识别目标代码仓库。

使用 GitMCP：

• AI 助手可直接从源代码访问最新的文档和代码。
• 获取准确的 API 用法和可靠的代码示例。
• 即使面对小众、较新或快速变化的库，也能高效工作。
• 大幅减少幻觉并提高代码正确性。

例如，下面的并排对比展示了在 Cursor 中使用同一个一次性提示词创建 three.js 场景的结果 -

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

✨ 功能

• 😎 获取任意 GitHub 项目的最新文档：让 AI 助手无缝访问 GitHub 项目的文档和代码。内置的智能搜索功能可以准确找到 AI 所需内容，同时避免消耗过多令牌！
• 🧠 告别幻觉：借助 GitMCP，AI 助手可以针对你的问题提供准确且相关的回答。
• ☁️ 零配置：GitMCP 在云端运行。只需在 IDE 中将所选的 GitMCP URL 添加为 MCP 服务即可——无需下载、安装、注册或进行任何更改。
• 💬 内嵌聊天：通过我们的浏览器内聊天功能直接与代码仓库文档对话，快速上手！
• ✅ 开放、免费且私密：GitMCP 是开源的，完全免费使用。它不会收集个人信息或存储查询内容。你甚至可以自行托管！

🚀 快速开始

使用 GitMCP 非常简单！只需按照以下步骤操作：

步骤 1：选择你想要的服务类型

根据你想连接的目标，选择以下一种 URL 格式：

• 对于 GitHub 仓库：gitmcp.io/{owner}/{repo}
• 对于 GitHub Pages 网站：{owner}.gitmcp.io/{repo}
• 对于支持任意仓库的通用工具（动态）：gitmcp.io/docs

将 {owner} 替换为 GitHub 用户名或组织名称，并将 {repo} 替换为仓库名称。

为方便起见，你也可以使用首页上的转换工具，将 GitHub URL 转换为 MCP URL！

步骤 2：连接你的 AI 助手

从下方选项中选择你的 AI 助手，并按照配置说明进行操作：

连接 Cursor

更新 Cursor 配置文件 ~/.cursor/mcp.json：

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

连接 Claude Desktop

1. 在 Claude Desktop 中，前往 Settings > Developer > Edit Config
2. 将配置替换为：

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

连接 Windsurf

更新 Windsurf 配置文件 ~/.codeium/windsurf/mcp_config.json：

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

连接 VSCode

更新 VSCode 配置文件 .vscode/mcp.json：

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

连接 Cline

更新 Cline 配置文件 ~/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": []
    }
  }
}

连接 Highlight AI

1. 打开 Highlight AI，然后点击侧边栏中的插件图标（@ 符号）
2. 点击侧边栏顶部的 Installed Plugins
3. 选择 Custom Plugin
4. 点击 Add a plugin using a custom SSE URL

插件名称：gitmcp SSE URL：https://gitmcp.io/{owner}/{repo}

有关向 HighlightAI 添加自定义 MCP 服务的更多详情，请参阅文档。

连接 Augment Code

1. 打开 Augment Code 设置
2. 前往 MCP 部分
3. 使用以下详情添加新的 MCP 服务：

将 MCP 服务命名为：git-mcp Docs

使用此命令：

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

或者使用以下配置：

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

连接 Msty AI

1. 打开 Msty Studio
2. 前往 Tools > Import Tools from JSON Clipboard
3. 粘贴以下配置：

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

有关在 Augment Code 中配置 MCP 服务的更多详情，请访问 Augment Code 文档。

注意： 请记得将 {owner} 和 {repo} 替换为实际的 GitHub 用户名/组织名称和仓库名称。你也可以使用动态端点 https://gitmcp.io/docs，让你的 AI 按需访问任意仓库。

⚙ 工作原理

GitMCP 使用 Model Context Protocol（MCP）将你的 AI 助手连接到 GitHub 仓库。MCP 是一种标准，允许 AI 工具从外部来源请求更多信息。

使用 GitMCP 时会发生什么：

1. 你向 AI 助手提供 GitMCP URL（例如 gitmcp.io/microsoft/typescript）。GitMCP 会提供文档获取、智能搜索、代码搜索等工具。
2. 向 AI 助手提出与文档/代码相关的问题。
3. 你的 AI 会向 GitMCP 发送请求来使用其工具（需经你批准）。
4. GitMCP 执行 AI 的请求并返回所需数据。
5. 你的 AI 接收信息并生成更准确、有依据且不会产生幻觉的回复。

支持的文档

GitMCP 目前支持以下文档（按优先级排序）：

1. llms.txt
2. 项目文档的 AI 优化版本
3. README.md/根目录

💡 示例

以下示例展示如何将 GitMCP 与不同的 AI 助手和仓库搭配使用：

示例 1：在 Windsurf 中使用指定仓库

对于 GitHub 仓库 https://github.com/microsoft/playwright-mcp，将 https://gitmcp.io/microsoft/playwright-mcp 添加为 Windsurf 的 MCP 服务。

对 Claude 的提示词：

“如何使用 Playwright MCP？”

Windsurf 将从 GitMCP 获取相关文档，以正确实现记忆功能。

示例 2：在 Cursor 中使用 GitHub Pages 网站

对于 GitHub Pages 网站 langchain-ai.github.io/langgraph，请将 https://langchain-ai.gitmcp.io/langgraph 添加为 Cursor 的 MCP 服务。

向 Cursor 提示：

“为我的 LangGraph Agent 添加记忆”

Cursor 会从 GitMCP 获取相关文档和代码，以正确实现记忆功能。

示例 3：在 Claude Desktop 中使用动态端点

你不必选择特定的仓库。通用的 gitmcp.io/docs 端点允许 AI 即时选择 GitHub 项目！

向任意 AI 助手提示：

“我想了解 OpenAI Whisper 语音识别模型。请解释它的工作原理。”

Claude 会从 GitMCP 获取数据并回答问题。

🛠️ 工具

GitMCP 为 AI 助手提供多种实用工具，帮助它们访问、理解和查询 GitHub 仓库。

fetch_<repo-name>_documentation

此工具用于获取 GitHub 仓库的主要文档。它会检索相关文档（例如 llms.txt），让 AI 大致了解项目的内容。

适用场景： 询问有关项目用途、功能或如何入门的一般性问题时

search_<repo-name>_documentation

此工具允许 AI 使用特定的搜索查询来搜索仓库文档。它不会加载所有文档（这些文档可能非常庞大），而是通过智能搜索仅查找相关内容。

适用场景： 询问有关项目中特定功能、函数或概念的问题时

fetch_url_content

此工具可帮助 AI 获取文档中提及的链接信息。它会检索这些链接的内容，并将其转换为 AI 易于阅读的格式。

适用场景： 文档引用了有助于回答问题的外部信息时

search_<repo-name>_code

此工具使用 GitHub 的代码搜索功能来搜索仓库中的实际代码，帮助 AI 查找特定代码示例或实现细节。

适用场景： 想查看某项功能的实现示例，或需要文档中未涵盖的技术细节时

注意： 使用动态端点（gitmcp.io/docs）时，这些工具的名称略有不同（fetch_generic_documentation、search_generic_code 和 search_generic_documentation），并且需要提供要访问的仓库的额外信息。

📊 徽章

GitMCP 为你的仓库 README 提供徽章。用户可通过 IDE 或浏览器（使用内嵌聊天）快速访问你的文档。它还会展示你的文档通过 GitMCP 被访问的次数。

示例（idosal/git-mcp）：

将徽章添加到你的仓库

将以下内容添加到你的 README.md：

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

将 OWNER 替换为你的 GitHub 用户名或组织名称，并将 REPO 替换为你的仓库名称。

如何统计浏览次数

每次针对特定仓库调用工具时，浏览次数都会递增。

自定义徽章

你可以通过参数自定义徽章外观：

参数	说明	默认值	示例
color	徽章值的颜色	aquamarine	?color=green
label	徽章标签	GitMCP	Documentation

如需帮助，请联系我们！

❓ 常见问题

什么是模型上下文协议？

模型上下文协议 是一项标准，允许 AI 助手以结构化的方式从外部来源请求并接收额外上下文，从而增强其理解能力和性能。

GitMCP 能与任何 AI 助手配合使用吗？

可以，GitMCP 与任何支持模型上下文协议的 AI 助手兼容，包括 Cursor、VSCode、Claude 等工具。

GitMCP 与所有 GitHub 项目兼容吗？

当然！GitMCP 无需任何修改，即可与任何公开的 GitHub 仓库配合使用。它会优先使用 llms.txt 文件；如果该文件不可用，则会使用 README.md 或其他页面。未来的更新计划支持更多文档方法，甚至动态生成内容。

GitMCP 要收费吗？

不收费。GitMCP 是一项免费向社区提供的服务，不会产生任何相关费用。

🔒 隐私

GitMCP 高度重视用户隐私。由于无需身份验证，该服务无法访问或存储任何个人身份信息。此外，它也不会存储 Agent 发送的任何查询。而且，由于 GitMCP 是一个开源项目，你可以在自己的环境中独立部署。

GitMCP 只会访问已经公开的内容，且仅在用户发起查询时访问。GitMCP 不会自动抓取仓库。在访问任何 GitHub Pages 网站之前，代码都会检查 robots.txt 规则，并遵循网站所有者设定的指令，让他们可以选择退出。请注意，GitMCP 不会永久存储有关 GitHub 项目或其内容的数据。

👥 贡献

欢迎贡献、反馈和创意！请查阅我们的贡献指南。

本地开发设置

1. 克隆仓库

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

2. 安装依赖项

   pnpm install
   

3. 在本地运行以进行开发

   npm run dev
   # or
   pnpm dev
   

使用 MCP Inspector 进行测试

1. 安装 MCP Inspector 工具：

   npx @modelcontextprotocol/inspector
   

2. 在 Inspector 界面中：

   • 将传输类型设为 SSE
   • 输入你的 GitMCP URL（例如，http://localhost:5173/docs）
   • 点击“连接”

📄 许可证

本项目采用 Apache License 2.0 许可。

免责声明

GitMCP 按“现状”提供，不附带任何形式的担保。虽然我们努力确保服务的可靠性和安全性，但对于因使用本服务而可能造成的任何损害或问题，我们概不负责。通过 GitMCP 访问的 GitHub 项目受其各自所有者的条款和条件约束。GitMCP 与 GitHub 或任何提及的 AI 工具均无关联。

Star 历史