feat(tools/postgres): add list_pg_settings, list_database_stats tools for postgres

Author: srividyareddy786

cmd/root.go

@@ -181,9 +181,11 @@ import (
 	_ "github.com/googleapis/genai-toolbox/internal/tools/postgres/postgresexecutesql"
 	_ "github.com/googleapis/genai-toolbox/internal/tools/postgres/postgreslistactivequeries"
 	_ "github.com/googleapis/genai-toolbox/internal/tools/postgres/postgreslistavailableextensions"
+	_ "github.com/googleapis/genai-toolbox/internal/tools/postgres/postgreslistdatabasestats"
 	_ "github.com/googleapis/genai-toolbox/internal/tools/postgres/postgreslistindexes"
 	_ "github.com/googleapis/genai-toolbox/internal/tools/postgres/postgreslistinstalledextensions"
 	_ "github.com/googleapis/genai-toolbox/internal/tools/postgres/postgreslistlocks"
+	_ "github.com/googleapis/genai-toolbox/internal/tools/postgres/postgreslistpgsettings"
 	_ "github.com/googleapis/genai-toolbox/internal/tools/postgres/postgreslistschemas"
 	_ "github.com/googleapis/genai-toolbox/internal/tools/postgres/postgreslistsequences"
 	_ "github.com/googleapis/genai-toolbox/internal/tools/postgres/postgreslisttables"

cmd/root_test.go

@@ -1478,7 +1478,7 @@ func TestPrebuiltTools(t *testing.T) {
 			wantToolset: server.ToolsetConfigs{
 				"alloydb_postgres_database_tools": tools.ToolsetConfig{
 					Name:      "alloydb_postgres_database_tools",
-					ToolNames: []string{"execute_sql", "list_tables", "list_active_queries", "list_available_extensions", "list_installed_extensions", "list_autovacuum_configurations", "list_memory_configurations", "list_top_bloated_tables", "list_replication_slots", "list_invalid_indexes", "get_query_plan", "list_views", "list_schemas", "database_overview", "list_triggers", "list_indexes", "list_sequences", "long_running_transactions", "list_locks", "replication_stats"},
+					ToolNames: []string{"execute_sql", "list_tables", "list_active_queries", "list_available_extensions", "list_installed_extensions", "list_autovacuum_configurations", "list_memory_configurations", "list_top_bloated_tables", "list_replication_slots", "list_invalid_indexes", "get_query_plan", "list_views", "list_schemas", "database_overview", "list_triggers", "list_indexes", "list_sequences", "long_running_transactions", "list_locks", "replication_stats", "list_pg_settings", "list_database_stats"},
 				},
 			},
 		},
@@ -1508,7 +1508,7 @@ func TestPrebuiltTools(t *testing.T) {
 			wantToolset: server.ToolsetConfigs{
 				"cloud_sql_postgres_database_tools": tools.ToolsetConfig{
 					Name:      "cloud_sql_postgres_database_tools",
-					ToolNames: []string{"execute_sql", "list_tables", "list_active_queries", "list_available_extensions", "list_installed_extensions", "list_autovacuum_configurations", "list_memory_configurations", "list_top_bloated_tables", "list_replication_slots", "list_invalid_indexes", "get_query_plan", "list_views", "list_schemas", "database_overview", "list_triggers", "list_indexes", "list_sequences", "long_running_transactions", "list_locks", "replication_stats"},
+					ToolNames: []string{"execute_sql", "list_tables", "list_active_queries", "list_available_extensions", "list_installed_extensions", "list_autovacuum_configurations", "list_memory_configurations", "list_top_bloated_tables", "list_replication_slots", "list_invalid_indexes", "get_query_plan", "list_views", "list_schemas", "database_overview", "list_triggers", "list_indexes", "list_sequences", "long_running_transactions", "list_locks", "replication_stats", "list_pg_settings", "list_database_stats"},
 				},
 			},
 		},
@@ -1608,7 +1608,7 @@ func TestPrebuiltTools(t *testing.T) {
 			wantToolset: server.ToolsetConfigs{
 				"postgres_database_tools": tools.ToolsetConfig{
 					Name:      "postgres_database_tools",
-					ToolNames: []string{"execute_sql", "list_tables", "list_active_queries", "list_available_extensions", "list_installed_extensions", "list_autovacuum_configurations", "list_memory_configurations", "list_top_bloated_tables", "list_replication_slots", "list_invalid_indexes", "get_query_plan", "list_views", "list_schemas", "database_overview", "list_triggers", "list_indexes", "list_sequences", "long_running_transactions", "list_locks", "replication_stats"},
+					ToolNames: []string{"execute_sql", "list_tables", "list_active_queries", "list_available_extensions", "list_installed_extensions", "list_autovacuum_configurations", "list_memory_configurations", "list_top_bloated_tables", "list_replication_slots", "list_invalid_indexes", "get_query_plan", "list_views", "list_schemas", "database_overview", "list_triggers", "list_indexes", "list_sequences", "long_running_transactions", "list_locks", "replication_stats", "list_pg_settings", "list_database_stats"},
 				},
 			},
 		},

docs/en/reference/prebuilt-tools.md

@@ -50,6 +50,9 @@ details on how to connect your AI tools (IDEs) to databases via Toolbox and MCP.
     *   `list_triggers`: Lists triggers in the database. 
     *   `list_indexes`: List available user indexes in a PostgreSQL database.
     *   `list_sequences`: List sequences in a PostgreSQL database.
+    *   `list_pg_settings`: List configuration parameters for the PostgreSQL server.
+    *   `list_database_stats`: Lists the key performance and activity statistics for
+        each database in the AlloyDB instance.
 
 ## AlloyDB Postgres Admin
 
@@ -224,6 +227,9 @@ details on how to connect your AI tools (IDEs) to databases via Toolbox and MCP.
     *   `list_triggers`: Lists triggers in the database. 
     *   `list_indexes`: List available user indexes in a PostgreSQL database.
     *   `list_sequences`: List sequences in a PostgreSQL database.
+    *   `list_pg_settings`: List configuration parameters for the PostgreSQL server.
+    *   `list_database_stats`: Lists the key performance and activity statistics for
+        each database in the postgreSQL instance.
 
 ## Cloud SQL for PostgreSQL Observability
 
@@ -525,6 +531,9 @@ details on how to connect your AI tools (IDEs) to databases via Toolbox and MCP.
     *   `list_triggers`: Lists triggers in the database. 
     *   `list_indexes`: List available user indexes in a PostgreSQL database.
     *   `list_sequences`: List sequences in a PostgreSQL database.
+    *   `list_pg_settings`: List configuration parameters for the PostgreSQL server.
+    *   `list_database_stats`: Lists the key performance and activity statistics for
+        each database in the PostgreSQL server.
 
 ## Google Cloud Serverless for Apache Spark
 

docs/en/resources/sources/alloydb-pg.md

@@ -71,6 +71,13 @@ cluster][alloydb-free-trial].
 - [`postgres-replication-stats`](../tools/postgres/postgres-replication-stats.md)
   List replication stats in a PostgreSQL database.
 
