Tools on MCP Toolbox for Databases

postgres-database-overview

Mon, 01 Jan 0001 00:00:00 +0000

About

The postgres-database-overview fetches the current state of the PostgreSQL server.

postgres-database-overview fetches the current state of the PostgreSQL server This tool does not take any input parameters.

Compatible Sources

This tool can be used with the following database sources:

Source Name
PostgreSQL
AlloyDB PostgreSQL
Cloud SQL for PostgreSQL

Example

kind: tool
name: database_overview
type: postgres-database-overview
source: cloudsql-pg-source
description: |
 fetches the current state of the PostgreSQL server. It returns the postgres version, whether it's a replica, uptime duration, maximum connection limit, number of current connections, number of active connections and the percentage of connections in use.

The response is a JSON object with the following elements:

postgres-execute-sql

Mon, 01 Jan 0001 00:00:00 +0000

About

A postgres-execute-sql tool executes a SQL statement against a Postgres database.

postgres-execute-sql takes one input parameter sql and run the sql statement against the source.

Note: This tool is intended for developer assistant workflows with human-in-the-loop and shouldn’t be used for production agents.

Compatible Sources

This tool can be used with the following database sources:

Source Name
PostgreSQL
AlloyDB PostgreSQL
Cloud SQL for PostgreSQL

Example

kind: tool
name: execute_sql_tool
type: postgres-execute-sql
source: my-pg-instance
description: Use this tool to execute sql statement.

Reference

field	type	required	description
type	string	true	Must be “postgres-execute-sql”.
source	string	true	Name of the source the SQL should execute on.
description	string	true	Description of the tool that is passed to the LLM.

postgres-get-column-cardinality

Mon, 01 Jan 0001 00:00:00 +0000

About

The postgres-get-column-cardinality tool estimates the number of unique values (cardinality) for one or all columns in a specific PostgreSQL table by using the database’s internal statistics.

postgres-get-column-cardinality returns detailed information as JSON about column cardinality values, ordered by estimated cardinality in descending order. The tool takes the following input parameters:

schema_name (required): The schema name in which the table is present.
table_name (required): The table name in which the column is present.
column_name (optional): The column name for which the cardinality is to be found. If not provided, cardinality for all columns will be returned. Default: "".

Compatible Sources

This tool can be used with the following database sources:

postgres-list-active-queries

Mon, 01 Jan 0001 00:00:00 +0000

About

The postgres-list-active-queries tool retrieves information about currently active queries in a Postgres database.

postgres-list-active-queries lists detailed information as JSON for currently active queries. The tool takes the following input parameters:

min_duraton (optional): Only show queries running at least this long (e.g., ‘1 minute’, ‘1 second’, ‘2 seconds’). Default: ‘1 minute’.
exclude_application_names (optional): A comma-separated list of application names to exclude from the query results. This is useful for filtering out queries from specific applications (e.g., ‘psql’, ‘pgAdmin’, ‘DBeaver’). The match is case-sensitive. Whitespace around commas and names is automatically handled. If this parameter is omitted, no applications are excluded.
limit (optional): The maximum number of rows to return. Default: 50.

Compatible Sources

This tool can be used with the following database sources:

postgres-list-available-extensions

Mon, 01 Jan 0001 00:00:00 +0000

About

The postgres-list-available-extensions tool retrieves all PostgreSQL extensions available for installation on a Postgres database.

postgres-list-available-extensions lists all PostgreSQL extensions available for installation (extension name, default version description) as JSON. The does not support any input parameter.

Compatible Sources

This tool can be used with the following database sources:

Source Name
PostgreSQL
AlloyDB PostgreSQL
Cloud SQL for PostgreSQL

Example

kind: tool
name: list_available_extensions
type: postgres-list-available-extensions
source: postgres-source
description: Discover all PostgreSQL extensions available for installation on this server, returning name, default_version, and description.

Reference

name	default_version	description
address_standardizer	3.5.2	Used to parse an address into constituent elements. Generally used to support geocoding address normalization step.
amcheck	1.4	functions for verifying relation integrity
anon	1.0.0	Data anonymization tools
autoinc	1.0	functions for autoincrementing fields

