README
🚀 GitHub MCP 服务器
这是一个用于与 GitHub 交互的模型上下文协议(MCP)服务器。此工具可让 AI 助手执行各类 GitHub 操作,涵盖仓库管理、文件操作、问题跟踪等,极大提升了与 GitHub 交互的便捷性和效率。
🚀 快速开始
该 GitHub MCP 服务器允许 AI 助手执行多种 GitHub 操作。使用前,需确保满足先决条件,并完成安装和配置。
✨ 主要特性
- 仓库操作:可创建仓库,叉取仓库。
- 文件操作:能创建、更新和读取文件,还可在单个提交中推多个文件。
- 问题管理:支持创建、更新、列出和对问题进行评论。
- 拉取请求:可创建拉取请求。
- 分支管理:能够创建分支。
- 搜索能力:可搜索代码、仓库、问题和用户。
- 提交历史:可列出提交。
📦 安装指南
先决条件
- Node.js 18 或更高版本
- 具备适当权限的 GitHub 个人访问令牌
安装步骤
- 克隆此仓库。
- 安装依赖项:
npm install - 构建项目:
npm run build
配置
此 MCP 服务器需要一个 GitHub 个人访问令牌来进行 GitHub API 的身份验证。该令牌应通过环境变量提供:
GITHUB_PERSONAL_ACCESS_TOKEN=your_token_here
当使用 Smithery 部署时,可以通过 githubPersonalAccessToken 配置选项来配置令牌。
💻 使用示例
本地运行
要本地运行服务器:
GITHUB_PERSONAL_ACCESS_TOKEN=your_token_here node dist/index.js
与 Smithery 部署
此仓库包含用于与 Smithery 部署的必要配置文件:
Dockerfile:定义如何构建 MCP 服务器的 Docker 镜像。smithery.yaml:配置 Smithery 如何启动 MCP 服务器。
请参考 Smithery 文档 了解部署说明。
📚 详细文档
开发
构建
npm run build
代码检查
npm run lint
📄 许可证
本项目采用 MIT 许可证。
Scan to join WeChat group