MCP GitHub Reader
About
Bring github repos into context using this mcp server
Details
- License
- Apache-2.0
Explore
- API-based: No local repository cloning required - works directly with GitHub's API
- Repository Analysis: Get overview and statistics for any GitHub repository
- File Access: Retrieve individual file contents or entire repository file structures
- Smart Filtering: Include or exclude files with glob and regex patterns
- Cache-enabled: Smart caching and optimized request patterns to avoid GitHub API limits
- Search Capabilities: Find files matching specific patterns within repositories
- MCP Compatible: Works with any LLM client supporting the Model Context Protocol
- Prompt Templates: Ready-to-use prompt templates for common repository analysis tasks
Setting up with Highlight
This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:
- Download and install Highlight from highlightai.com/download
- Navigate to the plugins tab and select "Add Custom Plugin"
-
Configure the plugin with the settings below
Plugin Name
MCP GitHub ReaderCommand (node, npx, python, etc.)Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.
- Enable "Start Automatically" if you want the plugin to start when Highlight launches
From the repository
npm install -g mcp-github-reader
npm install mcp-github-reader
mcp-github-reader
npx mcp-github-reader
Add this to your Claude Desktop tools configuration:
"github-reader": {
"runtime": "node",
"command": "npx",
"args": [
"-y",
"mcp-github-reader"
]
}
"github-reader-test": {
"command": "node",
"args": [
"/path/to/your/repo/src/mcp-github-reader.js"
]
}
Replace /path/to/your/repo with your actual repository location.
{
"name": "get_entire_repo_contents",
"parameters": {
"owner": "skydeckai",
"repo": "mcp-server-aidd",
"include_patterns": [".js", ".json", ".md"],
"exclude_patterns": [".test.js", "node_modules/*"],
"max_files": 30
}
}
get_individual_file_content
get_entire_repo_contents
analyzeRepository
searchRepository
The MCP server provides four powerful tools for interacting with GitHub repositories:
Claude Desktop / Cursor
Paste into your MCP client config file to install this server.
{
"mcpServers": {
"mcp github reader": {
"mcp-github-reader-prod": {
"command": "npx",
"args": [
"mcp-github-reader"
]
}
}
}
}McpServers
{
"mcp-github-reader-prod": {
"command": "npx",
"args": [
"mcp-github-reader"
]
}
}A lightweight Model Context Protocol (MCP) server for bringing GitHub repositories into context for large language models.
Features
- API-based: No local repository cloning required - works directly with GitHub's API
- Repository Analysis: Get overview and statistics for any GitHub repository
- File Access: Retrieve individual file contents or entire repository file structures
- Smart Filtering: Include or exclude files with glob and regex patterns
- Cache-enabled: Smart caching and optimized request patterns to avoid GitHub API limits
- Search Capabilities: Find files matching specific patterns within repositories
- MCP Compatible: Works with any LLM client supporting the Model Context Protocol
- Prompt Templates: Ready-to-use prompt templates for common repository analysis tasks
Installation
Global Installation (Recommended for CLI usage)
npm install -g mcp-github-reader
Local Installation
npm install mcp-github-reader
Usage
Running as a Standalone Server
```bash
Sign in to leave a review
Use Google, GitHub, or an email account so ratings stay tied to real people.
No reviews posted yet.
