GitHub MCP (Model Context Protocol) server

GitHub MCP (Model Context Protocol) server

site icon
2025.03.20 0
TypeScriptGitHub API交互仓库管理问题管理开发效率交流协作
GitHub MCP (Model Context Protocol) server 是一个设计用于让兼容MCP的LLMs(如Claude)与GitHub API交互的服务。它通过提供一系列工具和提示,帮助用户更高效地管理和操作GitHub上的仓库和问题。
View on GitHub

Overview

基本能力

产品定位

GitHub MCP server 是一个桥梁服务,使得MCP兼容的LLMs能够通过它与GitHub API进行交互,从而实现对GitHub仓库和问题的管理。

核心功能

  • 工具支持:提供4种工具,用于创建问题、获取仓库信息、列出问题和搜索仓库。
  • 提示支持:提供5种提示,用于生成问题描述、拉取请求描述、搜索仓库查询、创建问题参数和增强GitHub API响应数据。

适用场景

  • 开发者在GitHub上管理仓库和问题时需要自动化工具。
  • 团队协作时需要通过LLMs快速生成问题或拉取请求的描述。
  • 需要从GitHub API获取格式化或增强后的数据。

工具列表

  1. create-issue: 在GitHub仓库中创建新问题。
  2. get-repo-info: 获取特定GitHub仓库的信息。
  3. list-issues: 列出GitHub仓库中的问题。
  4. search-repos: 搜索GitHub仓库。

常见问题解答

  • 如何测试MCP服务器?
  • 使用MCP inspector或Claude Desktop进行测试。
  • 如何配置Claude Desktop以使用MCP服务器?
  • 在Claude Desktop的配置文件中添加MCP服务器的路径和GitHub令牌。

使用教程

使用依赖

  • TypeScript (编程语言)
  • Octokit (用于向GitHub发起API请求)
  • Model Context Protocol SDK

安装教程

  1. 克隆仓库。
  2. 运行 npm install
  3. 添加 .env 文件,参考 .env.example 文件中的示例。
  4. 构建TypeScript文件到Javascript,运行 npx tsc
  5. 运行项目,执行 node build/index.js

调试方式

  1. 使用MCP inspector测试:
  2. 运行 npx @modelcontextprotocol/inspector node build/index.js
  3. 访问 http://localhost:5173。
  4. 使用Claude Desktop测试:
  5. 下载并安装Claude Desktop。
  6. 在配置文件中添加MCP服务器的路径和GitHub令牌。
  7. 重启Claude Desktop。

许可证

None