# roow

> Ask your AI tool for answers, generate reports, and make changes using your real business data. roow masks sensitive information, controls access, and requires approval before changes happen.

roow is a remote MCP server in front of a team's databases (Supabase, Neon, PostgreSQL, MySQL, MongoDB). Each
person connects their AI tool with their own token. roow runs what the agent
asks within rules the workspace sets: read-only by default, changes held for a
person's approval (in Slack or the roow console), row limits, protected tables,
and a record of every query.

roow is early and changes quickly.

## Connect an agent

- MCP endpoint: https://api.roow.work/mcp (streamable HTTP)
- Sign in with OAuth (MCP authorization): add the endpoint to your MCP client;
  it registers itself, the person signs in to roow and approves one or more
  databases (each optionally read-only), and the client receives tokens.
  Discovery starts from the 401 on the endpoint and
  `/.well-known/oauth-protected-resource/mcp`.
- Several databases: call `list_databases`, then pass `database` (its name)
  to every tool. With one database it can be left out.
- `join` (two or more SQL databases): 2–5 sources, each
  `{name, database, sql}`, plus one SELECT over those names. Each source is a
  governed query on its own database; only returned rows are combined, in a
  sandbox. A source cut off by its row limit stops the join, so aggregate or
  filter it first.
- Or a personal token: `Authorization: Bearer gcx_…`, made on the
  connection's page in roow and shown once.
- Claude Code: `claude mcp add --transport http roow https://api.roow.work/mcp`

## Tools an agent gets

- `describe_schema()`: List the schemas, tables and columns, so an agent stops guessing names. Works with Supabase, Neon, PostgreSQL, MySQL, MongoDB.
- `check_query(sql)`: Say what a statement would read and write, and whether it would be allowed. Works with Supabase, Neon, PostgreSQL, MySQL.
- `query(sql)`: Run one read-only SQL statement. Works with Supabase, Neon, PostgreSQL, MySQL.
- `export(sql, format, name)`: Run one read-only query and keep the result as a CSV or JSON file in the workspace, under the same policy and row limit as `query`. Works with Supabase, Neon, PostgreSQL, MySQL.
- `write(sql)`: Insert, update or delete rows where this connection permits. A statement that would change more rows than the limit is rolled back. Works with Supabase, Neon, PostgreSQL, MySQL.
- `materialize(sql)`: Create one table from a query, into a destination this connection permits. Works with Supabase, Neon, PostgreSQL, MySQL.
- `list_files()`: List the workspace files this connection may see: its exports, and uploads. Works with Supabase, Neon, PostgreSQL, MySQL, MongoDB.
- `read_file(file_id, offset)`: Read a text file from the workspace, a page at a time. Works with Supabase, Neon, PostgreSQL, MySQL, MongoDB.
- `upload_file(name, content)`: Save text the agent wrote (CSV, JSON or markdown) as a file in the workspace, seen by whoever may use this connection. Off until someone switches it on. Off by default; a workspace admin turns it on. Works with Supabase, Neon, PostgreSQL, MySQL, MongoDB.
- `list_jobs()`: List the jobs on this connection: what each runs, when, and how it last went. Works with Supabase, Neon, PostgreSQL, MySQL.
- `run_job(job_id)`: Run one of this connection's jobs now, as the job, and say how it went. A write the job asks about first waits for a person, as it always does. Works with Supabase, Neon, PostgreSQL, MySQL.
- `job_status(execution_id)`: Look up how a run of one of this connection's jobs went, and the file it kept. Works with Supabase, Neon, PostgreSQL, MySQL.
- `list_migrations()`: List the migrations into or out of this connection and how each last went. For an owner's or admin's token only. Works with Supabase, Neon, PostgreSQL, MySQL.
- `migration_status(migration_id)`: How a migration is going, table by table, and its schema plan: what it builds, and what it left out with the source's SQL, for porting by hand. Works with Supabase, Neon, PostgreSQL, MySQL.
- `run_migration(migration_id, action)`: Start, pause, resume or cancel a migration, as its buttons do. Off until someone switches it on. Off by default; a workspace admin turns it on. Works with Supabase, Neon, PostgreSQL, MySQL.
- `run_status(run_id)`: Look up a run by id: how an agent learns a held run was approved. Works with Supabase, Neon, PostgreSQL, MySQL, MongoDB.
- `auth_users(since, provider, user_id, email_contains, limit)`: Look up the project's Supabase Auth users: when they signed up and last signed in, by which provider, confirmed or not. Email and phone only if the connection allows. Works with Supabase.
- `auth_stats(days)`: Signups and sign-ins per day, and users by provider, over the last N days. Works with Supabase.
- `auth_action(action, user_id, hours)`: Ask for a change to a Supabase Auth user (ban, unban, sign out, confirm email or delete), from the actions this connection allows. Usually held for a person to approve. Works with Supabase.
- `query_documents(collection, pipeline)`: Run one aggregation pipeline against one collection. Works with MongoDB.

A database that `list_databases` marks `stats_only` (set per person) answers
only numbers about groups: `query` there must return GROUP BY keys and
count, sum, avg, stddev or variance of plain columns (joins fine; subqueries
and CTEs in WHERE). If any group came from fewer records than its `min_group_size`, the
whole answer is refused: group more coarsely.

`describe_schema` marks a redacted column with `redacted`: it comes back as
`[redacted]` (hide) or a stable token (hash) that still joins and counts.
A WHERE on it tests the mask, so do not try to filter by its real value.

A change that a rule says to ask about returns `AWAITING_CONFIRMATION` with a
run id: tell the person it is waiting, and check later with `run_status`.

## Docs

- [Docs](https://roow.work/docs): connecting, tools, access rules, approvals, redaction, stats only, files, jobs and migrations
- [Terms and privacy](https://roow.work/terms)
- [Gantry](https://github.com/arvindram03/gantry): the open-source engine roow runs on
