使用说明
GitHub MCP服务器设置指南
本指南提供了使用Claude Desktop设置GitHub MCP(模型上下文协议)服务器的分步说明,实现了Claude和GitHub存储库之间的无缝集成。
什么是MCP?
模型上下文协议(MCP)是一种开放协议,使AI助手能够安全地连接到本地和远程资源。GitHub MCP服务器允许Claude Desktop与GitHub存储库交互,实现读取文件、创建存储库、管理问题等功能。
先决条件
在开始之前,请确保您已经:
- Claude Desktop已安装在您的计算机上
- 已安装Node.js(版本16或更高)
- GitHub帐户
- Git已安装在您的系统上
步骤1:安装GitHub MCP服务器
-
打开终端或命令提示符
-
使用npm全局安装GitHub MCP服务器:
npm install -g @modelcontextprotocol/server-github -
验证安装:
mcp-server-github --version
步骤2:创建GitHub个人访问令牌
- 转到GitHub并登录您的帐户
- 点击右上角的个人资料图片
- 从下拉菜单中选择“设置”
- 在左侧边栏中,单击“开发人员设置”
- 点击“个人访问令牌”→ “代币(经典)”
- 点击“生成新令牌”→ “生成新令牌(经典)”
- 为您的令牌命名(例如“Claude Desktop MCP”)
- 选择以下范围:
repo(完全控制私有存储库)user:email(访问用户电子邮件地址)read:user(读取用户配置文件信息)workflow(更新GitHub Action工作流)
- 点击“生成令牌”
- 重要:立即复制令牌并安全保存。你将无法再看到它。
步骤3:配置Claude桌面
对于macOS:
- 打开Finder并导航到
~/Library/Application Support/Claude/ - 创建或编辑
claude_desktop_config.json文件 - 添加以下配置:
{
"mcpServers": {
"github": {
"command": "mcp-server-github",
"args": [],
"env": {
"GITHUB_PERSONAL_ACCESS_TOKEN": "your_github_token_here"
}
}
}
}
对于Windows:
- 引导到
%APPDATA%\Claude\ - 创建或编辑
claude_desktop_config.json文件 - 添加与上述相同的配置
对于Linux:
- 引导到
~/.config/Claude/ - 创建或编辑
claude_desktop_config.json文件 - 添加与上述相同的配置
步骤4:替换令牌
在配置文件中,替换 your_github_token_here 使用您在步骤2中生成的实际令牌。
例子:
{
"mcpServers": {
"github": {
"command": "mcp-server-github",
"args": [],
"env": {
"GITHUB_PERSONAL_ACCESS_TOKEN": "ghp_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}
}
}
}
步骤5:重新启动克劳德桌面
- 完全退出克劳德桌面
- 重新启动应用程序
- GitHub MCP服务器现在应该已连接
步骤6:测试集成
尝试让Claude执行与GitHub相关的任务:
- “列出我的存储库”
- “创建一个名为“测试仓库”的新仓库”
- “在[存储库名称]中显示README文件的内容”
- “在[存储库名称]中创建问题”
可用特征
配置后,Claude可以帮助您:
- 库管理:创建、列出和管理存储库
- 文件操作:读取、创建和更新存储库中的文件
- 问题管理:创建、列出和更新问题
- 拉取请求管理:创建、审核和合并拉取请求
- 分行管理:创建和管理分支
- 搜索操作:搜索存储库、代码、问题和用户
- 协作:分叉存储库、创建评论和管理合作者
故障排除
常见问题:
-
“找不到MCP服务器”
- 确保全局安装了服务器:
npm install -g @modelcontextprotocol/server-github - 验证安装路径是否与系统的全局npm路径匹配
- 确保全局安装了服务器:
-
“身份验证失败”
- 仔细检查您的GitHub个人访问令牌
- 确保令牌具有正确的作用域
- 确保令牌未过期
-
“未加载配置”
- 验证配置文件是否在正确的位置
- 检查JSON语法是否有效
- 确保配置后已重新启动Claude Desktop
-
“权限被拒绝”
- 检查您的GitHub令牌是否具有必要的权限
- 验证您是否有权访问您尝试与之交互的存储库
调试步骤:
- 检查Claude Desktop日志中的错误消息
- 使用JSON验证器验证配置文件语法
- 直接使用GitHub API测试您的GitHub代币
- 确保Node.js和npm安装正确
安全考虑
- 安全地存储您的GitHub个人访问令牌
- 使用具有最低所需权限的令牌
- 定期轮换您的访问令牌
- 考虑使用环境变量而不是硬编码令牌
- 定期审查和审计存储库访问
具有环境变量的替代配置
为了增强安全性,您可以将令牌设置为环境变量:
-
设置环境变量:
export GITHUB_PERSONAL_ACCESS_TOKEN=your_token_here -
更新您的配置:
{ "mcpServers": { "github": { "command": "mcp-server-github", "args": [], "env": { "GITHUB_PERSONAL_ACCESS_TOKEN": "${GITHUB_PERSONAL_ACCESS_TOKEN}" } } } }
获取帮助
如果您遇到问题:
- 查看MCP官方文件
- 查看GitHub MCP服务器存储库以获取更新
- 验证您的GitHub API限制和使用
- 请咨询Claude Desktop支持资源
贡献
如果您发现本指南存在问题或有改进建议,请创建问题或向此存储库提交拉取请求。
这是由Claude出于测试目的生成的。
