使用说明
GitHub MCP(模型上下文协议)服务器
你好这是一个GitHub MCP服务器,旨在使兼容MCP的LLM(如Claude)能够与我的MCP服务器通信并与GitHub API交互。
需求
- TypeScript(编程语言)
- Octokit(用于向GitHub发出API请求)
- 模型上下文协议SDK
在本地设置项目
- 克隆存储库
- 跑
npm install - 添加
.env查看中提供的示例的文件.env.example文件 - 要将TypeScript文件构建为Javascript,请运行
npx tsc - 要最终运行项目,请运行
node build/index.js
测试方法
您可以通过两种方式测试MCP服务器:
- MCP检查员
- 克劳德桌面
使用MCP检验员进行测试
- 只需奔跑
npx @modelcontextprotocol/inspector node build/index.js在终端 - 首选http://localhost:5173
- 您现在可以看到 MCP检查员 和测试。
使用Claude Desktop进行测试
- 从下载并安装Claude Desktop 这里
- 转到“文件”>“设置”。..>开发人员>编辑配置
- 它应该打开claude_desktop_config.json文件的位置。
- 在代码编辑器中打开该文件并添加以下内容:
{ "mcpServers": { "gh": { "command": "node", "args": ["absolute\\path\\to\\your\\index.js\\file"], "env": { "GITHUB_TOKEN": "your-github-personal-access-token" } } } } - 退出并重新打开Claude桌面
功能
这 主控程序 主要支持 二 特征:
- 工具(4)
create-issue:在GitHub存储库中创建新问题get-repo-info:获取特定GitHub存储库的信息list-issues:列出GitHub存储库中的问题search-repos:搜索GitHub存储库
- 提示(5)
create-issue-description:为GitHub问题生成描述create-pull-request-description:为GitHub pull请求生成描述search-repos-prompt:生成用于搜索GitHub存储库的查询create-issue-prompt:生成创建GitHub问题的参数enhance-github-response:格式化并增强原始GitHub API响应数据
您可以编写自己的提示,也可以从Claude桌面中MCP的“选择集成”选项的下拉列表中选择合适的提示