Multigres

io.github.JoongHyuk-ShinPublished by GitHub account JoongHyuk-Shinv0.1.2Updated Nov 7, 2026

Postgres diagnostics and cluster operations for Multigres clusters.

Overview

AI-generated overview

An MCP server for Multigres Postgres clusters that lets an assistant inspect schemas, run read-only SQL, get query plans and index advice, and check cluster…

What you can do
  • Inspect schemas, tables, views, sequences and extensions, and read their columns, constraints and indexes
  • Run a single read-only statement, explain a query with optional ANALYZE or hypothetical indexes, and list the slowest or most expensive queries
  • Get index advice for the whole workload or for up to 10 given queries, without creating anything
  • Run health checks covering bloat, vacuum, locks, activity, waits, slow queries, missing indexes, cache, logs, replication and constraints
  • With an admin URL: read cluster status, list and verify backups, check backup job status, and read a node's Postgres log
  • In unrestricted mode: run writing SQL, switch a shard's primary, create or expire backups…
When to use it
Useful when you work with a Multigres cluster and want an assistant to diagnose slow queries, review index opportunities, or check cluster and backup state without hand-writing SQL and admin calls. It is read-only by default, so it fits exploratory analysis before you deliberately enable write tools.
Requirements
Runs as a local process over stdio, installed from the MCP Bundle or the bundled binaries (Linux, macOS, Windows on amd64). Requires DATABASE_URI, the Postgres connection string of the Multigres gateway. Cluster tools need MULTIGRES_ADMIN_URL, and MULTIGRES_ADMIN_TOKEN if multiadmin runs with auth. Optional: MULTIGRES_MCP_ACCESS_MODE, MULTIGRES_MCP_SQL_TIMEOUT, MULTIGRES_NODE_HOST_MAP. Network access to the gateway and multiadmin.
Before you install
DATABASE_URI and MULTIGRES_ADMIN_TOKEN are secrets; the server masks them in results, but a password equal to the user or database name is not masked. Unrestricted mode adds tools that write data, switch the primary, create or expire backups and toggle restarts, so keep restricted mode unless needed. Against production, also connect as a read-only role. Object bodies already in the database are trusted and not checked, and some session settings can leak to the next pooled client. Only a local…

Installation

In SourceWeft

  1. Open Multigres in the dashboard and add it to a workspace.
  2. Enable the server for the chats that should use its tools.

Desktop only via STDIO. STDIO servers start a local process, so they need the SourceWeft desktop host.

Other MCP clients

Follow the launch instructions in the repository.

README

multigres-mcp

An MCP server for Multigres clusters. It gives an MCP client two groups of tools:

  • Postgres diagnostics through the Multigres gateway: schemas and objects, read-only SQL, query plans with hypothetical indexes, top queries, index advice and a health check. These follow the tools of postgres-mcp.
  • Cluster tools through multiadmin: cluster status, backups, node logs, and in the unrestricted mode switching the primary and starting or expiring backups.

The server is read-only by default. Write tools are registered only in the unrestricted mode.

It has been tested against a local Multigres Docker cluster built from commit 49e7a2f7d4fe (2026-11-02, PostgreSQL 17.7, two cells) on Linux with Docker Engine. Other setups have not been tested.

Install

Each release has a multigres-mcp-<version>.mcpb file. It is an MCP Bundle: clients that install bundles ask for the settings under "Configuration" and run the server. It is also a zip file whose server/ directory holds binaries for Linux and macOS on amd64 and arm64 and for Windows on amd64, which any other client can run directly.

Build

Requires Go 1.26 or later.

sh
git clone https://github.com/JoongHyuk-Shin/multigres-mcpcd multigres-mcpgo build -o multigres-mcp ./cmd/multigres-mcp

The server talks MCP over standard input and output. ./multigres-mcp --help prints the options.

packaging/build-mcpb.sh builds the release bundle into dist/. It also needs jq, Node.js and openssl.

