Skip to content

Commit 04cb4fe

Browse files
committed
docs: add Antigravity installation guide
1 parent f197a9f commit 04cb4fe

File tree

2 files changed

+138
-0
lines changed

2 files changed

+138
-0
lines changed

docs/installation-guides/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ This directory contains detailed installation instructions for the GitHub MCP Se
44

55
## Installation Guides by Host Application
66
- **[GitHub Copilot in other IDEs](install-other-copilot-ides.md)** - Installation for JetBrains, Visual Studio, Eclipse, and Xcode with GitHub Copilot
7+
- **[Antigravity](install-antigravity.md)** - Installation for Google Antigravity IDE
78
- **[Claude Applications](install-claude.md)** - Installation guide for Claude Web, Claude Desktop and Claude Code CLI
89
- **[Cursor](install-cursor.md)** - Installation guide for Cursor IDE
910
- **[Google Gemini CLI](install-gemini-cli.md)** - Installation guide for Google Gemini CLI
Lines changed: 137 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,137 @@
1+
# Installing GitHub MCP Server in Antigravity
2+
3+
This guide covers setting up the GitHub MCP Server in Google's Antigravity IDE.
4+
5+
## Prerequisites
6+
7+
- Antigravity IDE installed (latest version)
8+
- GitHub Personal Access Token with appropriate scopes
9+
10+
## Installation Methods
11+
12+
### Option 1: Remote Server (Recommended)
13+
14+
Uses GitHub's hosted server at `https://api.githubcopilot.com/mcp/`.
15+
16+
#### Step 1: Access MCP Configuration
17+
18+
1. Open Antigravity
19+
2. Click the "..." (Additional Options) menu in the Agent panel
20+
3. Select "MCP Servers"
21+
4. Click "Manage MCP Servers"
22+
5. Click "View raw config"
23+
24+
This will open your `mcp_config.json` file at:
25+
- **Windows**: `C:\Users\<USERNAME>\.gemini\antigravity\mcp_config.json`
26+
- **macOS/Linux**: `~/.gemini/antigravity/mcp_config.json`
27+
28+
#### Step 2: Add Configuration
29+
30+
Add the following to your `mcp_config.json`:
31+
32+
```json
33+
{
34+
"mcpServers": {
35+
"github": {
36+
"serverUrl": "https://api.githubcopilot.com/mcp/",
37+
"headers": {
38+
"Authorization": "Bearer YOUR_GITHUB_PAT"
39+
}
40+
}
41+
}
42+
}
43+
```
44+
45+
**Important**: Note that Antigravity uses `serverUrl` instead of `url` for HTTP-based MCP servers.
46+
47+
#### Step 3: Configure Your Token
48+
49+
Replace `YOUR_GITHUB_PAT` with your actual GitHub Personal Access Token.
50+
51+
Create a token here: https://github.com/settings/tokens
52+
53+
Recommended scopes:
54+
- `repo` - Full control of private repositories
55+
- `read:org` - Read org and team membership
56+
- `read:user` - Read user profile data
57+
58+
#### Step 4: Restart Antigravity
59+
60+
Close and reopen Antigravity for the changes to take effect.
61+
62+
#### Step 5: Verify Installation
63+
64+
1. Open the MCP Servers panel (... menu → MCP Servers)
65+
2. You should see "github" with a green status indicator
66+
3. You can now use GitHub tools in your conversations
67+
68+
### Option 2: Local Docker Server
69+
70+
If you prefer running the server locally with Docker:
71+
72+
```json
73+
{
74+
"mcpServers": {
75+
"github": {
76+
"command": "docker",
77+
"args": [
78+
"run",
79+
"-i",
80+
"--rm",
81+
"-e",
82+
"GITHUB_PERSONAL_ACCESS_TOKEN",
83+
"ghcr.io/github/github-mcp-server"
84+
],
85+
"env": {
86+
"GITHUB_PERSONAL_ACCESS_TOKEN": "YOUR_GITHUB_PAT"
87+
}
88+
}
89+
}
90+
}
91+
```
92+
93+
**Requirements**:
94+
- Docker Desktop installed and running
95+
- Docker must be in your system PATH
96+
97+
## Troubleshooting
98+
99+
### "Error: serverUrl or command must be specified"
100+
101+
Make sure you're using `serverUrl` (not `url`) for the remote server configuration. Antigravity requires `serverUrl` for HTTP-based MCP servers.
102+
103+
### Server not appearing in MCP list
104+
105+
- Verify JSON syntax in your config file
106+
- Check that your PAT hasn't expired
107+
- Restart Antigravity completely
108+
109+
### Tools not working
110+
111+
- Ensure your PAT has the correct scopes
112+
- Check the MCP Servers panel for error messages
113+
- Verify internet connection for remote server
114+
115+
## Available Tools
116+
117+
Once installed, you'll have access to tools like:
118+
- `create_repository` - Create new GitHub repositories
119+
- `push_files` - Push files to repositories
120+
- `search_repositories` - Search for repositories
121+
- `create_or_update_file` - Manage file content
122+
- `get_file_contents` - Read file content
123+
- And many more...
124+
125+
For a complete list of available tools and features, see the [main README](../../README.md).
126+
127+
## Differences from Other IDEs
128+
129+
- **Configuration key**: Antigravity uses `serverUrl` instead of `url` for HTTP servers
130+
- **Config location**: `.gemini/antigravity/mcp_config.json` instead of `.cursor/mcp.json`
131+
- **Tool limits**: Antigravity recommends keeping total enabled tools under 50 for optimal performance
132+
133+
## Next Steps
134+
135+
- Explore the [Server Configuration Guide](../server-configuration.md) for advanced options
136+
- Check out [toolsets documentation](../toolsets.md) to customize available tools
137+
- See the [Remote Server Documentation](../remote-server.md) for more details

0 commit comments

Comments
 (0)