🚀 GitHub MCP（模型上下文协议）服务器
这是一个专门为GitHub打造的MCP（Model Context Protocol）服务器。其主要价值在于支持兼容MCP的大型语言模型（LLM），像Claude这类模型就能借助此服务器与MCP服务器通信，进而通过GitHub API实现交互。
🚀 快速开始
本项目旨在搭建一个GitHub MCP服务器，支持兼容MCP的大型语言模型与GitHub API交互。下面将为您介绍项目的需求、本地设置、测试方法以及主要功能。
✨ 主要特性
MCP主要支持以下两类功能：
工具（4个）
create-issue：可在GitHub仓库中创建新问题。get-repo-info：能够获取特定GitHub仓库的信息。list-issues：用于列出GitHub仓库中的问题。search-repos：可以搜索GitHub上的仓库。
提示（5个）
create-issue-description：生成GitHub问题的描述。create-pull-request-description：生成GitHub拉取请求的描述。search-repos-prompt：生成用于搜索GitHub仓库的查询。create-issue-prompt：生成创建GitHub问题的参数。enhance-github-response：格式化并增强原始GitHub API响应数据。
您既可以编写自己的提示，也能在Claude Desktop中“选择集成”选项的MCP下拉菜单里挑选合适的提示。
📦 安装指南
需求
- TypeScript（编程语言）
- Octokit（用于向GitHub发送API请求）
- 模型上下文协议SDK
本地设置步骤
- 克隆仓库。
- 运行
npm install。 - 根据提供的
.env.example文件创建一个.env文件。 - 要将TypeScript文件编译为JavaScript，运行
npx tsc。 - 最终运行项目时，运行
node build/index.js。
💻 使用示例
测试方法
您可以通过两种方式测试您的MCP服务器：
- 使用MCP检查工具（Inspector）
- 使用Claude Desktop
使用MCP检查工具进行测试
# 1. 在终端中运行以下命令
npx @modelcontextprotocol/inspector node build/index.js
# 2. 打开 http://localhost:5173
# 3. 您现在可以使用MCP检查工具并开始测试。
使用Claude Desktop进行测试
{
"mcpServers": {
"gh": {
"command": "node",
"args": ["绝对\\路径\\到\\您的\\index.js\\文件"],
"env": {
"GITHUB_TOKEN": "您的GitHub个人访问令牌"
}
}
}
}
具体步骤如下：
- 从这里下载并安装Claude Desktop。
- 进入菜单栏的 文件 > 设置... > 开发者 > 编辑配置。
- 它会打开
claude_desktop_config.json文件的位置。 - 打开该文件并在代码编辑器中添加上述JSON内容。
- 退出并重新打开Claude Desktop。