Website
Report Builder
Build data reports from a declarative definition. Loads sources (IAPI services or MAPI entities), filters them into groups, formats each row, and writes the result to the report_row entity for a page to render. Used together with pdf_document/render-page for scheduled PDF reports.
Endpoints (2)
Validate a report definition without running it. Returns every problem found, or confirms the spec is valid and echoes the accepted vocabulary. Validation is STRICT: unknown keys are errors rather than being ignored, because a misspelled operator that gets silently skipped produces a report that looks right and is wrong — and these reports run unattended. Pass either spec (inline object) or report (loads reports/{report}.json).
| Field | Type | Required | Description |
|---|---|---|---|
spec |
object | No | The report definition. Top-level keys: report (identifier), title (optional), sources (array, where the data comes from), groups (array, how it is filtered and mapped to report_row columns). |
report |
string | No | Identifier of a stored definition, loaded from reports/{report}.json. Use this instead of spec to check what is actually deployed. |
Execute a report definition and rewrite the report_row entity for that report. Existing rows of the same report are removed first, then the new set is written — all inside a single cache batch, so the whole rebuild costs one invalidation instead of one per row. The definition is validated first and a build is refused when it is invalid. Returns a summary (rows written, groups, source sizes, duration); never the rows themselves.
| Field | Type | Required | Description |
|---|---|---|---|
spec |
object | No | Inline definition. Handy while developing a report; for scheduled runs prefer report so the stored definition is the single source of truth. |
report |
string | No | Identifier of a stored definition, loaded from reports/{report}.json. |
MCP Tool Names
When using this integration through an AI assistant (Claude, ChatGPT, Cursor, etc.), the endpoints are available as MCP tools:
| Endpoint | MCP Tool Name |
|---|---|
| validate | report_builder_validate |
| build | report_builder_build |