Describe Schema
describe_schemaRead-onlyIdempotent
Return the semantic layer: marts, columns, invariants, canonical payers, and the tools YOU can call (the same list tools/list returns for you, never a wider catalog). Compact by default (a manifest: marts + a name + one-line summary per tool, under ~8K chars). Fetch one section with describe_schema(section='') / section='tools' / section='invariants'. Pass verbosity='full' for the previous full payload. Agents call this first to learn the surface, then fetch the section or tool they need.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| offset | No | ||
| section | No | ||
| mart_name | No | ||
| verbosity | No | compact | |
| include_examples | No | ||
| include_invariants | No |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| unit | No | ||
| as_of | No | ||
| value | No | ||
| source | No | ||
| status | No | complete | |
| caveats | No | ||
| failure | No | ||
| quality | No | ||
| refusal | No | ||
| vintage | No | ||
| explanation | No | ||
| methodology | No | ||
| tool_version | No | unknown | |
| response_hash | No | ||
| freshness_state | No | unknown | |
| semantic_version | No | ||
| invariants_applied | No |