+- [`postgres-list-pg-settings`](../tools/postgres/postgres-list-pg-settings.md)
+  List configuration parameters for the PostgreSQL server.
+
+- [`postgres-list-database-stats`](../tools/postgres/postgres-list-database-stats.md)
+  Lists the key performance and activity statistics for each database in the AlloyDB
+  instance.
+
 ### Pre-built Configurations
 
 - [AlloyDB using MCP](https://googleapis.github.io/genai-toolbox/how-to/connect-ide/alloydb_pg_mcp/)

docs/en/resources/sources/cloud-sql-pg.md

@@ -67,6 +67,13 @@ to a database by following these instructions][csql-pg-quickstart].
 - [`postgres-replication-stats`](../tools/postgres/postgres-replication-stats.md)
   List replication stats in a PostgreSQL database.
 
+- [`postgres-list-pg-settings`](../tools/postgres/postgres-list-pg-settings.md)
+  List configuration parameters for the PostgreSQL server.
+
+- [`postgres-list-database-stats`](../tools/postgres/postgres-list-database-stats.md)
+  Lists the key performance and activity statistics for each database in the postgreSQL
+  instance.
+
 ### Pre-built Configurations
 
 - [Cloud SQL for Postgres using

docs/en/resources/sources/postgres.md

@@ -62,6 +62,13 @@ reputation for reliability, feature robustness, and performance.
 - [`postgres-replication-stats`](../tools/postgres/postgres-replication-stats.md)
   List replication stats in a PostgreSQL database.
 
+- [`postgres-list-pg-settings`](../tools/postgres/postgres-list-pg-settings.md)
+  List configuration parameters for the PostgreSQL server.
+
+- [`postgres-list-database-stats`](../tools/postgres/postgres-list-database-stats.md)
+  Lists the key performance and activity statistics for each database in the postgreSQL
+  server.
+
 ### Pre-built Configurations
 
 - [PostgreSQL using MCP](https://googleapis.github.io/genai-toolbox/how-to/connect-ide/postgres_mcp/)

docs/en/resources/tools/postgres/postgres-list-database-stats.md

@@ -0,0 +1,95 @@
+---
+title: "postgres-list-database-stats"
+type: docs
+weight: 1
+description: >
+ The "postgres-list-database-stats" tool lists lists key performance and activity statistics of PostgreSQL databases.
+aliases:
+- /resources/tools/postgres-list-database-stats
+---
+
+## 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. It's compatible with
+any of the following sources:
+
+- [alloydb-postgres](../../sources/alloydb-pg.md)
+- [cloud-sql-postgres](../../sources/cloud-sql-pg.md)
+- [postgres](../../sources/postgres.md)
+
+`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`
+
+## Example
+
+```yaml
+tools:
+  list_database_stats:
+    kind: postgres-list-database-stats
+    source: postgres-source
+    description: |
+       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. It returns: the database name, whether the database is
+        connectable, database owner, default tablespace name, the percentage of
+        data blocks found in the buffer cache rather than being read from disk
+        (a higher value indicates better cache performance), the total number of
+        disk blocks read from disk, the total number of times disk blocks were
+        found already in the cache; the total number of committed transactions,
+        the total number of rolled back transactions, the percentage of rolled
+        back transactions compared to the total number of completed
+        transactions, the total number of rows returned by queries, the total
+        number of live rows fetched by scans, the total number of rows inserted,
+        the total number of rows updated, the total number of rows deleted, the
+        number of temporary files created by queries, the total size of
+        temporary files used by queries in bytes, the number of query
+        cancellations due to conflicts with recovery, the number of deadlocks
+        detected, the current number of active backend connections, the
+        timestamp when the database statistics were last reset, and the total
+        database size in bytes.
+```
+
+The response is a json array with the following elements:
+
+```json
+{
+ "database_name": "Name of the database",
+ "is_connectable": "Boolean indicating Whether the database allows connections",
+ "database_owner": "Username of the database owner",
+ "default_tablespace": "Name of the default tablespace for the database",
+ "cache_hit_ratio_percent": "The percentage of data blocks found in the buffer cache rather than being read from disk",
+ "blocks_read_from_disk": "The total number of disk blocks read for this database",
+ "blocks_hit_in_cache": "The total number of times disk blocks were found already in the cache.",
+ "xact_commit": "The total number of committed transactions",
+ "xact_rollback": "The total number of rolled back transactions",
+ "rollback_ratio_percent": "The percentage of rolled back transactions compared to the total number of completed transactions",
+ "rows_returned_by_queries": "The total number of rows returned by queries",
+ "rows_fetched_by_scans": "The total number of live rows fetched by scans",
+ "tup_inserted": "The total number of rows inserted",
+ "tup_updated": "The total number of rows updated",
+ "tup_deleted": "The total number of rows deleted",
+ "temp_files": "The number of temporary files created by queries",
+ "temp_size_bytes": "The total size of temporary files used by queries in bytes",
+ "conflicts": "Number of query cancellations due to conflicts",
+ "deadlocks": "Number of deadlocks detected",
+ "active_connections": "The current number of active backend connections",
+ "statistics_last_reset": "The timestamp when the database statistics were last reset",
+ "database_size_bytes": "The total disk size of the database in bytes"
+}
+```
+
+## Reference
+
+| **field**   | **type** | **required** | **description**                                      |
+|-------------|:--------:|:------------:|------------------------------------------------------|
+| kind        |  string  |     true     | Must be "postgres-list-database-stats".              |
+| source      |  string  |     true     | Name of the source the SQL should execute on.        |
+| description |  string  |    false     | Description of the tool that is passed to the agent. |

docs/en/resources/tools/postgres/postgres-list-pg-settings.md

@@ -0,0 +1,59 @@
+---
+title: "postgres-list-pg-settings"
+type: docs
+weight: 1
+description: >
+ The "postgres-list-pg-settings" tool lists PostgreSQL run-time configuration settings.
+aliases:
+- /resources/tools/postgres-list-pg-settings
+---
+
+## About
+
+The `postgres-list-pg-settings` tool lists the configuration parameters for the postgres server, their current values, and related information. It's compatible with any of the following sources:
+
+- [alloydb-postgres](../../sources/alloydb-pg.md)
+- [cloud-sql-postgres](../../sources/cloud-sql-pg.md)
+- [postgres](../../sources/postgres.md)
+
+`postgres-list-pg-settings` lists detailed information as JSON for each setting. The tool
+takes the following input parameters:
+
+- `name` (optional): A text to filter results by setting name. Default: `""`
+- `limit` (optional): The maximum number of rows to return. Default: `50`.
+
+## Example
+
+```yaml
+tools:
+  list_indexes:
+    kind: 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:
+
+```json
+{
+ "name": "Setting name",
+ "current_value": "Current value of the setting",
+ "unit": "Unit of the setting",
+ "short_desc": "Short description of the setting",
+ "source": "Source of the current value (e.g., default, configuration file, session)",
+ "requires_restart": "Indicates if a server restart is required to apply a change ('Yes', 'No', or 'No (Reload sufficient)')"
+}
+```
+
+## Reference
+
+| **field**   | **type** | **required** | **description**                                      |
+|-------------|:--------:|:------------:|------------------------------------------------------|
+| kind        |  string  |     true     | Must be "postgres-list-pg-settings".                     |
+| source      |  string  |     true     | Name of the source the SQL should execute on.        |
+| description |  string  |    false     | Description of the tool that is passed to the agent. |

internal/prebuiltconfigs/tools/alloydb-postgres.yaml

@@ -192,6 +192,14 @@ tools:
         kind: postgres-list-triggers
         source: alloydb-pg-source
 
+    list_pg_settings:
+        kind: postgres-list-pg-settings
+        source: alloydb-pg-source
+
+    list_database_stats:
+        kind: postgres-list-database-stats
+        source: alloydb-pg-source
+
 toolsets:
     alloydb_postgres_database_tools:
         - execute_sql
@@ -214,4 +222,6 @@ toolsets:
         - long_running_transactions
         - list_locks
         - replication_stats
+        - list_pg_settings
+        - list_database_stats
 

internal/prebuiltconfigs/tools/cloud-sql-postgres.yaml

@@ -194,6 +194,14 @@ tools:
         kind: postgres-list-sequences
         source: cloudsql-pg-source
 
+    list_pg_settings:
+        kind: postgres-list-pg-settings
+        source: cloudsql-pg-source
+
+    list_database_stats:
+        kind: postgres-list-database-stats
+        source: cloudsql-pg-source
+
 toolsets:
     cloud_sql_postgres_database_tools:
         - execute_sql
@@ -216,3 +224,5 @@ toolsets:
         - long_running_transactions
         - list_locks
         - replication_stats
+        - list_pg_settings
+        - list_database_stats