mcp-github

The mcp-github-server provides a Model Context Protocol (MCP) interface backed by the GitHub API. It allows clients to query GitHub data through the MCP contract, enabling operations such as discovering repositories, listing issues, retrieving pull requests, obtaining repository metadata, and browsing commit histories, all within the MCP context framework. The server acts as a bridge between MCP clients and GitHub, translating MCP requests into GitHub API calls and returning structured model context responses.

To use, run the server using the provided container image. Once running, you can connect your MCP client to the server endpoint and invoke the standard MCP commands to explore GitHub resources (e.g., repository contexts, issue contexts, and user contexts). If you need authenticated access (to access private data or higher rate limits), provide a GitHub token via the GITHUB_TOKEN environment variable when starting the container. The server will use this token to authenticate GitHub API requests.

Prerequisites:

• Docker installed and running
• Optional: GitHub API token if accessing private data or desiring higher rate limits

Installation and run (Docker):

1. Pull and run the image: docker run -i emrum01-mcp-github-server

2. If you need authentication, provide the token via environment variable: docker run -i -e GITHUB_TOKEN=YOUR_TOKEN_HERE emrum01-mcp-github-server

3. Verify the MCP endpoint is reachable using your MCP client and the server’s address (localhost or container network address).

Note: If you prefer not to use Docker, this repository may also support building from source. Refer to the project’s documentation for non-Docker build steps (e.g., Node/Python setup) if available.

Environment variables and configuration:

• GITHUB_TOKEN: Optional. GitHub API token to avoid strict rate limits and to access private data if permitted.
• Any other env vars would be documented in the repository; if you need custom GitHub API endpoints or proxies, they can typically be added via environment variables or a config file as supported by the image.

Common issues:

• Docker daemon not running: ensure Docker is up and running before executing the docker run command.
• GitHub rate limits: without a token, requests are subject to stricter rate limits; use GITHUB_TOKEN when possible.
• Network restrictions: ensure the container can reach api.github.com (no outbound network blocks).

Configuration options:

• The server uses the MCP protocol to expose GitHub data; consult the MCP client documentation to tailor requests for repositories, issues, pull requests, commits, and user data.