Skip to content

Commit 975d02e

Browse files
Yuan325Yuan325
authored
docs: update docs for antigravity (#2015)
Update docs formatting and bullet point indentation. Update option to move binary into executables folder.
1 parent 624d06e commit 975d02e

13 files changed

+532
-369
lines changed

‎docs/ALLOYDBADMIN_README.md‎

Lines changed: 42 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -13,30 +13,38 @@ An editor configured to use the AlloyDB MCP server can use its AI capabilities t
1313
### Prerequisites
1414

1515
* Download and install [MCP Toolbox](https://github.com/googleapis/genai-toolbox):
16-
1. **Download the Toolbox binary**:
17-
Download the latest binary for your operating system and architecture from the storage bucket. Check the [releases page](https://github.com/googleapis/genai-toolbox/releases) for OS and CPU architecture support:
18-
`https://storage.googleapis.com/genai-toolbox/v0.21.0/<os>/<arch>/toolbox`
19-
* Replace `<os>` with `linux`, `darwin` (macOS), or `windows`.
20-
* Replace `<arch>` with `amd64` (Intel) or `arm64` (Apple Silicon).
16+
1. **Download the Toolbox binary**:
17+
Download the latest binary for your operating system and architecture from the storage bucket. Check the [releases page](https://github.com/googleapis/genai-toolbox/releases) for OS and CPU architecture support:
18+
`https://storage.googleapis.com/genai-toolbox/v0.21.0/<os>/<arch>/toolbox`
19+
* Replace `<os>` with `linux`, `darwin` (macOS), or `windows`.
20+
* Replace `<arch>` with `amd64` (Intel) or `arm64` (Apple Silicon).
2121

22-
<!-- {x-release-please-start-version} -->
23-
```
24-
curl -L -o toolbox https://storage.googleapis.com/genai-toolbox/v0.21.0/linux/amd64/toolbox
25-
```
26-
<!-- {x-release-please-end} -->
27-
28-
2. **Make it executable**:
29-
```bash
30-
chmod +x toolbox
31-
```
32-
33-
3. **Add the binary to $PATH in `.~/bash_profile`**:
34-
```bash
35-
export PATH=$PATH:/path/to/toolbox
36-
```
22+
<!-- {x-release-please-start-version} -->
23+
```
24+
curl -L -o toolbox https://storage.googleapis.com/genai-toolbox/v0.21.0/linux/amd64/toolbox
25+
```
26+
<!-- {x-release-please-end} -->
27+
2. **Make it executable**:
28+
```bash
29+
chmod +x toolbox
30+
```
31+
32+
3. **Move binary to `/usr/local/bin/` or `/usr/bin/`**:
33+
```bash
34+
sudo mv toolbox /usr/local/bin/
35+
# sudo mv toolbox /usr/bin/
36+
```
37+
38+
**On Windows, move binary to the `WindowsApps\` folder**:
39+
```
40+
move "C:\Users\<path-to-binary>\toolbox.exe" "C:\Users\<username>\AppData\Local\Microsoft\WindowsApps\"
41+
```
3742
38-
**Note:** You may need to restart Antigravity for changes to take effect.
39-
Windows OS users will need to follow one of the Windows-specific methods.
43+
**Tip:** Ensure the destination folder for your binary is included in
44+
your system's PATH environment variable. To check `PATH`, use `echo
45+
$PATH` (or `echo %PATH%` on Windows).
46+
47+
**Note:** You may need to restart Antigravity for changes to take effect.
4048
4149
* A Google Cloud project with the **AlloyDB API** enabled.
4250
* Ensure [Application Default Credentials](https://cloud.google.com/docs/authentication/gcloud) are available in your environment.
@@ -71,18 +79,18 @@ Once configured, the MCP server will automatically provide AlloyDB capabilities
7179

7280
The AlloyDB MCP server provides the following tools:
7381

74-
| Tool Name | Description |
75-
| :--- | :--- |
76-
| `create_cluster` | Create an AlloyDB cluster. |
77-
| `create_instance` | Create an AlloyDB instance (PRIMARY, READ-POOL, or SECONDARY). |
78-
| `create_user` | Create ALLOYDB-BUILT-IN or IAM-based users for an AlloyDB cluster. |
79-
| `get_cluster` | Get details about an AlloyDB cluster. |
80-
| `get_instance` | Get details about an AlloyDB instance. |
81-
| `get_user` | Get details about a user in an AlloyDB cluster. |
82-
| `list_clusters` | List clusters in a given project and location. |
83-
| `list_instances` | List instances in a given project and location. |
84-
| `list_users` | List users in a given project and location. |
85-
| `wait_for_operation` | Poll the operations API until the operation is done. |
82+
| Tool Name | Description |
83+
|:---------------------|:-------------------------------------------------------------------|
84+
| `create_cluster` | Create an AlloyDB cluster. |
85+
| `create_instance` | Create an AlloyDB instance (PRIMARY, READ-POOL, or SECONDARY). |
86+
| `create_user` | Create ALLOYDB-BUILT-IN or IAM-based users for an AlloyDB cluster. |
87+
| `get_cluster` | Get details about an AlloyDB cluster. |
88+
| `get_instance` | Get details about an AlloyDB instance. |
89+
| `get_user` | Get details about a user in an AlloyDB cluster. |
90+
| `list_clusters` | List clusters in a given project and location. |
91+
| `list_instances` | List instances in a given project and location. |
92+
| `list_users` | List users in a given project and location. |
93+
| `wait_for_operation` | Poll the operations API until the operation is done. |
8694

8795

8896
## Documentation

‎docs/ALLOYDBPG_README.md‎

Lines changed: 43 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -16,29 +16,38 @@ An editor configured to use the AlloyDB MCP server can use its AI capabilities t
1616
### Prerequisites
1717

1818
* Download and install [MCP Toolbox](https://github.com/googleapis/genai-toolbox):
19-
1. **Download the Toolbox binary**:
20-
Download the latest binary for your operating system and architecture from the storage bucket. Check the [releases page](https://github.com/googleapis/genai-toolbox/releases) for OS and CPU architecture support:
21-
`https://storage.googleapis.com/genai-toolbox/v0.21.0/<os>/<arch>/toolbox`
22-
* Replace `<os>` with `linux`, `darwin` (macOS), or `windows`.
23-
* Replace `<arch>` with `amd64` (Intel) or `arm64` (Apple Silicon).
19+
1. **Download the Toolbox binary**:
20+
Download the latest binary for your operating system and architecture from the storage bucket. Check the [releases page](https://github.com/googleapis/genai-toolbox/releases) for OS and CPU architecture support:
21+
`https://storage.googleapis.com/genai-toolbox/v0.21.0/<os>/<arch>/toolbox`
22+
* Replace `<os>` with `linux`, `darwin` (macOS), or `windows`.
23+
* Replace `<arch>` with `amd64` (Intel) or `arm64` (Apple Silicon).
2424

25-
<!-- {x-release-please-start-version} -->
26-
```
27-
curl -L -o toolbox https://storage.googleapis.com/genai-toolbox/v0.21.0/linux/amd64/toolbox
28-
```
29-
<!-- {x-release-please-end} -->
30-
2. **Make it executable**:
31-
```bash
32-
chmod +x toolbox
33-
```
34-
35-
3. **Add the binary to $PATH in `.~/bash_profile`**:
36-
```bash
37-
export PATH=$PATH:/path/to/toolbox
38-
```
25+
<!-- {x-release-please-start-version} -->
26+
```
27+
curl -L -o toolbox https://storage.googleapis.com/genai-toolbox/v0.21.0/linux/amd64/toolbox
28+
```
29+
<!-- {x-release-please-end} -->
30+
2. **Make it executable**:
31+
```bash
32+
chmod +x toolbox
33+
```
34+
35+
3. **Move binary to `/usr/local/bin/` or `/usr/bin/`**:
36+
```bash
37+
sudo mv toolbox /usr/local/bin/
38+
# sudo mv toolbox /usr/bin/
39+
```
40+
41+
**On Windows, move binary to the `WindowsApps\` folder**:
42+
```
43+
move "C:\Users\<path-to-binary>\toolbox.exe" "C:\Users\<username>\AppData\Local\Microsoft\WindowsApps\"
44+
```
3945
40-
**Note:** You may need to restart Antigravity for changes to take effect.
41-
Windows OS users will need to follow one of the Windows-specific methods.
46+
**Tip:** Ensure the destination folder for your binary is included in
47+
your system's PATH environment variable. To check `PATH`, use `echo
48+
$PATH` (or `echo %PATH%` on Windows).
49+
50+
**Note:** You may need to restart Antigravity for changes to take effect.
4251
4352
* A Google Cloud project with the **AlloyDB API** enabled.
4453
* Ensure [Application Default Credentials](https://cloud.google.com/docs/authentication/gcloud) are available in your environment.
@@ -88,19 +97,19 @@ Once configured, the MCP server will automatically provide AlloyDB capabilities
8897

8998
The AlloyDB MCP server provides the following tools:
9099

91-
| Tool Name | Description |
92-
| :--- | :--- |
93-
| `list_tables` | Lists detailed schema information for user-created tables. |
94-
| `execute_sql` | Executes a SQL query. |
95-
| `list_active_queries` | List currently running queries. |
96-
| `list_available_extensions` | List available extensions for installation. |
97-
| `list_installed_extensions` | List installed extensions. |
98-
| `get_query_plan` | Get query plan for a SQL statement. |
99-
| `list_autovacuum_configurations` | List autovacuum configurations and their values. |
100-
| `list_memory_configurations` | List memory configurations and their values. |
101-
| `list_top_bloated_tables` | List top bloated tables. |
102-
| `list_replication_slots` | List replication slots. |
103-
| `list_invalid_indexes` | List invalid indexes. |
100+
| Tool Name | Description |
101+
|:---------------------------------|:-----------------------------------------------------------|
102+
| `list_tables` | Lists detailed schema information for user-created tables. |
103+
| `execute_sql` | Executes a SQL query. |
104+
| `list_active_queries` | List currently running queries. |
105+
| `list_available_extensions` | List available extensions for installation. |
106+
| `list_installed_extensions` | List installed extensions. |
107+
| `get_query_plan` | Get query plan for a SQL statement. |
108+
| `list_autovacuum_configurations` | List autovacuum configurations and their values. |
109+
| `list_memory_configurations` | List memory configurations and their values. |
110+
| `list_top_bloated_tables` | List top bloated tables. |
111+
| `list_replication_slots` | List replication slots. |
112+
| `list_invalid_indexes` | List invalid indexes. |
104113

105114
## Documentation
106115

‎docs/BIGQUERY_README.md‎

Lines changed: 39 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -15,29 +15,38 @@ An editor configured to use the BigQuery MCP server can use its AI capabilities
1515
### Prerequisites
1616

1717
* Download and install [MCP Toolbox](https://github.com/googleapis/genai-toolbox):
18-
1. **Download the Toolbox binary**:
19-
Download the latest binary for your operating system and architecture from the storage bucket. Check the [releases page](https://github.com/googleapis/genai-toolbox/releases) for OS and CPU architecture support:
20-
`https://storage.googleapis.com/genai-toolbox/v0.21.0/<os>/<arch>/toolbox`
21-
* Replace `<os>` with `linux`, `darwin` (macOS), or `windows`.
22-
* Replace `<arch>` with `amd64` (Intel) or `arm64` (Apple Silicon).
18+
1. **Download the Toolbox binary**:
19+
Download the latest binary for your operating system and architecture from the storage bucket. Check the [releases page](https://github.com/googleapis/genai-toolbox/releases) for OS and CPU architecture support:
20+
`https://storage.googleapis.com/genai-toolbox/v0.21.0/<os>/<arch>/toolbox`
21+
* Replace `<os>` with `linux`, `darwin` (macOS), or `windows`.
22+
* Replace `<arch>` with `amd64` (Intel) or `arm64` (Apple Silicon).
2323

24-
<!-- {x-release-please-start-version} -->
25-
```
26-
curl -L -o toolbox https://storage.googleapis.com/genai-toolbox/v0.21.0/linux/amd64/toolbox
27-
```
28-
<!-- {x-release-please-end} -->
29-
2. **Make it executable**:
30-
```bash
31-
chmod +x toolbox
32-
```
33-
34-
3. **Add the binary to $PATH in `.~/bash_profile`**:
35-
```bash
36-
export PATH=$PATH:/path/to/toolbox
37-
```
24+
<!-- {x-release-please-start-version} -->
25+
```
26+
curl -L -o toolbox https://storage.googleapis.com/genai-toolbox/v0.21.0/linux/amd64/toolbox
27+
```
28+
<!-- {x-release-please-end} -->
29+
2. **Make it executable**:
30+
```bash
31+
chmod +x toolbox
32+
```
33+
34+
3. **Move binary to `/usr/local/bin/` or `/usr/bin/`**:
35+
```bash
36+
sudo mv toolbox /usr/local/bin/
37+
# sudo mv toolbox /usr/bin/
38+
```
39+
40+
**On Windows, move binary to the `WindowsApps\` folder**:
41+
```
42+
move "C:\Users\<path-to-binary>\toolbox.exe" "C:\Users\<username>\AppData\Local\Microsoft\WindowsApps\"
43+
```
3844
39-
**Note:** You may need to restart Antigravity for changes to take effect.
40-
Windows OS users will need to follow one of the Windows-specific methods.
45+
**Tip:** Ensure the destination folder for your binary is included in
46+
your system's PATH environment variable. To check `PATH`, use `echo
47+
$PATH` (or `echo %PATH%` on Windows).
48+
49+
**Note:** You may need to restart Antigravity for changes to take effect.
4150
4251
* A Google Cloud project with the **BigQuery API** enabled.
4352
* Ensure [Application Default Credentials](https://cloud.google.com/docs/authentication/gcloud) are available in your environment.
@@ -86,16 +95,16 @@ Once configured, the MCP server will automatically provide BigQuery capabilities
8695

8796
The BigQuery MCP server provides the following tools:
8897

89-
| Tool Name | Description |
90-
| :--- | :--- |
91-
| `execute_sql` | Executes a SQL query. |
92-
| `forecast` | Forecast time series data. |
93-
| `get_dataset_info` | Get dataset metadata. |
94-
| `get_table_info` | Get table metadata. |
95-
| `list_dataset_ids` | Lists dataset IDs in the database. |
96-
| `list_table_ids` | Lists table IDs in the database. |
98+
| Tool Name | Description |
99+
|:-----------------------|:----------------------------------------------------------------|
100+
| `execute_sql` | Executes a SQL query. |
101+
| `forecast` | Forecast time series data. |
102+
| `get_dataset_info` | Get dataset metadata. |
103+
| `get_table_info` | Get table metadata. |
104+
| `list_dataset_ids` | Lists dataset IDs in the database. |
105+
| `list_table_ids` | Lists table IDs in the database. |
97106
| `analyze_contribution` | Perform contribution analysis, also called key driver analysis. |
98-
| `search_catalog` | Search for tables based on the provided query. |
107+
| `search_catalog` | Search for tables based on the provided query. |
99108

100109
## Documentation
101110

‎docs/CLOUDSQLMSSQLADMIN_README.md‎

Lines changed: 39 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -13,29 +13,38 @@ An editor configured to use the Cloud SQL for SQL Server MCP server can use its
1313
### Prerequisites
1414

1515
* Download and install [MCP Toolbox](https://github.com/googleapis/genai-toolbox):
16-
1. **Download the Toolbox binary**:
17-
Download the latest binary for your operating system and architecture from the storage bucket. Check the [releases page](https://github.com/googleapis/genai-toolbox/releases) for OS and CPU architecture support:
18-
`https://storage.googleapis.com/genai-toolbox/v0.21.0/<os>/<arch>/toolbox`
19-
* Replace `<os>` with `linux`, `darwin` (macOS), or `windows`.
20-
* Replace `<arch>` with `amd64` (Intel) or `arm64` (Apple Silicon).
16+
1. **Download the Toolbox binary**:
17+
Download the latest binary for your operating system and architecture from the storage bucket. Check the [releases page](https://github.com/googleapis/genai-toolbox/releases) for OS and CPU architecture support:
18+
`https://storage.googleapis.com/genai-toolbox/v0.21.0/<os>/<arch>/toolbox`
19+
* Replace `<os>` with `linux`, `darwin` (macOS), or `windows`.
20+
* Replace `<arch>` with `amd64` (Intel) or `arm64` (Apple Silicon).
2121

22-
<!-- {x-release-please-start-version} -->
23-
```
24-
curl -L -o toolbox https://storage.googleapis.com/genai-toolbox/v0.21.0/linux/amd64/toolbox
25-
```
26-
<!-- {x-release-please-end} -->
27-
2. **Make it executable**:
28-
```bash
29-
chmod +x toolbox
30-
```
31-
32-
3. **Add the binary to $PATH in `.~/bash_profile`**:
33-
```bash
34-
export PATH=$PATH:/path/to/toolbox
35-
```
22+
<!-- {x-release-please-start-version} -->
23+
```
24+
curl -L -o toolbox https://storage.googleapis.com/genai-toolbox/v0.21.0/linux/amd64/toolbox
25+
```
26+
<!-- {x-release-please-end} -->
27+
2. **Make it executable**:
28+
```bash
29+
chmod +x toolbox
30+
```
31+
32+
3. **Move binary to `/usr/local/bin/` or `/usr/bin/`**:
33+
```bash
34+
sudo mv toolbox /usr/local/bin/
35+
# sudo mv toolbox /usr/bin/
36+
```
37+
38+
**On Windows, move binary to the `WindowsApps\` folder**:
39+
```
40+
move "C:\Users\<path-to-binary>\toolbox.exe" "C:\Users\<username>\AppData\Local\Microsoft\WindowsApps\"
41+
```
3642
37-
**Note:** You may need to restart Antigravity for changes to take effect.
38-
Windows OS users will need to follow one of the Windows-specific methods.
43+
**Tip:** Ensure the destination folder for your binary is included in
44+
your system's PATH environment variable. To check `PATH`, use `echo
45+
$PATH` (or `echo %PATH%` on Windows).
46+
47+
**Note:** You may need to restart Antigravity for changes to take effect.
3948
4049
* A Google Cloud project with the **Cloud SQL Admin API** enabled.
4150
* Ensure [Application Default Credentials](https://cloud.google.com/docs/authentication/gcloud) are available in your environment.
@@ -69,15 +78,15 @@ Once configured, the MCP server will automatically provide Cloud SQL for SQL Ser
6978

7079
The Cloud SQL for SQL Server MCP server provides the following tools:
7180

72-
| Tool Name | Description |
73-
| :--- | :--- |
74-
| `create_instance` | Create an instance (PRIMARY, READ-POOL, or SECONDARY). |
75-
| `create_user` | Create BUILT-IN or IAM-based users for an instance. |
76-
| `get_instance` | Get details about an instance. |
77-
| `get_user` | Get details about a user in an instance. |
78-
| `list_instances` | List instances in a given project and location. |
79-
| `list_users` | List users in a given project and location. |
80-
| `wait_for_operation` | Poll the operations API until the operation is done. |
81+
| Tool Name | Description |
82+
|:---------------------|:-------------------------------------------------------|
83+
| `create_instance` | Create an instance (PRIMARY, READ-POOL, or SECONDARY). |
84+
| `create_user` | Create BUILT-IN or IAM-based users for an instance. |
85+
| `get_instance` | Get details about an instance. |
86+
| `get_user` | Get details about a user in an instance. |
87+
| `list_instances` | List instances in a given project and location. |
88+
| `list_users` | List users in a given project and location. |
89+
| `wait_for_operation` | Poll the operations API until the operation is done. |
8190

8291
## Documentation
8392

0 commit comments

Comments
 (0)