Skip to main content
Glama

Update article paragraph

cms_update_article_paragraph
DestructiveIdempotent

Update paragraph. Guidance: Update one article paragraph by paragraph id. | context: id, paragraph_id

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesArticle id returned by cms_list_articles.
captionNoPatch photo caption.
contentNoPatch text or quote body, or related photo field per block type.
embedUrlNoPatch embed HTML snippet. Set an explicit iframe width and height (for example 100%) so the block renders at a visible size.
isThumbnailNoPatch photo cover flag.
paragraph_idYesParagraph id returned by cms_list_article_paragraphs.
originalThumbnailNoPatch photo image source: URL, data URI, or base64.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/5.0
Behavior4/5

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

The annotations disclose that this is a destructive, idempotent, non-read-only operation (readOnlyHint: false, destructiveHint: true, idempotentHint: true). The description itself says 'Update', which aligns with these annotations, and there is no contradiction.

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

Conciseness4/5

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

The description is concise and front-loaded with the essential action ('Update paragraph'). The guidance clarifies the target and key identifiers. It is appropriately sized for a simple update operation, though it could include a bit more detail on updatable fields.

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

Completeness3/5

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

The description is minimal and does not explain whether the update is partial or full, nor does it mention optional fields or any side effects beyond what annotations state. Given the tool's simplicity and the annotations, it is adequate but not fully comprehensive.

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 descriptions already cover all parameters (100% coverage). The description adds a minor contextual note ('context: id, paragraph_id') but largely relies on the schema, so no significant additional meaning is provided beyond the baseline.

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?

The description clearly states the verb 'Update' and the resource 'article paragraph', distinguishing it from sibling tools for other paragraph types (e.g., event, map). The guidance explicitly mentions 'by paragraph id', making the purpose unambiguous.

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

Usage Guidelines4/5

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

The description indicates the tool updates one article paragraph using paragraph id, which provides clear context for when to use it. It does not explicitly contrast against alternatives, but the resource-specific wording and required parameters make the usage context clear.

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.