MCP Github Project Manager

🚀 GitHub Project Management MCP Server

A server implementing the Model Context Protocol (MCP) to provide GitHub Projects functionality through standardized tools and resources. This server enables LLM clients to programmatically manage GitHub projects via the MCP interface.

🚀 Quick Start

This server implements the Model Context Protocol to expose GitHub Projects functionality to LLM clients. It offers tools for managing projects, milestones, sprints, and metrics through GitHub's GraphQL API, maintaining state, and handling errors according to the MCP specification.

✨ Features

Project Management

• Create and manage GitHub Projects (v2).
• Handle project settings and configurations.
• Manage project visibility and access permissions.

Project Resources

• Manage issues and milestones.
• Plan and track sprints.
• Customize fields and views.
• Control resource versioning and locking.

MCP Implementation

• Full compliance with the MCP specification.
• Standardized tool definitions with Zod validation.
• Resource state management.
• Progressive response handling.
• Comprehensive error handling.

GitHub Integration

• GraphQL API integration with pagination support.
• Intelligent access tokens.
• A robust HTTP client with automatic retry and circuit breaker.
• Resource rate limiting and queuing.

📦 Installation

Install Dependencies

Use a package manager to install project dependencies:

npm install

Or for Yarn users:

yarn install

Configuration

Create a config.json file and add the following content:

{
  "github": {
    "clientId": "YOUR_GITHUB_CLIENT_ID",
    "clientSecret": "YOUR_GITHUB_CLIENT_SECRET"
  }
}

💻 Usage Examples

Start the Server

npm start

Or for Yarn users:

yarn start

Example Commands

Get user information:

curl http://localhost:3000/api/users

🔧 Technical Details

System Architecture

• Layered Architecture: A clear layered structure for easy maintenance and expansion.
• Modular Design: Core functions are decomposed into independent modules to improve code reusability.
• Dependency Injection: Loosely coupled components are achieved through dependency injection.

Current Status Analysis

Implemented Features

To-Do List

📚 Documentation

• User Guide - Detailed usage instructions.
• API Reference - Comprehensive tool documentation.
• Tutorials - Step-by-step guides.
• Examples - Code examples for common tasks.
• Architecture - System architecture and design.
• Contribution Guide - Development specifications.

Interactive Documentation

Open the API Explorer in your browser for interactive API exploration.

🛠️ Development

Testing

# Unit tests
npm test

# Integration tests
npm run test:integration

# End-to-end tests
npm run test:e2e

Code Quality

# Format code
npm run lint

# Type checking
npm run type-check

# Code formatting
npm run format

🤝 Contribution Guide

We welcome contributions to the GitHub Project Manager MCP Server! Please refer to our Contribution Guide for detailed information:

• Development Workflow
• Coding Standards
• Testing Guidelines
• Documentation Writing Guidelines

📄 License

MIT