-
Notifications
You must be signed in to change notification settings - Fork 3.3k
Add Antigravity installation docs #1624
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
04cb4fe
docs: add Antigravity installation guide
ManoloZocco 7c77bf5
docs: improve antigravity guide and address feedback
ManoloZocco cc9cd3e
Update docs/installation-guides/install-antigravity.md
ManoloZocco 4e3f8c0
Update docs/installation-guides/install-antigravity.md
ManoloZocco 9eba997
Merge branch 'main' into docs/antigravity-guide
tommaso-moro File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,143 @@ | ||||||
| # Installing GitHub MCP Server in Antigravity | ||||||
|
|
||||||
| This guide covers setting up the GitHub MCP Server in Google's Antigravity IDE. | ||||||
|
|
||||||
| ## Prerequisites | ||||||
|
|
||||||
| - Antigravity IDE installed (latest version) | ||||||
| - GitHub Personal Access Token with appropriate scopes | ||||||
|
|
||||||
| ## Installation Methods | ||||||
|
|
||||||
| ### Option 1: Remote Server (Recommended) | ||||||
|
|
||||||
| Uses GitHub's hosted server at `https://api.githubcopilot.com/mcp/`. | ||||||
|
|
||||||
| > [!NOTE] | ||||||
| > We recommend this manual configuration method because the "official" installation via the Antigravity MCP Store currently has known issues (often resulting in Docker errors). This direct remote connection is more reliable. | ||||||
|
|
||||||
| #### Step 1: Access MCP Configuration | ||||||
|
|
||||||
| 1. Open Antigravity | ||||||
| 2. Click the "..." (Additional Options) menu in the Agent panel | ||||||
| 3. Select "MCP Servers" | ||||||
| 4. Click "Manage MCP Servers" | ||||||
| 5. Click "View raw config" | ||||||
|
|
||||||
| This will open your `mcp_config.json` file at: | ||||||
| - **Windows**: `C:\Users\<USERNAME>\.gemini\antigravity\mcp_config.json` | ||||||
| - **macOS/Linux**: `~/.gemini/antigravity/mcp_config.json` | ||||||
|
|
||||||
| #### Step 2: Add Configuration | ||||||
|
|
||||||
| Add the following to your `mcp_config.json`: | ||||||
|
|
||||||
| ```json | ||||||
| { | ||||||
| "mcpServers": { | ||||||
| "github": { | ||||||
| "serverUrl": "https://api.githubcopilot.com/mcp/", | ||||||
| "headers": { | ||||||
| "Authorization": "Bearer YOUR_GITHUB_PAT" | ||||||
| } | ||||||
| } | ||||||
| } | ||||||
| } | ||||||
| ``` | ||||||
|
|
||||||
| **Important**: Note that Antigravity uses `serverUrl` instead of `url` for HTTP-based MCP servers. | ||||||
|
|
||||||
| #### Step 3: Configure Your Token | ||||||
|
|
||||||
| Replace `YOUR_GITHUB_PAT` with your actual GitHub Personal Access Token. | ||||||
|
|
||||||
| Create a token here: https://github.com/settings/tokens | ||||||
|
|
||||||
| Recommended scopes: | ||||||
| - `repo` - Full control of private repositories | ||||||
| - `read:org` - Read org and team membership | ||||||
| - `read:user` - Read user profile data | ||||||
|
|
||||||
| #### Step 4: Restart Antigravity | ||||||
|
|
||||||
| Close and reopen Antigravity for the changes to take effect. | ||||||
|
|
||||||
| #### Step 5: Verify Installation | ||||||
|
|
||||||
| 1. Open the MCP Servers panel (... menu → MCP Servers) | ||||||
| 2. You should see "github" with a list of available tools | ||||||
| 3. You can now use GitHub tools in your conversations | ||||||
|
|
||||||
| > [!NOTE] | ||||||
| > The status indicator in the MCP Servers panel might not immediately turn green in some versions, but the tools will still function if configured correctly. | ||||||
|
|
||||||
| ### Option 2: Local Docker Server | ||||||
|
|
||||||
| If you prefer running the server locally with Docker: | ||||||
|
|
||||||
| ```json | ||||||
| { | ||||||
| "mcpServers": { | ||||||
| "github": { | ||||||
| "command": "docker", | ||||||
| "args": [ | ||||||
| "run", | ||||||
| "-i", | ||||||
| "--rm", | ||||||
| "-e", | ||||||
| "GITHUB_PERSONAL_ACCESS_TOKEN", | ||||||
| "ghcr.io/github/github-mcp-server" | ||||||
| ], | ||||||
| "env": { | ||||||
| "GITHUB_PERSONAL_ACCESS_TOKEN": "YOUR_GITHUB_PAT" | ||||||
| } | ||||||
| } | ||||||
| } | ||||||
| } | ||||||
| ``` | ||||||
|
|
||||||
| **Requirements**: | ||||||
| - Docker Desktop installed and running | ||||||
| - Docker must be in your system PATH | ||||||
|
|
||||||
| ## Troubleshooting | ||||||
|
|
||||||
| ### "Error: serverUrl or command must be specified" | ||||||
|
|
||||||
| Make sure you're using `serverUrl` (not `url`) for the remote server configuration. Antigravity requires `serverUrl` for HTTP-based MCP servers. | ||||||
|
|
||||||
| ### Server not appearing in MCP list | ||||||
|
|
||||||
| - Verify JSON syntax in your config file | ||||||
| - Check that your PAT hasn't expired | ||||||
| - Restart Antigravity completely | ||||||
|
|
||||||
| ### Tools not working | ||||||
|
|
||||||
| - Ensure your PAT has the correct scopes | ||||||
| - Check the MCP Servers panel for error messages | ||||||
| - Verify internet connection for remote server | ||||||
|
|
||||||
| ## Available Tools | ||||||
|
|
||||||
| Once installed, you'll have access to tools like: | ||||||
| - `create_repository` - Create new GitHub repositories | ||||||
| - `push_files` - Push files to repositories | ||||||
| - `search_repositories` - Search for repositories | ||||||
| - `create_or_update_file` - Manage file content | ||||||
| - `get_file_contents` - Read file content | ||||||
| - And many more... | ||||||
|
|
||||||
| For a complete list of available tools and features, see the [main README](../../README.md). | ||||||
|
|
||||||
| ## Differences from Other IDEs | ||||||
|
|
||||||
| - **Configuration key**: Antigravity uses `serverUrl` instead of `url` for HTTP servers | ||||||
| - **Config location**: `.gemini/antigravity/mcp_config.json` instead of `.cursor/mcp.json` | ||||||
|
||||||
| - **Config location**: `.gemini/antigravity/mcp_config.json` instead of `.cursor/mcp.json` | |
| - **Config location**: Antigravity uses `.gemini/antigravity/mcp_config.json` (Cursor uses `.cursor/mcp.json`) |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The placeholder
<USERNAME>should use a consistent format. Consider using%USERNAME%for Windows (environment variable style) or keeping it consistent with the Unix-style~placeholder used in the macOS/Linux path.