🚀 GitHub MCP 使用说明

本项目提供了使用GitHub API进行问题、拉取请求、里程碑、标签和评论管理的方法，同时包含搜索查询语法、设置指南、构建说明等内容。

🚀 快速开始

你可以按照以下步骤快速使用GitHub MCP：

1. 创建个人访问令牌，具体步骤见“设置指南”中的“个人访问令牌创建”。
2. 根据需求使用不同的API进行操作，如创建问题、拉取请求等。

💻 使用示例

基础用法

问题创建示例

curl -X POST https://api.github.com/repos/{owner}/{repo}/issues \
-H "Authorization: token <YOUR_TOKEN>" \
-d '{"title":"这是一个测试问题","body":"这个问题是用于测试GitHub API的。"}'

拉取请求创建示例

curl -X POST https://api.github.com/repos/{owner}/{repo}/pulls \
-H "Authorization: token <YOUR_TOKEN>" \
-d '{"title":"这是一个测试拉取请求","body":"这个拉取请求是用于测试GitHub API的。","head":"main","base":"main"}'

高级用法

里程碑管理 - 创建新里程碑

curl -X POST https://api.github.com/repos/{owner}/{repo}/milestones \
-H "Authorization: token <YOUR_TOKEN>" \
-d '{"title":"v1.0","state":"open","description":"版本1.0的发布"}'

标签管理 - 创建新标签

curl -X POST https://api.github.com/repos/{owner}/{repo}/labels \
-H "Authorization: token <YOUR_TOKEN>" \
-d '{"name":"bug","color":"ff0000"}'

评论管理 - 添加问题评论

curl -X POST https://api.github.com/repos/{owner}/{repo}/issues/{issue_number}/comments \
-H "Authorization: token <YOUR_TOKEN>" \
-d '{"body":"这是一个测试评论。"}'

📚 详细文档

搜索查询语法

代码搜索

• 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: "John Doe" type:user location:New York

设置指南

个人访问令牌创建

1. 登录你的GitHub账户。
2. 进入 Personal Access Tokens 页面。
3. 点击“生成新令牌”按钮。
4. 勾选所需的权限，然后点击“生成令牌”。
5. 复制令牌并保存到安全位置。

在Claude Desktop中使用

Docker配置

# 安装Docker
curl -fsSL https://get.docker.com | bash -s docker

# 运行MCP服务器
docker run -it --rm -p 8080:8080 mcp-server:latest

NPX配置

npm install -g mcp-cli
mcp serve

构建说明

使用以下命令构建Docker镜像：

docker build -t mcp-server . && docker tag mcp-server:latest yourname/mcp-server:latest

📄 许可证

GitHub MCP 服务器遵循 MIT 许可证。有关详细信息，请参阅许可文件。