postgres-list-database-stats

Mon, 01 Jan 0001 00:00:00 +0000

About

The postgres-list-database-stats lists the key performance and activity statistics for each PostgreSQL database in the instance, offering insights into cache efficiency, transaction throughput, row-level activity, temporary file usage, and contention.

postgres-list-database-stats lists detailed information as JSON for each database. The tool takes the following input parameters:

database_name (optional): A text to filter results by database name. Default: ""
include_templates (optional): Boolean, set to true to include template databases in the results. Default: false
database_owner (optional): A text to filter results by database owner. Default: ""
default_tablespace (optional): A text to filter results by the default tablespace name. Default: ""
order_by (optional): Specifies the sorting order. Valid values are 'size' (descending) or 'commit' (descending). Default: database_name ascending.
limit (optional): The maximum number of databases to return. Default: 10

Compatible Sources

This tool can be used with the following database sources:

postgres-list-indexes

Mon, 01 Jan 0001 00:00:00 +0000

About

The postgres-list-indexes tool lists available user indexes in the database excluding those in pg_catalog and information_schema.

postgres-list-indexes lists detailed information as JSON for indexes. The tool takes the following input parameters:

table_name (optional): A text to filter results by table name. Default: ""
index_name (optional): A text to filter results by index name. Default: ""
schema_name (optional): A text to filter results by schema name. Default: ""
only_unused (optional): If true, returns indexes that have never been used.
limit (optional): The maximum number of rows to return. Default: 50.

Compatible Sources

This tool can be used with the following database sources:

postgres-list-installed-extensions

Mon, 01 Jan 0001 00:00:00 +0000

About

The postgres-list-installed-extensions tool retrieves all PostgreSQL extensions installed on a Postgres database.

postgres-list-installed-extensions lists all installed PostgreSQL extensions (extension name, version, schema, owner, description) as JSON. The does not support any input parameter.

Compatible Sources

This tool can be used with the following database sources:

Source Name
PostgreSQL
AlloyDB PostgreSQL
Cloud SQL for PostgreSQL

Example

kind: tool
name: list_installed_extensions
type: postgres-list-installed-extensions
source: postgres-source
description: List all installed PostgreSQL extensions with their name, version, schema, owner, and description.

Reference

field	type	required	description
type	string	true	Must be “postgres-list-active-queries”.
source	string	true	Name of the source the SQL should execute on.
description	string	true	Description of the tool that is passed to the LLM.

postgres-list-locks

Mon, 01 Jan 0001 00:00:00 +0000

About

The postgres-list-locks tool displays information about active locks by joining pg_stat_activity with pg_locks. This is useful to find transactions holding or waiting for locks and to troubleshoot contention.

This tool identifies all locks held by active processes showing the process ID, user, query text, and an aggregated list of all transactions and specific locks (relation, mode, grant status) associated with each process.

Compatible Sources

This tool can be used with the following database sources:

postgres-list-pg-settings

Mon, 01 Jan 0001 00:00:00 +0000

About

The postgres-list-pg-settings tool lists the configuration parameters for the postgres server, their current values, and related information.

postgres-list-pg-settings lists detailed information as JSON for each setting. The tool takes the following input parameters:

setting_name (optional): A text to filter results by setting name. Default: ""
limit (optional): The maximum number of rows to return. Default: 50.

Compatible Sources

This tool can be used with the following database sources:

Source Name
PostgreSQL
AlloyDB PostgreSQL
Cloud SQL for PostgreSQL

Example

kind: tool
name: list_indexes
type: postgres-list-pg-settings
source: postgres-source
description: |
 Lists configuration parameters for the postgres server ordered lexicographically, 
 with a default limit of 50 rows. It returns the parameter name, its current setting,
 unit of measurement, a short description, the source of the current setting (e.g.,
 default, configuration file, session), and whether a restart is required when the
 parameter value is changed."

The response is a json array with the following elements:

postgres-list-publication-tables

Mon, 01 Jan 0001 00:00:00 +0000

