使用说明

项目简介

本项目是一个配置示例，展示了如何配置和使用基于 Model Context Protocol (MCP) 的 GitHub 服务器。通过此配置，LLM 客户端可以连接到 GitHub MCP 服务器，安全地访问和操作 GitHub 上的仓库、代码等资源，实现代码检索、仓库管理等功能。

主要功能点

• GitHub 资源访问: 允许 LLM 应用通过 MCP 协议访问 GitHub 仓库信息、代码内容等资源。
• GitHub API 集成: 封装 GitHub API，提供诸如仓库搜索、代码检索等功能，方便 LLM 应用调用。
• 可配置的 MCP 服务器: 提供标准的 MCP 服务器配置，易于集成到支持 MCP 协议的 LLM 客户端。

安装步骤

本仓库本身无需安装，它仅提供了一个 MCP 服务器的配置示例。要实际运行 GitHub MCP 服务器，您需要安装 '@modelcontextprotocol/server-github' npm 包。

假设您已安装 Node.js 和 npm，请执行以下命令全局安装 '@modelcontextprotocol/server-github'：

npm install -g @modelcontextprotocol/server-github

服务器配置

对于 MCP 客户端，您需要配置 GitHub MCP 服务器的连接信息。以下是一个示例配置，您可以将其添加到您的 MCP 客户端的服务器配置中。

{
  "servers": {
    "github": {
      "command": "node",
      "args": [
        "/opt/homebrew/lib/node_modules/@modelcontextprotocol/server-github/dist/index.js", // GitHub MCP 服务器的入口文件路径
        "--debug" // 启用 debug 模式 (可选)
      ],
      "env": {
        "GITHUB_PERSONAL_ACCESS_TOKEN": "[Your GitHub Personal Access Token]"  // 替换为您的 GitHub Personal Access Token
      }
    }
  }
}

注意:

• 请将 '[Your GitHub Personal Access Token]' 替换为您在 GitHub 上生成的 Personal Access Token。该 Token 需要具有访问您希望 LLM 应用访问的 GitHub 资源的权限。
• '/opt/homebrew/lib/node_modules' 是 macOS 上 npm 全局安装路径的示例，您的实际路径可能有所不同。请根据您的环境调整路径。

基本使用方法

配置完成后，您的 MCP 客户端应该能够连接到名为 'github' 的 MCP 服务器。具体的使用方法取决于您的 MCP 客户端和 '@modelcontextprotocol/server-github' 提供的功能。

通常，您可以通过 MCP 客户端发送符合 MCP 协议的请求，例如：

• 请求访问 GitHub 仓库资源
• 调用 GitHub 提供的工具（例如仓库搜索）

请参考 '@modelcontextprotocol/server-github' 的文档和您的 MCP 客户端的使用说明，了解更详细的请求格式和功能调用方法。