GitMCP 概述
GitMCP(GitHub Model Context Protocol)是一个免费的开源 MCP 服务器,可以将任何 GitHub 项目(仓库或 GitHub Pages)转化为实时文档中心,使得 AI 工具(如 Cursor)可以随时访问最新的文档和代码,即使是 AI 从未遇到过的库,也能消除代码幻觉。
GitMCP 支持两种模式:
- 指定仓库(Specific Repository):适用于当你主要与某几个库打交道时,确保 AI 助手总是访问正确的项目,增强安全性和相关性,防止访问错误的仓库。
- 通用服务器(Generic Server):适用于需要频繁切换不同仓库的情况。AI 助手可以根据上下文自动决定每次请求要访问哪个仓库。
GitMCP 的优势
- 即时访问最新文档和代码:AI 助手能够实时获取项目的文档和代码,即便这些项目可能是 AI 从未接触过的。
- 精确的 API 用法和可靠的代码示例:无论是新的、冷门的,还是快速变化的库,GitMCP 都能确保 AI 提供准确的帮助。
- 减少代码幻觉:通过实时访问 GitHub 上的最新文档,消除了 AI 产生不准确的答案的可能性。
例如,通过 GitMCP,可以让 Cursor(一个 AI 工具)在创建一个 three.js 场景时,提供正确的、最新的 API 使用示例。
GitMCP 的功能
- 最新的文档:GitMCP 可以为任何 GitHub 项目提供最新的文档和代码,内置的智能搜索功能帮助 AI 快速找到相关信息,减少 token 消耗。
- 避免代码幻觉:AI 助手将从 GitMCP 获得最新的、准确的文档和代码,从而避免出现不准确的回答。
- 零设置:GitMCP 在云端运行,无需下载、安装或注册。只需将 GitMCP URL 添加为 MCP 服务器到你的 IDE 中即可。
- 内嵌聊天功能:用户可以通过浏览器直接与 GitMCP 仓库的文档进行交互,快速获得所需信息。
- 开源且免费的服务:GitMCP 是开源的,完全免费,并且不收集个人信息,也不存储查询数据。
获取和使用 GitMCP
GitMCP 的使用非常简单,按照以下步骤操作即可:
第一步:选择服务器类型
GitMCP 支持以下几种 URL 格式:
- 针对 GitHub 仓库:
gitmcp.io/{owner}/{repo} - 针对 GitHub Pages 站点:
{owner}.gitmcp.io/{repo} - 通用的工具支持所有仓库:
gitmcp.io/docs
将 {owner} 替换为 GitHub 用户名或组织名,{repo} 替换为仓库名。
第二步:连接你的 AI 助手
根据你使用的 AI 助手,选择合适的配置方式:
连接 Cursor
在 Cursor 的配置文件 ~/.cursor/mcp.json 中更新如下内容:
{"mcpServers":{"gitmcp":{"url":"https://gitmcp.io/{owner}/{repo}"}}}
连接 Claude Desktop
- 在 Claude Desktop 中,进入'设置 > 开发者 > 编辑配置'
- 用以下配置替换原有配置:
{"mcpServers":{"gitmcp":{"command":"npx","args":["mcp-remote","https://gitmcp.io/{owner}/{repo}"]}}}
连接 VSCode
在 VSCode 的配置文件 .vscode/mcp.json 中更新如下内容:
{"servers":{"gitmcp":{"type":"sse","url":"https://gitmcp.io/{owner}/{repo}"}}}
连接 Highlight AI
- 打开 Highlight AI,点击插件图标(@符号)
- 点击已安装插件,然后选择自定义插件
- 点击使用自定义 SSE URL 添加插件
插件名:gitmcp
SSE URL:https://gitmcp.io/{owner}/{repo}
如何使用 GitMCP
GitMCP 通过 Model Context Protocol(MCP)连接你的 AI 助手与 GitHub 仓库。当你给 AI 助手发送请求时,GitMCP 将根据请求返回相应的文档和代码。
支持的文档类型
GitMCP 当前支持以下几种文档类型,按优先级排列:
llms.txt(AI 优化版文档)- 项目的
README.md文件 - 根目录的其他文档文件
代码搜索工具
GitMCP 还提供了几种工具,帮助 AI 更好地查询和理解 GitHub 仓库:
fetch_<repo-name>_documentation:获取 GitHub 仓库的主要文档。search_<repo-name>_documentation:根据搜索查询在仓库的文档中查找相关内容。search_<repo-name>_code:在仓库的代码中搜索特定内容或实现示例。
代码示例
假设你正在使用 Windsurf 和 GitHub 仓库 microsoft/playwright-mcp,你可以将 https://gitmcp.io/microsoft/playwright-mcp 添加为 MCP 服务器,并向 Claude 提出如下问题:
Claude 提问:
'如何在 Playwright MCP 中使用内存功能?'
Windsurf 将从 GitMCP 获取最新的文档并实现内存功能。
常见问题
1. GitMCP 是如何工作的?
GitMCP 通过 MCP 协议与 AI 助手连接,并根据 AI 的请求从 GitHub 仓库中获取文档或代码。当 AI 助手发起请求时,GitMCP 返回相关数据,从而确保 AI 能够提供更准确、相关的答案。
2. GitMCP 适用于所有 GitHub 项目吗?
是的,GitMCP 支持任何公开的 GitHub 仓库,只要仓库的文档遵循一定的格式(如 README.md 或 llms.txt 文件)。
3. GitMCP 是否收费?
GitMCP 是完全免费的服务,任何人都可以使用,并且不收取任何费用。
结语
GitMCP 是一个革命性的工具,它通过将 GitHub 项目变成实时文档中心,消除了代码幻觉的发生,让 AI 助手能够提供更精确的帮助。如果你是开发者,尤其是在与多个 GitHub 仓库交互时,GitMCP 无疑会极大地提升你的工作效率。


