Postgres (read-only)

io.github.contextflo由 GitHub 账号 contextflo 发布v0.1.4更新于 Oct 24, 2026

Read-only Postgres: drop-in for the archived server-postgres, with schema context.

已验证STDIO仅桌面数据库数据与分析

概览

AI 生成的概览

本地运行的只读 Postgres 服务器,让助手执行 SELECT 查询、查看表结构,并维护一份共享的表说明上下文文件。

可以做什么
  • 一次执行一条只读语句:SELECT、WITH ... SELECT、EXPLAIN 或 SHOW,并受行数与输出上限约束。
  • 列出可读的表,并按名称或描述中的模式筛选。
  • 详细描述表:列、类型、键、外键目标、枚举值和人工撰写的说明。
  • 把关于表和列的注意事项追加到 markdown 上下文文件,后续会话会把它提供给模型。
  • 把表结构以 postgres:// 资源形式暴露,供依赖这些 URI 的客户端使用。
适用场景
当助手需要探索或查询 Postgres 数据库做分析,并且希望从设计上阻止写入时使用。适合希望模型通过可版本管理的上下文文件了解业务定义和表陷阱的团队。它也是已归档 server-postgres 的直接替代品。
运行要求
需要本地 Node.js 运行时,因为它以 npm 包形式通过 npx 和 stdio 运行。需要 DATABASE_URL 中的 Postgres 连接串,最好放在工作目录的 .env 文件中,或作为参数传入。建议使用只读数据库角色。可选参数可设置行数上限、语句超时、上下文文件路径、查询日志,以及带 AUTH_TOKEN 的 HTTP 模式。
安装前请注意
连接串是机密信息,应放在 .env 而不是命令行上。只读不等于低开销:助手的查询可能触发全表扫描,建议指向只读副本或分支。角色能读到什么,模型就能读到什么,只授予希望助手看到的数据。助手可以追加上下文文件内容,请审阅这些改动。把 HTTP 绑定到 0.0.0.0 会暴露一个实时数据库连接,应设置 AUTH_TOKEN 并使用私有网络。

安装

在 SourceWeft 中

  1. 打开 控制台中的 Postgres (read-only),将其添加到工作区。
  2. 为需要使用其工具的对话启用该服务。

Desktop only,通过 STDIO。 STDIO 服务会启动本地进程,因此需要 SourceWeft 桌面宿主。

其他 MCP 客户端

参照 仓库 中的启动说明。

README

@contextflo/postgres-mcp

The analytics MCP server for Postgres. Read-only by construction, with a context file you and the agent both write to, so the model answers the way your team would.

Built and maintained by Contextflo.

A drop-in replacement for the archived @modelcontextprotocol/server-postgres, which shipped with a SQL injection vulnerability that let COMMIT; DROP SCHEMA public CASCADE walk straight out of its read-only transaction.

Watch the 100-second demo: setup, the agent working out that an events table is not what it looks like and saving that as a note, and a DROP the server refuses.

bash
npx @contextflo/postgres-mcp postgresql://localhost/mydb

Why this one

Read-only that holds up. The archived server enforced read-only as a property of the SQL string. Here it is a property of the wire protocol, the connection, the Postgres parser, and the database role: four independent layers, each of which stops that payload on its own. The exploit is a test case in this repo.

Answers that make sense. A model that does not know fct_orders_v2 is the table your team actually uses, or that revenue is gross rather than net, writes confident, wrong SQL. .contextflo/context.md is a markdown file you edit and this server hands to the model, with nothing behind it but the file. The agent adds to it too: when it learns something the schema does not say, add_table_context appends a note, which you review in a diff like any other change.

Setup

1. Create a read-only role. Run this as the database owner, in psql or your provider's SQL editor. Use your database name and a real password, and repeat the schema lines for each schema the agent should see:

