GitHub MCP Server

GitHub MCP 服务

用于集成 GitHub 的模型上下文协议（MCP）服务实现。此服务通过 MCP 协议提供与 GitHub API 交互的工具。

功能

• 创建 GitHub 仓库
• 向仓库推送内容
• 获取用户信息
• 完善的错误处理和 TypeScript 类型安全
• 自动安装脚本

前提条件

• Node.js（v18 或更高版本）
• npm（v8 或更高版本）
• PowerShell（用于 Windows 安装）
• 具有 repo 权限范围的 GitHub Personal Access Token

安装

Windows

1. 克隆此仓库：

git clone https://github.com/oghenetejiriorukpegmail/github-mcp.git

2. 运行安装脚本：

.\install.ps1

脚本将：

• 创建所需目录
• 安装依赖项
• 构建 TypeScript 代码
• 配置 MCP 设置

手动安装

1. 创建 MCP 目录：

mkdir -p "$env:APPDATA\Roo-Code\MCP\github-mcp"

2. 将此仓库克隆到该目录：

git clone https://github.com/oghenetejiriorukpegmail/github-mcp.git "$env:APPDATA\Roo-Code\MCP\github-mcp"

3. 安装依赖项：

cd "$env:APPDATA\Roo-Code\MCP\github-mcp"
npm install

4. 构建 TypeScript 代码：

npm run build

5. 将服务配置添加到 MCP 设置文件中，文件路径为： %APPDATA%\Code\User\globalStorage\rooveterinaryinc.roo-cline\settings\cline_mcp_settings.json

{
  "mcpServers": {
    "github": {
      "command": "node",
      "args": [
        "%APPDATA%\Roo-Code\MCP\github-mcp\build\index.js"
      ],
      "env": {
        "GITHUB_TOKEN": "your-github-token-here"
      },
      "disabled": false,
      "alwaysAllow": []
    }
  }
}

可用工具

get_user

获取 GitHub 用户信息。

{
  "username": "octocat"
}

create_repo

创建新的 GitHub 仓库。

{
  "repo_name": "my-new-repo",
  "description": "A new repository",
  "private": false
}

push_to_repo

向 GitHub 仓库推送内容。

{
  "repo_name": "my-repo",
  "file_path": "docs/README.md",
  "content": "# My Project\nThis is a test file.",
  "message": "Add README file"
}

开发

1. 克隆仓库
2. 安装依赖项：npm install
3. 修改 src/index.ts
4. 构建：npm run build
5. 测试所做的更改

贡献

1. Fork 此仓库
2. 创建功能分支
3. 提交更改
4. 推送到分支
5. 创建 Pull Request

许可证

MIT