内容
# 🔄 GitHub MCP Server com Claude Desktop
本指南解释了如何设置 GitHub 的官方 MCP 服务器，以便与 Claude Desktop 一起使用，从而让您能够通过 Claude 与您的 GitHub 仓库进行交互。
该仓库还包括一个示例文件，位于项目根目录，演示了常见的用例。
## 📋 要求
1. **Claude Desktop** 已安装并更新
2. **Node.js 和 npm** 已安装在您的计算机上
3. **GitHub 个人访问令牌**（您将在此过程中创建）
4. 可选：**Docker** 用于容器运行
## 🔑 步骤 1：创建 GitHub 个人访问令牌
1. 访问 [github.com](https://github.com) 并登录到您的账户
2. 点击右上角的头像，选择 **Settings**
3. 在侧边菜单中，选择 **Developer settings**
4. 点击 **Personal access tokens**，然后点击 **Generate new token**
5. 给它一个描述性的名称，例如 "Claude MCP Server"
6. 选择所需的权限：
- 若要完全访问私有仓库，选择 `repo`
- 若仅访问公共仓库，选择 `public_repo`
7. 点击 **Generate token**
8. **重要**：复制并安全保存生成的令牌，因为它将不会再次显示
## ⚙️ 步骤 2：配置 Claude Desktop
### 选项 A：使用 Docker（推荐）
1. 打开 Claude Desktop 菜单，选择 **Settings**
2. 在设置面板中，点击侧边菜单中的 **Developer**
3. 点击 **Edit Config**
4. 将以下 JSON 添加到配置文件中，将 `<YOUR_TOKEN>` 替换为您的 GitHub 令牌：
```json
{
"mcpServers": {
"github": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"-e",
"GITHUB_PERSONAL_ACCESS_TOKEN",
"ghcr.io/github/github-mcp-server"
],
"env": {
"GITHUB_PERSONAL_ACCESS_TOKEN": "<YOUR_TOKEN>"
}
}
}
}
```
### 选项 B：使用 NPX（不使用 Docker）
1. 打开 Claude Desktop 菜单，选择 **Settings**
2. 在设置面板中，点击侧边菜单中的 **Developer**
3. 点击 **Edit Config**
4. 将以下 JSON 添加到配置文件中，将 `<YOUR_TOKEN>` 替换为您的 GitHub 令牌：
```json
{
"mcpServers": {
"github": {
"command": "npx",
"args": [
"-y",
"@modelcontextprotocol/server-github"
],
"env": {
"GITHUB_PERSONAL_ACCESS_TOKEN": "<YOUR_TOKEN>"
}
}
}
}
```
> **注意**：NPX 是一个随 Node.js 附带的工具，允许您在不永久安装包的情况下执行它们。此选项非常适合没有安装 Docker 或希望更轻量配置的用户。
## 📁 步骤 3：配置文件位置
配置文件位于：
- **macOS**：`~/Library/Application Support/Claude/claude_desktop_config.json`
- **Windows**：`C:\Users\[您的用户名]\AppData\Roaming\Claude\claude_desktop_config.json` 或 `C:\Users\[您的用户名]\AppData\Local\AnthropicClaude\claude_desktop_config.json`
如果文件不存在，请创建它。
## 🔄 步骤 4：重启 Claude Desktop
1. 保存配置文件
2. 完全关闭 Claude Desktop（确保它没有在后台运行）
3. 再次打开 Claude Desktop
## ✅ 步骤 5：检查集成
1. 在 Claude Desktop 中，启动一个新对话
2. 您应该在输入框的右下角看到一个工具图标（锤子）
3. 点击此图标以查看可用的 GitHub 工具
4. 通过请求 Claude 执行简单的 GitHub 操作（如列出您的仓库）来测试集成
## 📝 使用示例
在该仓库的根目录中，您将找到一个示例文件（[exemplo-de-uso.md](./exemplo-de-uso.md)），演示如何在实际场景中使用 GitHub 与 Claude Desktop 的集成。请参考此文件以：
- 查看命令和请求的示例
- 理解代码管理的常见工作流程
- 学习如何使用集成的高级功能
## 🔧 故障排除
### 启用开发者模式
1. 在 Claude Desktop 中，转到菜单（通常由三条线或点表示）-> **Help** -> **Enable Developer Mode**
2. 在 **Developer** 菜单中，您可以打开 MCP 日志文件以获取有关服务器连接的详细信息
### 检查路径
- 确保 `claude_desktop_config.json` 文件中的所有路径都是正确的
- 在 Windows 上，路径中使用双反斜杠（`\\`）
### 单独测试服务器
在管理员终端中，尝试手动运行服务器：
```bash
# 使用 NPX 启动 GitHub 服务器
npx -y @modelcontextprotocol/server-github
```
### Windows 上的常见问题
- 以管理员身份运行 Claude Desktop
- 对于可执行文件和文件使用绝对路径
- 全局安装 MCP 包（`npm install -g @modelcontextprotocol/server-github`）
- 检查环境变量是否正确配置
## 📚 其他资源
- [MCP 官方文档](https://modelcontextprotocol.io/)
- [GitHub 的 MCP 服务器](https://github.com/github/github-mcp-server)
- [MCP 服务器仓库](https://github.com/modelcontextprotocol/servers)
MCP 市场