Github GraphQL API

🚀 GitHub GraphQL API MCP

This is a tool based on the MCP (Model Control Protocol) for querying and utilizing the GitHub GraphQL API. This project offers a server that enables you to explore the GitHub GraphQL schema and execute GraphQL queries via MCP client tools (such as Claude AI).

🚀 Quick Start

Prerequisites

Before using this project, please ensure the following:

1. You have a valid GitHub account and have generated an access token with appropriate permissions.
2. Securely store your access token in the .env file to avoid committing it to the version control system.
3. Ensure your queries comply with the usage limits of the GitHub API.

Installation

Download the Code

You can download the source code of this project from the following link:

• GitHub Repository: GitHub GraphQL API MCP Repository

Install Dependencies

After entering the project directory, install the required Python packages:

pip install -r requirements.txt

Usage

Start the Server

Run the following command to start the MCP server:

python run_server.py --directory <Project Path>

Available Tools

1. print_type_field: Query the fields of the root type in the GitHub GraphQL schema.
2. graphql_schema_root_type: Obtain the documentation of the root type (Query/Mutation) in the GitHub GraphQL schema.
3. graphql_schema_type: Query the documentation of a specific type in the GitHub GraphQL schema.
4. call_github_graphql: Execute a GitHub GraphQL API query.

Example Usage

1. Query the root type documentation:

Use the graphql_schema_root_type tool, parameter type_name="QUERY"

2. Query field information:

Use the print_type_field tool, parameters type_name="QUERY", type_fields_name="repository"

3. Execute a GraphQL query:

Use the call_github_graphql tool, parameter:
graphql="""
query {
  viewer {
    login
    name
  }
}
"""

✨ Features

• Easy to Use: Provides an intuitive command-line interface and toolset for quick onboarding.
• Highly Flexible: Supports custom GraphQL queries to meet personalized requirements.
• Well-Documented: Includes detailed schema documentation to assist developers in quickly understanding the GitHub GraphQL API.

📚 Documentation

Why Use the GitHub GraphQL API

Functional Advantages

• Efficient Data Querying: With GraphQL, you can retrieve the required data in a single request, reducing the number of requests and data redundancy.
• Flexible Query Syntax: Supports custom query structures to meet various development needs.
• Comprehensive Schema Documentation: GitHub provides detailed GraphQL schema documentation, making it easy for developers to understand and use the API.

Use Cases

• Project Management: Query repository information, user information, etc., through GraphQL for efficient project management and collaboration.
• Data Integration: Integrate GitHub data with other systems, such as CI/CD processes or in - house team tools.
• Automation Scripts: Write automation scripts to perform repetitive tasks, such as getting the latest commits, creating issues, etc.

Application Scenarios

Example Screenshot

In this example, a user uses Claude to call the GitHub GraphQL API MCP:

🔧 Technical Details

Project Introduction

GitHub GraphQL API MCP is a toolset for interacting with the GitHub GraphQL API. It offers the following features:

1. Print Type Fields: Query the fields of the root type in the GitHub GraphQL schema.
2. Get Root Type Documentation: Obtain the documentation of the root type (Query/Mutation) in the GitHub GraphQL schema.
3. Get Specific Type Documentation: Query the documentation of a specific type in the GitHub GraphQL schema.
4. Call the GraphQL API: Execute a GitHub GraphQL API query.

📄 License

This project is licensed under the MIT License, which is a very permissive license that allows users to freely use, modify, distribute, and commercialize this software, as long as the copyright notice and license statement are retained.

For detailed terms, please refer to MIT License.

⚠️ Important Note

Ensure your GitHub access token has appropriate permissions. Securely store the .env file to avoid leakage. Comply with the usage limits of the GitHub API.