Configuration

Every option can be given as a flag or as an environment variable. A flag wins over the variable.

FlagVariableDefaultMeaning
--database-urlDATABASE_URInone, requiredConnection string of the Multigres gateway.
--admin-urlMULTIGRES_ADMIN_URLnonemultiadmin HTTP address. The cluster tools are registered only when it is set.
--admin-tokenMULTIGRES_ADMIN_TOKENnoneBearer token for multiadmin started with --enable-auth.
--node-host-mapMULTIGRES_NODE_HOST_MAPnonereported=reachable host pairs, comma separated, for the direct node connections of read_node_log and of the node option of diagnose and get_top_queries. multiadmin reports each node's host as the cluster sees it; this replaces a host that the server cannot reach. Ports are not changed.
--access-modeMULTIGRES_MCP_ACCESS_MODErestrictedrestricted (read-only) or unrestricted (adds the write tools).
--sql-timeoutMULTIGRES_MCP_SQL_TIMEOUT25sStatement timeout for the SQL every tool sends. See "Things to know".

Direct node connections reuse the user, password and database of --database-url and take the host and port from multiadmin.

In the local Docker cluster both nodes report the host localhost, while their Postgres ports are reachable only at the container's address. Find that address in the Multigres checkout with:

sh
docker inspect -f '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' "$(docker compose ps -q multigres)"

and pass it as --node-host-map localhost=<address>.

Adding it to an MCP client

With Claude Code, for the local Docker cluster (replace 172.18.0.2 with the address found above):

sh
claude mcp add multigres -e DATABASE_URI=postgres://postgres:postgres@localhost:15432/postgres -- /path/to/multigres-mcp --admin-url http://localhost:15000 --node-host-map localhost=172.18.0.2

Other clients take the same command, arguments and environment in their server configuration, for example:

json
{  "mcpServers": {    "multigres": {      "type": "stdio",      "command": "/path/to/multigres-mcp",      "args": ["--admin-url", "http://localhost:15000", "--node-host-map", "localhost=172.18.0.2"],      "env": {        "DATABASE_URI": "postgres://postgres:postgres@localhost:15432/postgres"      }    }  }}

Tools

ToolModeWhat it does
list_schemasbothList the schemas. The multigres schema is internal to Multigres.
list_objectsbothList the tables, views, sequences or extensions of a schema.
get_object_detailsbothColumns, constraints and indexes of a table or view, or details of a sequence or extension.
execute_sqlbothRun one read-only statement (SELECT, EXPLAIN of a SELECT, or SHOW). In both modes it only reads.
explain_querybothThe plan of a query, optionally with ANALYZE or with hypothetical indexes. A query with $1 placeholders, as stored in query statistics, gets a generic plan.
get_top_queriesbothThe slowest or most expensive queries, from pg_stat_statements and from the query statistics each gateway keeps, shown separately.
analyze_workload_indexesbothIndex advice for the workload in pg_stat_statements, by comparing planner costs with hypothetical indexes. Nothing is created.
analyze_query_indexesbothThe same for up to 10 given queries.
diagnosebothHealth checks: bloat, vacuum, locks, activity, waits, slow queries, missing indexes, cache, log, index health, sequences, replication and constraints. It starts with the statistics period of the node that answered.
cluster_statusboth, needs --admin-urlCells, databases, the primary and replicas of each shard with LSN and lag, gateways, orchestrators, recent primary changes, and whether the connected user is a superuser.
list_backupsboth, needs --admin-urlBackups of a shard.
verify_backupsboth, needs --admin-urlRun pgBackRest verify on a shard's backups, which checks that the backups and archived WAL in the repository are valid. It does not run a restore.
get_backup_job_statusboth, needs --admin-urlStatus of a backup job.
read_node_logboth, needs --admin-urlThe end of a node's Postgres log, read over a direct connection to that node.
execute_write_sqlunrestrictedRun one statement that may change data or schema, committed if it succeeds.
switch_primaryunrestricted, needs --admin-urlAsk Multigres to switch a shard's primary, then report the old and new primary and terms. Multigres may elect the same node again; the tool says so and does not retry.
create_backupunrestricted, needs --admin-urlStart a backup and return its job id.
expire_backupsunrestricted, needs --admin-urlExpire backups with the retention rules configured in the cluster.
set_postgres_restartsunrestricted, needs --admin-urlTurn automatic Postgres restarts on a node on or off.

