GitHub MCP Server for Cursor IDE

面向 Cursor IDE 的 GitHub MCP 服务

一个功能强大的 GitHub 集成服务，可让你直接在 Cursor IDE 中管理 GitHub 仓库。此服务提供 RESTful API 来与 GitHub 的 API 交互，让创建和管理仓库变得更加轻松。

功能

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

前提条件

• Node.js（v14 或更高版本）
• npm（v6 或更高版本）
• 拥有个人访问令牌的 GitHub 帐户
• Cursor IDE

设置

1. 克隆此仓库：

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

2. 安装依赖项：

npm install

3. 在根目录中创建一个 .env 文件：

cp .env.example .env

4. 在 .env 中配置环境变量：

# Server Configuration
PORT=3000
NODE_ENV=development

# GitHub Configuration
GITHUB_TOKEN=your_github_token_here
GITHUB_WEBHOOK_SECRET=your_webhook_secret_here

# Rate Limiting
RATE_LIMIT_WINDOW_MS=900000  # 15 minutes
RATE_LIMIT_MAX_REQUESTS=100

5. 生成 GitHub 个人访问令牌：

   • 前往 GitHub.com → Settings → Developer Settings → Personal Access Tokens → Tokens (classic)
   • 点击 "Generate new token" → "Generate new token (classic)"
   • 为令牌设置一个描述性名称（例如："MCP Server Integration"）
   • 选择以下权限：
     • repo（完全控制私有仓库）
     • read:org（读取组织数据）
     • admin:repo_hook（完全控制仓库钩子）
   • 复制生成的令牌并将其粘贴到 .env 文件中

6. 启动服务：

npm run dev

在 Cursor IDE 中使用

1. 打开 Cursor IDE
2. MCP 服务默认运行在 http://localhost:3000
3. 你可以使用以下端点：

创建新仓库

curl -X POST http://localhost:3000/api/github/repos \
  -H "Content-Type: application/json" \
  -d '{
    "name": "my-new-repo",
    "description": "A new repository created via MCP",
    "private": false,
    "auto_init": true
  }'

列出你的仓库

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

API 端点

GET /health

用于验证服务状态的健康检查端点。

GET /api/github/repos

列出经过身份验证的用户可访问的所有仓库。

POST /api/github/repos

创建新仓库。

请求正文：

{
  "name": "repository-name",
  "description": "Repository description",
  "private": false,
  "auto_init": true
}

错误处理

服务包含全面的错误处理，可应对：

• 无效的 GitHub 令牌
• 速率限制
• 验证错误
• GitHub API 错误
• 服务错误

所有错误都会记录日志，并以适当的 HTTP 状态代码返回。

安全功能

• 基于令牌的身份验证
• 速率限制保护
• 输入验证
• 安全的环境变量处理
• CORS 保护
• Helmet 安全标头

开发

如需在开发模式下运行服务并启用自动重新加载：

npm run dev

运行测试：

npm test

日志记录

日志存储于：

• error.log：错误级别的日志
• combined.log：所有日志

参与贡献

1. Fork 此仓库
2. 创建功能分支（git checkout -b feature/amazing-feature）
3. 提交更改（git commit -m 'Add some amazing feature'）
4. 将分支推送到远程仓库（git push origin feature/amazing-feature）
5. 创建 Pull Request

许可证

本项目采用 MIT License 授权，详情请参阅 LICENSE 文件。