MCP GitHub Server

MCP GitHub Server

site icon
2025.03.16 1
HTMLGitHub API仓库管理文件操作分支管理提交管理开发效率
MCP GitHub Server 是一个用于与GitHub API交互的服务器,提供方便的接口来管理GitHub仓库。它支持多种操作,包括获取仓库信息、创建仓库、管理文件和分支、提交更改等。
View on GitHub

Overview

基本能力

产品定位

MCP GitHub Server 是一个中间件服务,旨在简化与GitHub API的交互,提供一套易于使用的RESTful接口来管理GitHub仓库和相关资源。

核心功能

  1. 仓库管理:获取用户仓库列表、获取特定仓库信息、创建新仓库。
  2. 文件操作:获取文件内容、创建新文件。
  3. 分支管理:获取分支列表、创建新分支。
  4. 提交管理:获取提交列表、创建新提交(支持多文件更改)。

适用场景

  1. 自动化开发流程:集成到CI/CD管道中,自动化仓库管理和文件操作。
  2. 团队协作:简化团队成员对GitHub仓库的访问和操作。
  3. 教育用途:用于教学Git和GitHub的基本操作。

工具列表

  1. GitHub API 封装:提供对GitHub API的简化访问。
  2. RESTful 接口:标准化的HTTP端点,易于集成。
  3. 环境变量配置:支持通过.env文件配置GitHub令牌和端口。

常见问题解答

  1. 如何获取GitHub令牌?
  2. 进入GitHub账户设置 -> Developer settings -> Personal access tokens -> Tokens (classic) -> Generate new token。
  3. 选择所需权限(推荐:repo, user)。
  4. 如何调试API?
  5. 使用npm run dev启动开发模式,查看控制台日志。

使用教程

使用依赖

  1. 确保已安装Node.js和npm。
  2. 克隆仓库:
git clone https://github.com/fills/mcp-github-server.git
cd mcp-github-server
  1. 安装依赖:
npm install

安装教程

  1. 创建.env文件并添加以下内容:
PORT=3000
GITHUB_TOKEN=your_github_token_here
  1. 启动服务:
  2. 开发模式:npm run dev
  3. 生产模式:npm start

调试方式

  1. 检查服务是否运行:
GET http://localhost:3000/
  1. 测试API端点,例如获取用户仓库列表:
GET http://localhost:3000/api/repos/octocat

许可证

None