Total CMS docs, guides and CMS comparisons: Twig, field types, schemas, CLI, REST API and releases.
co.totalcms/docs — Model Context Protocol (MCP) Server
co.totalcms/docs is a read-only MCP server that exposes Total CMS documentation content. The provided materials cover Twig signatures, field types, schema options, as well as the Total CMS CLI and REST API. This server is intended for developers who need documentation references via an MCP integration.
🛠️ Key Features
Read-only access to Total CMS docs
Documentation coverage includes Twig signatures
Documentation coverage includes field types
Documentation coverage includes schema options
Documentation coverage includes the CLI
Documentation coverage includes the REST API
🚀 Use Cases
Looking up Total CMS documentation details for Twig signatures
Reviewing available field types for Total CMS implementations
Checking schema options and how they are documented
Accessing CLI and REST API documentation via MCP
⚡ Developer Benefits
Centralized access to Total CMS docs for development contexts
Developer-focused reference on Twig, schema, CLI, and REST API
Describe one collection in detail. Returns the collection metadata plus a properties array — each entry is a property with its type, description, and indexed/filterable/sortable flags. Call list_collections first to find a collection id, then describe_collection to see what is queryable inside it. `indexed: true` means the property appears in query_collection / search_collection results (and may be filterable/sortable). `indexed: false` means the property exists on objects but is not returned by query/search — retrieve it through get_object instead.
Parameters1
collection
string
required
Collection id (slug-form). Use list_collections to discover available collections.
Raw schema
{
"type": "object",
"properties": {
"collection": {
"type": "string",
"description": "Collection id (slug-form). Use list_collections to discover available collections.",
"examples": [
"blog",
"products",
"team"
]
}
},
"required": [
"collection"
],
"additionalProperties": false
}
describe_view
Describe one data view in detail. Returns metadata (id, name, description, last_built, access, total_items) plus output_shape — the list of keys present on the first cached item, sampled so agents can compose effective query_view / get_view calls. Admin callers also receive the view's Twig definition for dev visibility. Use list_views to discover view ids first.
Parameters1
id
string
required
View id. Use list_views to discover available views.
Look up a specific Total CMS reference entry: Twig functions/filters, field types, REST API endpoints, schema configuration keys, CLI commands, extension API, or builder API. Omit `name` to list all entries of a kind.
Parameters2
kind
string
required
name
string
optional
Entry name (function name, field type, "GET /api/collections", command name…). Omit to list the kind.
Raw schema
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"twig_function",
"twig_filter",
"field_type",
"api_endpoint",
"schema_config",
"cli_command",
"extension_api",
"builder_api"
]
},
"name": {
"type": "string",
"description": "Entry name (function name, field type, \"GET /api/collections\", command name…). Omit to list the kind."
}
},
"required": [
"kind"
]
}
docs_search
Search the Total CMS documentation. Returns matching pages with their path, title, group, and section headings. Use docs_get with a returned path to read the full page.
Parameters2
query
string
required
Search terms, e.g. "image resize twig" or "webhook automation"
Fetch the full document for a search result id. Returns {id, title, text, url, metadata}; `text` is the readable body for citation. Pass an id returned by the `search` tool.
Parameters1
id
string
required
A document id returned by the `search` tool.
Raw schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "A document id returned by the `search` tool."
}
},
"required": [
"id"
],
"additionalProperties": false
}
find_comparison
Find the head-to-head comparison page for a competitor by name (case-insensitive partial match). Returns the full page content including the feature table.
Parameters:
- competitor (string, required): Competitor name, e.g. "Kirby" or "Craft".
Returns: paginated comparisons objects with url per item.
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 collection has a public URL pattern configured. This tool does not search or filter — use query_collection for paginated lists or search_collection for free-text search.
Available collections and filterable properties:
- articles — id (id, sortable), title (text), author (select), summary (textarea), date (date, sortable), draft (toggle), updated (datetime, sortable)
- comparisons — competitor (text), competitorUrl (url), heading (text), lede (textarea), reviewed (date, sortable), draft (toggle), sort (number, sortable), id (id, sortable)
- extension — id (id, sortable), name (text), extensionId (text), soldAs (text), summary (textarea), category (select), price (number, sortable), currency (select), minEdition (select), minVersion (text), bundled (toggle), beta (toggle), docsUrl (url), productUrl (url), draft (toggle), owner (select), featured (toggle), approved (datetime, sortable), submitted (datetime, sortable), weight (range, sortable)
- guides — heading (text), lede (textarea), reviewed (date, sortable), draft (toggle), sort (number, sortable), id (id, sortable), kind (select), product (select)
- releases — id (id, sortable), version (text), title (text), date (date, sortable), draft (toggle), urgent (toggle), fullnotesurl (url), announce (toggle)
- showcase — name (text), url (url), industry (select), id (id, sortable), owner (select), draft (toggle), featured (toggle), approved (datetime, sortable), submitted (datetime, sortable), weight (range, sortable)
Parameters4
collection
string
required
Collection id. Use list_collections to discover available collections.
id
string
required
Object id (slug). Get candidate ids from query_collection or search_collection output.
format
string
optional
Rendered format for content fields. Accepted now for forward-compat; full conversion ships with the Tiptap→markdown converter in a later release.
locale
string
optional
BCP 47 locale tag. Accepted for forward-compat with the 3.6 i18n release — has no effect today.
Raw schema
{
"type": "object",
"properties": {
"collection": {
"type": "string",
"description": "Collection id. Use list_collections to discover available collections.",
"examples": [
"blog",
"products"
]
},
"id": {
"type": "string",
"description": "Object id (slug). Get candidate ids from query_collection or search_collection output.",
"examples": [
"hello-world",
"fall-collection-2025"
]
},
"format": {
"type": "string",
"enum": [
"markdown",
"html",
"text"
],
"default": "markdown",
"description": "Rendered format for content fields. Accepted now for forward-compat; full conversion ships with the Tiptap→markdown converter in a later release."
},
"locale": {
"type": "string",
"default": "",
"description": "BCP 47 locale tag. Accepted for forward-compat with the 3.6 i18n release — has no effect today."
}
},
"required": [
"collection",
"id"
],
"additionalProperties": false
}
get_resource
Resolve a tcms:// resource URI to its underlying object. Format: tcms://{collection}/{id} — e.g. tcms://blog/hello-world. Equivalent to calling get_object with the parsed collection and id; returns the same shape. Use this when a URI has been surfaced to you (in other tool output, in user input, etc.); use get_object directly when you have a separate collection + id pair. Extension-registered URIs (other schemes) are reachable via the resources/read transport surface.
Parameters1
uri
string
required
A tcms:// resource URI identifying one object. Format: tcms://{collection}/{id}.
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 describe_view first to learn the expected shape. Capped at 50 items; larger views return the first 50 plus a hint to call query_view for pagination. For per-item paginated access use query_view directly.
Parameters3
id
string
required
View id. Use list_views to discover available views.
format
string
optional
Forward-compat with collection tools. View data is freeform so this has no effect today.
locale
string
optional
BCP 47 locale tag — forward-compat for the 3.6 i18n release. No effect today.
Raw schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "View id. Use list_views to discover available views.",
"examples": [
"recent-posts",
"monthly-sales-summary"
]
},
"format": {
"type": "string",
"enum": [
"markdown",
"html",
"text"
],
"default": "markdown",
"description": "Forward-compat with collection tools. View data is freeform so this has no effect today."
},
"locale": {
"type": "string",
"default": "",
"description": "BCP 47 locale tag — forward-compat for the 3.6 i18n release. No effect today."
}
},
"required": [
"id"
],
"additionalProperties": false
}
latest_release
The most recent Total CMS release: version, title, date and the release summary.
Returns: paginated releases objects with url per item.
Parameters
No parameters.
Raw schema
{
"type": "object",
"properties": {}
}
list_collections
Discover the collections visible to you. Lean overview — one entry per collection. Returns id, name (display label), schema (the schema id this collection uses), description, url_pattern, access level, and total_objects (so you can decide whether to paginate or enumerate). For the per-property detail of one collection (which properties exist, which are filterable/sortable), call describe_collection. Then query_collection / search_collection / get_object for the data.
The site's Guides: evergreen buying-guide pages served at /guides/{id}. Returns every guide in display order with its id, heading, lede, reviewed date and draft flag. A guide's full content (contenders, choose, howToChoose, faqs, sources) is on the object itself: get_object with collection "guides".
Returns: paginated guides objects with url per item.
Parameters
No parameters.
Raw schema
{
"type": "object",
"properties": {}
}
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 across collections; their result is cached and accessible by id. Returns id, name, description, last_built, and access. Use the id with query_view (paginated query), get_view (fetch the whole cached result), or describe_view (output shape + metadata). For raw collection content use list_collections instead.
Comparison pages ordered by how long ago their competitor facts were last verified, oldest first. Pass `before` (ISO date) to return only pages last verified before that date. Each page shows its verification date publicly, so keeping these fresh matters.
Parameters:
- before (string, optional): Only pages whose reviewed date is on or before this ISO date (optional).
Returns: paginated comparisons objects with url per item.
Parameters1
before
string
optional
Only pages whose reviewed date is on or before this ISO date (optional).
Raw schema
{
"type": "object",
"properties": {
"before": {
"type": "string",
"description": "Only pages whose reviewed date is on or before this ISO date (optional).",
"format": "date"
}
}
}
query_collection
Query a collection for paginated content. Returns the matching items plus pagination metadata (total, limit, offset, has_more); each item is decorated with a public `url` field where one is configured. Use REST-style `include` / `exclude` filter strings (comma-separated field:value pairs; AND-semantics for include, OR-semantics for exclude) and `sort` (e.g. `date:desc`). Only properties listed in the catalog below are queryable — other schema properties exist on objects but are not filterable here; use get_object if you need the full record or describe_collection to see every property. This tool does not free-text search content — use search_collection for that. It does not fetch a single object by id — use get_object.
Available collections and filterable properties:
- articles — id (id, sortable), title (text), author (select), summary (textarea), date (date, sortable), draft (toggle), updated (datetime, sortable)
- comparisons — competitor (text), competitorUrl (url), heading (text), lede (textarea), reviewed (date, sortable), draft (toggle), sort (number, sortable), id (id, sortable)
- extension — id (id, sortable), name (text), extensionId (text), soldAs (text), summary (textarea), category (select), price (number, sortable), currency (select), minEdition (select), minVersion (text), bundled (toggle), beta (toggle), docsUrl (url), productUrl (url), draft (toggle), owner (select), featured (toggle), approved (datetime, sortable), submitted (datetime, sortable), weight (range, sortable)
- guides — heading (text), lede (textarea), reviewed (date, sortable), draft (toggle), sort (number, sortable), id (id, sortable), kind (select), product (select)
- releases — id (id, sortable), version (text), title (text), date (date, sortable), draft (toggle), urgent (toggle), fullnotesurl (url), announce (toggle)
- showcase — name (text), url (url), industry (select), id (id, sortable), owner (select), draft (toggle), featured (toggle), approved (datetime, sortable), submitted (datetime, sortable), weight (range, sortable)
Parameters8
collection
string
required
Collection id (slug-form). Use list_collections to discover available collections.
include
string
optional
Comma-separated field:value pairs items must ALL match. Wildcards "*foo*", "foo*", "*foo" supported.
exclude
string
optional
Comma-separated field:value pairs that exclude items (OR). Drafts the caller may not see are removed before this filter runs, whatever it says.
sort
string
optional
Sort rule "field:direction"; multiple rules comma-separated. Only fields marked sortable in the catalog will sort.
limit
integer
optional
Maximum items to return. Capped at 50 (vs. REST's 100) to fit MCP response-size budgets.
offset
integer
optional
Number of items to skip — combine with limit for pagination.
format
string
optional
Rendered format for content fields. Accepted now for forward-compat; full conversion ships with the Tiptap→markdown converter in a later release.
locale
string
optional
BCP 47 locale tag. Accepted for forward-compat with the 3.6 i18n release — has no effect today.
Raw schema
{
"type": "object",
"properties": {
"collection": {
"type": "string",
"description": "Collection id (slug-form). Use list_collections to discover available collections.",
"examples": [
"blog",
"products",
"team"
]
},
"include": {
"type": "string",
"default": "",
"description": "Comma-separated field:value pairs items must ALL match. Wildcards \"*foo*\", \"foo*\", \"*foo\" supported.",
"examples": [
"featured:true",
"category:tech,published:true"
]
},
"exclude": {
"type": "string",
"default": "",
"description": "Comma-separated field:value pairs that exclude items (OR). Drafts the caller may not see are removed before this filter runs, whatever it says.",
"examples": [
"draft:true",
"status:archived,featured:false"
]
},
"sort": {
"type": "string",
"default": "",
"description": "Sort rule \"field:direction\"; multiple rules comma-separated. Only fields marked sortable in the catalog will sort.",
"examples": [
"date:desc",
"title:asc"
]
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 50,
"default": 10,
"description": "Maximum items to return. Capped at 50 (vs. REST's 100) to fit MCP response-size budgets."
},
"offset": {
"type": "integer",
"minimum": 0,
"default": 0,
"description": "Number of items to skip — combine with limit for pagination."
},
"format": {
"type": "string",
"enum": [
"markdown",
"html",
"text"
],
"default": "markdown",
"description": "Rendered format for content fields. Accepted now for forward-compat; full conversion ships with the Tiptap→markdown converter in a later release."
},
"locale": {
"type": "string",
"default": "",
"description": "BCP 47 locale tag. Accepted for forward-compat with the 3.6 i18n release — has no effect today."
}
},
"required": [
"collection"
],
"additionalProperties": false
}
query_view
Paginated query against a data view's cached result. REST-syntax include/exclude/sort, same vocabulary as query_collection. View data is freeform — call describe_view first to learn the field set before composing filters. `limit` is capped at 50; use offset to paginate larger views.
Parameters8
id
string
required
View id from list_views.
include
string
optional
REST-style filter, e.g. "category:tech,published:true". Field names depend on the view's output shape.
exclude
string
optional
REST-style negative filter.
sort
string
optional
Sort spec, e.g. "date:desc".
limit
integer
optional
offset
integer
optional
format
string
optional
Forward-compat with query_collection; no effect today since view data is freeform.
Search site content across all collections you can see. Returns matching results as {id, title, url}; pass a result id to `fetch` to read the full document. Drafts are hidden from anonymous callers.
Free-text search within a single collection. Returns matching items decorated with a public `url`; total reflects what was found. Supports AND (default), OR, and "quoted phrases". Searches across the properties listed in the catalog below — other schema properties exist on objects but are not searchable here; use get_object for the full record or describe_collection to see every property. This tool does not filter by field value — use query_collection with `include`/`exclude` for that. Drafts are auto-hidden from anonymous callers.
Available collections and filterable properties:
- articles — id (id, sortable), title (text), author (select), summary (textarea), date (date, sortable), draft (toggle), updated (datetime, sortable)
- comparisons — competitor (text), competitorUrl (url), heading (text), lede (textarea), reviewed (date, sortable), draft (toggle), sort (number, sortable), id (id, sortable)
- extension — id (id, sortable), name (text), extensionId (text), soldAs (text), summary (textarea), category (select), price (number, sortable), currency (select), minEdition (select), minVersion (text), bundled (toggle), beta (toggle), docsUrl (url), productUrl (url), draft (toggle), owner (select), featured (toggle), approved (datetime, sortable), submitted (datetime, sortable), weight (range, sortable)
- guides — heading (text), lede (textarea), reviewed (date, sortable), draft (toggle), sort (number, sortable), id (id, sortable), kind (select), product (select)
- releases — id (id, sortable), version (text), title (text), date (date, sortable), draft (toggle), urgent (toggle), fullnotesurl (url), announce (toggle)
- showcase — name (text), url (url), industry (select), id (id, sortable), owner (select), draft (toggle), featured (toggle), approved (datetime, sortable), submitted (datetime, sortable), weight (range, sortable)
Parameters5
collection
string
required
Collection id to search within. Use list_collections to discover available collections.
query
string
required
Search terms. AND-semantics by default; use `or` between terms for OR; wrap phrases in double quotes.
limit
integer
optional
Maximum items to return (capped at 50 to fit MCP response-size budgets).
format
string
optional
Output format for styledtext properties on the matched items. markdown is friendliest for AI consumption.
locale
string
optional
BCP 47 locale tag. Accepted for forward-compat with the 3.6 i18n release — has no effect today.
Raw schema
{
"type": "object",
"properties": {
"collection": {
"type": "string",
"description": "Collection id to search within. Use list_collections to discover available collections.",
"examples": [
"blog",
"products"
]
},
"query": {
"type": "string",
"description": "Search terms. AND-semantics by default; use `or` between terms for OR; wrap phrases in double quotes.",
"examples": [
"rust performance",
"\"static analysis\"",
"php or python"
]
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 50,
"default": 10,
"description": "Maximum items to return (capped at 50 to fit MCP response-size budgets)."
},
"format": {
"type": "string",
"enum": [
"markdown",
"html",
"text"
],
"default": "markdown",
"description": "Output format for styledtext properties on the matched items. markdown is friendliest for AI consumption."
},
"locale": {
"type": "string",
"default": "",
"description": "BCP 47 locale tag. Accepted for forward-compat with the 3.6 i18n release — has no effect today."
}
},
"required": [
"collection",
"query"
],
"additionalProperties": false
}
search_collections
Full-text search across every collection you can see, in one call. Returns matching items each decorated with `collection` (which collection the hit came from) and `url`. Pair `collection` + `id` to fetch the full record via get_object. Call list_collections for the available collections and describe_collection on any one for its full property list; properties not flagged filterable there exist on objects but are not searched here (use get_object for the full record). For a single-collection search use search_collection instead — same query syntax, scoped tighter. Drafts are auto-hidden from anonymous callers.
Parameters4
query
string
required
Search terms. AND-semantics by default; use `or` between terms for OR; wrap phrases in double quotes.
limit
integer
optional
Maximum items returned in aggregate across all collections. Capped at 50 for MCP response-size budgets.
format
string
optional
Output format for styledtext properties on the matched items. markdown is friendliest for AI consumption.
locale
string
optional
BCP 47 locale tag. Accepted for forward-compat with the 3.6 i18n release — has no effect today.
Raw schema
{
"type": "object",
"properties": {
"query": {
"type": "string",
"description": "Search terms. AND-semantics by default; use `or` between terms for OR; wrap phrases in double quotes.",
"examples": [
"rust performance",
"\"static analysis\"",
"php or python"
]
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 50,
"default": 10,
"description": "Maximum items returned in aggregate across all collections. Capped at 50 for MCP response-size budgets."
},
"format": {
"type": "string",
"enum": [
"markdown",
"html",
"text"
],
"default": "markdown",
"description": "Output format for styledtext properties on the matched items. markdown is friendliest for AI consumption."
},
"locale": {
"type": "string",
"default": "",
"description": "BCP 47 locale tag. Accepted for forward-compat with the 3.6 i18n release — has no effect today."
}
},
"required": [
"query"
],
"additionalProperties": false
}
Total CMS is a content management system built on PHP 8.2+ and Slim 4 that stores content as
flat JSON files instead of in a database. There is no MySQL to provision, no migrations to run,
and no plugin ecosystem to keep patched — content lives on disk, so it version-controls,
backs up, and deploys like the rest of your code.
It is designed for web designers, freelancers, and agencies who want structured content and a
polished admin for their clients, on any commodity PHP host.
No database — content is JSON on disk; deploy by copying files
33 built-in collection types — blog, image, gallery, file, and more — plus unlimited custom schemas
Twig templating — 89 custom filters and 49 functions on top of stock Twig 3
Site Builder — add a page in the admin and it is live; no build or generate step
REST API — full CRUD for headless use, with API-key or OAuth 2.1 authentication
Built-in MCP server — exposes your site's collections and search to AI agents (Pro)
Automations — schedule, webhook, and event-triggered handlers with a job queue
Extensions — a register/boot lifecycle with capability-based permissions
Admin interface — form builder with 20+ field types, media management, passkey login
CLI (tcms) — collections, schemas, objects, import/export, sync, and deploys
Image processing — on-the-fly resizing, watermarking, and OKLCH color handling
Requirements
PHP 8.2+ (8.4 supported)
Composer 2.0+
Apache or Nginx with URL rewriting
PHP extensions: GD or ImageMagick, JSON, Fileinfo, OpenSSL
No database server. No Node.js runtime in production.
Installation
bash
composer create-project totalcms/totalcms mysite
cd mysite
Point your web server's document root at public/, then open the site in a browser — the
setup wizard handles the admin account, data directory, and license from there.
The installer also offers a subpath layout, which serves Total CMS from /tcms/ and leaves
public/ free for your own frontend build. See the
Installation Guide for web server
configuration.
Twig templates
twig
{% for post in cms.collection.objects('blog') %}
<article>
<h2>{{ post.title }}</h2>
{{ post.content|markdown }}
</article>
{% endfor %}