Available tools
Search schemas
One tool covers both discovery and fetch-by-ID.- Discovery
- Fetch by ID
Search by keywords, table names, tags, or a description of the data:Each hit returns the table ID, database, schema, table name, description, row count, tags, and score. Bodies are omitted by default so the payload stays small.
advanced search mode isn’t enabled for every organization. If it returns an error, retry with search_mode: "basic" or contact [email protected].Search and browse documentation
search_docs is semantic search over docs.allium.so — use it for data-model questions, API usage, and querying best practices.
browse_docs walks the same content as a filesystem. Every directory has an _index.md listing its contents with descriptions.
- Read
_index.mdat the root to see the top-level sections. - Read a section’s
_index.md(for examplehistorical-data/_index.md). - Drill down through subdirectory index files.
- Read the specific file for table schemas, SQL examples, or API specs.
Realtime tool descriptions include a
docs_path pointing at the exact file that documents their supported chains, edge cases, and response shape. Pass it straight to browse_docs.
Terminal dashboards
Terminal is Allium’s library of public, analyst-built dashboards. Two tools read it, and neither consumes Explorer Units — they read existing definitions and precomputed results.1
Find a dashboard
include_content: true with a small limit for the full rendered dashboard markdown. Never returns raw result rows or SQL.2
List its charts
Call
get_terminal_results with the dashboard_id and no chart_id to get the chart manifest.3
Read a chart
mode is queries for SQL only, results for rows only, or both.Terminal results are precomputed. Cite
result.queried_at when you report values so the reader knows how fresh the numbers are, and link the reader to the Terminal dashboard itself — it carries context and visualizations the raw rows don’t.A typical discovery flow
1
Check Terminal
search_terminal — is this already built? If yes, get_terminal_results for the SQL and use it as your baseline.2
Find the tables
search_schemas with a descriptive query, then fetch the top table by id for full column detail.3
Check the data model
search_docs for the vertical’s conventions — adjusted volume, decimals, re-org handling.4
Load the SQL rules
get_skill(name="sql-optimization") before writing the query.Related resources
SQL & queries
Run the query once you’ve found the tables
Skills
Allium’s own guidance on writing efficient SQL
Data Catalog
The human-readable version of the schema catalog
Terminal
Browse the public dashboards yourself