返回 MCP 目录
public公开dns本地运行

github-mcp-server-6gm

GitHub MCP服务器是一个用于与GitHub API交互的模型上下文协议服务,提供仓库管理、提交创建等工具。

article

README

🚀 GitHub MCP 服务器

GitHub MCP 服务器是一个与 GitHub API 交互的模型上下文协议 (MCP) 服务器,它提供了一系列工具,可帮助用户方便地管理 GitHub 仓库。

✨ 主要特性

工具

  • list_user_repos:用于列出认证用户的所有仓库。
    • 参数说明
      • type(可选):可取值为 "owner"、"all" 或 "member",默认值为 "owner"。
      • sort(可选):可取值为 "created"、"updated"、"pushed" 或 "full_name",默认值为 "full_name"。
      • direction(可选):可取值为 "asc" 或 "desc",默认值为 "asc"。
      • per_page(可选):每页显示的结果数量,默认值为 30,最大值为 100。
      • page(可选):页码,默认值为 1。
  • get_repo:获取特定仓库的详细信息。
    • 参数说明
      • repo(必需):仓库名称。
      • owner(可选):账户所有者,若未提供,则使用认证用户。
  • create_repo:创建一个新的仓库。
    • 参数说明
      • name(必需):仓库名称。
      • description(可选):仓库的简短描述。
      • private(可选):是否将仓库设置为私有仓库,默认值为 false。
      • auto_init(可选):是否创建初始提交并带有空 README 文件,默认值为 false。
  • create_commit:创建一个新的包含文件更改的提交。
    • 参数说明
      • repo(必需):仓库名称。
      • owner(可选):账户所有者,若未提供,则使用认证用户。
      • branch(可选):分支名称,默认值为 "main"。
      • message(必需):提交信息。
      • files(必需):包含在提交中的文件数组,每个文件需要包含以下信息:
        • path:相对于仓库根目录的文件路径。
        • content:文件内容。
  • push:将更改推送到远程仓库。
    • 参数说明
      • repo(必需):仓库名称。
      • owner(可选):账户所有者,若未提供,则使用认证用户。
      • branch(可选):分支名称,默认值为 "main"。
  • pull:从远程仓库拉取更改。
    • 参数说明
      • repo(必需):仓库名称。
      • owner(可选):账户所有者,若未提供,则使用认证用户。
      • branch(必需):分支名称。

📦 安装指南

环境需求

  • Node.js 需 18+ 版本。
  • 具备适当权限的 GitHub 个人访问令牌。
  • 设置 GITHUB_TOKEN 环境变量。

安装步骤

npm install
npm run build

🚀 快速开始

配置

将你的 GitHub 令牌设置为环境变量:

export GITHUB_TOKEN=your_token_here

运行服务器

npm start

💻 使用示例

开发

带有自动重建功能的开发:

npm run watch

调试

使用 MCP 检查器

npm run inspector
help

运行方式说明

cloud

托管运行

托管运行通常表示这个 MCP Server 由服务方环境承载,用户一般按页面提供的连接方式或授权流程接入,不需要在本地长期启动一个 MCP 进程

  1. 打开服务方连接页
  2. 完成授权或复制端点
  3. 在 MCP 客户端中连接
terminal

本地运行 / 其它方式

本地运行通常需要用户在自己的电脑或服务器上安装依赖,把 server_config 复制到 MCP 客户端,并按 env_schema 补齐环境变量、密钥或其它配置

  1. 复制 server_config
  2. 安装所需依赖
  3. 补齐环境变量后重启客户端