MCP Server Github Repo

🚀 MCP GitHub Repository Server

An MCP (Model Context Protocol) server that provides access to the contents of GitHub repositories. This server allows AI assistants to browse and read files in specified GitHub repositories.

🎥 Demo

✨ Features

Resources

• Access any file in the repository via URI.
• List repository contents and navigate directories.
• Support branch-specific file access.
• Provide file contents in plain text format.

Resource URIs

• Basic URL format: https://api.github.com/repos/{owner}/{repo}/contents/{path}.
• Support files and directories.
• Use the text/plain MIME type for files.
• Use the application/x-directory MIME type for directories.

📦 Installation

When using with Claude Desktop, add the server configuration:

Configuration Location

• MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json
• Windows: %APPDATA%/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "mcp-server-github-repo": {
      "command": "/path/to/mcp-server-github-repo/build/index.js"
    }
  }
}

💻 Usage Examples

Basic Usage

The server requires the following environment variables:

GITHUB_PERSONAL_ACCESS_TOKEN=your_github_token
GITHUB_OWNER=repository_owner
GITHUB_REPO=repository_name
GITHUB_BRANCH=branch_name  # Optional

Advanced Usage

Install Dependencies

npm install

Build the Server

npm run build

Develop with Automatic Rebuilding

npm run watch

📚 Documentation

API Implementation

The server implements three main MCP endpoints:

1. ListResources - List files and directories in the repository.
2. ReadResource - Get the content of a specific file.

Authentication

The server uses a GitHub personal access token for authentication. Ensure your token has the appropriate permissions to access the repository contents.

Error Handling

The server includes the following error handling:

• Missing environment variables.
• GitHub API errors.
• Invalid paths (e.g., trying to read a directory as a file).
• Authentication failures.

Debugging

Since the MCP server communicates via stdio, debugging can be challenging. Use the MCP Inspector for debugging:

npm run inspector

This will provide a URL to access the debugging tools in the browser.

Security Considerations

• Keep your GitHub personal access token secure.
• Consider using a token with the minimum required permissions.
• Be aware of repository size limitations to avoid issues when accessing large repositories.

📄 License

MIT