MCP Github Reader Prod

🚀 MCP GitHub Reader

A lightweight Model Context Protocol (MCP) server for bringing GitHub repositories into the context of large language models.

✨ Features

• API-based: No need to clone repositories locally - interact directly with the GitHub API.
• Repository analysis: Get an overview and statistics of any GitHub repository.
• File access: Retrieve the content of a single file or the entire repository file structure.
• Intelligent filtering: Include or exclude files using wildcards and regular expressions.
• Cache support: Smart caching and optimized request patterns to avoid GitHub API limits.
• Search functionality: Find files that match specific patterns.
• MCP compatibility: Compatible with any LLM client that supports the Model Context Protocol.
• Prompt templates: Ready-to-use prompt templates for common repository analysis tasks.

📦 Installation

Global installation (recommended for CLI use)

npm install -g mcp-github-reader

Local installation

npm install mcp-github-reader

💻 Usage Examples

Run as a standalone server

# If globally installed
mcp-github-reader

# If locally installed
npx mcp-github-reader

Integrate with Claude

For npm installation:

Add this to your Claude Desktop tool configuration:

"github-reader": {
  "runtime": "node",
  "command": "npx",
  "args": [
    "-y",
    "mcp-github-reader"
  ]
}

For local installation:

"github-reader-test": {
  "command": "node",
  "args": [
    "/path/to/your/repo/src/mcp-github-reader.js"
  ]
}

Replace /path/to/your/repo with the actual repository path.

📚 Documentation

The MCP server provides four powerful tools to interact with GitHub repositories:

1. Get single file content

Retrieve the content of a specific file from a GitHub repository.

Parameters:

• owner: Repository owner (e.g., "skydeckai")
• repo: Repository name (e.g., "mcp-server-aidd")
• path: File path in the repository (e.g., "README.md")
• branch (optional): Branch name

2. Get entire repository content

Retrieve all files that match specific patterns from a specified repository.

Parameters:

• owner: Repository owner
• repo: Repository name
• include_patterns: List of file patterns to include
• exclude_patterns: List of file patterns to exclude
• max_files: Maximum number of files to return

3. Analyze repository

Analyze a specified repository and return a detailed report.

Parameters:

• repository: Repository to analyze (in the format "owner/repo")
• include_files: Whether to include file content

4. Search files

Search for files that match a specific query in a specified repository.

Parameters:

• repository: Repository to search
• query: Search query
• file_type (optional): File type

💻 Usage Examples

Get single file content

{
  "name": "get_individual_file_content",
  "parameters": {
    "owner": "skydeckai",
    "repo": "mcp-server-aidd",
    "path": "README.md"
  }
}

Get entire repository content

{
  "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
  }
}

Analyze repository

{
  "name": "analyze_repository",
  "parameters": {
    "repository": "skydeckai/mcp-server-aidd",
    "include_files": true
  }
}

🔧 Technical Details

• Currently, only public GitHub repositories are supported.
• Private repositories or authentication are not supported.
• Limited by the GitHub API rate limit (60 unauthenticated requests per hour).

📄 License

This project is licensed under the Apache License 2.0. For more details, see the LICENSE file.

Copyright © 2025 SkyDeck AI Inc.