GitHub MCP 服务器

一个用于GitHub集成的模型上下文协议(MCP)服务器实现,提供通过MCP协议与GitHub API交互的工具。

  • by oghenetejiriorukpegmail
  • JavaScript
  • 本地部署
  • 更新于
在 GitHub 查看 oghenetejiriorukpegmail/github-mcp

使用说明

GitHub MCP服务器

GitHub集成的模型上下文协议(MCP)服务器实现。该服务器提供了通过MCP协议与GitHub的API进行交互的工具。

特性

  • 创建GitHub存储库
  • 将内容推送到存储库
  • 获取用户信息
  • 正确的错误处理和TypeScript类型安全
  • 自动安装脚本

先决条件

  • Node.js(v18或更高版本)
  • npm(v8或更高版本)
  • PowerShell(用于Windows安装)
  • 具有repo范围的GitHub个人访问令牌

安装

视窗

  1. 克隆此存储库:
git clone https://github.com/oghenetejiriorukpegmail/github-mcp.git
  1. 运行安装脚本:
.\install.ps1

脚本将:

  • 创建必要的目录
  • 安装依赖项
  • 构建TypeScript代码
  • 配置MCP设置

手动安装

  1. 创建MCP目录:
mkdir -p "$env:APPDATA\Roo-Code\MCP\github-mcp"
  1. 将此存储库克隆到该目录中:
git clone https://github.com/oghenetejiriorukpegmail/github-mcp.git "$env:APPDATA\Roo-Code\MCP\github-mcp"
  1. 安装依赖项:
cd "$env:APPDATA\Roo-Code\MCP\github-mcp"
npm install
  1. 构建TypeScript代码:
npm run build
  1. 将服务器配置添加到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. 分叉存储库
  2. 创建要素分支
  3. 提交您的更改
  4. 推到分支
  5. 创建拉取请求

许可证

麻省理工学院