That is 14 tools in the restricted mode and 19 in the unrestricted mode, or 9 and 10 without --admin-url. diagnose and get_top_queries take an optional node to read one node directly instead of through the gateway, for example the old primary after a failover.

Safety

The restricted mode does not register any tool that can write. Writing SQL is a tool of its own, execute_write_sql, so a client permission given to execute_sql never covers a write, even after the server is restarted in the unrestricted mode.

Every statement that execute_sql, explain_query and analyze_query_indexes receive passes these checks. They do not rely on each other: checks 1, 3 and 4 each stop a write on their own.

  1. It is parsed with the Multigres parser. It must be exactly one statement, the top statement must be SELECT, EXPLAIN of a SELECT, or SHOW, and the tree must not contain data-changing statements, SELECT INTO or locking clauses. Functions must be on an allow list (the postgres-mcp list with functions that have side effects removed), and a schema-qualified function must be in pg_catalog.
  2. It is sent with the extended query protocol, which carries one statement only.
  3. The read-only connection is opened with default_transaction_read_only=on.
  4. It runs in BEGIN TRANSACTION READ ONLY, which is always rolled back.
  5. search_path is pinned, and a statement that calls an unqualified function whose name also exists outside pg_catalog is not sent.
  6. A statement timeout is set.

This covers the statements the model sends and the functions they call directly. The bodies of objects already in the database (views, functions, operators, policies) are trusted and not checked. Against a production database, connect as a read-only role as well. cluster_status shows whether the connected user is a superuser.

Multigres hands pooled Postgres connections from one client to the next. Within the same transaction, the server removes the hypothetical indexes and session advisory locks a tool call may have left on its connection. If that cleanup fails, it ends its own Postgres session rather than hand the state on. execute_write_sql rejects transaction control, session-level SET and RESET, multigres.* settings, hypopg functions, and statements that leave session state behind (temporary objects, PREPARE, LISTEN, DECLARE ... WITH HOLD, LOAD, DISCARD, DO). Session settings (set_config(..., false)) and the random seed (setseed) changed inside the body of a function or trigger are not removed and can reach the next client of that connection; like the other object bodies, they are trusted.

Direct node connections run fixed queries only, never SQL from the model.

The multiadmin address (in full and as host:port), the admin token and the database password are removed from tool results and error messages. The removal replaces text, so a password that is a common word is masked wherever that word appears. A password equal to the user or database name is not masked, because results show those names; the server prints a warning when it starts.

