Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions .github/trusted-contribution.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Copyright 2025 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# Trigger presubmit tests for trusted contributors
# https://github.com/googleapis/repo-automation-bots/tree/main/packages/trusted-contribution
# Install: https://github.com/apps/trusted-contributions-gcf

trustedContributors:
- "dependabot[bot]"
- "renovate-bot"
annotations:
# Trigger Cloud Build tests
- type: comment
text: "/gcbrun"
- type: label
text: "tests: run"
70 changes: 44 additions & 26 deletions docs/ALLOYDBADMIN_README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,31 +8,46 @@ An editor configured to use the AlloyDB MCP server can use its AI capabilities t

* **Provision & Manage Infrastructure**: Create and manage AlloyDB clusters, instances, and users

## Installation and Setup
To connect to the database to explore and query data, search the MCP store for the AlloyDB for PostgreSQL MCP Server.

### Prerequisites
## 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).
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 additional versions:

<!-- {x-release-please-start-version} -->
```
curl -L -o toolbox https://storage.googleapis.com/genai-toolbox/v0.21.0/linux/amd64/toolbox
```
* To install Toolbox as a binary on Linux (AMD64):
```bash
curl -L -o toolbox https://storage.googleapis.com/genai-toolbox/v0.21.0/linux/amd64/toolbox
```

* To install Toolbox as a binary on macOS (Apple Silicon):
```bash
curl -L -o toolbox https://storage.googleapis.com/genai-toolbox/v0.21.0/darwin/arm64/toolbox
```

* To install Toolbox as a binary on macOS (Intel):
```bash
curl -L -o toolbox https://storage.googleapis.com/genai-toolbox/v0.21.0/darwin/amd64/toolbox
```

* To install Toolbox as a binary on Windows (AMD64):
```powershell
curl -o toolbox.exe "https://storage.googleapis.com/genai-toolbox/v0.21.0/windows/amd64/toolbox.exe"
```
<!-- {x-release-please-end} -->

2. **Make it executable**:

```bash
chmod +x toolbox
```

3. **Move binary to `/usr/local/bin/` or `/usr/bin/`**:
3. **Add the binary to $PATH in `.~/bash_profile`** (Note: You may need to restart Antigravity for changes to take effect.):

```bash
sudo mv toolbox /usr/local/bin/
# sudo mv toolbox /usr/bin/
export PATH=$PATH:path/to/folder
```

