GitHub MCP 服务器

这是一个用于与 GitHub 集成的 Model Context Protocol (MCP) 服务器实现。该服务器提供了通过 MCP 协议与 GitHub API 交互的工具。

功能

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

前提条件

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

安装

Windows

1. 克隆此仓库：
   powershell
   git clone https://github.com/oghenetejiriorukpegmail/github-mcp.git

2. 运行安装脚本：
   powershell
   .install.ps1

该脚本将：

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

手动安装

1. 创建 MCP 目录：
   powershell
   mkdir -p "$env:APPDATARoo-CodeMCPgithub-mcp"

2. 将此仓库克隆到该目录中：
   powershell
   git clone https://github.com/oghenetejiriorukpegmail/github-mcp.git "$env:APPDATARoo-CodeMCPgithub-mcp"

3. 安装依赖项：
   powershell
   cd "$env:APPDATARoo-CodeMCPgithub-mcp"
   npm install

4. 构建 TypeScript 代码：
   powershell
   npm run build

5. 在以下位置的 MCP 设置文件中添加服务器配置：
   %APPDATA%CodeUserglobalStorage ooveterinaryinc.roo-clinesettingscline_mcp_settings.json

json
{
"mcpServers": {
"github": {
"command": "node",
"args": [
"%APPDATA%Roo-CodeMCPgithub-mcpuildindex.js"
],
"env": {
"GITHUB_TOKEN": "your-github-token-here"
},
"disabled": false,
"alwaysAllow": []
}
}
}

可用工具

get_user

获取 GitHub 用户信息。

json
{
"username": "octocat"
}

create_repo

创建一个新的 GitHub 仓库。

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

push_to_repo

将内容推送到 GitHub 仓库。

json
{
"repo_name": "my-repo",
"file_path": "docs/README.md",
"content": "# My Project
This 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. 创建一个 Pull Request

许可证

MIT