Gh MCP Server

🚀 GitHub Repo MCP Server

The Model Context Protocol (MCP) server enables AI models to access the content of GitHub repositories as context. It offers tools to obtain file content, repository structure, and the entire repository for use as context in AI interactions.

🚀 Quick Start

The MCP server serves as a bridge, allowing AI models to leverage GitHub repositories as a rich source of context. It equips you with the means to retrieve repository content, structure, and specific file details, enhancing the context available during AI interactions.

✨ Features

• Retrieve the entire repository content as context.
• Obtain the content of specific files from a repository.
• Get the repository structure (file list).
• Filter files by extension.
• Exclude specific paths.
• Limit the number of returned files.

📦 Installation

# Clone the repository
git clone https://github.com/shanksxz/github-mcp.git
cd github-mcp

# Install dependencies
npm install

# Build the project
npm run build

💻 Usage Examples

Basic Usage

Set Up GitHub Authentication

Although the server can work with public repositories without authentication, the GitHub API for unauthenticated requests has strict rate limits (60 requests per hour). To increase the rate limit to 5000 requests per hour, set the GITHUB_TOKEN environment variable:

# Create a file named gh.sh and add the following content:
export GITHUB_TOKEN=your_github_personal_access_token
# Make the file executable
chmod +x gh.sh
# Run the file
./gh.sh

You can create a personal access token in GitHub Developer Settings.

Use with Cursor

To use this server with Cursor, follow these steps:

1. Open Cursor settings.
2. Search for "MCP".
3. Click "Add New MCP Server".
4. Fill in the following information:
   • Name: github-repo-context (or any name you prefer).
   • Type: Command.
   • Command: /path/to/your-local-repo-setup/gh.sh.
5. Click "Save".
6. Enable the server by clicking the toggle switch next to the server name.
7. You should now be able to use the server in this project.

The server communicates via stdin/stdout following the MCP protocol.

Advanced Usage

Available Tools

The server provides the following tools:

1. get-repo-context: Retrieve all files from a GitHub repository for use as context.

   • Parameters:
     • owner: The name of the GitHub repository owner/organization.
     • repo: The name of the GitHub repository.
     • maxFiles (optional): The maximum number of files to include (default: 50).
     • fileExtensions (optional): The file extensions to include (e.g., ['js', 'ts', 'md']).
     • excludePaths (optional): The paths to exclude (default: ['node_modules', 'dist', 'build']).

2. get-file-content: Retrieve the content of a specific file from a GitHub repository.

   • Parameters:
     • owner: The name of the GitHub repository owner/organization.
     • repo: The name of the GitHub repository.
     • path: The file path within the repository.

3. get-repo-structure: Retrieve the structure of a GitHub repository.

   • Parameters:
     • owner: The name of the GitHub repository owner/organization.
     • repo: The name of the GitHub repository.

Example

When used in conjunction with an AI model that supports MCP, you can execute commands like the following:

Get the structure of the tensorflow/tensorflow repository.

The AI will use the get-repo-structure tool to retrieve and display the repository structure.