Installation¶
There are multiple ways to install and use GitHub to MCP depending on your needs.
Web UI (No Installation)¶
The easiest way to get started — no installation required:
👉 github-to-mcp.modelcontextprotocol.name
Simply paste a GitHub URL, configure options, and download your generated MCP server.
CLI Installation¶
Using npx (Recommended)¶
Run directly without installing:
Global Installation¶
Install globally for repeated use:
Then use the github-to-mcp command:
Programmatic Installation¶
Add as a dependency to your project:
Then import in your code:
Verify Installation¶
Check that the CLI is installed correctly:
You should see the version number printed:
System Requirements¶
| Requirement | Version |
|---|---|
| Node.js | 18.0.0 or higher |
| npm | 9.0.0 or higher |
| Operating System | macOS, Linux, Windows |
Environment Setup¶
GitHub Token (Optional)¶
For private repositories or to increase API rate limits (60/hr → 5000/hr), set a GitHub token:
Creating a GitHub Token
- Go to GitHub Settings → Developer Settings → Personal Access Tokens
- Click "Generate new token (classic)"
- Select scopes:
repo(for private repos) orpublic_repo(for public only) - Copy and save the token
Next Steps¶
Now that you have GitHub to MCP installed, continue to the Quick Start guide to generate your first MCP server!