Skip to main content

Manage repositories, users, releases, and automate GitHub workflows

Project description

GitHub MCP Server

Base URL: https://api.github.com

Category Developer Tools
Tools 929
Auth Bearer Token, OAuth2

API Info


Install

Quick Start (recommended)

OAUTH2_CLIENT_ID=YOUR_OAUTH2_CLIENT_ID \
OAUTH2_CLIENT_SECRET=YOUR_OAUTH2_CLIENT_SECRET \
OAUTH2_SCOPES=YOUR_OAUTH2_SCOPES \
BEARER_TOKEN=YOUR_BEARER_TOKEN \
uvx mcparmory-github

With pip

pip install mcparmory-github
OAUTH2_CLIENT_ID=YOUR_OAUTH2_CLIENT_ID \
OAUTH2_CLIENT_SECRET=YOUR_OAUTH2_CLIENT_SECRET \
OAUTH2_SCOPES=YOUR_OAUTH2_SCOPES \
BEARER_TOKEN=YOUR_BEARER_TOKEN \
mcparmory-github

MCP Client Configuration

Add to your MCP client config (e.g. Claude Desktop, Cursor, Codex):

{
  "mcpServers": {
    "github": {
      "command": "uvx",
      "args": ["mcparmory-github"],
      "env": {
        "OAUTH2_CLIENT_ID": "YOUR_OAUTH2_CLIENT_ID",
        "OAUTH2_CLIENT_SECRET": "YOUR_OAUTH2_CLIENT_SECRET",
        "OAUTH2_SCOPES": "YOUR_OAUTH2_SCOPES",
        "BEARER_TOKEN": "YOUR_BEARER_TOKEN"
      }
    }
  }
}

Set OAUTH2_SCOPES to a comma-separated list of scopes your app requires (e.g. OAUTH2_SCOPES=scope_a,scope_b). Some OAuth2 providers may also use additional scope env vars such as OAUTH2_USER_SCOPES; open .env to see all generated scope buckets and descriptions.


Credentials

Set the following environment variables (via MCP client env config, shell export, or .env file):

  • OAUTH2_CLIENT_ID — OAuth2 client ID
  • OAUTH2_CLIENT_SECRET — OAuth2 client secret
  • OAUTH2_SCOPES — OAuth2 scopes (comma-separated)
  • BEARER_TOKEN — Bearer token Do not commit credentials to version control.

OAuth2

Add this redirect URI to your OAuth provider's allowed redirect URIs:

http://localhost:9400/callback

If you change OAUTH2_CALLBACK_PORT in .env, update the redirect URI to match.

On first use, a browser window opens automatically for OAuth authorization. Grant access when prompted — tokens are saved to tokens/oauth2_tokens.json and refreshed automatically.

Re-authorization: Delete tokens/oauth2_tokens.json and restart the server.


Run Locally

First, configure your credentials in .env (see Credentials above).

pip install -r requirements.txt
python server.py

Connect MCP Client

Edit .mcp.json and replace <SERVER_DIR> with the absolute path to this directory, then add to your MCP client configuration.

Example (if server is at /home/user/mcp-servers/github):

{
  "mcpServers": {
    "github": {
      "command": "python",
      "args": ["/home/user/mcp-servers/github/server.py"]
    }
  }
}

Docker

Pre-built image (recommended)

docker run -p 8000:8000 -p 9400:9400 -v ./tokens:/app/tokens \
  -e OAUTH2_CLIENT_ID=YOUR_OAUTH2_CLIENT_ID \
  -e OAUTH2_CLIENT_SECRET=YOUR_OAUTH2_CLIENT_SECRET \
  -e OAUTH2_SCOPES=YOUR_OAUTH2_SCOPES \
  -e BEARER_TOKEN=YOUR_BEARER_TOKEN \
  ghcr.io/mcparmory/github:latest

Build from source

First, configure your credentials in .env (see Credentials above).

docker build -t github .
mkdir -p tokens
docker run -p 8000:8000 -p 9400:9400 -v ./tokens:/app/tokens --env-file .env github

Before running, make sure ports 8000, 9400 are free. If you changed the callback port in .env, update the -p port mapping and your OAuth provider's redirect URI to match.

On first run, the server prints an authorization URL — check docker logs for the URL. Open it in your browser to complete OAuth consent. Tokens are persisted to ./tokens/ via the volume mount so re-authorization is not needed on subsequent runs.

MCP client config (Docker)

For Docker, use SSE transport in your MCP client config:

{
  "mcpServers": {
    "github": {
      "type": "sse",
      "url": "http://localhost:8000/sse"
    }
  }
}

Files

  • .env - Credentials and server configuration
  • .mcp.json - MCP client config template
  • Dockerfile - Container build
  • LICENSE - MIT license for this generated code
  • requirements.txt - Python dependencies
  • README.md - This file
  • server.py - MCP server entry point
  • _auth.py - Authentication handlers
  • _models.py - Request/response models
  • _validators.py - Input validation

Note: Files starting with . are hidden by default on macOS/Linux. Use ls -a in terminal or enable "Show hidden files" in your file manager to see .env and .mcp.json.


MCP Blacksmith
Generated by MCP Blacksmith · Quickstart docs · Report a bug

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mcparmory_github-1.0.4-py3-none-any.whl (349.1 kB view details)

Uploaded Python 3

File details

Details for the file mcparmory_github-1.0.4-py3-none-any.whl.

File metadata

File hashes

Hashes for mcparmory_github-1.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 35676c51533ea579001c7577b3a77d78c53bf89d7eb6a586d57411a813e65e1b
MD5 c709a12cc0a745b0519b7f3db376d314
BLAKE2b-256 d1b71d2a7d7cbe90e13aa4b30a7385438af57554168cdb50bdc991b181930b35

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page