使用说明
GitHub MCP服务器
一个模型上下文协议(MCP)服务器,将GitHub功能与Cursor等AI助手集成在一起,实现与GitHub存储库、问题、拉取请求等的无缝交互。
什么是MCP服务器?
模型上下文协议(MCP)是人工智能助手与外部工具和服务交互的标准化方式。此GitHub MCP服务器充当您的人工智能助手和GitHub API之间的桥梁,允许您:
- 管理存储库 直接从您的AI聊天中
- 创建和跟踪问题 无需离开您的开发环境
- 审查拉取请求 并深入了解代码更改
- 访问文件内容 从您有权访问的任何存储库
- 执行GitHub操作 使用自然语言命令
特性
此MCP服务器提供以下工具:
🗂️ 库管理
list_repositories-列出经过身份验证的用户的存储库get_repository-获取特定存储库的详细信息
🐛 问题管理
list_issues-使用筛选选项列出存储库的问题create_issue-使用标题、正文、标签和指定人员创建新问题
🔄 拉取请求管理
list_pull_requests-列出对具有状态筛选的存储库的拉取请求
📄 文件操作
get_file_content-从任何存储库分支读取文件内容或提交
🔍 高级过滤
- 按存储库类型筛选(所有者、成员、全部)
- 按创建日期、上次更新或名称对存储库进行排序
- 按状态筛选问题和PR(打开、关闭、全部)
- 对问题应用基于标签的过滤
安装
先决条件
- Node.js 18或更高版本
- GitHub个人访问令牌
- Cursor IDE或其他兼容MCP的AI助手
步骤1:克隆和设置
# Clone the repository
git clone https://github.com/mazedur1056/github-mcp-server.git
cd github-mcp-server
# Install dependencies
npm install
第二步:GitHub代币设置
- 首选 GitHub设置>个人访问令牌
- 点击“生成新令牌(经典)”
- 选择以下范围:
repo(完全控制私有存储库)read:user(读取个人资料信息)read:org(读取组织信息)
- 复制生成的令牌
步骤3:构建和测试
# Build the TypeScript
npm run build
# Set your GitHub token
export GITHUB_TOKEN=your_github_token_here
# Start the server (runs the compiled JavaScript)
npm start
仅适用于Linux
运行前授予执行权限
chmod +x server.ts
或者,对于开发(直接使用tsx运行server.ts):
npm run dev
步骤4:配置游标
在以下位置之一创建或编辑MCP配置文件:
macOS:
~/Library/Application Support/Cursor/User/globalStorage/mcp.json
Linux:
~/.config/Cursor/User/globalStorage/mcp.json
或
~/.cursor/mcp.config
窗户:
%APPDATA%\Cursor\User\globalStorage\mcp.json
添加以下配置:
{
"mcpServers": {
"github": {
"command": "node",
"args": ["/absolute/path/to/your/github-mcp-server/dist/server.ts"],
"env": {
"GITHUB_TOKEN": "your_github_personal_access_token"
}
}
}
}
重要提示: 替换 /absolute/path/to/your/github-mcp-server/dist/server.js 使用构建的服务器文件的实际绝对路径(运行后 npm run build).
步骤5:重新启动游标
- 完全退出Cursor
- 重新启动游标
- GitHub MCP服务器现在应该可用了
测试安装
安装后,您可以通过询问Cursor来测试集成:
您必须将您的github令牌添加到环境中
export GITHUB_TOKEN="Your Github Token"
List my GitHub repositories
Show me the open issues in my project-name repository
Get the content of README.md from my repository-name
如果配置正确,Cursor将使用MCP服务器从GitHub获取此信息。
故障排除
“0个工具已启用”错误
- 验证MCP配置中的绝对路径
- 确保GitHub令牌具有适当的权限
- 检查是否安装了所有依赖项(
npm install) - 完全重新启动游标
服务器未启动
- 验证Node.js版本(18+)
- 检查是否设置了GITHUB_TOKEN环境变量
- 跑
npm run dev或npm start直接查看错误消息
权限错误
- 确保您的GitHub令牌具有所需的作用域
- 验证您是否有权访问您尝试查询的存储库
许可证
麻省理工学院