About

The postgres-list-publication-tables tool lists all publication tables in the database.

postgres-list-publication-tables lists detailed information as JSON for publication tables. A publication table in PostgreSQL is a table that is explicitly included as a source for replication within a publication (a set of changes generated from a table or group of tables) as part of the logical replication feature. The tool takes the following input parameters:

table_names (optional): Filters by a comma-separated list of table names. Default: ""
publication_names (optional): Filters by a comma-separated list of publication names. Default: ""
schema_names (optional): Filters by a comma-separated list of schema names. Default: ""
limit (optional): The maximum number of rows to return. Default: 50

Compatible Sources

This tool can be used with the following database sources:

postgres-list-query-stats

Mon, 01 Jan 0001 00:00:00 +0000

About

The postgres-list-query-stats tool retrieves query statistics from the pg_stat_statements extension in a PostgreSQL database. It provides detailed performance metrics for executed queries.

postgres-list-query-stats lists detailed query statistics as JSON, ordered by total execution time in descending order. The tool takes the following input parameters:

database_name (optional): The database name to filter query stats for. The input is used within a LIKE clause. Default: "" (all databases).
limit (optional): The maximum number of results to return. Default: 50.

Compatible Sources

This tool can be used with the following database sources:

postgres-list-roles

Mon, 01 Jan 0001 00:00:00 +0000

About

The postgres-list-roles tool lists all the user-created roles in the instance, excluding system roles (like cloudsql% or pg_%). It provides details about each role’s attributes and memberships.

postgres-list-roles lists detailed information as JSON for each role. The tool takes the following input parameters:

role_name (optional): A text to filter results by role name. Default: ""
limit (optional): The maximum number of roles to return. Default: 50

Compatible Sources

This tool can be used with the following database sources:

postgres-list-schemas

Mon, 01 Jan 0001 00:00:00 +0000

About

The postgres-list-schemas tool retrieves information about schemas in a database excluding system and temporary schemas.

postgres-list-schemas lists detailed information as JSON for each schema. The tool takes the following input parameters:

schema_name (optional): A text to filter results by schema name. Default: ""
owner (optional): A text to filter results by owner name. Default: ""
limit (optional): The maximum number of rows to return. Default: 50.

Compatible Sources

This tool can be used with the following database sources:

postgres-list-sequences

Mon, 01 Jan 0001 00:00:00 +0000

About

The postgres-list-sequences tool retrieves information about sequences in a Postgres database.

postgres-list-sequences lists detailed information as JSON for all sequences. The tool takes the following input parameters:

sequence_name (optional): A text to filter results by sequence name. The input is used within a LIKE clause. Default: ""
schema_name (optional): A text to filter results by schema name. The input is used within a LIKE clause. Default: ""
limit (optional): The maximum number of rows to return. Default: 50.

Compatible Sources

This tool can be used with the following database sources:

postgres-list-stored-procedure

Mon, 01 Jan 0001 00:00:00 +0000

About

The postgres-list-stored-procedure tool queries PostgreSQL system catalogs (pg_proc, pg_namespace, pg_roles, and pg_language) to retrieve comprehensive metadata about stored procedures in the database. It filters for procedures (kind = ‘p’) and provides the full procedure definition along with ownership and language information.

The tool returns a JSON array where each element represents a stored procedure with its schema, name, owner, language, complete definition, and optional description. Results are sorted by schema name and procedure name, with a default limit of 20 procedures.

postgres-list-table-stats

Mon, 01 Jan 0001 00:00:00 +0000

About

The postgres-list-table-stats tool queries pg_stat_all_tables to provide comprehensive statistics about tables in the database. It calculates useful metrics like index scan ratio and dead row ratio to help identify performance issues and table bloat.

The tool returns a JSON array where each element represents statistics for a table, including scan metrics, row counts, and vacuum history. Results are sorted by sequential scans by default and limited to 50 rows.

postgres-list-tables

Mon, 01 Jan 0001 00:00:00 +0000

About

The postgres-list-tables tool retrieves schema information for all or specified tables in a Postgres database.

