article
README
🚀 GitHub MCP 服务器用于 Claude 桌面版
此项目通过无缝的 GitHub 集成,为 Claude 桌面版增添强大功能。它将 Claude 桌面版直接连接到您的 GitHub 仓库和 git 命令,让您能够通过自然对话与代码和仓库进行交互。
✨ 主要特性
- 🔄
git-clone:轻松请求即可克隆任何仓库。 - 📊
git-status:查看仓库中的动态。 - 📋
github-list-repos:浏览您的 GitHub 仓库。 - 🔍
github-repo-info:获取任意仓库的详细信息。 - 📝
git-commit:提交更改到您的仓库。 - 🚀
git-push:将提交推送到 GitHub。 - 🆕
github-create-repo:创建新的 GitHub 仓库。
🚀 快速开始
克隆仓库
git clone https://github.com/shibdad/github-mcp-server.git
cd github-mcp-server
安装依赖项
npm install
使其可执行
chmod +x start.sh index.js
添加 GitHub 令牌
echo "your-github-token" > .github_token
⚠️ 重要提示
此令牌用于访问私有仓库和 API,请妥善保管。
连接到 Claude 桌面版
编辑 Claude 的配置文件:
- macOS:
~/Library/Application Support/Claude/claude_desktop_config.json - Windows:
%APPDATA%\Claude\claude_desktop_config.json
添加到您的配置中:
{
"mcpServers": {
"github": {
"command": "/bin/sh",
"args": ["-c", "/path/to/github-mcp-server/start.sh"]
}
}
}
重启 Claude
重启 Claude 后,一切准备就绪!
💻 使用示例
基础用法
连接成功后,您可以向 Claude 发出以下指令:
- “将 tensorflow/models 仓库克隆到我的下载文件夹”
- “查看我项目目录的 git 状态”
- “显示我的 GitHub 仓库列表”
- “获取 microsoft/vscode 仓库的详细信息”
- “使用消息‘更新文档’提交更改”
- “将提交推送到 GitHub”
- “创建名为‘my-awesome-project’的新仓库”
🔧 技术细节
要求
- Node.js 16+ 版本
- Git 命令行工具
- Claude 桌面版
- GitHub 个人访问令牌(用于 API 访问)
GitHub 令牌选项
若需要访问私有仓库,可通过以下方式添加您的令牌:
- 在项目文件夹中创建
.github_token文件。 - 设置
GITHUB_TOKEN环境变量。 - 直接在 Claude 的配置中添加:
{
"mcpServers": {
"github": {
"command": "/bin/sh",
"args": ["-c", "/path/to/github-mcp-server/start.sh"],
"env": {
"GITHUB_TOKEN": "your-github-token"
}
}
}
}
🙋♂️ 贡献
若您发现错误或想要添加功能,欢迎提交拉取请求!
📄 许可证
本项目采用 MIT 协议。
Scan to join WeChat group