使用说明

项目简介

GitMCP 是一个免费开源的 Model Context Protocol (MCP) 服务器，可以将任何 GitHub 项目（仓库或 GitHub Pages）转换为文档中心。它允许 AI 工具（如 Cursor）访问最新的文档和代码，从而减少 AI 幻觉。

主要功能点

最新文档获取: 为 AI 助手提供访问任何 GitHub 项目的最新文档和代码的能力。内置智能搜索功能，帮助 AI 快速找到所需信息。
零配置部署: 无需下载、安装或注册，只需在 AI 助手的 MCP 服务器配置中添加 GitMCP URL 即可使用。
免费且私密: GitMCP 是开源且完全免费的服务。不收集个人信息，也不存储用户查询。支持用户自行托管。

安装步骤

GitMCP 服务本身无需安装，它作为一个远程 MCP 服务器运行。如果您希望自托管 GitMCP，请参考仓库的贡献指南进行本地开发环境搭建。

服务器配置

要将 MCP 客户端连接到 GitMCP 服务器，您需要在 MCP 客户端的配置文件中添加 GitMCP 服务器的配置信息。以下是一些常见 MCP 客户端的配置示例，您需要根据您的客户端类型选择相应的配置并进行设置。

重要提示: 请将配置示例中的 '{owner}' 和 '{repo}' 替换为实际的 GitHub 用户名/组织名和仓库名。如果您希望 AI 能够按需访问任何仓库，可以使用动态端点 'https://gitmcp.io/docs'。

Cursor 配置 ( '~/.cursor/mcp.json' )

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

Claude Desktop 配置 ( 'Settings > Developer > Edit Config' )

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

Windsurf 配置 ( '~/.codeium/windsurf/mcp_config.json' )

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

VSCode 配置 ( '.vscode/mcp.json' )

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

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": []
    }
  }
}

基本使用方法

选择 GitMCP URL: 根据您要连接的 GitHub 项目类型，选择合适的 GitMCP URL 格式。例如，对于 GitHub 仓库 'https://github.com/microsoft/typescript'，可以使用 'https://gitmcp.io/microsoft/typescript'。对于 GitHub Pages 站点，请使用 '{owner}.gitmcp.io/{repo}' 格式。动态访问任何仓库可以使用 'https://gitmcp.io/docs'。
配置 AI 助手: 根据您使用的 AI 助手的类型，按照上述 “服务器配置” 部分的说明，将选择的 GitMCP URL 添加到您的 AI 助手的 MCP 服务器配置中。
向 AI 助手提问: 在您的 AI 助手中使用自然语言提出关于文档或代码的问题。例如，询问 “如何使用 Playwright MCP” 或 “解释 OpenAI Whisper 模型的工作原理”。
AI 助手请求信息: 当 AI 助手需要更多上下文信息时，它会向 GitMCP 服务器发送请求，获取相关文档或代码。您可能需要批准这些请求，具体取决于您的 AI 助手配置。
获取更准确的回答: AI 助手从 GitMCP 获取信息后，将生成更准确、更可靠的回答，减少幻觉的产生。

关键词