**On Windows, move binary to the `WindowsApps\` folder**:
Expand All @@ -44,28 +59,17 @@ An editor configured to use the AlloyDB MCP server can use its AI capabilities t
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.
* IAM Permissions:
* AlloyDB Admin (`roles/alloydb.admin`) (for managing infrastructure)
* Service Usage Consumer (`roles/serviceusage.serviceUsageConsumer`)

### Configuration
## Install & Configuration

Add the following configuration to your MCP client (e.g., `settings.json` for Gemini CLI):
1. In the Antigravity MCP Store, click the "Install" button.

```json
{
"mcpServers": {
"alloydb-admin": {
"command": "toolbox",
"args": ["--prebuilt", "alloydb-postgres-admin", "--stdio"],
}
}
}
```
You'll now be able to see all enabled tools in the "Tools" tab.

## Usage

Expand All @@ -92,6 +96,20 @@ The AlloyDB MCP server provides the following tools:
| `list_users` | List users in a given project and location. |
| `wait_for_operation` | Poll the operations API until the operation is done. |

## Custom MCP Server Configuration

Add the following configuration to your MCP client (e.g., `settings.json` for Gemini CLI, `mcp_config.json` for Antigravity):

```json
{
"mcpServers": {
"alloydb-admin": {
"command": "toolbox",
"args": ["--prebuilt", "alloydb-postgres-admin", "--stdio"]
}
}
}
```

## Documentation

Expand Down
99 changes: 60 additions & 39 deletions docs/ALLOYDBPG_README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,31 +11,46 @@ An editor configured to use the AlloyDB MCP server can use its AI capabilities t
- **Monitor Performance** - View active queries, query plans, and other performance metrics (via observability tools)
- **Manage Extensions** - List available and installed PostgreSQL extensions

## Installation and Setup
For AlloyDB infrastructure management, search the MCP store for the AlloyDB for PostgreSQL Admin MCP Server.

### Prerequisites
## 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).
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 additional versions:

<!-- {x-release-please-start-version} -->
```
curl -L -o toolbox https://storage.googleapis.com/genai-toolbox/v0.21.0/linux/amd64/toolbox
```
* To install Toolbox as a binary on Linux (AMD64):
```bash
curl -L -o toolbox https://storage.googleapis.com/genai-toolbox/v0.21.0/linux/amd64/toolbox
```

* To install Toolbox as a binary on macOS (Apple Silicon):
```bash
curl -L -o toolbox https://storage.googleapis.com/genai-toolbox/v0.21.0/darwin/arm64/toolbox
```

* To install Toolbox as a binary on macOS (Intel):
```bash
curl -L -o toolbox https://storage.googleapis.com/genai-toolbox/v0.21.0/darwin/amd64/toolbox
```

* To install Toolbox as a binary on Windows (AMD64):
```powershell
curl -o toolbox.exe "https://storage.googleapis.com/genai-toolbox/v0.21.0/windows/amd64/toolbox.exe"
```
<!-- {x-release-please-end} -->

2. **Make it executable**:

```bash
chmod +x toolbox
```

3. **Move binary to `/usr/local/bin/` or `/usr/bin/`**:
3. **Add the binary to $PATH in `.~/bash_profile`** (Note: You may need to restart Antigravity for changes to take effect.):

```bash
sudo mv toolbox /usr/local/bin/
# sudo mv toolbox /usr/bin/
export PATH=$PATH:path/to/folder
```

**On Windows, move binary to the `WindowsApps\` folder**:
Expand All @@ -47,43 +62,21 @@ An editor configured to use the AlloyDB MCP server can use its AI capabilities t
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.
* IAM Permissions:
* AlloyDB Client (`roles/alloydb.client`) (for connecting and querying)
* Service Usage Consumer (`roles/serviceusage.serviceUsageConsumer`)

### Configuration
> **Note:** If your AlloyDB instance uses private IPs, you must run the MCP server in the same Virtual Private Cloud (VPC) network.

The AlloyDB MCP server is configured using environment variables.
## Install & Configuration

```bash
export ALLOYDB_POSTGRES_PROJECT="<your-gcp-project-id>"
export ALLOYDB_POSTGRES_REGION="<your-alloydb-region>"
export ALLOYDB_POSTGRES_CLUSTER="<your-alloydb-cluster-id>"
export ALLOYDB_POSTGRES_INSTANCE="<your-alloydb-instance-id>"
export ALLOYDB_POSTGRES_DATABASE="<your-database-name>"
export ALLOYDB_POSTGRES_USER="<your-database-user>" # Optional
export ALLOYDB_POSTGRES_PASSWORD="<your-database-password>" # Optional
export ALLOYDB_POSTGRES_IP_TYPE="PUBLIC" # Optional: `PUBLIC`, `PRIVATE`, `PSC`. Defaults to `PUBLIC`.
```
1. In the Antigravity MCP Store, click the "Install" button.

> **Note:** If your AlloyDB instance uses private IPs, you must run the MCP server in the same Virtual Private Cloud (VPC) network.
2. Add the required inputs for your [cluster](https://docs.cloud.google.com/alloydb/docs/cluster-list) in the configuration pop-up, then click "Save". You can update this configuration at any time in the "Configure" tab.

Add the following configuration to your MCP client (e.g., `settings.json` for Gemini CLI):

```json
{
"mcpServers": {
"alloydb-postgres": {
"command": "toolbox",
"args": ["--prebuilt", "alloydb-postgres", "--stdio"],
}
}
}
```
You'll now be able to see all enabled tools in the "Tools" tab.

## Usage

Expand Down Expand Up @@ -111,6 +104,34 @@ The AlloyDB MCP server provides the following tools:
| `list_replication_slots` | List replication slots. |
| `list_invalid_indexes` | List invalid indexes. |

## Custom MCP Server Configuration

The AlloyDB MCP server is configured using environment variables.

```bash
export ALLOYDB_POSTGRES_PROJECT="<your-gcp-project-id>"
export ALLOYDB_POSTGRES_REGION="<your-alloydb-region>"
export ALLOYDB_POSTGRES_CLUSTER="<your-alloydb-cluster-id>"
export ALLOYDB_POSTGRES_INSTANCE="<your-alloydb-instance-id>"
export ALLOYDB_POSTGRES_DATABASE="<your-database-name>"
export ALLOYDB_POSTGRES_USER="<your-database-user>" # Optional
export ALLOYDB_POSTGRES_PASSWORD="<your-database-password>" # Optional
export ALLOYDB_POSTGRES_IP_TYPE="PUBLIC" # Optional: `PUBLIC`, `PRIVATE`, `PSC`. Defaults to `PUBLIC`.
```

Add the following configuration to your MCP client (e.g., `settings.json` for Gemini CLI, `mcp_config.json` for Antigravity):

```json
{
"mcpServers": {
"alloydb-postgres": {
"command": "toolbox",
"args": ["--prebuilt", "alloydb-postgres", "--stdio"]
}
}
}
```

## Documentation

For more information, visit the [AlloyDB for PostgreSQL documentation](https://cloud.google.com/alloydb/docs).
Loading
Loading