Skip to main content
Glama

Sync article to CMS

sync_article_to_cms
Idempotent

Pushes the current content of a published (or published-in-draft) article to every connected CMS, clearing its Out of Sync state. Synchronous: returns once the CMS accepted the update (a few seconds; Shopware, Umbraco and BigCommerce finish in the background). Fails for articles that are not on a CMS yet: publish those with publish_article. Framer and webhook connections are never synced. Pass website_id when the account has several websites (see get_account).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
article_idYesArticle id from list_articles.
website_idNoWebsite id from get_account. Optional when the account has a single website.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
slugYes
localeYesTranslation locale the change applied to; null for the default-language article or a field shared by every locale. The other fields always describe the default-language article.
statusYesRaw status; status_label is the human reading.
messageYesWhat changed, e.g. "Headline updated for the fr version."
headlineYes
article_idYes
created_atYes
preview_textYesFirst 200 characters of the body.
published_atYes
status_labelYesStatus as shown in the app, e.g. Published, Draft on CMS, Failed to publish.
is_out_of_syncYesEdited since the last push to the CMS; sync_article_to_cms clears it.
main_image_urlYesCover image URL.
target_keywordYes
meta_descriptionYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • addedOutput schema / properties / locale
      Added value: +{
      +  "description": "Translation locale the change applied to; null for the default-language article or a field shared by every locale. The other fields always describe the default-language article.",
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
    • addedOutput schema / properties / message
      Added value: +{
      +  "description": "What changed, e.g. \"Headline updated for the fr version.\"",
      +  "type": "string"
      +}
    • changedOutput schema / required
      Previous value: -[
      -  "article_id",
      -  "headline",
      -  "slug",
      -  "status",
      -  "status_label",
      -  "created_at",
      -  "published_at",
      -  "is_out_of_sync",
      -  "meta_description",
      -  "preview_text",
      -  "main_image_url",
      -  "target_keyword"
      -]New value: +[
      +  "article_id",
      +  "headline",
      +  "slug",
      +  "status",
      +  "status_label",
      +  "created_at",
      +  "published_at",
      +  "is_out_of_sync",
      +  "meta_description",
      +  "preview_text",
      +  "main_image_url",
      +  "target_keyword",
      +  "message",
      +  "locale"
      +]
  2. First observed

TDQS

A4.7/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations only declare idempotency, non-destructiveness and open-world scope; the description goes much further, disclosing synchronous return semantics, that Shopware/Umbraco/BigCommerce complete in the background, the prerequisite failure mode, and the connection types that are never synced.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The primary action and the Out-of-Sync effect are front-loaded, followed by timing, failure/prerequisite handling, exclusions, and the parameter hint. Every sentence carries distinct operational information with no filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With an output schema present, return values need no explanation. The description covers prerequisites, alternatives, cross-account scoping and per-integration execution behavior, leaving no meaningful gap for an agent calling this tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100% and the schema already documents both parameters, including that website_id is optional for single-website accounts. The description's note about passing website_id for multi-website accounts and referring to get_account largely restates the schema, so it sits at the baseline with only marginal added value.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource (pushes current article content to connected CMS) plus the resulting state change (clearing Out of Sync). It clearly distinguishes itself from publish_article, which is named as the tool for articles not yet on a CMS.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly names the failure condition (article not on a CMS yet) and routes the agent to the alternative (publish_article), plus states which connections are out of scope (Framer, webhooks) and when website_id is required. When-to-use, when-not, and alternatives are all covered.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.