GitHub MCP Server

GitHub MCP 服务

此仓库用于测试 Model Context Protocol (MCP) 服务的实现和使用方法。

概述

Model Context Protocol (MCP) 是一种用于标准化大模型 (LLM) 与客户端应用程序之间通信的协议。使用此协议，Agent 可以与外部工具和客户端应用程序有效协作。

GitHub MCP 服务与 GitHub API 集成，为 LLM Agent 提供仓库操作、代码搜索、问题管理等功能。

特点

• 仓库操作：创建仓库、添加和编辑文件、管理分支
• 代码搜索：搜索 GitHub 上的代码
• 问题/PR 管理：创建、更新问题或拉取请求，以及发表评论
• 身份验证管理：安全地验证 GitHub API

必要条件

• Node.js (v16.0.0 以上)
• npm 或 yarn
• GitHub 账户和个人访问令牌 (PAT)

安装方法

# リポジトリをクローン
git clone https://github.com/tomo-cps/mcp-test.git
cd mcp-test

# 依存パッケージのインストール
npm install
# または
yarn install

配置

1. 创建 .env 文件，并设置以下环境变量：

GITHUB_TOKEN=your_github_personal_access_token
PORT=3000

2. 获取 GitHub 个人访问令牌的方法：
   • 登录 GitHub
   • 点击右上角的个人资料图标 > Settings > Developer settings > Personal access tokens
   • 点击 "Generate new token"
   • 选择所需权限（推荐 repo、user、read:org）
   • 生成令牌，并将其保存到 .env 文件

启动服务

# 開発モード
npm run dev
# または
yarn dev

# 本番モード
npm start
# または
yarn start

默认情况下，服务将在 http://localhost:3000 上运行。

API 端点

此 MCP 服务提供以下主要端点：

• /mcp/describe：描述可用功能和参数
• /mcp/execute：执行指定命令
• /mcp/state：获取或更新当前状态

使用示例

1. 获取仓库信息

// クライアント側のコード例
const response = await fetch('http://localhost:3000/mcp/execute', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    command: 'get_repository',
    params: {
      owner: 'octocat',
      repo: 'hello-world'
    }
  })
});

const data = await response.json();
console.log(data);

2. 创建问题

// クライアント側のコード例
const response = await fetch('http://localhost:3000/mcp/execute', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    command: 'create_issue',
    params: {
      owner: 'your-username',
      repo: 'your-repo',
      title: 'バグ: ログイン画面で問題が発生',
      body: '詳細な説明をここに記述します...',
      labels: ['bug', 'priority:high']
    }
  })
});

const data = await response.json();
console.log(data);

故障排除

常见问题及解决方法：

1. 身份验证错误：请确认 GitHub 令牌已正确设置。
2. 速率限制：GitHub API 有速率限制。达到限制时，请稍等片刻后重试。
3. CORS 错误：进行跨源调用时，请确认服务已设置适当的 CORS 标头。

贡献

1. Fork 此仓库
2. 创建功能分支（git checkout -b feature/amazing-feature）
3. 提交更改（git commit -m 'Add some amazing feature'）
4. 推送分支（git push origin feature/amazing-feature）
5. 创建拉取请求

许可证

MIT License - 详情请参阅 LICENSE 文件。

参考资料

• Model Context Protocol 规范
• GitHub REST API 文档