Github Chat

🚀 Analyze and Query GitHub Repositories with GitHub Chat MCP

GitHub Chat MCP (Model Context Protocol) is a protocol for analyzing and querying GitHub repositories via the GitHub Chat API. Official website: https://github-chat.com

🚀 Quick Start

✨ Features

GitHub Chat MCP enables users to analyze and query GitHub repositories through the GitHub Chat API, providing functions like repository indexing and querying.

📦 Installation

Install the Package

# Install using pip
pip install github-chat-mcp

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

Start Using with Claude

• Example prompts:
  • "Analyze the React repository using github-chat-mcp"
  • "Index the TypeScript repository with github-chat-mcp and inquire about its architecture"

🔧 GitHub Chat MCP Server Setup

Setup Instructions

⚠️ Important Note

First, make sure you have a GitHub Chat API key. This is a prerequisite for using the service.

Install uv

• 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 for Cursor

In mcp.json:

{
  "mcpServers": {
    "github-chat": {
      "command": "uvx",
      "args": [
        "github-chat-mcp"
      ]
    }
  }
}

With this setup, no environment variables are required as this is a free trial version.

Setup for Claude Desktop

# claude_desktop_config.json
# You can find the location by:
# Clicking the hamburger menu -> File -> Settings -> Developers -> Edit Configuration
# You must first run: brew install uv
{
  "mcpServers": {
    "github-chat": {
      "command": "uvx",
      "args": ["github-chat-mcp"],
      "env": {
      }
    }
  }
}

Installation with Smithery

You can use Smithery to automatically install GitHub Chat for Claude Desktop:

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

Using GitHub Chat with Claude

1. First, index a GitHub repository:
   • "Index the GitHub repository at https://github.com/username/repo"
2. Then, ask questions about the repository:
   • "What is the core technology stack of this repository?"

Debugging

Run:

npx @modelcontextprotocol/inspector uvx github-chat-mcp

🔧 Local/Development Environment Setup

Clone the Repository

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

Install Dependencies

Install uv

• MacOS/Linux:

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

• Windows:

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

Install Dependencies in the GitHub Chat-MCP Project

cd github-chat-mcp

# Create a virtual environment and activate it
uv venv

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

# Install dependencies
uv sync

Setup for Claude Desktop

Using the MCP CLI SDK

# If not already installed, first run `pip install mcp[cli]`
mcp install /ABSOLUTE/PATH/TO/PARENT/FOLDER/github-chat-mcp/src/github_chat_mcp/server.py -v "GITHUB_API_KEY=API_KEY_HERE"

Manual Setup

# claude_desktop_config.json
# You can find the location by:
# Clicking the hamburger menu -> File -> Settings -> Developers -> Edit Configuration
{
  "mcpServers": {
    "github-chat": {
      "command": "uv",
      "args": [
        "--directory",
        "/ABSOLUTE/PATH/TO/PARENT/FOLDER/github-chat-mcp",
        "github-chat-mcp"
      ]
    }
  }
}

Using GitHub Chat with Claude

1. First, index a GitHub repository:
   • Send the /index <repository-url> command, e.g., /index https://github.com/yourusername/repo
2. Then, query the indexed repository:
   • Send the /query <question> command, e.g., /query What is the core technology stack of this repository?

Notes

⚠️ Important Note

• You can adjust the log level via the environment variable FASTMCP_LOG_LEVEL (e.g., FASTMCP_LOG_LEVEL="ERROR").
• This MCP server provides two main functions:
  1. Repository indexing - Index and analyze a GitHub repository.
  2. Repository querying - Query an indexed repository.