Skip to main content
Glama
fruggr

Zendesk MCP Server by Fruggr

by fruggr
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

Get Article Outline

get_article_outline
Read-onlyIdempotent

Retrieve a compact article outline with h1/h2/h3 sections, word counts, and translation outdated status for a given locale; use it to scan structure before fetching a section.

Instructions

Return a compact outline of an article (list of sections delimited by h1/h2/h3, with word counts) for the given locale (defaults to source_locale). Includes available translations with their outdated status. Use get_article_section to fetch a specific section.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
localeNoLocale of the body to outline (defaults to article source_locale)
article_idYesArticle ID — the numeric id of the Help Center article. Obtain it from list_articles or search_articles.

Schema Changelog

Changes observed during successful MCP inspections.

  1. 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"
  2. 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."
  3. Changed1 schema field changedv2.3.1
    • addedInput schema / additionalProperties
      Added value: +false
  4. First observedv1.7.0

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive, so the safety profile is covered. The description adds real behavioral value beyond annotations: it discloses the return shape (h1/h2/h3 sections with word counts) and that translations with outdated status are bundled in — non-obvious extra content the agent should expect.

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 tight sentences with the primary behavior front-loaded and the sibling routing second. Every clause earns its place; nothing is padded.

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

Completeness4/5

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

With no output schema, the description does the necessary work of describing the return payload (sections, word counts, translation status), which is what an agent needs to decide to call it. What it omits — ordering, pagination, empty-article behavior — is minor for a read-only outline 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 both params (article_id, locale) are documented in the schema. The description only restates the locale default that the schema already states, adding no syntax or format detail beyond it, so the baseline 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?

States a specific verb and resource ('Return a compact outline of an article') and details exactly what the outline contains — h1/h2/h3 sections with word counts plus translation/outdated status. An agent can distinguish it from get_article and get_article_section without opening a schema.

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?

Explicitly routes the agent to a sibling: 'Use get_article_section to fetch a specific section,' which distinguishes outline-level vs section-level access. It stops short of stating when to prefer this over get_article for a full body, but the alternative is named with a selecting condition.

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