Github Repository Inspector

🚀 MCP-Inspector-v0.6.0: GitHub MCP Server

A server implementing the Model Context Protocol (MCP) that enables AI assistants (such as Claude) to interact with GitHub repositories, issues, and pull requests.

🚀 Quick Start

The MCP server allows AI assistants to interact with GitHub resources. It follows the Model Context Protocol to provide structured operations and results.

✨ Features

• Repository Search: Find GitHub repositories based on search queries.
• Issue Management: Retrieve, create, and comment on issues.
• Pull Request Handling: View and manage pull requests.
• Repository Analysis: Obtain statistics and insights about repositories.

📦 Installation

Prerequisites

• Python 3.8+
• GitHub API token

Steps

1. Clone this repository:

   git clone https://github.com/yourusername/github-mcp-server.git
   cd github-mcp-server
   

2. Install dependencies:

   pip install -r requirements.txt
   

3. Set your GitHub token as an environment variable:

   export GITHUB_TOKEN=your_github_token_here
   

4. Run the server:

   python server.py
   

The server will start at http://localhost:5000.

💻 Usage Examples

Basic Usage

The MCP server provides the following endpoints:

• GET /mcp/discover: Return available operations and their parameters.
• POST /mcp/execute: Execute an operation based on the provided parameters.

Advanced Usage

Discover

curl -X GET http://localhost:5000/mcp/discover

Execute Repository Search

curl -X POST http://localhost:5000/mcp/execute \
  -H "Content-Type: application/json" \
  -d '{
    "endpoint": "search_repositories",
    "parameters": {
      "query": "machine learning"
    }
  }'

Get Repository Issues

curl -X POST http://localhost:5000/mcp/execute \
  -H "Content-Type: application/json" \
  -d '{
    "endpoint": "get_repo_issues",
    "parameters": {
      "owner": "openai",
      "repo": "whisper"
    }
  }'

📚 Documentation

Architecture

The server adheres to the Model Context Protocol specification, allowing AI assistants to:

1. Discover available operations.
2. Execute operations with appropriate parameters.
3. Process and return results in a structured format.

Extending the Server

You can extend the server by:

1. Adding new endpoints in the discover() function.
2. Implementing corresponding handling functions.
3. Updating the routing in the execute() function.

Security Considerations

• The server uses API tokens for GitHub authentication.
• Implement rate limiting to prevent abuse.
• Perform input validation on all parameters.
• Consider implementing OAuth for more secure token management.

🎥 Demo

Please refer to the demo video for a walkthrough of the server's functionality.

📄 License

This project is licensed under the MIT License.

📞 Contact

For issues or support, please open an issue on this repository.