Home · Quick start · charter.yaml · Sources · Agent · CLI · MCP · About · FAQ

datacharter mcp runs a Model Context Protocol server that exposes your workspace’s data to any MCP client (Cursor, Cline, or your own agent) — safely. The same governance the built-in agent uses is applied to every tool call:

• Read-only — writes and filesystem/remote functions are rejected by the SQL parser guard, regardless of the query the client sends.
• PII-masked — PII columns, whether declared in charter.yaml or auto-detected, are masked in results so the model never sees the raw values; the same agent_access overrides apply here too.
• Credential-scrubbed — connection secrets never appear in errors.

Want to see exactly what a client receives before wiring one up? Open the UI (datacharter serve) and flip Agent view on any result — PII columns render as •••, which is precisely what query returns over MCP.

Run it

datacharter mcp            # serve the workspace in the current directory
datacharter mcp /path/to/workspace

The server speaks JSON-RPC 2.0 over stdio (standard input/output). A charter is required — run datacharter init first if you don’t have one. Diagnostics are written to standard error; standard output carries only the protocol.

DataCharter is published in the official MCP Registry as io.github.datacharter/datacharter, so MCP clients that read the registry can discover it directly.

Tools exposed

Tool	Arguments	Returns
list_sources	—	configured sources and their types
list_tables	—	queryable relations with column names
describe_table	relation	columns and types for one relation
query	sql	rows from a read-only SQL query (PII masked)

Wire it into an MCP client

Most clients take a JSON config that launches the server as a subprocess. For example:

{
  "mcpServers": {
    "datacharter": {
      "command": "datacharter",
      "args": ["mcp", "/path/to/your/workspace"]
    }
  }
}

Use the absolute path to your workspace (the directory containing charter.yaml). If datacharter is installed in a virtual environment, use its full path (or uvx datacharter).

Run it in Docker

The repository ships a Dockerfile that runs the MCP server over stdio with a bundled demo workspace, so it starts and answers introspection out of the box:

docker build -t datacharter-mcp .
docker run -i --rm datacharter-mcp                       # demo workspace
docker run -i --rm -v "$PWD:/workspace" datacharter-mcp  # your own workspace

An MCP client can launch it with "command": "docker", "args": ["run", "-i", "--rm", "datacharter-mcp"].

Scope

This is the local, single-user surface: stdio transport, no authentication — the same trust model as running datacharter serve on your own machine. A network-addressable server with per-caller authentication and authorization is a separate, enterprise-oriented capability and is not part of this command.