GitHub MCP Server

What is GitHub MCP Server?

GitHub MCP Server is a Model Context Protocol (MCP) server that provides a standardized interface for AI models to interact with the GitHub API. It enables repository operations, file management, issue and pull request handling, code search, branch management, and commit history access.

How to use GitHub MCP Server?

Clone the repository, install dependencies with npm install, configure a GitHub Personal Access Token via config.json or the GITHUB_TOKEN environment variable, then build (npm run build) and start (npm start) the server (default port 3000). Use the endpoints POST /list-tools, POST /call-tool, GET /health, and GET /events to interact with the server.

Key features of GitHub MCP Server

• Full GitHub API integration
• Repository operations: create, fork, search
• File operations: create, update, read
• Issue and pull request management
• Code search capabilities
• Branch management and commit history access
• Real-time updates via Server-Sent Events

Use cases of GitHub MCP Server

• Automating repository creation and forking workflows
• Managing issues and pull requests through an AI assistant
• Searching code and accessing commit history across repositories
• Building AI-powered tools that need to read, create, or update files on GitHub
• Receiving real-time notifications for repository events (forks, branch creation, file updates, etc.)

FAQ from GitHub MCP Server

What is required to run GitHub MCP Server?

Node.js and npm are required. A GitHub Personal Access Token must be configured either in config.json or as the GITHUB_TOKEN environment variable.

How do I configure the GitHub token?

Copy config.example.json to config.json and add your token, or set the GITHUB_TOKEN environment variable.

What API endpoints does the server provide?

POST /list-tools lists available operations, POST /call-tool executes a GitHub operation, GET /health checks server status, and GET /events provides real-time updates via Server-Sent Events.

Can I change the server port?

Yes, set the PORT environment variable. The default port is 3000.

Does the server support real-time updates?

Yes, it supports Server-Sent Events (SSE) on the /events endpoint. Available events include repository_forked, branch_created, repository_created, file_updated, files_pushed, issue_created, and pull_request_created.