Skip to main content

GitHub Chat MCP server for analyzing GitHub repositories

Project description

GitHub Chat MCP

A Machine Computer Program (MCP) for analyzing and querying GitHub repositories using the GitHub Chat API.

Installation

# Install with pip
pip install github-chat-mcp

# Or install with the newer uv package manager
uv install github-chat-mcp

Usage

  1. Get a GitHub Chat API key from https://github-chat.com

  2. Add the MCP to your Claude config file:

{
  "mcpServers": {
    "github-chat": {
      "command": "github-chat-mcp",
      "env": {
        "GITHUB_API_KEY": "YOUR_API_KEY_HERE"
      }
    }
  }
}
  1. Start using it with Claude!

Example prompts:

  • "Use github-chat-mcp to analyze the React repository"
  • "Index the TypeScript repository with github-chat-mcp and ask about its architecture"

GitHub Chat MCP server

smithery badge

Setup Instructions

Before anything, ensure you have a GitHub Chat API key. This is required to use the service.

Install uv first.

MacOS/Linux:

curl -LsSf https://astral.sh/uv/install.sh | sh

Windows:

powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

Setup with Claude Desktop

# claude_desktop_config.json
# Can find location through:
# Hamburger Menu -> File -> Settings -> Developer -> Edit Config
{
  "mcpServers": {
    "github-chat": {
      "command": "uvx",
      "args": ["github-chat-mcp"],
      "env": {
        "GITHUB_API_KEY": "YOUR_API_KEY_HERE"
      }
    }
  }
}

Installing via Smithery

You can install GitHub Chat for Claude Desktop automatically via Smithery:

npx -y @smithery/cli install github-chat-mcp --client claude

Using GitHub Chat with Claude

  1. Index a GitHub repository first: "Index the GitHub repository at https://github.com/username/repo"

  2. Then ask questions about the repository: "What is the core tech stack used in this repository?"

Debugging

Run:

npx @modelcontextprotocol/inspector uvx github-chat-mcp

Local/Dev Setup Instructions

Clone repo

git clone https://github.com/yourusername/github-chat-mcp.git

Install dependencies

Install uv first.

MacOS/Linux:

curl -LsSf https://astral.sh/uv/install.sh | sh

Windows:

powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

Then install MCP server dependencies:

cd github-chat-mcp

# Create virtual environment and activate it
uv venv

source .venv/bin/activate # MacOS/Linux
# OR
.venv/Scripts/activate # Windows

# Install dependencies
uv sync

Setup with Claude Desktop

Using MCP CLI SDK

# `pip install mcp[cli]` if you haven't
mcp install /ABSOLUTE/PATH/TO/PARENT/FOLDER/github-chat-mcp/src/github_chat_mcp/server.py -v "GITHUB_API_KEY=API_KEY_HERE"

Manually

# claude_desktop_config.json
# Can find location through:
# Hamburger Menu -> File -> Settings -> Developer -> Edit Config
{
  "mcpServers": {
    "github-chat": {
      "command": "uv",
      "args": [
        "--directory",
        "/ABSOLUTE/PATH/TO/PARENT/FOLDER/github-chat-mcp",
        "run",
        "github-chat-mcp"
      ],
      "env": {
        "GITHUB_API_KEY": "YOUR_API_KEY_HERE"
      }
    }
  }
}

Using GitHub Chat with Claude

  1. Index a GitHub repository first: "Index the GitHub repository at https://github.com/username/repo"

  2. Then ask questions about the repository: "What is the core tech stack used in this repository?"

Debugging

Run:

# If mcp cli installed (`pip install mcp[cli]`)
mcp dev /ABSOLUTE/PATH/TO/PARENT/FOLDER/github-chat-mcp/src/github_chat_mcp/server.py

# If not
npx @modelcontextprotocol/inspector \
      uv \
      --directory /ABSOLUTE/PATH/TO/PARENT/FOLDER/github-chat-mcp \
      run \
      github-chat-mcp

Then access MCP Inspector at http://localhost:5173. You may need to add your GitHub API key in the environment variables in the inspector under GITHUB_API_KEY.

Notes

  • Level of logging is adjustable through the FASTMCP_LOG_LEVEL environment variable (e.g. FASTMCP_LOG_LEVEL="ERROR")
  • This MCP server provides two main tools:
    1. Repository Indexing - Index and analyze a GitHub repository
    2. Repository Querying - Ask questions about the indexed repository

Project details


Download files

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

Source Distribution

github_chat_mcp-0.1.0.tar.gz (18.1 kB view details)

Uploaded Source

Built Distribution

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

github_chat_mcp-0.1.0-py3-none-any.whl (5.2 kB view details)

Uploaded Python 3

File details

Details for the file github_chat_mcp-0.1.0.tar.gz.

File metadata

  • Download URL: github_chat_mcp-0.1.0.tar.gz
  • Upload date:
  • Size: 18.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.6

File hashes

Hashes for github_chat_mcp-0.1.0.tar.gz
Algorithm Hash digest
SHA256 fd6c86861682100b6fe1b8842ebebc82fb93ca0e2499312179ea9900695f7eb2
MD5 f24d375e1eb8729b833f250f7b53542f
BLAKE2b-256 613cf0b6d60c41dbd0c1b82a01bb03615a7b5843cc32ecfacb54320fbc1fff4c

See more details on using hashes here.

File details

Details for the file github_chat_mcp-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for github_chat_mcp-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4fe3eda6c4afd8a20d1aaff534d5d46ab96199db8ca726620b165f0e0abe32b1
MD5 9973e0bf46fe7edfe5c7bee56f4df093
BLAKE2b-256 1845ee12d868261b56a91f8bd6d58c4e0dfedb932602ddef8923c2547094f7e0

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