Tools reference

Every MCP tool your AI assistant gets from Orcabase, grouped by what it does, plus what’s deliberately left out: no edits, deletes or settings.

These are the tools Orcabase gives an AI assistant over MCP. The built-in Data Agent uses the same ones, except the two notebook tools, plus one of its own for drawing charts in the chat. Every tool acts on the organization the token belongs to.

Discover

ToolWhat it does
list_data_sourcesLists the data sources the assistant can query: name, engine (Postgres, BigQuery or DuckDB) and kind.
list_schemasLists the schemas (BigQuery datasets) in a data source.
list_tablesLists the tables and views in a schema.
describe_tableA table’s columns and types, so SQL is written against the real schema instead of guesses.
preview_tableA handful of sample rows, to see real values, formats and codes.

Query

ToolWhat it does
run_queryRuns SQL against a data source and returns the result (up to 5,000 rows). Saves nothing.
list_queriesLists saved queries, so existing work is reused rather than rewritten.
run_saved_queryRe-runs a saved query and saves its new result, which is what dashboards show.

Metrics and data models

ToolWhat it does
list_metricsYour metrics, certified first, with their descriptions and status.
describe_metricOne metric in words, and every field it can be split or filtered by, with time grains.
query_metricsComputes metrics from their definitions, grouped and filtered, and returns the rows plus the SQL that ran.
list_data_modelsYour data models, with their dimensions, measures and joins.
describe_data_modelOne data model in full, including the SQL behind each dimension and measure.
scaffold_data_modelDrafts a data model from a table’s columns. Saves nothing.
create_data_modelCreates a new data model. Fails if the name is taken, so it never overwrites one.
create_metricCreates a new metric, always as a draft for a person to certify.

Metrics first

The tool descriptions tell assistants to reach for query_metrics whenever a certified metric fits the question, and to write SQL only when none does. That’s what keeps an assistant’s numbers matching your dashboards.

Build

ToolWhat it does
save_querySaves SQL, or a metric query, as a query in Orcabase, optionally with its chart.
list_dashboardsLists dashboards.
get_dashboardA dashboard and the charts already on it.
create_dashboardCreates an empty dashboard.
add_widgetPins a saved query’s chart to a dashboard. Without a position, it takes the first free spot.
create_notebookCreates an empty notebook. Not available to the built-in agent.
add_notebook_cellAdds a SQL cell (saving a new query) or a text cell to a notebook. Not available to the built-in agent.

Deliberately left out

There are no tools to edit or delete anything, to certify or deprecate metrics, to add data sources or upload data, or to manage members, tokens and settings. Those stay with people, in Orcabase. See What it can’t do.

Something unclear or missing? Troubleshooting covers the common errors, or message us.

↑↓ to move↵ to openesc to close