Welcome to the OrbitalMCP documentation. This guide provides a comprehensive overview of how to use OrbitalMCP to streamline your AI development workflow. Whether you're using our VS Code extension or our web dashboard, this guide will help you get started.
You may find additional information for various AI agents and extensions in the OrbitalMCP blog.
Your OrbitalMCP API key is your universal credential for accessing all your configured MCP servers. To get your API key, you first need to sign up for an OrbitalMCP account.
1. Sign Up: If you don't have an account, sign up here.
2. Navigate to API Keys: Once you are logged in, go to the dashboard and click on the "API Keys" tab.
3. Generate Key: Click the "Generate New API Key" button. Give your key a descriptive name (e.g., "My VS Code Key") and click "Generate".
4. Copy Your Key: Your new API key will be displayed. Copy it to a safe place. You will not be able to see this key again.
1. Open VS Code and go to the Extensions view (Ctrl+Shift+X).
2. Search for "OrbitalMCP" and click Install.
3. Once installed, open the command palette (Ctrl+Shift+P) and run the command OrbitalMCP: Set API Key.
4. Paste your OrbitalMCP API key when prompted.
The OrbitalMCP Connector includes seamless integration with Google's official Gemini Code Assist extension for VS Code.
Once you install the OrbitalMCP Connector and set your API key, Gemini Code Assist is automatically configured to access your OrbitalMCP servers:
1. Install the Gemini Code Assist extension from the VS Code Marketplace (if not already installed).
2. Install the OrbitalMCP Connector extension.
3. Set your OrbitalMCP API key using the command OrbitalMCP: Set API Key.
4. The extension automatically configures MCP servers in your VS
Code settings (cloudcode.gemini.mcp.server.list).
5. Gemini Code Assist now has direct access to all your OrbitalMCP tools through its chat interface.
Note: No additional configuration required. Gemini uses its own authentication and automatically discovers MCP servers configured in VS Code settings.
The OrbitalMCP Connector runs a local MCP server that acts as a proxy to your OrbitalMCP account. Gemini Code Assist connects to this local server, which handles authentication and provides access to all your configured MCP servers and tools.
The extension automatically configures your environment to use OrbitalMCP as a proxy for your MCP servers. Any MCP-compatible tool or agent you run from within VS Code will now have access to the servers you've configured in your OrbitalMCP dashboard.
The extension supports all major AI coding assistants including: Gemini Code Assist, Claude Code, GitHub Copilot, Cline, Roo-Cline, Continue.dev, Cursor, Windsurf, Zencoder, and GitHub Copilot.
The extension adds a new view to your activity bar that shows:
For GitHub Copilot users: Use the @orbitalmcp chat participant to access OrbitalMCP tools directly in Copilot Chat.
The dashboard is the central hub for managing your MCP servers.
You can add any MCP-compliant server to your dashboard.
1. Go to the My Servers tab in the dashboard.
2. Click the Add New Server button.
3. Fill in the server details:
4. Click Save Server. The server will now be available to any tool using your OrbitalMCP API key.