Tools in this category
| Tool | Mutating | Description |
|---|---|---|
list_combined_views |
no | List the user’s combined views — saved, nested, rule-filtered reads that span several entity types at once (e.g. clients with their projects, documents and invoices beneath each). Returns each view’s full spec. To read the ROWS a view produces, call resolve_combined_view. |
get_combined_view |
no | Fetch one combined view by ID, including its full spec. The spec describes what the view reads; it does not contain any records — use resolve_combined_view for those. |
create_combined_view |
yes | Create a combined view from a spec. A spec is { version: 1, levels: [...] }, root level first; each level holds one or more sources, and each source names an entity, the relation it descends through (via, absent at the root), optional pivots to group by, and an optional AND/OR filter tree. Creating a view does not copy or move any records — it saves a query. |
update_combined_view |
yes | Update a combined view’s name, description or spec. Only supplied fields change, so a rename leaves the spec alone. A supplied spec REPLACES the previous one wholesale — read the view first and amend what you fetched rather than sending a partial spec. |
delete_combined_view |
yes | Delete a combined view. The records it displayed are untouched — a view is a saved query, not a container. |
resolve_combined_view |
no | Read ONE level of a combined view, paged. Levels resolve lazily: call with level: 0 for the root, then call again with path set to the ancestors you walked through to open a child level. Pass viewId for a saved view, or spec to resolve one that has not been saved. When the source declares pivots and pivotPath names fewer values than it has, the result is the next level of GROUPS rather than records. |
list_combined_views
Mutating: no
List the user’s combined views — saved, nested, rule-filtered reads that span several entity types at once (e.g. clients with their projects, documents and invoices beneath each). Returns each view’s full spec. To read the ROWS a view produces, call resolve_combined_view.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
page |
integer | no | Page number (default: 1). |
limit |
integer | no | Items per page (default: 20, max: 50). |
get_combined_view
Mutating: no
Fetch one combined view by ID, including its full spec. The spec describes what the view reads; it does not contain any records — use resolve_combined_view for those.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
string | yes | Combined view ID (UUID). |
create_combined_view
Mutating: yes
Create a combined view from a spec. A spec is { version: 1, levels: [...] }, root level first; each level holds one or more sources, and each source names an entity, the relation it descends through (via, absent at the root), optional pivots to group by, and an optional AND/OR filter tree. Creating a view does not copy or move any records — it saves a query.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
name |
string | yes | View name. |
description |
string | no | Free-form description. |
spec |
object | yes | The view specification: { version: 1, levels: [{ sources: [{ id, entity, via?, pivots: [], filter: null }] }] }. Rejected with the offending path if it names an unknown entity, relation, field or operator. |
update_combined_view
Mutating: yes
Update a combined view’s name, description or spec. Only supplied fields change, so a rename leaves the spec alone. A supplied spec REPLACES the previous one wholesale — read the view first and amend what you fetched rather than sending a partial spec.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
string | yes | Combined view ID (UUID). |
name |
string | no | View name. |
description |
string | no | Free-form description. |
spec |
object | no | Replacement view specification; same shape as create_combined_view. |
delete_combined_view
Mutating: yes
Delete a combined view. The records it displayed are untouched — a view is a saved query, not a container.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
string | yes | Combined view ID (UUID). |
resolve_combined_view
Mutating: no
Read ONE level of a combined view, paged. Levels resolve lazily: call with level: 0 for the root, then call again with path set to the ancestors you walked through to open a child level. Pass viewId for a saved view, or spec to resolve one that has not been saved. When the source declares pivots and pivotPath names fewer values than it has, the result is the next level of GROUPS rather than records.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
viewId |
string | no | Saved view to resolve. Omit when passing spec. |
spec |
object | no | An inline spec to resolve without saving it. Omit when passing viewId. |
level |
number | yes | 0-based level to resolve. Root is 0. |
sourceId |
string | yes | Which source at that level, by its id in the spec. |
path |
array | no | Ancestors already opened, root first, as { sourceId, key }. The parent record is re-derived from this, so it states a position in the tree — never which rows to return. |
pivotPath |
array | no | Pivot values already chosen for this source, outermost first. |
page |
integer | no | Page number (default: 1). |
limit |
integer | no | Items per page (default: 20, max: 50). |
Items of path:
sourceId(string)key(string)