genai-toolbox/docs/en/resources/sources/postgres.md at cfd4b18dee648f770ce5da59d09da756f28b8d5d

mirror of https://github.com/googleapis/genai-toolbox.git synced 2026-02-09 22:55:26 -05:00

Files

Srividya Reddy 1a19cac7cd feat(tools/postgres-list-schemas): add new postgres-list-schemas tool (#1741 )

## Description
Add a read-only PostgreSQL custom list_schemas tool, that returns the
schemas present in the database excluding system and temporary schemas.
Returns the schema name, schema owner, grants, number of functions,
number of tables, and number of views within each schema.

<img width="1985" height="1043" alt="Screenshot 2025-10-20 at 7 45
45 PM"
src="https://github.com/user-attachments/assets/8c4f0bb8-587c-489a-8795-efa79e92b06f"
/>

<img width="3372" height="1694" alt="3NpZG7W6h3XGsM7"
src="https://github.com/user-attachments/assets/370b5440-cc48-4c4e-82ea-4fd508cbcf2b"
/>

> Should include a concise description of the changes (bug or feature),
it's
> impact, along with a summary of the solution

## PR Checklist

> Thank you for opening a Pull Request! Before submitting your PR, there
are a
> few things you can do to make sure it goes smoothly:

- [x] Make sure you reviewed

[CONTRIBUTING.md](https://github.com/googleapis/genai-toolbox/blob/main/CONTRIBUTING.md)
- [x] Make sure to open an issue as a

[bug/issue](https://github.com/googleapis/genai-toolbox/issues/new/choose)
  before writing your code! That way we can discuss the change, evaluate
  designs, and agree on the general idea
- [x] Ensure the tests and linter pass
- [x] Code coverage does not decrease (if any source code was changed)
- [x] Appropriate docs were updated (if necessary)
- [x] Make sure to add `!` if this involve a breaking change

🛠️ Fixes #<issue_number_goes_here>

Co-authored-by: Yuan Teoh <45984206+Yuan325@users.noreply.github.com>

2025-11-06 00:54:01 +00:00

3.3 KiB

Raw Blame History

title, type, weight, description

title	type	weight	description
PostgreSQL	docs	1	PostgreSQL is a powerful, open source object-relational database.

About

PostgreSQL is a powerful, open source object-relational database system with over 35 years of active development that has earned it a strong reputation for reliability, feature robustness, and performance.

Available Tools

postgres-sql Execute SQL queries as prepared statements in PostgreSQL.
postgres-execute-sql Run parameterized SQL statements in PostgreSQL.
postgres-list-tables List tables in a PostgreSQL database.
postgres-list-active-queries List active queries in a PostgreSQL database.
postgres-list-available-extensions List available extensions for installation in a PostgreSQL database.
postgres-list-installed-extensions List installed extensions in a PostgreSQL database.
postgres-list-views List views in a PostgreSQL database.
postgres-list-schemas List schemas in a PostgreSQL database.

Pre-built Configurations

PostgreSQL using MCP Connect your IDE to PostgreSQL using Toolbox.

Requirements

Database User

This source only uses standard authentication. You will need to create a PostgreSQL user to login to the database with.

Example

sources:
    my-pg-source:
        kind: postgres
        host: 127.0.0.1
        port: 5432
        database: my_db
        user: ${USER_NAME}
        password: ${PASSWORD}

{{< notice tip >}} Use environment variable replacement with the format ${ENV_NAME} instead of hardcoding your secrets into the configuration file. {{< /notice >}}

Reference

field	type	required	description
kind	string	true	Must be "postgres".
host	string	true	IP address to connect to (e.g. "127.0.0.1")
port	string	true	Port to connect to (e.g. "5432")
database	string	true	Name of the Postgres database to connect to (e.g. "my_db").
user	string	true	Name of the Postgres user to connect as (e.g. "my-pg-user").
password	string	true	Password of the Postgres user (e.g. "my-password").
queryParams	map[string]string	false	Raw query to be added to the db connection string.

3.3 KiB Raw Blame History