postgres-list-tables lists detailed schema information (object type, columns, constraints, indexes, triggers, owner, comment) as JSON for user-created tables (ordinary or partitioned). The tool takes the following input parameters: * table_names (optional): Filters by a comma-separated list of names. By default, it lists all tables in user schemas.* output_format (optional): Indicate the output format of table schema. simple will return only the table names, detailed will return the full table information. Default: detailed.

postgres-list-tablespaces

Mon, 01 Jan 0001 00:00:00 +0000

About

The postgres-list-tablespaces tool lists available tablespaces in the database.

postgres-list-tablespaces lists detailed information as JSON for tablespaces. The tool takes the following input parameters:

tablespace_name (optional): A text to filter results by tablespace name. Default: ""
limit (optional): The maximum number of tablespaces to return. Default: 50

Compatible Sources

This tool can be used with the following database sources:

Source Name
PostgreSQL
AlloyDB PostgreSQL
Cloud SQL for PostgreSQL

Example

kind: tool
name: list_tablespaces
type: postgres-list-tablespaces
source: postgres-source
description: |
 Lists all tablespaces in the database. Returns the tablespace name,
 owner name, size in bytes(if the current user has CREATE privileges on
 the tablespace, otherwise NULL), internal object ID, the access control
 list regarding permissions, and any specific tablespace options.

The response is a json array with the following elements:

postgres-list-triggers

Mon, 01 Jan 0001 00:00:00 +0000

About

The postgres-list-triggers tool lists available non-internal triggers in the database.

postgres-list-triggers lists detailed information as JSON for triggers. The tool takes the following input parameters:

trigger_name (optional): A text to filter results by trigger name. The input is used within a LIKE clause. Default: ""
schema_name (optional): A text to filter results by schema name. The input is used within a LIKE clause. Default: ""
table_name (optional): A text to filter results by table name. The input is used within a LIKE clause. Default: ""
limit (optional): The maximum number of triggers to return. Default: 50

Compatible Sources

This tool can be used with the following database sources:

postgres-list-views

Mon, 01 Jan 0001 00:00:00 +0000

About

The postgres-list-views tool retrieves a list of top N (default 50) views from a Postgres database, excluding those in system schemas (pg_catalog, information_schema).

postgres-list-views lists detailed view information (schemaname, viewname, ownername, definition) as JSON for views in a database. The tool takes the following input parameters:

view_name (optional): A string pattern to filter view names. Default: ""
schema_name (optional): A string pattern to filter schema names. Default: ""
limit (optional): The maximum number of rows to return. Default: 50.

Compatible Sources

This tool can be used with the following database sources:

postgres-long-running-transactions

Mon, 01 Jan 0001 00:00:00 +0000

About

The postgres-long-running-transactions tool reports transactions that exceed a configured duration threshold by scanning pg_stat_activity for sessions where xact_start is set and older than the configured interval.

The tool returns a JSON array with one object per matching session (non-idle). Each object contains the process id, database and user, application name, client address, session state, several age intervals (connection, transaction, query, and last activity), wait event info, and the SQL text currently associated with the session.

postgres-replication-stats

Mon, 01 Jan 0001 00:00:00 +0000

About

The postgres-replication-stats tool queries pg_stat_replication to surface the status of connected replicas. It reports application_name, client address, connection and sync state, and human-readable lag sizes (sent, write, flush, replay, and total) computed using WAL LSN differences.

This tool takes no parameters. It returns a JSON array; each element represents a replication connection on the primary and includes lag metrics formatted by pg_size_pretty.

Compatible Sources

This tool can be used with the following database sources:

postgres-sql

Mon, 01 Jan 0001 00:00:00 +0000

About

A postgres-sql tool executes a pre-defined SQL statement against a Postgres database. The specified SQL statement is executed as a prepared statement, and specified parameters will be inserted according to their position: e.g. $1 will be the first parameter specified, $2 will be the second parameter, and so on. If template parameters are included, they will be resolved before execution of the prepared statement.

Compatible Sources

This tool can be used with the following database sources: