GitHub MCP Server for Cursor IDE

基本能力

产品定位

GitHub MCP Server 是一个专为 Cursor IDE 设计的 GitHub 集成服务，旨在简化 GitHub 仓库的管理和操作。

核心功能

• 创建新的 GitHub 仓库
• 列出现有仓库
• 安全的令牌认证
• 速率限制保护
• 全面的错误处理
• 详细的日志记录
• Webhook 支持（即将推出）

适用场景

• 在 Cursor IDE 中直接管理 GitHub 仓库
• 自动化创建和配置新仓库
• 集成 GitHub API 到开发工作流中

工具列表

• curl: 用于测试 API 端点
• npm: 用于安装依赖和运行脚本
• GitHub Personal Access Token: 用于认证和授权

常见问题解答

• 如何生成 GitHub Personal Access Token？ 在 GitHub.com 的 Settings → Developer Settings → Personal Access Tokens 中生成，并确保选择 repo、read:org 和 admin:repo_hook 权限。
• 如何配置环境变量？ 复制 .env.example 到 .env 并填写相应的配置。
• 如何启动服务器？ 运行 npm run dev 启动开发服务器。

使用教程

使用依赖

• Node.js (v14 或更高版本)
• npm (v6 或更高版本)
• GitHub 账户和 Personal Access Token
• Cursor IDE

安装教程

1. 克隆仓库：

git clone <your-repo-url>
cd github-mcp-server

1. 安装依赖：

npm install

1. 创建 .env 文件：

cp .env.example .env

1. 配置 .env 文件：

PORT=3000
NODE_ENV=development
GITHUB_TOKEN=your_github_token_here
GITHUB_WEBHOOK_SECRET=your_webhook_secret_here
RATE_LIMIT_WINDOW_MS=900000
RATE_LIMIT_MAX_REQUESTS=100

1. 生成 GitHub Personal Access Token 并配置权限。
2. 启动服务器：

npm run dev

调试方式

1. 使用 curl 测试 API 端点：

curl http://localhost:3000/api/github/repos

1. 检查日志文件 error.log 和 combined.log 以获取错误和运行信息。
2. 运行测试：

npm test

许可证

该项目遵循 MIT 开源许可条款。