Things to know

  • --sql-timeout defaults to 25s because the multipooler ends a transaction's connection when one statement runs past --connpool-user-reserved-inactivity-timeout (default 30s). To use a longer timeout, raise that pooler setting too.
  • The results of execute_sql and execute_write_sql end with a line naming the settings the server set for that call only (statement_timeout, lock_timeout, and for reads search_path), and the statement_timeout its own session had before. The gateway enforces statement_timeout itself without setting it on the node, so the node's pg_settings shows 0 for it while SHOW through the gateway answers with the gateway's value.
  • Cumulative statistics are kept per node. After a failover the new primary's statistics do not include what happened on the old primary. The tools that use statistics start with the period they cover; the node option of diagnose and get_top_queries reads another node.
  • Index sizes in the advice are hypopg estimates and ignore btree deduplication. On a column with many repeated values the estimate can be several times the real size (on 200,000 rows with 1,000 distinct values: 4,644,864 bytes estimated, 1,384,448 bytes real).
  • The gateway truncates the query text it keeps to --query-metrics-sql-max-bytes (default 4096) without a marker. Plans and index advice use the pg_stat_statements text or the full statement you give.
  • Statement texts from pg_stat_statements are shown in full. One very long statement can fill the 50,000-character result: diagnose then leaves out the rest of the slow query check and the checks after it, and get_top_queries leaves out the gateway part. The result says it was cut. Ask diagnose for the later checks by name, and get_top_queries for source: gateway.
  • VACUUM and CREATE INDEX CONCURRENTLY cannot run in a transaction, so execute_write_sql cannot run them.
  • Calls to multiadmin time out after 30 seconds, verify_backups after 10 minutes.
  • If execute_write_sql gets no reply to its COMMIT, it says it does not know whether the statement was committed. Check the data before sending it again.

Tests

sh
go test ./...

runs the unit tests. The integration and end-to-end tests have the build tag cluster and need a local Multigres Docker cluster with pg_stat_statements preloaded and hypopg installed. They switch the primary, drop and recreate the two extensions, and end sessions, so do not point them at a cluster you care about. They fail rather than skip when the cluster cannot be reached.

Start the cluster from a Multigres checkout:

sh
git clone https://github.com/multigres/multigrescd multigresgit checkout 49e7a2f7d4feMULTIGRES_PG_EXTRA_CONF="shared_preload_libraries = 'pg_stat_statements'" docker compose up -d --build

Wait until docker compose ps shows the container as healthy, then install hypopg and create both extensions:

sh
docker compose exec -u root multigres sh -c 'apt-get update -q && apt-get install -y -q --no-install-recommends postgresql-17-hypopg'docker compose exec -e PGPASSWORD=postgres multigres psql -h localhost -p 15432 -U postgres -d postgres -c 'CREATE EXTENSION pg_stat_statements' -c 'CREATE EXTENSION hypopg'

Then, in this repository, with MULTIGRES_MCP_TEST_NODE_HOST set to the container address from the docker inspect command above:

sh
MULTIGRES_MCP_TEST_NODE_HOST=<address> go test -tags cluster -p 1 -count=1 -timeout 25m ./...

-p 1 runs one package at a time, because the packages share the cluster's primary, extensions and connection pools. The tests use the gateway at localhost:15432, multiadmin at localhost:15000 and the node ports 25432 and 25433 of the Docker cluster; MULTIGRES_MCP_TEST_GATEWAY_URL and MULTIGRES_MCP_TEST_ADMIN_URL change the first two. test/facts-map.md maps the Multigres behaviour the design relies on to the test that checks it.

License

Apache License 2.0, see LICENSE. Parts adapted from postgres-mcp are under the MIT License, see THIRD_PARTY_NOTICES.md.

Source: README.md at commit 45fc7b1

Tools

0
SourceWeft started this package once in an isolated sandbox, without credentials, to list its tools. That failed: the package type cannot run in the sandbox.

Version history

3
  1. v0.1.2LatestNov 7, 2026
  2. v0.1.1Nov 6, 2026
  3. v0.1.0Nov 5, 2026

Score

50% of the applicable checks met

How complete this listing is, computed from the registry entry, the endpoint and public sources. Not a rating of the server and not a statement that it is safe or working today: reachability is a dated check, and no installs or reviews go into the score.

  • Reached in the last 30 days25 pts

    Keep the endpoint answering the MCP handshake; SourceWeft probes it every 30 days.

  • Auth declared10 pts

    Declare the credential headers in the registry entry, or keep the endpoint answering the probe so its auth can be classified.

  • Tools listed15 pts

    Answer tools/list without a credential, or ship a package that starts in a sandbox without one.

  • DescriptionRequired15 pts
  • Logo10 pts
  • Documentation15 pts
  • License10 pts