Tools
Exactly what the server advertised in the scan completed . Effects and capabilities are classified by Squatch from each tool's metadata. Squatch never runs tools. Compared with the previous scan: 0 new, 3 changed.
- Effect: Read 19
- Effect: Write 1
Showing 20 of 20 tools
| Details | ||
|---|---|---|
| latest_release The most recent Total CMS release: version, title, date and the release summary. Returns: paginated releases objects with url per item. | Effect: Write | |
| describe_collection Describe one collection in detail. Returns the collection metadata plus a properties array — each entry is a property with its type, descri… | Effect: Read | |
| describe_view Describe one data view in detail. Returns metadata (id, name, description, last_built, access, total_items) plus output_shape — the list of… | Effect: Read | |
| docs_get Fetch a full Total CMS documentation page as markdown by its path (as returned by docs_search), e.g. "twig/data" or "site-builder/overview". | Effect: Read | |
| docs_lookup Look up a specific Total CMS reference entry: Twig functions/filters, field types, REST API endpoints, schema configuration keys, CLI comma… | Effect: Read | |
| docs_search Search the Total CMS documentation. Returns matching pages with their path, title, group, and section headings. Use docs_get with a returne… | Effect: Read | |
| fetch Fetch the full document for a search result id. Returns {id, title, text, url, metadata}; `text` is the readable body for citation. Pass an… | Effect: Read | |
| find_comparison Find the head-to-head comparison page for a competitor by name (case-insensitive partial match). Returns the full page content including th… | Effect: Read | |
| get_objectChanged Fetch a single object by its id from a collection. Returns the full object as a flat map of fields, decorated with a `url` field where the … | Effect: Read | |
| get_resource Resolve a tcms:// resource URI to its underlying object. Format: tcms://{collection}/{id} — e.g. tcms://blog/hello-world. Equivalent to cal… | Effect: Read | |
| get_view Fetch a data view's full cached result by id. Output is freeform — each item's field set depends on the view's Twig definition. Call descri… | Effect: Read | |
| list_collections Discover the collections visible to you. Lean overview — one entry per collection. Returns id, name (display label), schema (the schema id … | Effect: Read | |
| list_guides The site's Guides: evergreen buying-guide pages served at /guides/{id}. Returns every guide in display order with its id, heading, lede, re… | Effect: Read | |
| list_views Discover the pre-computed data views visible to you. Lean overview — one entry per view. Data views are Twig-defined queries that aggregate… | Effect: Read | |
| needs_review Comparison pages ordered by how long ago their competitor facts were last verified, oldest first. Pass `before` (ISO date) to return only p… | Effect: Read | |
| query_collectionChanged Query a collection for paginated content. Returns the matching items plus pagination metadata (total, limit, offset, has_more); each item i… | Effect: Read | |
| query_view Paginated query against a data view's cached result. REST-syntax include/exclude/sort, same vocabulary as query_collection. View data is fr… | Effect: Read | |
| search Search site content across all collections you can see. Returns matching results as {id, title, url}; pass a result id to `fetch` to read t… | Effect: Read | |
| search_collectionChanged Free-text search within a single collection. Returns matching items decorated with a public `url`; total reflects what was found. Supports … | Effect: Read | |
| search_collections Full-text search across every collection you can see, in one call. Returns matching items each decorated with `collection` (which collectio… | Effect: Read |