Github MCP 服务器

一个用于 Github 的 模型上下文协议 服务器。

通过 MCP 提供与 Github 的集成，允许 LLM 与之交互。

Github REST Api 文档

安装

手动安装

1. 为您的 Github 帐户创建或获取访问令牌：指南

2. 将服务器配置添加到 Claude Desktop：

   • MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json
   • Windows: 查看此指南

{
  "mcpServers": {
    "github": {
      "command": "npx",
      "args": ["-y", "github-mcp-server"],
      "env": {
        "GITHUB_PERSONAL_ACCESS_TOKEN": "your_personal_github_access_token"
      }
    }
  }
}

组件

工具

1. search_repositories: 搜索 GitHub 上的仓库。

   • 必需输入：
     • query (字符串): 用于搜索仓库的查询。
     • page (数字, 默认: 30, 最大: 100): 分页的页码。
     • per_page (数字, 默认: 30, 最大: 100): 每页的结果数。

2. search_issues: 从仓库中搜索 issue。

   • 必需输入：
     • query (字符串): 用于搜索仓库的查询。
     • page (数字, 默认: 1): 分页的页码。
     • per_page (数字, 默认: 30, 最大: 100): 每页的结果数。
     • order (可选字符串, 默认: desc): 排序方式 (asc 或 desc)。
     • sort (可选字符串, 默认: best match): 排序字段 (可以是以下之一: comments, reactions, reactions-+1, reactions--1, reactions-smile, reactions-thinking_face, reactions-heart, reactions-tada, interactions, created 或 updated)。

3. search_commits: 从仓库中搜索 commit。

   • 必需输入：
     • query (字符串): 用于搜索仓库的查询。
     • page (数字, 默认: 1): 分页的页码。
     • per_page (数字, 默认: 30, 最大: 100): 每页的结果数。
     • order (可选字符串, 默认: desc): 排序方式 (asc 或 desc)。
     • sort (可选字符串, 默认: best match): 排序字段 (可以是以下之一: committer-date 或 author-date)。

4. search_code: 从仓库中搜索代码。

   • 必需输入：
     • query (字符串): 用于搜索仓库的查询。
     • page (数字, 默认: 1): 分页的页码。
     • per_page (数字, 默认: 30, 最大: 100): 每页的结果数。

5. search_users: 从仓库中搜索用户。

   • 必需输入：
     • query (字符串): 用于搜索仓库的查询。
     • page (数字, 默认: 1): 分页的页码。
     • per_page (数字, 默认: 30, 最大: 100): 每页的结果数。
     • order (可选字符串, 默认: desc): 排序方式 (asc 或 desc)。
     • sort (可选字符串, 默认: best match): 排序字段 (可以是以下之一: followers, repositories 或 joined)。

6. search_topics: 搜索主题。

   • 必需输入：
     • query (字符串): 用于搜索仓库的查询。
     • page (数字, 默认: 1): 分页的页码。
     • per_page (数字, 默认: 30, 最大: 100): 每页的结果数。

7. search_labels: 搜索仓库中的标签。

   • 必需输入：
     • query (字符串): 用于搜索仓库的查询。
     • page (数字, 默认: 1): 分页的页码。
     • per_page (数字, 默认: 30, 最大: 100): 每页的结果数。
     • order (可选字符串, 默认: desc): 排序方式 (asc 或 desc)。
     • sort (可选字符串, 默认: best match): 排序字段 (可以是以下之一: created 或 updated)。

8. list_repositories_issues: 列出仓库中的 issue。

   • 必需输入：
     • owner (字符串): 仓库的所有者。
     • repo (字符串): 仓库名称。
     • page (可选数字, 默认: 1): 分页的页码。
     • per_page (可选数字, 默认: 30, 最大: 100): 每页的结果数。
     • direction (可选字符串, 默认: desc): 排序方向 (asc 或 desc)。
     • sort (可选字符串, 默认: created): 排序字段 (可以是以下之一: created, comments 或 updated)。
     • since (可选字符串): 结果在给定时间之后最后更新 (ISO 8601 格式: YYYY-MM-DDTHH:MM:SSZ.)。
     • labels (可选字符串): 逗号分隔的标签名称。例如: bug,ui,@high。
     • milestone (可选字符串): 里程碑编号。
     • assignee (可选字符串): 受让人用户名 (* 表示全部)。
     • creator (可选字符串): 创建 issue 的用户 (* 表示全部)。
     • mentioned (可选字符串): 在 issue 中被提及的用户。

9. get_issue: 从仓库中获取一个 issue。

   • 必需输入：
     • owner (字符串): 仓库的所有者。
     • repo (字符串): 仓库名称。
     • issue_number (数字): issue 编号。

10. list_repositories_pull_requests: 列出仓库中的 pull request。

    • 必需输入：
      • owner (字符串): 仓库的所有者。
      • repo (字符串): 仓库名称。
      • page (可选数字, 默认: 1): 分页的页码。
      • per_page (可选数字, 默认: 30, 最大: 100): 每页的结果数。
      • direction (可选字符串, 默认: desc): 排序方向 (asc 或 desc)。
      • sort (可选字符串, 默认: created): 排序字段 (可以是以下之一: created, popularity, long-running 或 updated)。
      • head (可选字符串): 按 head 用户或 head 组织和分支名称过滤 pull request，格式为 user:ref-name 或 organization:ref-name (例如: github:new-script-format 或 octocat:test-branch)。
      • base (可选字符串): 按 base 分支名称过滤 pull request (例如: gh-pages)。

11. get_pull_request: 从仓库中获取一个 pull request。

    • 必需输入：
      • owner (字符串): 仓库的所有者。
      • repo (字符串): 仓库名称。
      • pull_request_number (数字): pull request 编号。

使用示例

一些可以用来与 Github 交互的示例提示：

1. "modelcontextprotocol" → 执行 search_repositories 工具来查找提及 modelcontextprotocol 的仓库。
2. "What is the 739 issue on modelcontextprotocol servers repo" → 执行 get_issue 工具来查找 modelcontextprotocol servers 仓库中的 739 号 issue。
3. "What is the 717 PR on modelcontextprotocol servers repo" → 执行 get_pull_request 工具来查找 modelcontextprotocol servers 仓库中的 717 号 PR。

开发

1. 安装依赖：

pnpm install

2. 在 .env 中配置 Github 访问令牌：

GITHUB_PERSONAL_ACCESS_TOKEN=<your_personal_github_access_token>

3. 在本地运行并监听更改：

pnpm dev

4. 构建服务器：

pnpm build

5. 使用 inspector 进行本地调试：

pnpm inspector