The full upstream README, mirrored here for reference. Install config, tool schemas, adoption signals, and an original overview live on the Valv listing page.
Let agents query your database. Just not all of it.
valv gives an agent structured tools to read your database — and, opt-in, to write to it. The model emits a structured query (or insert/update/delete) — never a native database command — and valv validates it against your schema, scopes it to the current user with policies you write in code, compiles it for your database, and runs it.
The model's query is treated as fully untrusted. It can't read a column you hid, a row the user isn't allowed to see, call a function you didn't allow, write a column you didn't permit, or escape its tenant on a write. Valv rebuilds and checks the query on the server before it reaches the database adapter.
@valv/mcp-sdk, scoped per request.@valv/mcp at a database and a tool like Claude Code queries it safely — no code required.Install an adapter for your database (it pulls in @valv/core):
Wire it up — connect, write a policy, hand the tools to an agent:
The agent gets four tools — list_resources, search_resources, describe_resource, and query — discovers your schema, and runs a query. valv scopes it to acme, compiles it to ClickHouse SQL, runs it, and hands back rows.
One query tool covers the whole read surface. The grammar is Prisma-idiomatic — a shape models already know cold — and desugars server-side into a checked query:
That's enough for real analytics — filters ({ field: value } equality, operator objects like { gte, lt, in, contains }, and AND/OR/NOT trees), aggregates, time-series (bucket with a function and group by the alias), top-N (order by an aggregate), and conditional aggregation (countIf, sumIf). ClickHouse adds dialect functions like quantileTiming and toStartOfInterval; every function is type-checked and its literals parameterized.
To read a related resource, reference its column with a dotted path from the root. The model can only follow relations declared in your schema; valv derives the joins, picks the keys, and composes the policy of every table it touches — each joined table is scoped by its own policy and field allowlist, so a join can never reach a hidden column or another tenant's rows.
belongsTo and hasMany relations are supported; join depth, table count, and fan-out are capped, and every query runs under a statement timeout. Relations are auto-introspected on Prisma and declared in the schema on ClickHouse.
createValv is async — it loads the schema on construction, so the instance is ready to use. Call it once at startup.
defaultPolicy: "deny-all" (recommended) makes a resource invisible until you write a policy for it.
A policy is a function of your context. It decides what the caller may read, per resource:
read value | Meaning |
|---|---|
true / false | allow / deny outright |
{ field: value } | a row filter, AND-ed into the query server-side |
The model can't widen or override the row filter. Valv injects it after parsing
the model's query and before handing the query to the database adapter. Fields
are denied two ways: fields.deny (a blacklist) or fields.allow (a
whitelist). Denied and unknown columns fail with the same message, so the model
can't probe for hidden columns. Use "*" as the resource name for a default
policy.
The same policy object carries the write axes — create, update, delete (and write as a shorthand for create+update) — which default to denied. See Writes.
valv.tools.<format>(ctx, options) returns provider-ready tools, bound to that context. Discovery is policy-filtered — list/search/describe only surface what the caller may read.
The aisdk format returns self-executing tools (the SDK runs them). The provider formats (anthropic/openai/gemini) return tool definitions for the API request; you dispatch a tool call with runTool:
The discovery tools (list/search/describe) are on by default; the write tools (create/update/delete) are off by default — turn them on per call:
await valv.instructions(ctx) returns a drop-in system-prompt block: how to drive the tools (discover → describe → query, filters are scoped server-side) plus the resources this caller may read — so the model can skip the opening list_resources round-trip. Put it in your system prompt alongside the tools. The static text is also exported as AGENT_INSTRUCTIONS if you'd rather compose the resource list yourself.
Writes are off until you both allow them in policy and expose the tool. Each is its own tool and its own policy axis, with stronger guarantees than reads — the model can't set columns you didn't permit, can't aim a row at another tenant, and can't run an unscoped update/delete:
create force-injects the policy's owned fields (tenant_id) onto the row — the model can't choose, omit, or override them.update/delete AND the policy predicate into your where, which is required (no implicit "all rows"). The model can only touch rows within its scope.readOnly fields aren't writable. A where can only filter by columns the caller can read.create only. MongoDB is
read-only.Because the model emits a plain query object, you can store it and re-run it — a dashboard that refreshes without the LLM in the loop. Replays go through the full pipeline every time, so policy is always re-applied for the current viewer:
resultSchema derives the output shape ([{ name, type }]) from the query alone — handy for driving chart config and detecting drift when the schema changes. A stored query is never trusted: it's re-validated on every replay, so it can't outlive the permissions it was created under.
A worked example. The agent asks for revenue per status and emits:
With the policy read: { tenant_id: ctx.tenant.id } and ctx.tenant.id = "acme", valv emits:
The model never wrote the WHERE clause, and it can't remove it. If it had
selected a denied column (internal_notes), referenced an unknown function, or
hidden a sensitive column inside a sumIf predicate, validation would have
rejected the query before the adapter compiled it. SQL adapters bind values as
parameters instead of concatenating strings. MongoDB emits typed aggregation
pipeline values. Safety doesn't depend on the model behaving.
Expose your database to an agent like Claude Code over the Model Context Protocol — same tools, same policy enforcement.
@valv/mcp needs no code. Run the guided setup, which probes your database and writes the config for you:
Or wire it by hand in your .mcp.json — point it at a connection string:
It introspects the live schema, serves the four tools read-only by default, and works with Prisma-supported SQL databases, ClickHouse, and MongoDB. Narrow access with VALV_TABLES / VALV_EXCLUDE, or take full control with a VALV_POLICY_FILE.
@valv/mcp-sdk turns a valv instance you configure into an MCP server, with policy and per-request context in your hands:
skills/valv is a Claude Code skill that turns a data question into a chart: it queries through the valv MCP and renders the result as a self-contained Chart.js HTML file. Ask it to "visualize revenue by month" and it discovers the schema, runs one structured query, and opens the chart.
It also learns your database as you use it. The first time it describes a table, figures out the dialect's time-bucket function, or maps "revenue" to sum(total) on orders, it records that in .valv/notes.md in your working directory — so later sessions skip the rediscovery and start warm. The notes hold schema and semantics only, never result rows, and the file is plain markdown you can read, edit, or pre-seed yourself.
| Package | Database | Install |
|---|---|---|
@valv/clickhouse | ClickHouse | npm i @valv/clickhouse @clickhouse/client |
@valv/mongodb | MongoDB | npm i @valv/mongodb mongodb |
@valv/prisma | PostgreSQL, MySQL, SQLite, CockroachDB | npm i @valv/prisma @prisma/client |
Everything above the adapter (the query grammar, validation, policy injection, and the tool layer) lives in @valv/core and is database-agnostic. Each adapter introspects its database and runs the validated, policy-injected query. SQL adapters share one emitter; the MongoDB adapter compiles the same query into an aggregation pipeline.
examples/hand-schema — offline, no database: a
hand-defined schema, queries, and resultSchema. The fastest way to see the
pipeline.examples/mongodb — MongoDB introspection, tenant policy,
field allowlisting, and a grouped aggregation.examples/clickhouse-analytics — an agent
answering analytics questions over ClickHouse.examples/ecommerce — an agent over Postgres (Prisma),
plus a saved-query dashboard.MIT