使用说明
MCP GitHub上下文
一个模型上下文协议(MCP)服务器,为AI助手和编辑器提供GitHub上下文。
✨ 特性
- 📥 获取拉取请求差异
- 📋 列出并检查拉取请求、评论和评论
- 📁 列出PR中的文件并检查提交
- 🔀 比较分支
- 🔍 从本地存储库提取Git远程信息
📦 安装
来自npm
npm install -g mcp-github-context
来源
git clone https://github.com/junielton/mcp-github-context.git
cd mcp-github-context
npm install
npm run build
🚀 用法
环境变量
| 变量 | 必填 | 描述 |
|---|---|---|
GITHUB_TOKEN |
推荐 | GitHub个人访问令牌用于私有仓库和更高的速率限制(5000/小时vs 60/小时) |
在以下位置生成令牌:https://github.com/settings/tokens
所需范围: repo 对于私人回购,或 public_repo 仅供公众使用。
运行服务器
# Development
GITHUB_TOKEN=your_token npm run dev
# Production
GITHUB_TOKEN=your_token npm start
# If installed globally
GITHUB_TOKEN=your_token mcp-github-context
🔧 MCP客户端配置
将此添加到您的MCP客户端配置中(例如,Claude、Cursor等):
使用npx(推荐)
{
"mcpServers": {
"github-context": {
"command": "npx",
"args": ["-y", "mcp-github-context"],
"env": {
"GITHUB_TOKEN": "your_github_token_here"
}
}
}
}
使用全局安装
{
"mcpServers": {
"github-context": {
"command": "mcp-github-context",
"env": {
"GITHUB_TOKEN": "your_github_token_here"
}
}
}
}
使用本地安装
{
"mcpServers": {
"github-context": {
"command": "node",
"args": ["/path/to/mcp-github-context/dist/server.js"],
"env": {
"GITHUB_TOKEN": "your_github_token_here"
}
}
}
}
🛠️ 可用工具
| 工具 | 说明 |
|---|---|
fetch_github_pr_diff |
从PR获取原始差异内容 |
list_pull_requests |
列出带有可选过滤器(状态、限制)的PR |
get_pr_details |
获取完整的PR详细信息(标题、正文、标签、统计数据) |
get_pr_comments |
获取所有公关评论(一般+评论) |
get_pr_reviews |
获取所有PR评论及其状态 |
get_pr_files |
列出PR中更改的文件及其统计信息 |
compare_branches |
比较两个分支(提交、文件) |
get_commit_details |
获取提交信息(作者、消息、文件) |
get_git_remote_info |
从本地Git仓库中提取所有者/仓库 |
💡 示例提示
配置后,您可以使用以下提示:
- “在facebook上列出公开的PR/反应”
- “从org/repo获取PR#123的详细信息”
- “显示PR#456的差异”
- “比较org/repo中的主分支和开发分支”
- “提交abc123时更改了哪些文件?”
📄 许可证
Apache-2.0--参见 许可证
👤 作者
朱尼尔顿 - GitHub
🙏 致谢
- 建立在 模型上下文协议
- 由...驱动 GitHub REST API
