Deploy MCP Postgres Server

OpenAPI definition for the Deploy MCP Postgres server. The API exposes schema discovery, SQL execution, performance insights, and health checks backed by a live PostgreSQL connection provided at request time.

Version 1.0.09 endpoints

Endpoints

GET/analysis/db-healthanalyze_db_health

Run diagnostic checks against the connected database and report potential issues.

Parameters

Name	In	Required	Description
include_diagnostics	query	No	Include raw diagnostic data alongside summarized findings.

Responses

Status	Description
200	Results of health checks and recommended actions.
400	The request payload or parameters were invalid.
401	Authentication failed or connection string could not be used.
500	Unexpected error while communicating with Postgres.

POST/analysis/query/indexesanalyze_query_indexes

Analyze a specific query and suggest indexes that could improve its execution plan.

Request body

application/json

Responses

Status	Description
200	Index recommendations relevant to the query.
400	The request payload or parameters were invalid.
401	Authentication failed or connection string could not be used.
500	Unexpected error while communicating with Postgres.

POST/analysis/workload/indexesanalyze_workload_indexes

Suggest indexes that could improve performance for a representative workload of queries.

Request body

application/json

Responses

Status	Description
200	Index recommendations tailored to the supplied workload.
400	The request payload or parameters were invalid.
401	Authentication failed or connection string could not be used.
500	Unexpected error while communicating with Postgres.

GET/monitoring/top-queriesget_top_queries

Return statements with the highest execution cost according to pg_stat_statements.

Parameters

Name	In	Required	Description
interval_minutes	query	No	How far back in minutes to consider statistics for ranking.
limit	query	No	Maximum number of queries to return.

Responses

Status	Description
200	Top queries ordered by total execution time.
400	The request payload or parameters were invalid.
401	Authentication failed or connection string could not be used.
500	Unexpected error while communicating with Postgres.

GET/schemaslist_schemas

Return the schemas accessible through the provided Postgres connection.

Parameters

Name	In	Required	Description
include_system_schemas	query	No	Whether to include system schemas such as `pg_catalog` and `information_schema`.

Responses

Status	Description
200	Schemas visible to the connection user.
400	The request payload or parameters were invalid.
401	Authentication failed or connection string could not be used.
500	Unexpected error while communicating with Postgres.

GET/schemas/{schema}/objectslist_objects

Enumerate tables, views, functions, and other objects that live in the target schema.

Parameters

Name	In	Required	Description
schema	path	Yes	Schema name to inspect.
types	query	No	Filter results to one or more object types.

Responses

Status	Description
200	Objects that match the criteria.
400	The request payload or parameters were invalid.
401	Authentication failed or connection string could not be used.
500	Unexpected error while communicating with Postgres.

GET/schemas/{schema}/objects/{object}get_object_details

Return DDL, column metadata, indexes, and dependencies for a schema-qualified object.

Parameters

Name	In	Required	Description
schema	path	Yes	Schema that owns the object.
object	path	Yes	Name of the object to inspect.
include_stats	query	No	When true, include planner statistics and index usage details where available.

Responses

Status	Description
200	Detailed metadata for the requested object.
400	The request payload or parameters were invalid.
401	Authentication failed or connection string could not be used.
500	Unexpected error while communicating with Postgres.

POST/sql/executeexecute_sql

Run a SQL statement and return any resulting rows.

Request body

application/json

Responses

Status	Description
200	Execution results from the database.
400	The request payload or parameters were invalid.
401	Authentication failed or connection string could not be used.
500	Unexpected error while communicating with Postgres.

POST/sql/explainexplain_query

Return the execution plan produced by EXPLAIN or EXPLAIN ANALYZE.

Request body

application/json

Responses

Status	Description
200	Query plan returned by Postgres.
400	The request payload or parameters were invalid.
401	Authentication failed or connection string could not be used.
500	Unexpected error while communicating with Postgres.

See Deploy in action in under five minutes

Get Started