🚀 GitHub GraphQL API MCP
一个基于MCP（模型控制协议）的工具，用于查询和使用GitHub GraphQL API。此项目提供了一个服务器，允许您通过MCP客户端工具（如Claude AI）探索GitHub GraphQL模式并执行GraphQL查询。
🚀 快速开始
GitHub GraphQL API MCP是一个用于与GitHub GraphQL API交互的工具集。它提供了一个服务器，允许您通过MCP客户端工具（如Claude AI）探索GitHub GraphQL模式并执行GraphQL查询。
在使用此项目之前，请确保您有一个有效的GitHub账户，并且已经生成了具有适当权限的访问令牌。将您的访问令牌安全地存储在.env文件中，避免将其提交到版本控制系统。同时，确保您的查询符合GitHub API的使用限制。
下载代码
您可以从以下链接下载此项目的源代码：
- GitHub仓库：GitHub GraphQL API MCP 仓库地址
安装依赖项
进入项目目录后，安装所需的Python包：
pip install -r requirements.txt
启动服务器
运行以下命令启动MCP服务器：
python run_server.py --directory <项目路径>
✨ 主要特性
- 简单易用：提供直观的命令行接口和工具集，便于快速上手。
- 高度灵活：支持自定义GraphQL查询，满足个性化需求。
- 文档丰富：内置详细的模式文档，帮助开发者快速理解GitHub GraphQL API。
📚 详细文档
项目介绍
GitHub GraphQL API MCP提供了以下功能：
- 打印类型字段：查询GitHub GraphQL模式中根类型的字段。
- 获取根类型文档：获取GitHub GraphQL模式中根类型（Query/Mutation）的文档。
- 获取特定类型文档：查询GitHub GraphQL模式中的特定类型文档。
- 调用GraphQL API：执行GitHub GraphQL API查询。
为什么使用GitHub GraphQL API
功能优势
- 高效的数据查询：通过GraphQL，您可以一次性获取所需数据，减少请求次数和数据冗余。
- 灵活的查询语法：支持自定义查询结构，满足各种开发需求。
- 强大的模式文档：GitHub提供了详细的GraphQL模式文档，方便开发者理解和使用API。
使用场景
- 项目管理：通过GraphQL查询仓库信息、用户信息等，实现高效的项目管理和协作。
- 数据集成：将GitHub的数据与其他系统集成，例如CI/CD流程或团队内部工具。
- 自动化脚本：编写自动化脚本来执行重复性任务，如获取最新提交、创建问题等。
应用场景
示例截图
在此示例中，用户使用Claude调用GitHub GraphQL API MCP：
可用工具
- print_type_field：查询GitHub GraphQL模式中根类型的字段。
- graphql_schema_root_type：获取根类型（Query/Mutation）的文档。
- graphql_schema_type：查询特定类型的文档。
- call_github_graphql：执行GitHub GraphQL API查询。
示例用法
基础用法
- 查询根类型文档：
Use the graphql_schema_root_type tool, parameter type_name="QUERY"
- 查询字段信息：
Use the print_type_field tool, parameters type_name="QUERY", type_fields_name="repository"
高级用法
- 执行GraphQL查询：
Use the call_github_graphql tool, parameter:
graphql="""
query {
viewer {
login
name
}
}
"""
⚠️ 注意事项
⚠️ 重要提示
- 确保您的GitHub访问令牌具有适当的权限。
- 将
.env文件妥善保管，避免泄露。- 遵守GitHub API的使用限制。
📄 许可证
此项目采用MIT License，这是一种非常宽松的许可证，允许用户自由使用、修改、分发和商业化此软件，只要保留版权声明和许可声明。 详细条款请参阅MIT License。