Skip to main content

pgops-mcp

Let an AI assistant operate your PostgreSQL database — without letting it wreck anything.

Point Claude, Cursor, or VS Code at a database and ask questions in plain English. Your assistant gets 17 tools for inspecting schemas, running queries, diagnosing slow ones, and planning migrations. What it does not get is a way to quietly destroy your data.

What it actually looks like

Every number below is real output from the demo database in this repo — 1.2M rows, 114 MB.

You: I want to index orders.status

Assistant: (calls migration.plan)

CREATE INDEX "idx_orders_status" ON "orders" (status)
  risk=medium   estimate=4000ms   confidence=medium
  blocks:  writes yes, reads no
  SAFER:   CREATE INDEX CONCURRENTLY "idx_orders_status" ON "orders" (status)

Assistant: A plain index build blocks writes for roughly 4 seconds. CONCURRENTLY is slower overall but keeps writes working. Which do you want?

The tool didn't return a raw plan for the model to interpret — it returned a verdict, a duration estimate with an honest confidence level, and the safer alternative.

query.explain works the same way. Instead of handing back JSON, it says things like:

planner overestimated rows by 5833x (estimated 239,160, actual 40)
  -> run ANALYZE; if it persists the columns may be correlated, consider CREATE STATISTICS

And when something is genuinely dangerous

You: clear out the orders table

Assistant: (calls query.write with DELETE FROM orders)

CONFIRMATION_REQUIRED
DELETE has no WHERE clause and would affect every row in the table

Where your client supports it, the approval prompt goes to you — not to the assistant. Nothing runs until a human answers, and the refusal is written to the audit log whether or not you approve.

That last part is the point. The assistant cannot approve its own dangerous action, because it is not the one being asked. Where a client can't show a prompt, it degrades to a single-use token bound to that exact statement — never to "allowed".

Why this exists

Most Postgres MCP servers are thin query wrappers: introspect and SELECT. None handle migrations with lock-impact analysis, none diagnose performance from EXPLAIN and pg_stat_statements, and none understand the container the database runs in. Agents operating databases today are doing it blind, and without guardrails.

pgops-mcp is the operations brain: schema intelligence → guarded queries → migration engine → performance diagnosis → environment awareness, with a safety architecture that makes every action classifiable, confirmable, and auditable.

New here? docs/GETTING_STARTED.md is a 15-minute guided tour that assumes no MCP knowledge.

Tool surface

Group Tools
Schema schema.inspect
Queries query.read, query.write (guarded), query.explain (parsed plan + verdict)
Performance index.advise, db.health
Migrations migration.plan (dry-run + lock analysis), migration.describe (plain English), migration.apply, migration.rollback, migration.history
Environment env.topology, env.correlate, container.logs, container.stats
Gated container.restart, container.exec

* Not registered at all unless the server runs with --approval-mode, and even then each call needs a confirmation token. container.exec additionally enforces a read-only diagnostic command allowlist — it does not offer a shell. The Docker socket is root-equivalent on the host, so the default is read-only access.

Safety model (the core differentiator)

  • Separate read-only / read-write connection roles; tools bind to the right role
  • Statement classification before execution — unbounded DELETE/UPDATE blocked
  • Destructive actions require explicit confirmation tokens
  • Every executed statement lands in an append-only audit log with timing and verdict
  • Runaway-query cancellation with timeout tiers

MCP surface

Primitive What's here
Tools 17 — schema, query, explain, advise, migrate, environment
Resources pgops://schema, schema/summary, schema/{table}, health, migrations, audit/recent, config
Prompts diagnose-slow-query, plan-safe-migration, incident-triage, review-index-health, explain-safety-model
Elicitation Dangerous actions ask the user directly, not via the agent; confirmation tokens are the fallback
Sampling migration.describe turns English into a plan using your model — this server ships no API key
Completions Table-name autocomplete for pgops://schema/{table}
Progress / logging Best-effort notifications during long operations

Remote access & agent tokens

stdio needs no auth — the server is a subprocess your client spawns, with no open port. HTTP does, so it refuses to start without a key:

pgops-mcp keygen                                    # RS256 keypair
pgops-mcp issue-token --subject my-agent            # read-only by default
pgops-mcp issue-token --subject deploy-bot --scope pgops:read --scope pgops:write
pgops-mcp scopes                                    # which scope each tool needs

pgops-mcp --transport http --public-key ~/.pgops/keys/pgops_public.pem

The server holds only the public key, so it can verify tokens but never mint them. Scopes (pgops:read / pgops:write / pgops:admin) map to the same danger tiers as the guardrails, and a tool with no scope entry requires admin — deny by default. Binds loopback unless you say otherwise.

Install

pgops-mcp is an MCP server, not a Python library — nothing in it is meant to be imported, and pgops.* carries no API-stability promise. You install it the way you install any MCP server: point your client at it.

Claude Desktop / Cursor / VS Code:

{
  "mcpServers": {
    "pgops": {
      "command": "uvx",
      "args": ["pgops-mcp"],
      "env": { "PGOPS_DSN": "postgresql://user:pass@localhost:5432/mydb" }
    }
  }
}

uvx fetches and runs it in a throwaway environment — nothing to install first, and nothing added to your own project's dependencies.

Or run the container, if you would rather not put a Python toolchain on the machine that talks to your database:

{
  "mcpServers": {
    "pgops": {
      "command": "docker",
      "args": [
        "run", "-i", "--rm",
        "-e", "PGOPS_DSN",
        "-v", "pgops-audit:/var/lib/pgops",
        "ghcr.io/arzharch/pgops-mcp:latest"
      ],
      "env": { "PGOPS_DSN": "postgresql://user:pass@host.docker.internal:5432/mydb" }
    }
  }
}

Two things the container changes: mount a volume at /var/lib/pgops or the audit log dies with the container, and localhost inside a container is the container itself — use host.docker.internal or a compose service name.

Check the connection before wiring a client to it:

uvx pgops-mcp --selfcheck --dsn "postgresql://user:pass@localhost:5432/mydb"

Both paths install the same server and are listed together in the MCP Registry entry — they fail for different people. uvx needs nothing preinstalled but assumes the host may run Python; the container assumes only Docker.

See SETUP.md for configuration, HTTP transport, agent tokens and troubleshooting, and CONTRIBUTING.md to run it from a source checkout.

Docs

Links are absolute so they resolve from the PyPI project page as well as from GitHub.

Using it

Doc What's in it
Getting started First 15 minutes, no MCP knowledge assumed
Tool reference All 17 tools: parameters, returns, error codes, scopes
Setup & configuration Clients, HTTP auth, observability, troubleshooting
Environment variables Every knob, documented
Security model What it can do, what it refuses, known limits
Changelog What changed per release

How it works

Doc What's in it
Architecture System design and trade-offs
System design The safety pipeline, with diagrams
Decision records Why each choice was made, and what it cost
Benchmarks What is measured, and against what

Contributing

Doc What's in it
Contributing Source checkout, gates, release process
Module layout What each module is for

How it's verified

471 tests, and the ones that matter run against a real PostgreSQL 16 in a container — not mocks. That is a deliberate decision (ADR-005): a guardrail proven only against a fake has been proven against the wrong thing. The interesting failures — default_transaction_read_only, lock escalation, transactional DDL, relfilenode changes on rewrite — are behaviours of the real database.

Suite What it proves
Guardrails & classifier Every refusal rule, against live Postgres
Property-based (Hypothesis) The invariant itself, over inputs nobody thought to write
Red-team 15 named attacks a hostile agent would try — each refused and audited
Live server Real HTTP server, real JWTs, end to end
Benchmarks Latency budgets as regression tripwires, published as CI artifacts

The red-team suite has found real bugs, which is the argument for having it: it caught a confirmation token issued for a refused statement being redeemable against a different one, and a pgops:read token that could call query.write because the scope table was documentation rather than enforcement.

Known limits

Stated here rather than left to be discovered:

  • No per-session database isolation. Auth identifies the caller and scopes limit what they may do, but every caller shares one connection manager and one audit log. Built for one engineer and a few databases, not multi-tenant SaaS.
  • index.advise names the table taking sequential scans, not the column to index — that needs per-statement plan inspection. It says so instead of inventing a CREATE INDEX.
  • DROP INDEX / DROP CONSTRAINT cannot be rolled back, because the object's definition is not captured before the drop. The rollback refuses and explains why rather than reconstructing a guess.

Sample of what migration.plan returns for a type change on the 1.2M-row orders:

ALTER TABLE "orders" ALTER COLUMN "total_cents" TYPE bigint
  op=table_rewrite  risk=high  estimate=4800ms  confidence=medium
  why:   rewrites every row and rebuilds every index, holding AccessExclusiveLock
  SAFER: add a new column of the target type, backfill in batches, sync with a
         trigger, swap the names, then drop the old column

Try it without a database of your own

A seeded stack with the 1.2M-row orders table used in every example above. Host port 5435, so it does not collide with a local Postgres on 5432:

git clone https://github.com/arzharch/pgops-mcp && cd pgops-mcp
docker compose up -d
uvx pgops-mcp --selfcheck --dsn "postgresql://pgops:pgops_dev@localhost:5435/pgops_demo"

MIT licensed. Contributions welcome — see CONTRIBUTING.md.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pgops_mcp-0.1.2.tar.gz (101.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pgops_mcp-0.1.2-py3-none-any.whl (122.0 kB view details)

Uploaded Python 3

File details

Details for the file pgops_mcp-0.1.2.tar.gz.

File metadata

  • Download URL: pgops_mcp-0.1.2.tar.gz
  • Upload date:
  • Size: 101.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for pgops_mcp-0.1.2.tar.gz
Algorithm Hash digest
SHA256 6d5a5e631f55285fd8c299fcbbae3b0573e8655908fc07de016f9c08dcd53970
MD5 0b0aed2119a9715b92aac54f72e5fbe5
BLAKE2b-256 450c62909a71ccd4b8813fb12c678cdd0c8fe92d5f5441c7a625bffab0cef646

See more details on using hashes here.

Provenance

The following attestation bundles were made for pgops_mcp-0.1.2.tar.gz:

Publisher: publish.yml on arzharch/pgops-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pgops_mcp-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: pgops_mcp-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 122.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for pgops_mcp-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 85849d6d0ea6b34054fd66a2bfa8e2fca4bcbc2d59e39adb9c30edfd88baf92e
MD5 08c4d4af6e570d80ee9a5b6cf0251dc9
BLAKE2b-256 aee9fe0e458d5814c3d379d3f19904a30d9c1a9cf8988ee6b181a98c83e961ea

See more details on using hashes here.

Provenance

The following attestation bundles were made for pgops_mcp-0.1.2-py3-none-any.whl:

Publisher: publish.yml on arzharch/pgops-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.1.2 This release

2 files

0.1.1

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page