sql
CREATE ROLE mcp_readonly LOGIN PASSWORD 'change-me';GRANT CONNECT ON DATABASE mydb TO mcp_readonly;GRANT USAGE ON SCHEMA public TO mcp_readonly;GRANT SELECT ON ALL TABLES IN SCHEMA public TO mcp_readonly;ALTER DEFAULT PRIVILEGES IN SCHEMA public GRANT SELECT ON TABLES TO mcp_readonly;

This makes read-only a property of the database, not just of this server's code.

2. Put that role's connection string in .env in your project folder:

bash
DATABASE_URL='postgresql://mcp_readonly:[email protected]:5432/mydb'

Keep the quotes: hosted providers add ?sslmode=require&..., and the & needs them. The server reads DATABASE_URL from .env in the directory it starts in, so the connection string never appears on a command line.

Point it at a read replica or a branch rather than your primary if you can. Read-only stops writes, not load: an agent exploring your data can run a full-table scan or a heavy join, and on the primary that competes with your application. Neon and Supabase can branch or replicate a database in a few clicks, and RDS, Cloud SQL, and most other hosts offer read replicas. The statement timeout (30 seconds by default, --statement-timeout) and the row cap limit how long one query runs and how much it returns; they do not make it cheap.

3. Generate the context file:

bash
npx @contextflo/postgres-mcp init

That writes .contextflo/context.md, seeded from your COMMENT ON values. Edit it: the business definitions section is where the value is.

4. Add it to your client. Claude Code starts servers in your project folder, so it finds .env and the context file on its own:

bash
claude mcp add postgres --scope project -- npx -y @contextflo/postgres-mcp

--scope project writes .mcp.json into the folder instead of your global config.

Cursor, Claude Desktop, VS Code

Other clients may start servers outside your project folder (Claude Desktop starts them in /), so give them the connection string and the context file explicitly:

json
{  "mcpServers": {    "postgres": {      "command": "npx",      "args": ["-y", "@contextflo/postgres-mcp", "--context-file", "/path/to/project/.contextflo/context.md"],      "env": { "DATABASE_URL": "postgresql://mcp_readonly:[email protected]:5432/mydb" }    }  }}

Cursor uses .cursor/mcp.json. Claude Desktop uses claude_desktop_config.json (macOS: ~/Library/Application Support/Claude/, Windows: %APPDATA%\Claude\). VS Code uses .vscode/mcp.json, with servers in place of mcpServers.

Tools

ToolWhat it does
queryRuns one read-only statement: SELECT, WITH ... SELECT, EXPLAIN, or SHOW.
list_tablesLists readable tables with descriptions. pattern matches anywhere in the name or description.
get_table_contextDescribes tables: columns, types, keys, foreign key targets, enum values, curated descriptions.
add_table_contextLets the agent write down a gotcha it found (amount is in cents, status has an undocumented value) in the context file.

There is no separate search tool, and that is deliberate. information_schema and pg_catalog are ordinary tables, so anything more specific, like finding every column named like %revenue% or listing tables with no primary key, is a query the model can write itself:

sql
SELECT table_schema, table_name, column_nameFROM information_schema.columnsWHERE column_name ILIKE '%revenue%';

Table schemas are also exposed as postgres://<host>/<table>/schema resources, matching the archived server, for anything pinned to those URIs. Most clients never fetch resources on their own, which is why discovery lives in the tools.

How read-only is enforced

Four layers. Each one stops the archived server's exploit by itself.

1. Extended query protocol. User SQL goes through pg-cursor, which always issues Parse/Bind/Execute, so Postgres itself rejects multi-statement input. The archived server called client.query(sql) with a bare string; node-postgres only prepares a statement when there are bind values, so that took the simple protocol path, where ; separates statements. That is the whole bug.

2. Connection-level read-only. default_transaction_read_only=on is set in the startup packet, and every statement runs inside an explicit BEGIN READ ONLY that always ends in ROLLBACK, never COMMIT. The rollback also undoes any SET made inside the transaction, so a statement cannot leave a pooled connection weakened for whoever gets it next.

3. A statement allowlist on the real Postgres parser. libpg-query is the actual Postgres C parser compiled to WASM, not a JavaScript approximation of SQL. The whole parse tree is walked rather than just the top-level node, which is what catches a data-modifying CTE:

sql
WITH x AS (INSERT INTO users VALUES (1) RETURNING *) SELECT * FROM x

That parses as a SelectStmt. A validator checking only the statement type runs it. Unknown node types fail closed.

Functions are checked against the database's own catalog. Postgres labels every function immutable, stable, or volatile, and only volatile ones can have side effects, so a volatile function is refused unless it is on a short list of harmless ones analysis needs (random(), clock_timestamp(), the table size functions). That covers dblink, pg_logical_emit_message (which writes to the WAL even in a read-only transaction), advisory locks, statistics resets, and whatever a future Postgres adds, without anyone having to name them. SECURITY DEFINER functions, which run with their owner's privileges, are refused whatever their label. A fixed list of known escapes is checked as well.

4. A read-only database role. The layers above are code, and code has bugs. A role that cannot write is enforced by Postgres regardless, which is why creating one is the first step of Setup. The server warns on startup if you connect as a superuser, and init prints the role snippet if the role it connects as can write.

What this does not protect against. The function check sees the functions a query calls directly, and it trusts how each is labelled. A user-defined function declared STABLE that writes anyway is allowed, and so is a function reached indirectly: inside a view, behind an operator, or through a type cast. The read-only transaction still refuses anything that changes table data that way; what can slip through is the rarer kind of side effect, such as a message written to the WAL. Layer 4 is what stops those, which is why the read-only role is the recommended setup rather than an optional extra. Read-only is also not confidentiality: anything the connected role can read, a model can read, so grant it only what you want an agent to see.

Migrating from @modelcontextprotocol/server-postgres

Swap the package name. The tool is still called query, still takes sql, still returns JSON rows, and the connection string is still the first argument.

Four deliberate differences:

  1. Multi-statement SQL and SET/RESET are rejected with a clear error. On the archived server these "worked", and that was the vulnerability.
  2. Results are capped at 1000 rows and 50,000 characters by default, and single values over 2,000 characters are shortened. Truncation is stated in the output, never silent. Rows come back one per line rather than pretty-printed, which roughly halves their token cost; it is still a JSON array. Dates and timestamps are exactly what Postgres sent, not re-rendered in the server's timezone.
  3. Schema discovery is a tool, not just a resource. Most clients do not auto-attach resources, which is why models using the old server so often did not know the schema.
  4. All non-system schemas are visible, not only public, and column descriptions come through from COMMENT ON.

Options

--max-rows <n>            Maximum rows returned per query (default: 1000)--max-output-chars <n>    Character budget for one query result (default: 50000)--statement-timeout <ms>  Server-side statement timeout (default: 30000)--context-file <path>     Curated schema context (default: .contextflo/context.md)--no-context-writes       Do not offer add_table_context; the context file is only read--log-file <path>         Query audit log (default: .contextflo/log.md once that directory exists)--no-log                  Never write a query log--http                    Serve over streamable HTTP instead of stdio--port <n>                HTTP port (default: 8080)--host <addr>             HTTP bind address (default: 127.0.0.1)

DATABASE_URL supplies the connection string if you do not pass one, from the environment or from .env in the current directory. The server connects on first use: without a connection string it still starts and lists its tools, and each tool call says what is missing. AUTH_TOKEN, with --http, requires that value as a bearer token.

Connection poolers. PgBouncer (and so the pooled connection strings from Supabase, Neon, and others) refuses the startup parameters this server normally sends. When that happens it reconnects without them and says so on stderr. Nothing is weakened: every statement still runs in BEGIN READ ONLY with its own statement timeout, and CI runs the read-only suite through PgBouncer in transaction mode.

