GitHub MCP Server

A Model Context Protocol (MCP) server implementation for GitHub API integration. This server provides a standardized interface for AI models to interact with GitHub repositories, issues, pull requests, and more.

Features

- Full GitHub API integration
- Support for repository operations (create, fork, search)
- File operations (create, update, read)
- Issue and PR management
- Code search capabilities
- Branch management
- Commit history access

Setup

1. Clone the repository:

git clone https://github.com/marvelouscypherman/github-mcp-server.git

cd github-mcp-server

2. Install dependencies:

npm install

3. Configure GitHub token:
- Copy config.example.json to config.json
- Add your GitHub Personal Access Token:

{

  "github": {

    "token": "YOUR_GITHUB_TOKEN"

  }

}

export GITHUB_TOKEN="your_token_here"

4. Build the server:

npm run build

5. Start the server:

npm start

The server will start on port 3000 by default. You can change this by setting the PORT environment variable.

Configuration

The server can be configured either through:
- Environment variables (GITHUB_TOKEN)
- Configuration file (config.json)

API Endpoints

- POST /list-tools - List available GitHub operations
- POST /call-tool - Execute a GitHub operation
- GET /health - Server health check
- GET /events - Server-Sent Events endpoint for real-time updates

Server-Sent Events (SSE)

The server supports real-time updates through Server-Sent Events. Connect to the /events endpoint to receive updates for various GitHub operations:

Available Events:

- repository_forked - When a repository is forked
- branch_created - When a new branch is created
- repository_created - When a new repository is created
- file_updated - When a file is created or updated
- files_pushed - When multiple files are pushed
- issue_created - When a new issue is created
- pull_request_created - When a new pull request is created

Example Usage:

const eventSource = new EventSource('http://localhost:3000/events');
eventSource.onmessage = function(event) {

    const data = JSON.parse(event.data);

    console.log(data.type, data.data);

};

A complete example client implementation can be found in examples/sse-client.html.

License

MIT License