README
🚀 MCP-Inspector-v0.6.0:GitHub MCP 服务器
本项目实现了 Model Context Protocol (MCP) 服务器,可让人工智能助手(如 Claude)与 GitHub 仓库、问题和拉取请求进行交互,极大提升了 AI 与 GitHub 生态的协作效率。
🚀 快速开始
本服务器能使人工智能助手与 GitHub 仓库、问题和拉取请求进行交互。启动前,请确保满足以下先决条件:
- Python 3.8+
- GitHub API 令牌
安装步骤
- 克隆此仓库:
git clone https://github.com/yourusername/github-mcp-server.git cd github-mcp-server - 安装依赖项:
pip install -r requirements.txt - 设置你的 GitHub 令牌为环境变量:
export GITHUB_TOKEN=your_github_token_here - 运行服务器:
python server.py
服务器将在 http://localhost:5000 上启动。
✨ 主要特性
- 仓库搜索:根据搜索查询查找 GitHub 仓库
- 问题管理:获取、创建和评论问题
- 拉取请求处理:查看和管理拉取请求
- 仓库分析:获取仓库的统计信息和见解
💻 使用示例
端点
MCP 服务器提供以下端点:
- GET /mcp/discover:返回可用操作及其参数
- POST /mcp/execute:根据提供的参数执行操作
基础用法
发现
curl -X GET http://localhost:5000/mcp/discover
执行仓库搜索
curl -X POST http://localhost:5000/mcp/execute \
-H "Content-Type: application/json" \
-d '{
"endpoint": "search_repositories",
"parameters": {
"query": "machine learning"
}
}'
获取仓库问题
curl -X POST http://localhost:5000/mcp/execute \
-H "Content-Type: application/json" \
-d '{
"endpoint": "get_repo_issues",
"parameters": {
"owner": "openai",
"repo": "whisper"
}
}'
📚 详细文档
架构
服务器遵循 Model Context Protocol 规范,以允许 AI 助手:
- 发现可用操作
- 执行带有适当参数的操作
- 以结构化格式处理和返回结果
扩展服务器
你可以通过以下方式扩展服务器:
- 在
discover()函数中添加新的端点 - 实现相应的处理函数
- 更新
execute()函数中的路由
安全注意事项
- 服务器使用 API 令牌进行 GitHub 身份验证
- 实现速率限制以防止滥用
- 对所有参数进行输入验证
- 考虑实现 OAuth 以获得更安全的令牌管理
演示
请参阅演示视频了解服务器功能的 walkthrough。
📄 许可证
本项目采用 MIT License。
📞 联系
有关问题或支持,请在此仓库上打开问题。
Scan to join WeChat group