The context file

markdown
# Database context
Revenue means gross, before refunds."Active customer" means an order in the last 90 days.
## Tables
### public.ordersOne row per customer order. Source of truth for revenue, not `orders_legacy`.
- revenue_usd: Gross revenue, before refunds. Net lives in `order_refunds`.- status: One of pending, paid, refunded.

Everything above ## Tables is handed to the model: as server instructions, and again at the top of list_tables, because several clients never show the model server instructions. HTML comments are left out. Under ## Tables, a ### heading names a table, the prose beneath describes it, and - column: meaning lines describe columns (a dash separator works too). Your text wins over COMMENT ON. Edits take effect on the next tool call; no restart.

A relative --context-file resolves against the directory the client starts the server in. Claude Desktop starts servers in /, so there it falls back to your home directory (~/.contextflo/context.md). For a file that lives in a repo, pass an absolute path. The server prints the path it is using on startup.

The agent adds to it. When the model finds something the schema does not say (amount is in cents, status also holds 'void' on old rows, every query needs deleted_at IS NULL), add_table_context appends it to this file, and every later session starts knowing it. Notes are only ever appended, never substituted for what you wrote, and only for tables and columns that exist. Treat them like any other change: keep the file in git and read the diff. A model can be wrong, and text inside your data can steer what it writes, so a note is a suggestion until someone has looked at it. --no-context-writes turns the tool off.

init seeds this from existing comments, and only for columns that already have one. A file with a blank placeholder for all 4000 columns is a file nobody edits.

Richer context generated from your code and docs, and shared across a team, is what contextflo.com does.

Query log

Once .contextflo/ exists, every statement is appended to .contextflo/log.md with its outcome, row count, and duration. It is written for you, not fed back to the model. --no-log turns it off.

Docker

bash
docker run -i --rm ghcr.io/contextflo/postgres-mcp postgresql://host.docker.internal/mydb

For a remote endpoint, see docker-compose.example.yml. Note what you are doing before you bind 0.0.0.0: that is a live database connection on a port. Set AUTH_TOKEN, keep it inside a private network, and terminate TLS in front of it, because the token is plaintext on the wire otherwise. The server prints a warning when it is exposed without a token.

On the default loopback bind, requests whose Host or Origin is not local are refused. That is what stops a web page from using DNS rebinding to reach a server on 127.0.0.1 through your browser.

Development

bash
npm installnpm run buildnpm test
npm run db:up   # throwaway Postgres for the integration suite (needs Docker)TEST_DATABASE_URL=postgres://postgres:postgres@localhost:55432/postgres npm testnpm run db:down

The integration suite deliberately bypasses the parser and drives the database directly, so it proves the wire and transaction layers rather than the validator. It skips without TEST_DATABASE_URL and is required to run in CI.

Security

Please report vulnerabilities privately. See SECURITY.md.

License

MIT

来源:README.md,提交 f370d7d

工具

0
SourceWeft 尚未在沙箱中启动过该软件包,因此其工具未知。

版本历史

1
  1. v0.1.4最新Sep 28, 2026

评分

已满足适用检查项的 50%

该评分衡量此收录条目的完整程度,依据注册中心条目、端点与公开来源计算得出。它不是对服务器本身的评价,也不表示服务器安全或当前可用:可连通性是带日期的检查结果,评分也不包含安装量或用户评价。

  • 近 30 天内可连通25 分

    请保持端点能够响应 MCP 握手;SourceWeft 每 30 天探测一次。

  • 已声明认证方式10 分

    请在注册中心条目中声明凭据请求头,或保持端点能够响应探测,以便判定其认证方式。

  • 已列出工具15 分

    请让服务器在无凭据时响应 tools/list,或发布可在沙箱中无凭据启动的软件包。

  • 描述必需15 分
  • 图标10 分
  • 文档15 分
  • 许可证10 分