Skip to main content
Glama

Update article

update_article

Update an existing article. Creates a new version with a change note.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "articleId": "<articleId>"
    },
    "name": "update_article"
  }
}

Input Schema

NameRequiredDescriptionDefault
seoNoSEO metadata object with optional fields: metaTitle (max 60 chars), metaDescription (max 160 chars), keywords (array of strings or comma-separated string)
slugNoURL slug
tagsNoArray of tag strings
titleNoArticle title
statusNoArticle status
contentNoArticle content (Markdown format, will be converted to HTML)
excerptNoArticle excerpt (max 500 characters)
categoryNoArticle category
articleIdYesArticle ID
changeNoteNoOptional note describing the changes made (max 500 characters). If not provided, a summary of changed fields will be generated.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.9/5.0
Behavior4/5

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

The annotations already declare this is a non-read-only, non-destructive, non-idempotent mutation. The description adds an important behavioral fact beyond the annotations: updating creates a new version with a change note, implying version history is preserved rather than overwritten. It does not explain partial-update semantics or permission requirements, but the versioning disclosure is valuable.

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 description is two sentences and front-loads the core operation before adding the versioning note. There is no filler or repetition.

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?

For a 10-parameter mutation tool with no output schema, the description covers the essential operation and versioning behavior. However, it omits important update semantics, such as whether omitted fields are preserved or cleared, which affects how an agent should construct the call.

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%, so all 10 parameters, including the nested SEO object and the changeNote field, are already documented in the schema. The description adds no parameter-level detail beyond what the schema provides, so the baseline score of 3 applies.

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 states a specific verb and resource: update an existing article. It is clearly distinct from create_article, get_article, and delete_article, and the versioning note adds useful identity detail beyond the tool name.

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

Usage Guidelines3/5

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

The phrase 'Update an existing article' implies the tool is for existing articles rather than new ones, but there is no explicit guidance on when to use it versus create_article or restore_article_version. No exclusions or alternatives are named.

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.

Resources