Skip to main content
Glama
fruggr

Zendesk MCP Server by Fruggr

Update Article Section

update_article_section
DestructiveIdempotent

Replace a single article section's body in a given locale while keeping its heading and the rest of the article intact. Fetches the current body, swaps the targeted section, and PUTs the rebuilt body via the Translations API.

Instructions

Replace the body of one article section, heading excluded (the heading is kept as is), in a given locale, leaving the rest of the article intact. The server fetches the current body, replaces the targeted section, and PUTs the full reconstructed body via the Translations API. A leading heading in content that repeats the section heading is removed; any other h1-h3 in content creates new sections and shifts the later indexes (the response warns). section_index 0 is the heading-less intro, which exists only when the body has text before its first heading. Default format="html" for fidelity. Use format="markdown" only when you control the input and know it does not rely on structures that round-trip poorly (code blocks with line breaks, tables with multi-paragraph cells).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
formatNoInput format. "html" (default) is the safe path. "markdown" is converted to HTML server-side but may introduce artifacts on complex content.html
localeYesLocale of the translation to update
contentYesNew content for the section (heading excluded: send neither the heading nor the "## [n] hN: ..." label line that get_article_section prints). HTML by default, Markdown if format="markdown".
article_idYesArticle ID — the numeric id of the Help Center article. Obtain it from list_articles or search_articles.
section_indexYes0-based index of the section to replace (see get_article_outline). 0 is the heading-less intro when the body has text before its first heading, otherwise the first heading.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv3.0.1
    • changedInput schema / properties / content / description
      Previous value: -"New content for the section (heading excluded). HTML by default, Markdown if format=\"markdown\"."New value: +"New content for the section (heading excluded: send neither the heading nor the \"## [n] hN: ...\" label line that get_article_section prints). HTML by default, Markdown if format=\"markdown\"."
    • changedInput schema / properties / section_index / description
      Previous value: -"0-based index of the section to replace (see get_article_outline)"New value: +"0-based index of the section to replace (see get_article_outline). 0 is the heading-less intro when the body has text before its first heading, otherwise the first heading."
  2. Changed1 schema field changedv2.24.0
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  3. Addedv2.15.0
  4. Removedv2.14.0
  5. Changed1 schema field changedv2.6.0
    • changedInput schema / properties / article_id / description
      Previous value: -"Article ID"New value: +"Article ID — the numeric id of the Help Center article. Obtain it from list_articles or search_articles."
  6. Changed1 schema field changedv2.3.1
    • addedInput schema / additionalProperties
      Added value: +false
  7. First observedv1.7.0

TDQS

A4.6/5.0
Behavior5/5

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

Adds substantial behavior beyond the annotations: server fetches current body, reconstructs and PUTs the full body via the Translations API, strips a duplicated leading heading, and warns that other h1-h3 in content spawn new sections and shift later indexes. That index-shifting side effect is exactly the non-obvious behavior an agent needs before writing.

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?

Front-loaded with the core replace semantics, then side-effect warnings, then the format guidance. Dense but every sentence carries operational information; slightly verbose but not padded.

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?

No output schema exists, yet the description pre-announces the response warning about index shifts, and covers the reconstruction/PUT mechanics, locale scoping, and content format expectations. For a destructive mutation tool this is complete.

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

Parameters4/5

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

Schema coverage is 100%, so the baseline is 3, but the description genuinely enriches it: section_index 0 is defined as the heading-less intro, and content's heading/label-line exclusion and format trade-offs are explained beyond the schema text.

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 ('Replace the body of one article section') and scopes it precisely: heading excluded, one locale, rest of article intact. This cleanly separates it from update_article (whole article), update_article_translation, and set_section_translation.

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?

Gives explicit conditional guidance for format (default html for fidelity; markdown only when you control input) and explains when section_index 0 exists. It does not name sibling alternatives to route between (e.g. full-article vs per-section updates), so it stops short of a full when/when-not/alternative map.

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