article
README
🚀 GitHub MCP 服务器
GitHub MCP 服务器提供了强大的搜索功能,支持代码、问题和用户搜索。同时,它还详细说明了设置步骤,包括创建个人访问令牌以及如何在 Claude Desktop 中使用。此外,文档还介绍了 Docker 构建方法和许可证信息。
🚀 快速开始
你可以通过以下步骤快速使用 GitHub MCP 服务器:
- 按照“设置”部分的说明创建个人访问令牌。
- 根据自己的需求,选择合适的搜索类型(代码、问题、用户)进行搜索。
- 若要在 Claude Desktop 中使用,按相应配置添加到
claude_desktop_config.json文件。
✨ 主要特性
代码搜索
language:javascript:可按编程语言进行搜索。repo:owner/name:能在特定仓库中进行搜索。path:app/src:支持按路径搜索代码。extension:js:可按文件扩展名搜索。- 示例:
q: "import express" language:typescript path:src/
问题搜索
is:issue或is:pr:可按类型筛选问题或拉取请求。is:open或is:closed:能按状态筛选问题或拉取请求。label:bug:可按标签筛选问题。author:username:能按作者筛选问题。- 示例:
q: "memory leak" is:issue is:open label:bug
用户搜索
type:user或type:org:可按账户类型筛选用户或组织。followers:>1000:能按关注者数量筛选用户。location:London:可按位置筛选用户。- 示例:
q: "fullstack developer" location:London followers:>100
有关详细搜索语法,请参阅 GitHub 的搜索文档。
📦 安装指南
个人访问令牌
创建 GitHub 个人访问令牌 并赋予适当的权限:
- 访问 个人访问令牌(在 GitHub 设置 > 开发者设置中)。
- 选择您希望此令牌访问的仓库(公共、所有或选择)。
- 创建一个具有
repo权限范围的令牌(“对私人仓库进行全面控制”)。- 如果仅与公共仓库一起使用,可以选择仅
public_repo范围。
- 如果仅与公共仓库一起使用,可以选择仅
- 复制生成的令牌。
与 Claude Desktop 使用
要在 Claude Desktop 中使用此功能,请将以下内容添加到您的 claude_desktop_config.json:
Docker
{
"mcpServers": {
"github": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"-e",
"GITHUB_PERSONAL_ACCESS_TOKEN",
"mcp/github"
],
"env": {
"GITHUB_PERSONAL_ACCESS_TOKEN": "<YOUR_TOKEN>"
}
}
}
}
NPX
{
"mcpServers": {
"github": {
"command": "npx",
"args": [
"-y",
"@modelcontextprotocol/server-github"
],
"env": {
"GITHUB_PERSONAL_ACCESS_TOKEN": "<YOUR_TOKEN>"
}
}
}
}
💻 使用示例
基础用法
若要搜索特定仓库中的 JavaScript 代码,可使用以下搜索语法:
q: "function example" language:javascript repo:owner/name
高级用法
如果要搜索某个位置且关注者数量大于 100 的全栈开发者用户,可使用以下搜索语法:
q: "fullstack developer" location:London followers:>100
📚 详细文档
构建
Docker 构建:
docker build -t mcp/github -f src/github/Dockerfile .
📄 许可证
此 MCP 服务器根据 MIT 许可证发布。这意味着您可以自由使用、修改和分发软件,但需遵守 MIT 许可证的条款和条件。有关详细信息,请参阅项目仓库中的 LICENSE 文件。
微信扫一扫