Skip to main content
Glama
fruggr

Zendesk MCP Server by Fruggr

by fruggr
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

Update Help Center Article

update_article
DestructiveIdempotent

Update Zendesk article metadata—publish state, promotion, labels, tags, section, and sort position—without altering content. Use separate translation tools for title and body edits.

Instructions

Update article metadata only (draft, promoted, labels, tags, visibility, section, sort position, etc.) and return the updated article. Does NOT update content (title, body) — use update_article_translation for that.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
draftNoSet true to unpublish the article (revert to draft) or false to publish it.
positionNoSort position within the section (manual ordering only; 0 = first/top). New articles default to position 0. To move an article to the END of its section, set this to one more than the highest current position: read the highest position P from list_articles with sort_by="position", sort_order="desc", then set position = P + 1.
promotedNoSet true to promote (feature) the article in its section, or false to unpromote it.
author_idNoUser id of the article author (from search_users).
article_idYesArticle ID — the numeric id of the article to update. Obtain it from list_articles or search_articles.
section_idNoMove the article to this section (numeric id from list_sections).
label_namesNoLabel names for search ranking (use list_labels to see existing labels).
content_tag_idsNoContent tag ids to attach (use list_content_tags to find them).
user_segment_idNoUser segment that controls who can see the article (id from list_user_segments; if that is forbidden because the token is not a Guide admin, reuse the user_segment_id of an existing article from get_article).
permission_group_idNoGuide permission group controlling who can edit (id from list_permission_groups; if that is forbidden because the token is not a Guide admin, reuse the permission_group_id of an existing article from get_article).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv2.15.0
  2. Removedv2.14.0
  3. Changed2 schema fields changedv2.12.1
    • changedInput schema / properties / permission_group_id / description
      Previous value: -"Guide permission group controlling who can edit (id from list_permission_groups)."New value: +"Guide permission group controlling who can edit (id from list_permission_groups; if that is forbidden because the token is not a Guide admin, reuse the permission_group_id of an existing article from get_article)."
    • changedInput schema / properties / user_segment_id / description
      Previous value: -"User segment that controls who can see the article (id from list_user_segments)."New value: +"User segment that controls who can see the article (id from list_user_segments; if that is forbidden because the token is not a Guide admin, reuse the user_segment_id of an existing article from get_article)."
  4. Changed9 schema fields changedv2.6.0
    • addedInput schema / properties / article_id / description
      Added value: +"Article ID — the numeric id of the article to update. Obtain it from list_articles or search_articles."
    • changedInput schema / properties / author_id / description
      Previous value: -"Author user ID"New value: +"User id of the article author (from search_users)."
    • changedInput schema / properties / content_tag_ids / description
      Previous value: -"Content tag IDs"New value: +"Content tag ids to attach (use list_content_tags to find them)."
    • addedInput schema / properties / draft / description
      Added value: +"Set true to unpublish the article (revert to draft) or false to publish it."
    • changedInput schema / properties / label_names / description
      Previous value: -"Label names for search ranking"New value: +"Label names for search ranking (use list_labels to see existing labels)."
    • changedInput schema / properties / permission_group_id / description
      Previous value: -"Permission group ID"New value: +"Guide permission group controlling who can edit (id from list_permission_groups)."
    • addedInput schema / properties / promoted / description
      Added value: +"Set true to promote (feature) the article in its section, or false to unpromote it."
    • addedInput schema / properties / section_id / description
      Added value: +"Move the article to this section (numeric id from list_sections)."
    • changedInput schema / properties / user_segment_id / description
      Previous value: -"User segment ID for visibility"New value: +"User segment that controls who can see the article (id from list_user_segments)."
  5. Changed1 schema field changedv2.3.1
    • addedInput schema / additionalProperties
      Added value: +false
  6. Changed1 schema field changed
    • addedInput schema / properties / position
      Added value: +{
+  "description": "Sort position within the section (manual ordering only; 0 = first/top). New articles default to position 0. To move an article to the END of its section, set this to one more than the highest current position: read the highest position P from list_articles with sort_by=\"position\", sort_order=\"desc\", then set position = P + 1.",
+  "maximum": 9007199254740991,
+  "minimum": 0,
+  "type": "integer"
+}
  7. First observedv1.7.0

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already provide readOnlyHint=false, destructiveHint=true, etc. The description adds context that the tool returns the updated article and does NOT update content (title, body). This is helpful but not extensive beyond annotations.

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?

Two sentences, front-loaded with the core purpose, and every sentence adds value. No wasted words.

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?

Given the tool's complexity (10 parameters, no output schema), the description is complete enough. It covers the scope, return value, and exclusions, sufficient for an agent to use correctly.

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 the schema already documents all parameters well. The description adds very little extra meaning beyond stating the return value. Baseline 3 is appropriate.

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 specifies the resource 'article metadata only'. It distinguishes from the sibling tool update_article_translation by excluding content updates, which removes ambiguity.

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?

The description explicitly states when to use this tool (for metadata updates) and when not to (for content updates, use update_article_translation). This provides clear guidance and alternatives.

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

Deploy Server

Other Tools