MCPg documentation

A landing page for the published docs. Items are grouped roughly by “first read this”, “then this”, “and reach for these when you need them” — pick the section that matches what you’re trying to do.

Get started

• Installation — pip install mcpg, the Docker image, and what the environment variables mean.
• Client integrations — one-click installs for Cursor / VS Code / Claude Desktop, plus setup for Windsurf, JetBrains, Zed, Cline, Antigravity, Qwen Code, Perplexity, ChatGPT, Copilot Studio, Continue, and HTTP clients.
• Demo dataset — mcpg --demo seeds a curated playground schema; a captured walkthrough shows the pivotal tools finding its planted flaws.
• Tour — a guided walkthrough of the tools you’ll reach for most, grouped by what you’re trying to do.
• Cookbook — short, copy-pasteable recipes for the common workflows (read-replica routing, NL→SQL, OIDC bearer auth, RLS, hybrid search, …).

Reference

• Tools — every MCP tool MCPg exposes, including the capability gates that need to be on.
• Architecture — how the pieces fit together (server, drivers, replicas, cursors, audit, transports).
• Scaling guide — pool sizing, replica fan-out, observability, performance tuning notes.
• Performance benchmark — the honest, reproducible overhead result: MCPg’s added latency is small, fixed, and decomposed (t_db is identical to native), with a run-it-yourself harness.
• Token efficiency — the deterministic Tier-A result: MCPg’s compact tool output vs the raw-SQL equivalent (−76 % schema, −96 % query plan), with the honest break-even against the full tool surface (~18 tasks).

Operate

• Security hardening roadmap — shipped vs queued security features.
• PG 19 operations playbook — PostgreSQL 19 behaviour changes that affect operators even when MCPg itself isn’t the surface that exposes them (JIT defaults, LZ4 TOAST, RADIUS removal, OAuth pg_hba, MD5 deprecation, …).
• Release process — the playbook for cutting a new MCPg release to PyPI.
• User guide — end-user-facing reference.

Project history

• Comparison matrix — MCPg against other PostgreSQL MCP servers.
• Feature roadmap — what’s planned, and the persistent home for gaps surfaced during PR / phase retrospectives.
• Progress log — chronological build log.
• Release notes: v0.6.11 · v0.6.10 · v0.6.9 · v0.6.8 · v0.6.7 · v0.6.6 · v0.6.5 · v0.6.4 · v0.6.0 · v0.5.0 · v0.4.0 · v0.3.0 · see CHANGELOG for patch releases and unreleased work.
• Architecture Decision Records — the durable design decisions, one ADR per choice.

---

For the project source, issue tracker, and contribution guidelines, head to github.com/devopam/MCPg.