mirror of
https://github.com/googleapis/genai-toolbox.git
synced 2026-01-10 07:58:12 -05:00
docs: update docs for antigravity (#2015)
Update docs formatting and bullet point indentation. Update option to move binary into executables folder.
This commit is contained in:
@@ -13,30 +13,38 @@ An editor configured to use the AlloyDB MCP server can use its AI capabilities t
|
||||
### Prerequisites
|
||||
|
||||
* Download and install [MCP Toolbox](https://github.com/googleapis/genai-toolbox):
|
||||
1. **Download the Toolbox binary**:
|
||||
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:
|
||||
`https://storage.googleapis.com/genai-toolbox/v0.21.0/<os>/<arch>/toolbox`
|
||||
* Replace `<os>` with `linux`, `darwin` (macOS), or `windows`.
|
||||
* Replace `<arch>` with `amd64` (Intel) or `arm64` (Apple Silicon).
|
||||
1. **Download the Toolbox binary**:
|
||||
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:
|
||||
`https://storage.googleapis.com/genai-toolbox/v0.21.0/<os>/<arch>/toolbox`
|
||||
* Replace `<os>` with `linux`, `darwin` (macOS), or `windows`.
|
||||
* Replace `<arch>` with `amd64` (Intel) or `arm64` (Apple Silicon).
|
||||
|
||||
<!-- {x-release-please-start-version} -->
|
||||
```
|
||||
curl -L -o toolbox https://storage.googleapis.com/genai-toolbox/v0.21.0/linux/amd64/toolbox
|
||||
```
|
||||
<!-- {x-release-please-end} -->
|
||||
<!-- {x-release-please-start-version} -->
|
||||
```
|
||||
curl -L -o toolbox https://storage.googleapis.com/genai-toolbox/v0.21.0/linux/amd64/toolbox
|
||||
```
|
||||
<!-- {x-release-please-end} -->
|
||||
2. **Make it executable**:
|
||||
```bash
|
||||
chmod +x toolbox
|
||||
```
|
||||
|
||||
2. **Make it executable**:
|
||||
```bash
|
||||
chmod +x toolbox
|
||||
```
|
||||
3. **Move binary to `/usr/local/bin/` or `/usr/bin/`**:
|
||||
```bash
|
||||
sudo mv toolbox /usr/local/bin/
|
||||
# sudo mv toolbox /usr/bin/
|
||||
```
|
||||
|
||||
3. **Add the binary to $PATH in `.~/bash_profile`**:
|
||||
```bash
|
||||
export PATH=$PATH:/path/to/toolbox
|
||||
```
|
||||
**On Windows, move binary to the `WindowsApps\` folder**:
|
||||
```
|
||||
move "C:\Users\<path-to-binary>\toolbox.exe" "C:\Users\<username>\AppData\Local\Microsoft\WindowsApps\"
|
||||
```
|
||||
|
||||
**Note:** You may need to restart Antigravity for changes to take effect.
|
||||
Windows OS users will need to follow one of the Windows-specific methods.
|
||||
**Tip:** Ensure the destination folder for your binary is included in
|
||||
your system's PATH environment variable. To check `PATH`, use `echo
|
||||
$PATH` (or `echo %PATH%` on Windows).
|
||||
|
||||
**Note:** You may need to restart Antigravity for changes to take effect.
|
||||
|
||||
* A Google Cloud project with the **AlloyDB API** enabled.
|
||||
* 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
|
||||
|
||||
The AlloyDB MCP server provides the following tools:
|
||||
|
||||
| Tool Name | Description |
|
||||
| :--- | :--- |
|
||||
| `create_cluster` | Create an AlloyDB cluster. |
|
||||
| `create_instance` | Create an AlloyDB instance (PRIMARY, READ-POOL, or SECONDARY). |
|
||||
| `create_user` | Create ALLOYDB-BUILT-IN or IAM-based users for an AlloyDB cluster. |
|
||||
| `get_cluster` | Get details about an AlloyDB cluster. |
|
||||
| `get_instance` | Get details about an AlloyDB instance. |
|
||||
| `get_user` | Get details about a user in an AlloyDB cluster. |
|
||||
| `list_clusters` | List clusters in a given project and location. |
|
||||
| `list_instances` | List instances in a given project and location. |
|
||||
| `list_users` | List users in a given project and location. |
|
||||
| `wait_for_operation` | Poll the operations API until the operation is done. |
|
||||
| Tool Name | Description |
|
||||
|:---------------------|:-------------------------------------------------------------------|
|
||||
| `create_cluster` | Create an AlloyDB cluster. |
|
||||
| `create_instance` | Create an AlloyDB instance (PRIMARY, READ-POOL, or SECONDARY). |
|
||||
| `create_user` | Create ALLOYDB-BUILT-IN or IAM-based users for an AlloyDB cluster. |
|
||||
| `get_cluster` | Get details about an AlloyDB cluster. |
|
||||
| `get_instance` | Get details about an AlloyDB instance. |
|
||||
| `get_user` | Get details about a user in an AlloyDB cluster. |
|
||||
| `list_clusters` | List clusters in a given project and location. |
|
||||
| `list_instances` | List instances in a given project and location. |
|
||||
| `list_users` | List users in a given project and location. |
|
||||
| `wait_for_operation` | Poll the operations API until the operation is done. |
|
||||
|
||||
|
||||
## Documentation
|
||||
|
||||
@@ -16,29 +16,38 @@ An editor configured to use the AlloyDB MCP server can use its AI capabilities t
|
||||
### Prerequisites
|
||||
|
||||
* Download and install [MCP Toolbox](https://github.com/googleapis/genai-toolbox):
|
||||
1. **Download the Toolbox binary**:
|
||||
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:
|
||||
`https://storage.googleapis.com/genai-toolbox/v0.21.0/<os>/<arch>/toolbox`
|
||||
* Replace `<os>` with `linux`, `darwin` (macOS), or `windows`.
|
||||
* Replace `<arch>` with `amd64` (Intel) or `arm64` (Apple Silicon).
|
||||
1. **Download the Toolbox binary**:
|
||||
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:
|
||||
`https://storage.googleapis.com/genai-toolbox/v0.21.0/<os>/<arch>/toolbox`
|
||||
* Replace `<os>` with `linux`, `darwin` (macOS), or `windows`.
|
||||
* Replace `<arch>` with `amd64` (Intel) or `arm64` (Apple Silicon).
|
||||
|
||||
<!-- {x-release-please-start-version} -->
|
||||
```
|
||||
curl -L -o toolbox https://storage.googleapis.com/genai-toolbox/v0.21.0/linux/amd64/toolbox
|
||||
```
|
||||
<!-- {x-release-please-end} -->
|
||||
2. **Make it executable**:
|
||||
```bash
|
||||
chmod +x toolbox
|
||||
```
|
||||
<!-- {x-release-please-start-version} -->
|
||||
```
|
||||
curl -L -o toolbox https://storage.googleapis.com/genai-toolbox/v0.21.0/linux/amd64/toolbox
|
||||
```
|
||||
<!-- {x-release-please-end} -->
|
||||
2. **Make it executable**:
|
||||
```bash
|
||||
chmod +x toolbox
|
||||
```
|
||||
|
||||
3. **Add the binary to $PATH in `.~/bash_profile`**:
|
||||
```bash
|
||||
export PATH=$PATH:/path/to/toolbox
|
||||
```
|
||||
3. **Move binary to `/usr/local/bin/` or `/usr/bin/`**:
|
||||
```bash
|
||||
sudo mv toolbox /usr/local/bin/
|
||||
# sudo mv toolbox /usr/bin/
|
||||
```
|
||||
|
||||
**On Windows, move binary to the `WindowsApps\` folder**:
|
||||
```
|
||||
move "C:\Users\<path-to-binary>\toolbox.exe" "C:\Users\<username>\AppData\Local\Microsoft\WindowsApps\"
|
||||
```
|
||||
|
||||
**Note:** You may need to restart Antigravity for changes to take effect.
|
||||
Windows OS users will need to follow one of the Windows-specific methods.
|
||||
**Tip:** Ensure the destination folder for your binary is included in
|
||||
your system's PATH environment variable. To check `PATH`, use `echo
|
||||
$PATH` (or `echo %PATH%` on Windows).
|
||||
|
||||
**Note:** You may need to restart Antigravity for changes to take effect.
|
||||
|
||||
* A Google Cloud project with the **AlloyDB API** enabled.
|
||||
* 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
|
||||
|
||||
The AlloyDB MCP server provides the following tools:
|
||||
|
||||
| Tool Name | Description |
|
||||
| :--- | :--- |
|
||||
| `list_tables` | Lists detailed schema information for user-created tables. |
|
||||
| `execute_sql` | Executes a SQL query. |
|
||||
| `list_active_queries` | List currently running queries. |
|
||||
| `list_available_extensions` | List available extensions for installation. |
|
||||
| `list_installed_extensions` | List installed extensions. |
|
||||
| `get_query_plan` | Get query plan for a SQL statement. |
|
||||
| `list_autovacuum_configurations` | List autovacuum configurations and their values. |
|
||||
| `list_memory_configurations` | List memory configurations and their values. |
|
||||
| `list_top_bloated_tables` | List top bloated tables. |
|
||||
| `list_replication_slots` | List replication slots. |
|
||||
| `list_invalid_indexes` | List invalid indexes. |
|
||||
| Tool Name | Description |
|
||||
|:---------------------------------|:-----------------------------------------------------------|
|
||||
| `list_tables` | Lists detailed schema information for user-created tables. |
|
||||
| `execute_sql` | Executes a SQL query. |
|
||||
| `list_active_queries` | List currently running queries. |
|
||||
| `list_available_extensions` | List available extensions for installation. |
|
||||
| `list_installed_extensions` | List installed extensions. |
|
||||
| `get_query_plan` | Get query plan for a SQL statement. |
|
||||
| `list_autovacuum_configurations` | List autovacuum configurations and their values. |
|
||||
| `list_memory_configurations` | List memory configurations and their values. |
|
||||
| `list_top_bloated_tables` | List top bloated tables. |
|
||||
| `list_replication_slots` | List replication slots. |
|
||||
| `list_invalid_indexes` | List invalid indexes. |
|
||||
|
||||
## Documentation
|
||||
|
||||
|
||||
@@ -15,29 +15,38 @@ An editor configured to use the BigQuery MCP server can use its AI capabilities
|
||||
### Prerequisites
|
||||
|
||||
* Download and install [MCP Toolbox](https://github.com/googleapis/genai-toolbox):
|
||||
1. **Download the Toolbox binary**:
|
||||
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:
|
||||
`https://storage.googleapis.com/genai-toolbox/v0.21.0/<os>/<arch>/toolbox`
|
||||
* Replace `<os>` with `linux`, `darwin` (macOS), or `windows`.
|
||||
* Replace `<arch>` with `amd64` (Intel) or `arm64` (Apple Silicon).
|
||||
1. **Download the Toolbox binary**:
|
||||
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:
|
||||
`https://storage.googleapis.com/genai-toolbox/v0.21.0/<os>/<arch>/toolbox`
|
||||
* Replace `<os>` with `linux`, `darwin` (macOS), or `windows`.
|
||||
* Replace `<arch>` with `amd64` (Intel) or `arm64` (Apple Silicon).
|
||||
|
||||
<!-- {x-release-please-start-version} -->
|
||||
```
|
||||
curl -L -o toolbox https://storage.googleapis.com/genai-toolbox/v0.21.0/linux/amd64/toolbox
|
||||
```
|
||||
<!-- {x-release-please-end} -->
|
||||
2. **Make it executable**:
|
||||
```bash
|
||||
chmod +x toolbox
|
||||
```
|
||||
<!-- {x-release-please-start-version} -->
|
||||
```
|
||||
curl -L -o toolbox https://storage.googleapis.com/genai-toolbox/v0.21.0/linux/amd64/toolbox
|
||||
```
|
||||
<!-- {x-release-please-end} -->
|
||||
2. **Make it executable**:
|
||||
```bash
|
||||
chmod +x toolbox
|
||||
```
|
||||
|
||||
3. **Add the binary to $PATH in `.~/bash_profile`**:
|
||||
```bash
|
||||
export PATH=$PATH:/path/to/toolbox
|
||||
```
|
||||
3. **Move binary to `/usr/local/bin/` or `/usr/bin/`**:
|
||||
```bash
|
||||
sudo mv toolbox /usr/local/bin/
|
||||
# sudo mv toolbox /usr/bin/
|
||||
```
|
||||
|
||||
**On Windows, move binary to the `WindowsApps\` folder**:
|
||||
```
|
||||
move "C:\Users\<path-to-binary>\toolbox.exe" "C:\Users\<username>\AppData\Local\Microsoft\WindowsApps\"
|
||||
```
|
||||
|
||||
**Note:** You may need to restart Antigravity for changes to take effect.
|
||||
Windows OS users will need to follow one of the Windows-specific methods.
|
||||
**Tip:** Ensure the destination folder for your binary is included in
|
||||
your system's PATH environment variable. To check `PATH`, use `echo
|
||||
$PATH` (or `echo %PATH%` on Windows).
|
||||
|
||||
**Note:** You may need to restart Antigravity for changes to take effect.
|
||||
|
||||
* A Google Cloud project with the **BigQuery API** enabled.
|
||||
* 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
|
||||
|
||||
The BigQuery MCP server provides the following tools:
|
||||
|
||||
| Tool Name | Description |
|
||||
| :--- | :--- |
|
||||
| `execute_sql` | Executes a SQL query. |
|
||||
| `forecast` | Forecast time series data. |
|
||||
| `get_dataset_info` | Get dataset metadata. |
|
||||
| `get_table_info` | Get table metadata. |
|
||||
| `list_dataset_ids` | Lists dataset IDs in the database. |
|
||||
| `list_table_ids` | Lists table IDs in the database. |
|
||||
| Tool Name | Description |
|
||||
|:-----------------------|:----------------------------------------------------------------|
|
||||
| `execute_sql` | Executes a SQL query. |
|
||||
| `forecast` | Forecast time series data. |
|
||||
| `get_dataset_info` | Get dataset metadata. |
|
||||
| `get_table_info` | Get table metadata. |
|
||||
| `list_dataset_ids` | Lists dataset IDs in the database. |
|
||||
| `list_table_ids` | Lists table IDs in the database. |
|
||||
| `analyze_contribution` | Perform contribution analysis, also called key driver analysis. |
|
||||
| `search_catalog` | Search for tables based on the provided query. |
|
||||
| `search_catalog` | Search for tables based on the provided query. |
|
||||
|
||||
## Documentation
|
||||
|
||||
|
||||
@@ -13,29 +13,38 @@ An editor configured to use the Cloud SQL for SQL Server MCP server can use its
|
||||
### Prerequisites
|
||||
|
||||
* Download and install [MCP Toolbox](https://github.com/googleapis/genai-toolbox):
|
||||
1. **Download the Toolbox binary**:
|
||||
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:
|
||||
`https://storage.googleapis.com/genai-toolbox/v0.21.0/<os>/<arch>/toolbox`
|
||||
* Replace `<os>` with `linux`, `darwin` (macOS), or `windows`.
|
||||
* Replace `<arch>` with `amd64` (Intel) or `arm64` (Apple Silicon).
|
||||
1. **Download the Toolbox binary**:
|
||||
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:
|
||||
`https://storage.googleapis.com/genai-toolbox/v0.21.0/<os>/<arch>/toolbox`
|
||||
* Replace `<os>` with `linux`, `darwin` (macOS), or `windows`.
|
||||
* Replace `<arch>` with `amd64` (Intel) or `arm64` (Apple Silicon).
|
||||
|
||||
<!-- {x-release-please-start-version} -->
|
||||
```
|
||||
curl -L -o toolbox https://storage.googleapis.com/genai-toolbox/v0.21.0/linux/amd64/toolbox
|
||||
```
|
||||
<!-- {x-release-please-end} -->
|
||||
2. **Make it executable**:
|
||||
```bash
|
||||
chmod +x toolbox
|
||||
```
|
||||
<!-- {x-release-please-start-version} -->
|
||||
```
|
||||
curl -L -o toolbox https://storage.googleapis.com/genai-toolbox/v0.21.0/linux/amd64/toolbox
|
||||
```
|
||||
<!-- {x-release-please-end} -->
|
||||
2. **Make it executable**:
|
||||
```bash
|
||||
chmod +x toolbox
|
||||
```
|
||||
|
||||
3. **Add the binary to $PATH in `.~/bash_profile`**:
|
||||
```bash
|
||||
export PATH=$PATH:/path/to/toolbox
|
||||
```
|
||||
3. **Move binary to `/usr/local/bin/` or `/usr/bin/`**:
|
||||
```bash
|
||||
sudo mv toolbox /usr/local/bin/
|
||||
# sudo mv toolbox /usr/bin/
|
||||
```
|
||||
|
||||
**On Windows, move binary to the `WindowsApps\` folder**:
|
||||
```
|
||||
move "C:\Users\<path-to-binary>\toolbox.exe" "C:\Users\<username>\AppData\Local\Microsoft\WindowsApps\"
|
||||
```
|
||||
|
||||
**Note:** You may need to restart Antigravity for changes to take effect.
|
||||
Windows OS users will need to follow one of the Windows-specific methods.
|
||||
**Tip:** Ensure the destination folder for your binary is included in
|
||||
your system's PATH environment variable. To check `PATH`, use `echo
|
||||
$PATH` (or `echo %PATH%` on Windows).
|
||||
|
||||
**Note:** You may need to restart Antigravity for changes to take effect.
|
||||
|
||||
* A Google Cloud project with the **Cloud SQL Admin API** enabled.
|
||||
* 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
|
||||
|
||||
The Cloud SQL for SQL Server MCP server provides the following tools:
|
||||
|
||||
| Tool Name | Description |
|
||||
| :--- | :--- |
|
||||
| `create_instance` | Create an instance (PRIMARY, READ-POOL, or SECONDARY). |
|
||||
| `create_user` | Create BUILT-IN or IAM-based users for an instance. |
|
||||
| `get_instance` | Get details about an instance. |
|
||||
| `get_user` | Get details about a user in an instance. |
|
||||
| `list_instances` | List instances in a given project and location. |
|
||||
| `list_users` | List users in a given project and location. |
|
||||
| `wait_for_operation` | Poll the operations API until the operation is done. |
|
||||
| Tool Name | Description |
|
||||
|:---------------------|:-------------------------------------------------------|
|
||||
| `create_instance` | Create an instance (PRIMARY, READ-POOL, or SECONDARY). |
|
||||
| `create_user` | Create BUILT-IN or IAM-based users for an instance. |
|
||||
| `get_instance` | Get details about an instance. |
|
||||
| `get_user` | Get details about a user in an instance. |
|
||||
| `list_instances` | List instances in a given project and location. |
|
||||
| `list_users` | List users in a given project and location. |
|
||||
| `wait_for_operation` | Poll the operations API until the operation is done. |
|
||||
|
||||
## Documentation
|
||||
|
||||
|
||||
@@ -14,29 +14,38 @@ An editor configured to use the Cloud SQL for SQL Server MCP server can use its
|
||||
### Prerequisites
|
||||
|
||||
* Download and install [MCP Toolbox](https://github.com/googleapis/genai-toolbox):
|
||||
1. **Download the Toolbox binary**:
|
||||
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:
|
||||
`https://storage.googleapis.com/genai-toolbox/v0.21.0/<os>/<arch>/toolbox`
|
||||
* Replace `<os>` with `linux`, `darwin` (macOS), or `windows`.
|
||||
* Replace `<arch>` with `amd64` (Intel) or `arm64` (Apple Silicon).
|
||||
1. **Download the Toolbox binary**:
|
||||
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:
|
||||
`https://storage.googleapis.com/genai-toolbox/v0.21.0/<os>/<arch>/toolbox`
|
||||
* Replace `<os>` with `linux`, `darwin` (macOS), or `windows`.
|
||||
* Replace `<arch>` with `amd64` (Intel) or `arm64` (Apple Silicon).
|
||||
|
||||
<!-- {x-release-please-start-version} -->
|
||||
```
|
||||
curl -L -o toolbox https://storage.googleapis.com/genai-toolbox/v0.21.0/linux/amd64/toolbox
|
||||
```
|
||||
<!-- {x-release-please-end} -->
|
||||
2. **Make it executable**:
|
||||
```bash
|
||||
chmod +x toolbox
|
||||
```
|
||||
<!-- {x-release-please-start-version} -->
|
||||
```
|
||||
curl -L -o toolbox https://storage.googleapis.com/genai-toolbox/v0.21.0/linux/amd64/toolbox
|
||||
```
|
||||
<!-- {x-release-please-end} -->
|
||||
2. **Make it executable**:
|
||||
```bash
|
||||
chmod +x toolbox
|
||||
```
|
||||
|
||||
3. **Add the binary to $PATH in `.~/bash_profile`**:
|
||||
```bash
|
||||
export PATH=$PATH:/path/to/toolbox
|
||||
```
|
||||
3. **Move binary to `/usr/local/bin/` or `/usr/bin/`**:
|
||||
```bash
|
||||
sudo mv toolbox /usr/local/bin/
|
||||
# sudo mv toolbox /usr/bin/
|
||||
```
|
||||
|
||||
**On Windows, move binary to the `WindowsApps\` folder**:
|
||||
```
|
||||
move "C:\Users\<path-to-binary>\toolbox.exe" "C:\Users\<username>\AppData\Local\Microsoft\WindowsApps\"
|
||||
```
|
||||
|
||||
**Note:** You may need to restart Antigravity for changes to take effect.
|
||||
Windows OS users will need to follow one of the Windows-specific methods.
|
||||
**Tip:** Ensure the destination folder for your binary is included in
|
||||
your system's PATH environment variable. To check `PATH`, use `echo
|
||||
$PATH` (or `echo %PATH%` on Windows).
|
||||
|
||||
**Note:** You may need to restart Antigravity for changes to take effect.
|
||||
|
||||
* A Google Cloud project with the **Cloud SQL Admin API** enabled.
|
||||
* Ensure [Application Default Credentials](https://cloud.google.com/docs/authentication/gcloud) are available in your environment.
|
||||
@@ -91,9 +100,9 @@ Once configured, the MCP server will automatically provide Cloud SQL for SQL Ser
|
||||
|
||||
The Cloud SQL for SQL Server MCP server provides the following tools:
|
||||
|
||||
| Tool Name | Description |
|
||||
| :--- | :--- |
|
||||
| `execute_sql` | Use this tool to execute SQL. |
|
||||
| Tool Name | Description |
|
||||
|:--------------|:-----------------------------------------------------------|
|
||||
| `execute_sql` | Use this tool to execute SQL. |
|
||||
| `list_tables` | Lists detailed schema information for user-created tables. |
|
||||
|
||||
## Documentation
|
||||
|
||||
@@ -13,29 +13,38 @@ An editor configured to use the Cloud SQL for MySQL MCP server can use its AI ca
|
||||
### Prerequisites
|
||||
|
||||
* Download and install [MCP Toolbox](https://github.com/googleapis/genai-toolbox):
|
||||
1. **Download the Toolbox binary**:
|
||||
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:
|
||||
`https://storage.googleapis.com/genai-toolbox/v0.21.0/<os>/<arch>/toolbox`
|
||||
* Replace `<os>` with `linux`, `darwin` (macOS), or `windows`.
|
||||
* Replace `<arch>` with `amd64` (Intel) or `arm64` (Apple Silicon).
|
||||
1. **Download the Toolbox binary**:
|
||||
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:
|
||||
`https://storage.googleapis.com/genai-toolbox/v0.21.0/<os>/<arch>/toolbox`
|
||||
* Replace `<os>` with `linux`, `darwin` (macOS), or `windows`.
|
||||
* Replace `<arch>` with `amd64` (Intel) or `arm64` (Apple Silicon).
|
||||
|
||||
<!-- {x-release-please-start-version} -->
|
||||
```
|
||||
curl -L -o toolbox https://storage.googleapis.com/genai-toolbox/v0.21.0/linux/amd64/toolbox
|
||||
```
|
||||
<!-- {x-release-please-end} -->
|
||||
2. **Make it executable**:
|
||||
```bash
|
||||
chmod +x toolbox
|
||||
```
|
||||
<!-- {x-release-please-start-version} -->
|
||||
```
|
||||
curl -L -o toolbox https://storage.googleapis.com/genai-toolbox/v0.21.0/linux/amd64/toolbox
|
||||
```
|
||||
<!-- {x-release-please-end} -->
|
||||
2. **Make it executable**:
|
||||
```bash
|
||||
chmod +x toolbox
|
||||
```
|
||||
|
||||
3. **Add the binary to $PATH in `.~/bash_profile`**:
|
||||
```bash
|
||||
export PATH=$PATH:/path/to/toolbox
|
||||
```
|
||||
3. **Move binary to `/usr/local/bin/` or `/usr/bin/`**:
|
||||
```bash
|
||||
sudo mv toolbox /usr/local/bin/
|
||||
# sudo mv toolbox /usr/bin/
|
||||
```
|
||||
|
||||
**On Windows, move binary to the `WindowsApps\` folder**:
|
||||
```
|
||||
move "C:\Users\<path-to-binary>\toolbox.exe" "C:\Users\<username>\AppData\Local\Microsoft\WindowsApps\"
|
||||
```
|
||||
|
||||
**Note:** You may need to restart Antigravity for changes to take effect.
|
||||
Windows OS users will need to follow one of the Windows-specific methods.
|
||||
**Tip:** Ensure the destination folder for your binary is included in
|
||||
your system's PATH environment variable. To check `PATH`, use `echo
|
||||
$PATH` (or `echo %PATH%` on Windows).
|
||||
|
||||
**Note:** You may need to restart Antigravity for changes to take effect.
|
||||
|
||||
* A Google Cloud project with the **Cloud SQL Admin API** enabled.
|
||||
* 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 MySQL c
|
||||
|
||||
The Cloud SQL for MySQL MCP server provides the following tools:
|
||||
|
||||
| Tool Name | Description |
|
||||
| :--- | :--- |
|
||||
| `create_instance` | Create an instance (PRIMARY, READ-POOL, or SECONDARY). |
|
||||
| `create_user` | Create BUILT-IN or IAM-based users for an instance. |
|
||||
| `get_instance` | Get details about an instance. |
|
||||
| `get_user` | Get details about a user in an instance. |
|
||||
| `list_instances` | List instances in a given project and location. |
|
||||
| `list_users` | List users in a given project and location. |
|
||||
| `wait_for_operation` | Poll the operations API until the operation is done. |
|
||||
| Tool Name | Description |
|
||||
|:---------------------|:-------------------------------------------------------|
|
||||
| `create_instance` | Create an instance (PRIMARY, READ-POOL, or SECONDARY). |
|
||||
| `create_user` | Create BUILT-IN or IAM-based users for an instance. |
|
||||
| `get_instance` | Get details about an instance. |
|
||||
| `get_user` | Get details about a user in an instance. |
|
||||
| `list_instances` | List instances in a given project and location. |
|
||||
| `list_users` | List users in a given project and location. |
|
||||
| `wait_for_operation` | Poll the operations API until the operation is done. |
|
||||
|
||||
## Documentation
|
||||
|
||||
|
||||
@@ -16,29 +16,38 @@ An editor configured to use the Cloud SQL for MySQL MCP server can use its AI ca
|
||||
### Prerequisites
|
||||
|
||||
* Download and install [MCP Toolbox](https://github.com/googleapis/genai-toolbox):
|
||||
1. **Download the Toolbox binary**:
|
||||
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:
|
||||
`https://storage.googleapis.com/genai-toolbox/v0.21.0/<os>/<arch>/toolbox`
|
||||
* Replace `<os>` with `linux`, `darwin` (macOS), or `windows`.
|
||||
* Replace `<arch>` with `amd64` (Intel) or `arm64` (Apple Silicon).
|
||||
1. **Download the Toolbox binary**:
|
||||
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:
|
||||
`https://storage.googleapis.com/genai-toolbox/v0.21.0/<os>/<arch>/toolbox`
|
||||
* Replace `<os>` with `linux`, `darwin` (macOS), or `windows`.
|
||||
* Replace `<arch>` with `amd64` (Intel) or `arm64` (Apple Silicon).
|
||||
|
||||
<!-- {x-release-please-start-version} -->
|
||||
```
|
||||
curl -L -o toolbox https://storage.googleapis.com/genai-toolbox/v0.21.0/linux/amd64/toolbox
|
||||
```
|
||||
<!-- {x-release-please-end} -->
|
||||
2. **Make it executable**:
|
||||
```bash
|
||||
chmod +x toolbox
|
||||
```
|
||||
<!-- {x-release-please-start-version} -->
|
||||
```
|
||||
curl -L -o toolbox https://storage.googleapis.com/genai-toolbox/v0.21.0/linux/amd64/toolbox
|
||||
```
|
||||
<!-- {x-release-please-end} -->
|
||||
2. **Make it executable**:
|
||||
```bash
|
||||
chmod +x toolbox
|
||||
```
|
||||
|
||||
3. **Add the binary to $PATH in `.~/bash_profile`**:
|
||||
```bash
|
||||
export PATH=$PATH:/path/to/toolbox
|
||||
```
|
||||
3. **Move binary to `/usr/local/bin/` or `/usr/bin/`**:
|
||||
```bash
|
||||
sudo mv toolbox /usr/local/bin/
|
||||
# sudo mv toolbox /usr/bin/
|
||||
```
|
||||
|
||||
**On Windows, move binary to the `WindowsApps\` folder**:
|
||||
```
|
||||
move "C:\Users\<path-to-binary>\toolbox.exe" "C:\Users\<username>\AppData\Local\Microsoft\WindowsApps\"
|
||||
```
|
||||
|
||||
**Note:** You may need to restart Antigravity for changes to take effect.
|
||||
Windows OS users will need to follow one of the Windows-specific methods.
|
||||
**Tip:** Ensure the destination folder for your binary is included in
|
||||
your system's PATH environment variable. To check `PATH`, use `echo
|
||||
$PATH` (or `echo %PATH%` on Windows).
|
||||
|
||||
**Note:** You may need to restart Antigravity for changes to take effect.
|
||||
|
||||
* A Google Cloud project with the **Cloud SQL Admin API** enabled.
|
||||
* Ensure [Application Default Credentials](https://cloud.google.com/docs/authentication/gcloud) are available in your environment.
|
||||
@@ -94,14 +103,14 @@ Once configured, the MCP server will automatically provide Cloud SQL for MySQL c
|
||||
|
||||
The Cloud SQL for MySQL MCP server provides the following tools:
|
||||
|
||||
| Tool Name | Description |
|
||||
| :--- | :--- |
|
||||
| `execute_sql` | Use this tool to execute SQL. |
|
||||
| `list_active_queries` | Lists top N ongoing queries from processlist and innodb_trx. |
|
||||
| `get_query_plan` | Provide information about how MySQL executes a SQL statement (EXPLAIN). |
|
||||
| `list_tables` | Lists detailed schema information for user-created tables. |
|
||||
| `list_tables_missing_unique_indexes` | Find tables that do not have primary or unique key constraint. |
|
||||
| `list_table_fragmentation` | List table fragmentation in MySQL. |
|
||||
| Tool Name | Description |
|
||||
|:-------------------------------------|:------------------------------------------------------------------------|
|
||||
| `execute_sql` | Use this tool to execute SQL. |
|
||||
| `list_active_queries` | Lists top N ongoing queries from processlist and innodb_trx. |
|
||||
| `get_query_plan` | Provide information about how MySQL executes a SQL statement (EXPLAIN). |
|
||||
| `list_tables` | Lists detailed schema information for user-created tables. |
|
||||
| `list_tables_missing_unique_indexes` | Find tables that do not have primary or unique key constraint. |
|
||||
| `list_table_fragmentation` | List table fragmentation in MySQL. |
|
||||
|
||||
## Documentation
|
||||
|
||||
|
||||
@@ -13,29 +13,38 @@ An editor configured to use the Cloud SQL for PostgreSQL MCP server can use its
|
||||
### Prerequisites
|
||||
|
||||
* Download and install [MCP Toolbox](https://github.com/googleapis/genai-toolbox):
|
||||
1. **Download the Toolbox binary**:
|
||||
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:
|
||||
`https://storage.googleapis.com/genai-toolbox/v0.21.0/<os>/<arch>/toolbox`
|
||||
* Replace `<os>` with `linux`, `darwin` (macOS), or `windows`.
|
||||
* Replace `<arch>` with `amd64` (Intel) or `arm64` (Apple Silicon).
|
||||
1. **Download the Toolbox binary**:
|
||||
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:
|
||||
`https://storage.googleapis.com/genai-toolbox/v0.21.0/<os>/<arch>/toolbox`
|
||||
* Replace `<os>` with `linux`, `darwin` (macOS), or `windows`.
|
||||
* Replace `<arch>` with `amd64` (Intel) or `arm64` (Apple Silicon).
|
||||
|
||||
<!-- {x-release-please-start-version} -->
|
||||
```
|
||||
curl -L -o toolbox https://storage.googleapis.com/genai-toolbox/v0.21.0/linux/amd64/toolbox
|
||||
```
|
||||
<!-- {x-release-please-end} -->
|
||||
2. **Make it executable**:
|
||||
```bash
|
||||
chmod +x toolbox
|
||||
```
|
||||
<!-- {x-release-please-start-version} -->
|
||||
```
|
||||
curl -L -o toolbox https://storage.googleapis.com/genai-toolbox/v0.21.0/linux/amd64/toolbox
|
||||
```
|
||||
<!-- {x-release-please-end} -->
|
||||
2. **Make it executable**:
|
||||
```bash
|
||||
chmod +x toolbox
|
||||
```
|
||||
|
||||
3. **Add the binary to $PATH in `.~/bash_profile`**:
|
||||
```bash
|
||||
export PATH=$PATH:/path/to/toolbox
|
||||
```
|
||||
3. **Move binary to `/usr/local/bin/` or `/usr/bin/`**:
|
||||
```bash
|
||||
sudo mv toolbox /usr/local/bin/
|
||||
# sudo mv toolbox /usr/bin/
|
||||
```
|
||||
|
||||
**On Windows, move binary to the `WindowsApps\` folder**:
|
||||
```
|
||||
move "C:\Users\<path-to-binary>\toolbox.exe" "C:\Users\<username>\AppData\Local\Microsoft\WindowsApps\"
|
||||
```
|
||||
|
||||
**Note:** You may need to restart Antigravity for changes to take effect.
|
||||
Windows OS users will need to follow one of the Windows-specific methods.
|
||||
**Tip:** Ensure the destination folder for your binary is included in
|
||||
your system's PATH environment variable. To check `PATH`, use `echo
|
||||
$PATH` (or `echo %PATH%` on Windows).
|
||||
|
||||
**Note:** You may need to restart Antigravity for changes to take effect.
|
||||
|
||||
* A Google Cloud project with the **Cloud SQL Admin API** enabled.
|
||||
* 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 Postgre
|
||||
|
||||
The Cloud SQL for PostgreSQL MCP server provides the following tools:
|
||||
|
||||
| Tool Name | Description |
|
||||
| :--- | :--- |
|
||||
| `create_instance` | Create an instance (PRIMARY, READ-POOL, or SECONDARY). |
|
||||
| `create_user` | Create BUILT-IN or IAM-based users for an instance. |
|
||||
| `get_instance` | Get details about an instance. |
|
||||
| `get_user` | Get details about a user in an instance. |
|
||||
| `list_instances` | List instances in a given project and location. |
|
||||
| `list_users` | List users in a given project and location. |
|
||||
| `wait_for_operation` | Poll the operations API until the operation is done. |
|
||||
| Tool Name | Description |
|
||||
|:---------------------|:-------------------------------------------------------|
|
||||
| `create_instance` | Create an instance (PRIMARY, READ-POOL, or SECONDARY). |
|
||||
| `create_user` | Create BUILT-IN or IAM-based users for an instance. |
|
||||
| `get_instance` | Get details about an instance. |
|
||||
| `get_user` | Get details about a user in an instance. |
|
||||
| `list_instances` | List instances in a given project and location. |
|
||||
| `list_users` | List users in a given project and location. |
|
||||
| `wait_for_operation` | Poll the operations API until the operation is done. |
|
||||
|
||||
## Documentation
|
||||
|
||||
|
||||
@@ -16,29 +16,38 @@ An editor configured to use the Cloud SQL for PostgreSQL MCP server can use its
|
||||
### Prerequisites
|
||||
|
||||
* Download and install [MCP Toolbox](https://github.com/googleapis/genai-toolbox):
|
||||
1. **Download the Toolbox binary**:
|
||||
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:
|
||||
`https://storage.googleapis.com/genai-toolbox/v0.21.0/<os>/<arch>/toolbox`
|
||||
* Replace `<os>` with `linux`, `darwin` (macOS), or `windows`.
|
||||
* Replace `<arch>` with `amd64` (Intel) or `arm64` (Apple Silicon).
|
||||
1. **Download the Toolbox binary**:
|
||||
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:
|
||||
`https://storage.googleapis.com/genai-toolbox/v0.21.0/<os>/<arch>/toolbox`
|
||||
* Replace `<os>` with `linux`, `darwin` (macOS), or `windows`.
|
||||
* Replace `<arch>` with `amd64` (Intel) or `arm64` (Apple Silicon).
|
||||
|
||||
<!-- {x-release-please-start-version} -->
|
||||
```
|
||||
curl -L -o toolbox https://storage.googleapis.com/genai-toolbox/v0.21.0/linux/amd64/toolbox
|
||||
```
|
||||
<!-- {x-release-please-end} -->
|
||||
2. **Make it executable**:
|
||||
```bash
|
||||
chmod +x toolbox
|
||||
```
|
||||
<!-- {x-release-please-start-version} -->
|
||||
```
|
||||
curl -L -o toolbox https://storage.googleapis.com/genai-toolbox/v0.21.0/linux/amd64/toolbox
|
||||
```
|
||||
<!-- {x-release-please-end} -->
|
||||
2. **Make it executable**:
|
||||
```bash
|
||||
chmod +x toolbox
|
||||
```
|
||||
|
||||
3. **Add the binary to $PATH in `.~/bash_profile`**:
|
||||
```bash
|
||||
export PATH=$PATH:/path/to/toolbox
|
||||
```
|
||||
3. **Move binary to `/usr/local/bin/` or `/usr/bin/`**:
|
||||
```bash
|
||||
sudo mv toolbox /usr/local/bin/
|
||||
# sudo mv toolbox /usr/bin/
|
||||
```
|
||||
|
||||
**On Windows, move binary to the `WindowsApps\` folder**:
|
||||
```
|
||||
move "C:\Users\<path-to-binary>\toolbox.exe" "C:\Users\<username>\AppData\Local\Microsoft\WindowsApps\"
|
||||
```
|
||||
|
||||
**Note:** You may need to restart Antigravity for changes to take effect.
|
||||
Windows OS users will need to follow one of the Windows-specific methods.
|
||||
**Tip:** Ensure the destination folder for your binary is included in
|
||||
your system's PATH environment variable. To check `PATH`, use `echo
|
||||
$PATH` (or `echo %PATH%` on Windows).
|
||||
|
||||
**Note:** You may need to restart Antigravity for changes to take effect.
|
||||
|
||||
* A Google Cloud project with the **Cloud SQL Admin API** enabled.
|
||||
* Ensure [Application Default Credentials](https://cloud.google.com/docs/authentication/gcloud) are available in your environment.
|
||||
@@ -95,25 +104,25 @@ Once configured, the MCP server will automatically provide Cloud SQL for Postgre
|
||||
|
||||
The Cloud SQL for PostgreSQL MCP server provides the following tools:
|
||||
|
||||
| Tool Name | Description |
|
||||
| :--- | :--- |
|
||||
| `execute_sql` | Use this tool to execute sql. |
|
||||
| `list_tables` | Lists detailed schema information for user-created tables. |
|
||||
| `list_active_queries` | List the top N currently running queries. |
|
||||
| `list_available_extensions` | Discover all PostgreSQL extensions available for installation. |
|
||||
| `list_installed_extensions` | List all installed PostgreSQL extensions. |
|
||||
| `list_autovacuum_configurations` | List PostgreSQL autovacuum-related configurations. |
|
||||
| `list_memory_configurations` | List PostgreSQL memory-related configurations. |
|
||||
| `list_top_bloated_tables` | List the top tables by dead-tuple (approximate bloat signal). |
|
||||
| `list_replication_slots` | List key details for all PostgreSQL replication slots. |
|
||||
| `list_invalid_indexes` | Lists all invalid PostgreSQL indexes. |
|
||||
| `get_query_plan` | Generate a PostgreSQL EXPLAIN plan in JSON format. |
|
||||
| `list_views` | Lists views in the database. |
|
||||
| `list_schemas` | Lists all schemas in the database. |
|
||||
| `database_overview` | Fetches the current state of the PostgreSQL server. |
|
||||
| `list_triggers` | Lists all non-internal triggers in a database. |
|
||||
| `list_indexes` | Lists available user indexes in the database. |
|
||||
| `list_sequences` | Lists sequences in the database. |
|
||||
| Tool Name | Description |
|
||||
|:---------------------------------|:---------------------------------------------------------------|
|
||||
| `execute_sql` | Use this tool to execute sql. |
|
||||
| `list_tables` | Lists detailed schema information for user-created tables. |
|
||||
| `list_active_queries` | List the top N currently running queries. |
|
||||
| `list_available_extensions` | Discover all PostgreSQL extensions available for installation. |
|
||||
| `list_installed_extensions` | List all installed PostgreSQL extensions. |
|
||||
| `list_autovacuum_configurations` | List PostgreSQL autovacuum-related configurations. |
|
||||
| `list_memory_configurations` | List PostgreSQL memory-related configurations. |
|
||||
| `list_top_bloated_tables` | List the top tables by dead-tuple (approximate bloat signal). |
|
||||
| `list_replication_slots` | List key details for all PostgreSQL replication slots. |
|
||||
| `list_invalid_indexes` | Lists all invalid PostgreSQL indexes. |
|
||||
| `get_query_plan` | Generate a PostgreSQL EXPLAIN plan in JSON format. |
|
||||
| `list_views` | Lists views in the database. |
|
||||
| `list_schemas` | Lists all schemas in the database. |
|
||||
| `database_overview` | Fetches the current state of the PostgreSQL server. |
|
||||
| `list_triggers` | Lists all non-internal triggers in a database. |
|
||||
| `list_indexes` | Lists available user indexes in the database. |
|
||||
| `list_sequences` | Lists sequences in the database. |
|
||||
|
||||
## Documentation
|
||||
|
||||
|
||||
@@ -14,29 +14,38 @@ An editor configured to use the Dataplex MCP server can use its AI capabilities
|
||||
### Prerequisites
|
||||
|
||||
* Download and install [MCP Toolbox](https://github.com/googleapis/genai-toolbox):
|
||||
1. **Download the Toolbox binary**:
|
||||
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:
|
||||
`https://storage.googleapis.com/genai-toolbox/v0.21.0/<os>/<arch>/toolbox`
|
||||
* Replace `<os>` with `linux`, `darwin` (macOS), or `windows`.
|
||||
* Replace `<arch>` with `amd64` (Intel) or `arm64` (Apple Silicon).
|
||||
1. **Download the Toolbox binary**:
|
||||
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:
|
||||
`https://storage.googleapis.com/genai-toolbox/v0.21.0/<os>/<arch>/toolbox`
|
||||
* Replace `<os>` with `linux`, `darwin` (macOS), or `windows`.
|
||||
* Replace `<arch>` with `amd64` (Intel) or `arm64` (Apple Silicon).
|
||||
|
||||
<!-- {x-release-please-start-version} -->
|
||||
```
|
||||
curl -L -o toolbox https://storage.googleapis.com/genai-toolbox/v0.21.0/linux/amd64/toolbox
|
||||
```
|
||||
<!-- {x-release-please-end} -->
|
||||
2. **Make it executable**:
|
||||
```bash
|
||||
chmod +x toolbox
|
||||
```
|
||||
<!-- {x-release-please-start-version} -->
|
||||
```
|
||||
curl -L -o toolbox https://storage.googleapis.com/genai-toolbox/v0.21.0/linux/amd64/toolbox
|
||||
```
|
||||
<!-- {x-release-please-end} -->
|
||||
2. **Make it executable**:
|
||||
```bash
|
||||
chmod +x toolbox
|
||||
```
|
||||
|
||||
3. **Add the binary to $PATH in `.~/bash_profile`**:
|
||||
```bash
|
||||
export PATH=$PATH:/path/to/toolbox
|
||||
```
|
||||
3. **Move binary to `/usr/local/bin/` or `/usr/bin/`**:
|
||||
```bash
|
||||
sudo mv toolbox /usr/local/bin/
|
||||
# sudo mv toolbox /usr/bin/
|
||||
```
|
||||
|
||||
**On Windows, move binary to the `WindowsApps\` folder**:
|
||||
```
|
||||
move "C:\Users\<path-to-binary>\toolbox.exe" "C:\Users\<username>\AppData\Local\Microsoft\WindowsApps\"
|
||||
```
|
||||
|
||||
**Note:** You may need to restart Antigravity for changes to take effect.
|
||||
Windows OS users will need to follow one of the Windows-specific methods.
|
||||
**Tip:** Ensure the destination folder for your binary is included in
|
||||
your system's PATH environment variable. To check `PATH`, use `echo
|
||||
$PATH` (or `echo %PATH%` on Windows).
|
||||
|
||||
**Note:** You may need to restart Antigravity for changes to take effect.
|
||||
|
||||
* A Google Cloud project with the **Dataplex API** enabled.
|
||||
* Ensure [Application Default Credentials](https://cloud.google.com/docs/authentication/gcloud) are available in your environment.
|
||||
@@ -78,11 +87,11 @@ Once configured, the MCP server will automatically provide Dataplex capabilities
|
||||
|
||||
The Dataplex MCP server provides the following tools:
|
||||
|
||||
| Tool Name | Description |
|
||||
| :--- | :--- |
|
||||
| `search_entries` | Search for entries in Dataplex Catalog. |
|
||||
| `lookup_entry` | Retrieve a specific entry from Dataplex Catalog. |
|
||||
| `search_aspect_types` | Find aspect types relevant to the query. |
|
||||
| Tool Name | Description |
|
||||
|:----------------------|:-------------------------------------------------|
|
||||
| `search_entries` | Search for entries in Dataplex Catalog. |
|
||||
| `lookup_entry` | Retrieve a specific entry from Dataplex Catalog. |
|
||||
| `search_aspect_types` | Find aspect types relevant to the query. |
|
||||
|
||||
## Documentation
|
||||
|
||||
|
||||
@@ -18,30 +18,38 @@ An editor configured to use the Looker MCP server can use its AI capabilities to
|
||||
### Prerequisites
|
||||
|
||||
* Download and install [MCP Toolbox](https://github.com/googleapis/genai-toolbox):
|
||||
1. **Download the Toolbox binary**:
|
||||
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:
|
||||
`https://storage.googleapis.com/genai-toolbox/v0.21.0/<os>/<arch>/toolbox`
|
||||
* Replace `<os>` with `linux`, `darwin` (macOS), or `windows`.
|
||||
* Replace `<arch>` with `amd64` (Intel) or `arm64` (Apple Silicon).
|
||||
1. **Download the Toolbox binary**:
|
||||
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:
|
||||
`https://storage.googleapis.com/genai-toolbox/v0.21.0/<os>/<arch>/toolbox`
|
||||
* Replace `<os>` with `linux`, `darwin` (macOS), or `windows`.
|
||||
* Replace `<arch>` with `amd64` (Intel) or `arm64` (Apple Silicon).
|
||||
|
||||
<!-- {x-release-please-start-version} -->
|
||||
```
|
||||
curl -L -o toolbox https://storage.googleapis.com/genai-toolbox/v0.21.0/linux/amd64/toolbox
|
||||
```
|
||||
<!-- {x-release-please-end} -->
|
||||
|
||||
2. **Make it executable**:
|
||||
```bash
|
||||
chmod +x toolbox
|
||||
```
|
||||
<!-- {x-release-please-start-version} -->
|
||||
```
|
||||
curl -L -o toolbox https://storage.googleapis.com/genai-toolbox/v0.21.0/linux/amd64/toolbox
|
||||
```
|
||||
<!-- {x-release-please-end} -->
|
||||
2. **Make it executable**:
|
||||
```bash
|
||||
chmod +x toolbox
|
||||
```
|
||||
|
||||
3. **Add the binary to $PATH in `.~/bash_profile`**:
|
||||
```bash
|
||||
export PATH=$PATH:/path/to/toolbox
|
||||
```
|
||||
3. **Move binary to `/usr/local/bin/` or `/usr/bin/`**:
|
||||
```bash
|
||||
sudo mv toolbox /usr/local/bin/
|
||||
# sudo mv toolbox /usr/bin/
|
||||
```
|
||||
|
||||
**On Windows, move binary to the `WindowsApps\` folder**:
|
||||
```
|
||||
move "C:\Users\<path-to-binary>\toolbox.exe" "C:\Users\<username>\AppData\Local\Microsoft\WindowsApps\"
|
||||
```
|
||||
|
||||
**Note:** You may need to restart Antigravity for changes to take effect.
|
||||
Windows OS users will need to follow one of the Windows-specific methods.
|
||||
**Tip:** Ensure the destination folder for your binary is included in
|
||||
your system's PATH environment variable. To check `PATH`, use `echo
|
||||
$PATH` (or `echo %PATH%` on Windows).
|
||||
|
||||
**Note:** You may need to restart Antigravity for changes to take effect.
|
||||
|
||||
* Access to a Looker instance.
|
||||
* API Credentials (`Client ID` and `Client Secret`) or OAuth configuration.
|
||||
@@ -90,19 +98,19 @@ Once configured, the MCP server will automatically provide Looker capabilities t
|
||||
|
||||
The Looker MCP server provides a wide range of tools. Here are some of the key capabilities:
|
||||
|
||||
| Tool Name | Description |
|
||||
| :--- | :--- |
|
||||
| `get_models` | Retrieves the list of LookML models. |
|
||||
| `get_explores` | Retrieves the list of explores defined in a LookML model. |
|
||||
| `query` | Run a query against the LookML model. |
|
||||
| `query_sql` | Generate the SQL that Looker would run. |
|
||||
| `run_look` | Runs a saved look. |
|
||||
| `run_dashboard` | Runs all tiles in a dashboard. |
|
||||
| `make_dashboard` | Creates a new dashboard. |
|
||||
| `add_dashboard_element` | Adds a tile to a dashboard. |
|
||||
| `health_pulse` | Checks the status of the Looker instance. |
|
||||
| `dev_mode` | Toggles development mode. |
|
||||
| `get_projects` | Lists LookML projects. |
|
||||
| Tool Name | Description |
|
||||
|:------------------------|:----------------------------------------------------------|
|
||||
| `get_models` | Retrieves the list of LookML models. |
|
||||
| `get_explores` | Retrieves the list of explores defined in a LookML model. |
|
||||
| `query` | Run a query against the LookML model. |
|
||||
| `query_sql` | Generate the SQL that Looker would run. |
|
||||
| `run_look` | Runs a saved look. |
|
||||
| `run_dashboard` | Runs all tiles in a dashboard. |
|
||||
| `make_dashboard` | Creates a new dashboard. |
|
||||
| `add_dashboard_element` | Adds a tile to a dashboard. |
|
||||
| `health_pulse` | Checks the status of the Looker instance. |
|
||||
| `dev_mode` | Toggles development mode. |
|
||||
| `get_projects` | Lists LookML projects. |
|
||||
|
||||
*(See the full list of tools in the extension)*
|
||||
|
||||
|
||||
@@ -14,30 +14,38 @@ An editor configured to use the Cloud Spanner MCP server can use its AI capabili
|
||||
### Prerequisites
|
||||
|
||||
* Download and install [MCP Toolbox](https://github.com/googleapis/genai-toolbox):
|
||||
1. **Download the Toolbox binary**:
|
||||
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:
|
||||
`https://storage.googleapis.com/genai-toolbox/v0.21.0/<os>/<arch>/toolbox`
|
||||
* Replace `<os>` with `linux`, `darwin` (macOS), or `windows`.
|
||||
* Replace `<arch>` with `amd64` (Intel) or `arm64` (Apple Silicon).
|
||||
1. **Download the Toolbox binary**:
|
||||
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:
|
||||
`https://storage.googleapis.com/genai-toolbox/v0.21.0/<os>/<arch>/toolbox`
|
||||
* Replace `<os>` with `linux`, `darwin` (macOS), or `windows`.
|
||||
* Replace `<arch>` with `amd64` (Intel) or `arm64` (Apple Silicon).
|
||||
|
||||
<!-- {x-release-please-start-version} -->
|
||||
```
|
||||
curl -L -o toolbox https://storage.googleapis.com/genai-toolbox/v0.21.0/linux/amd64/toolbox
|
||||
```
|
||||
<!-- {x-release-please-end} -->
|
||||
<!-- {x-release-please-start-version} -->
|
||||
```
|
||||
curl -L -o toolbox https://storage.googleapis.com/genai-toolbox/v0.21.0/linux/amd64/toolbox
|
||||
```
|
||||
<!-- {x-release-please-end} -->
|
||||
2. **Make it executable**:
|
||||
```bash
|
||||
chmod +x toolbox
|
||||
```
|
||||
|
||||
2. **Make it executable**:
|
||||
```bash
|
||||
chmod +x toolbox
|
||||
```
|
||||
3. **Move binary to `/usr/local/bin/` or `/usr/bin/`**:
|
||||
```bash
|
||||
sudo mv toolbox /usr/local/bin/
|
||||
# sudo mv toolbox /usr/bin/
|
||||
```
|
||||
|
||||
3. **Add the binary to $PATH in `.~/bash_profile`**:
|
||||
```bash
|
||||
export PATH=$PATH:/path/to/toolbox
|
||||
```
|
||||
**On Windows, move binary to the `WindowsApps\` folder**:
|
||||
```
|
||||
move "C:\Users\<path-to-binary>\toolbox.exe" "C:\Users\<username>\AppData\Local\Microsoft\WindowsApps\"
|
||||
```
|
||||
|
||||
**Note:** You may need to restart Antigravity for changes to take effect.
|
||||
Windows OS users will need to follow one of the Windows-specific methods.
|
||||
**Tip:** Ensure the destination folder for your binary is included in
|
||||
your system's PATH environment variable. To check `PATH`, use `echo
|
||||
$PATH` (or `echo %PATH%` on Windows).
|
||||
|
||||
**Note:** You may need to restart Antigravity for changes to take effect.
|
||||
|
||||
* A Google Cloud project with the **Cloud Spanner API** enabled.
|
||||
* Ensure [Application Default Credentials](https://cloud.google.com/docs/authentication/gcloud) are available in your environment.
|
||||
@@ -87,11 +95,11 @@ Once configured, the MCP server will automatically provide Cloud Spanner capabil
|
||||
|
||||
The Cloud Spanner MCP server provides the following tools:
|
||||
|
||||
| Tool Name | Description |
|
||||
| :--- | :--- |
|
||||
| `execute_sql` | Use this tool to execute DML SQL. |
|
||||
| `execute_sql_dql` | Use this tool to execute DQL SQL. |
|
||||
| `list_tables` | Lists detailed schema information for user-created tables. |
|
||||
| Tool Name | Description |
|
||||
|:------------------|:-----------------------------------------------------------|
|
||||
| `execute_sql` | Use this tool to execute DML SQL. |
|
||||
| `execute_sql_dql` | Use this tool to execute DQL SQL. |
|
||||
| `list_tables` | Lists detailed schema information for user-created tables. |
|
||||
|
||||
## Documentation
|
||||
|
||||
|
||||
58
docs/TOOLBOX_README.md
Normal file
58
docs/TOOLBOX_README.md
Normal file
@@ -0,0 +1,58 @@
|
||||
# MCP Toolbox for Databases Server
|
||||
|
||||
The MCP Toolbox for Databases Server gives AI-powered development tools the ability to work with your custom tools. It is designed to simplify and secure the development of tools for interacting with databases.
|
||||
|
||||
## Installation and Setup
|
||||
|
||||
### Prerequisites
|
||||
|
||||
* Download and install [MCP Toolbox](https://github.com/googleapis/genai-toolbox):
|
||||
1. **Download the Toolbox binary**:
|
||||
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:
|
||||
`https://storage.googleapis.com/genai-toolbox/v0.21.0/<os>/<arch>/toolbox`
|
||||
* Replace `<os>` with `linux`, `darwin` (macOS), or `windows`.
|
||||
* Replace `<arch>` with `amd64` (Intel) or `arm64` (Apple Silicon).
|
||||
|
||||
<!-- {x-release-please-start-version} -->
|
||||
```
|
||||
curl -L -o toolbox https://storage.googleapis.com/genai-toolbox/v0.21.0/linux/amd64/toolbox
|
||||
```
|
||||
<!-- {x-release-please-end} -->
|
||||
2. **Make it executable**:
|
||||
```bash
|
||||
chmod +x toolbox
|
||||
```
|
||||
|
||||
3. **Move binary to `/usr/local/bin/` or `/usr/bin/`**:
|
||||
```bash
|
||||
sudo mv toolbox /usr/local/bin/
|
||||
# sudo mv toolbox /usr/bin/
|
||||
```
|
||||
|
||||
**On Windows, move binary to the `WindowsApps\` folder**:
|
||||
```
|
||||
move "C:\Users\<path-to-binary>\toolbox.exe" "C:\Users\<username>\AppData\Local\Microsoft\WindowsApps\"
|
||||
```
|
||||
|
||||
**Tip:** Ensure the destination folder for your binary is included in
|
||||
your system's PATH environment variable. To check `PATH`, use `echo
|
||||
$PATH` (or `echo %PATH%` on Windows).
|
||||
|
||||
**Note:** You may need to restart Antigravity for changes to take effect.
|
||||
|
||||
* Any required APIs and permissions for connecting to your database.
|
||||
|
||||
### Configuration
|
||||
|
||||
Add your [`tools.yaml` configuration
|
||||
file](https://googleapis.github.io/genai-toolbox/getting-started/configure/) to
|
||||
the directory you are running Antigravity
|
||||
|
||||
## Usage
|
||||
|
||||
Interact with your custom tools using natural language.
|
||||
|
||||
|
||||
## Documentation
|
||||
|
||||
For more information, visit the [MCP Toolbox for Databases documentation](https://googleapis.github.io/genai-toolbox/getting-started/introduction/).
|
||||
Reference in New Issue
Block a user