article
README
🚀 GitHub MCP 服务器
GitHub MCP 服务器是一个管理控制面板(MCP),借助 GitHub Issues API 来管理 GitHub 项目、任务以及团队协作。它为用户提供了一种简便途径,无需直接使用 GitHub 的 Projects 功能,就能轻松管理 GitHub 项目。
✨ 主要特性
- 查看所有仓库
- 创建、更新和跟踪跨仓库的问题(任务)
- 将问题分配给团队成员
- 向问题添加评论
- 创建和管理标签以对任务进行分类
- 查看仓库里程碑
- 查看仓库协作者
📦 安装指南
先决条件
- Node.js(v14 或更高版本)
- npm 或 yarn
- GitHub 个人访问令牌,带有
repo范围
安装步骤
- 克隆此仓库:
git clone https://github.com/brukhabtu/github-mcp-server.git cd github-mcp-server - 安装依赖项:
npm install # 或者 yarn install - 基于示例创建一个
.env文件:cp .env.example .env - 编辑
.env文件并添加您的 GitHub 个人访问令牌:
您可以在GitHub 设置 > 开发人员设置 > 个人访问令牌处生成令牌。请确保令牌具有GITHUB_TOKEN=your_github_personal_access_token_hererepo范围以访问私有仓库。 - 启动服务器:
用于开发且带有自动重启:npm start # 或者 yarn startnpm run dev # 或者 yarn dev - 打开浏览器并导航到
http://localhost:3000以访问 MCP 界面。
📚 详细文档
API 端点
服务器提供了以下 API 端点:
仓库
GET /api/repos- 获取当前用户的全部仓库
问题(任务)
GET /api/repos/:owner/:repo/issues- 获取仓库中的所有问题POST /api/repos/:owner/:repo/issues- 创建新的问题PATCH /api/repos/:owner/:repo/issues/:issue_number- 更新一个问题POST /api/repos/:owner/:repo/issues/:issue_number/comments- 向一个问题添加评论
标签
GET /api/repos/:owner/:repo/labels- 获取仓库中的所有标签POST /api/repos/:owner/:repo/labels- 创建新的标签
里程碑
GET /api/repos/:owner/:repo/milestones- 获取仓库中的所有里程碑
协作者
GET /api/repos/:owner/:repo/collaborators- 获取仓库中的所有协作者
前端开发
要通过自定义前端增强 MCP,请将 HTML、CSS 和 JavaScript 文件添加到public目录中。服务器会从该目录提供静态文件。
自定义
您可以通过以下方式自定义服务器:
- 在
server.js中添加更多 API 端点 - 在
public目录中创建更复杂的前端 - 实现多用户访问的身份验证
- 添加数据库支持以存储项目元数据
📄 许可证
MIT
🤝 贡献
欢迎贡献!请随意提交 Pull Request。
微信扫一扫