Skip to main content
Glama

kayako

Get a help-center article

kayako_get_article
Read-only

Fetch one knowledge-base article with its localized titles and contents expanded (include defaults to 'locale_field'), status, section, tags, votes and help-center URL. Kayako: GET /api/v1/articles/{id}.json.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
includeNoResource types to expand. Defaults to 'locale_field' so titles/contents are readable.
article_idYesThe article id (integer).

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?

readOnlyHint=true already covers the safety profile, but the description adds real behavioral context: it discloses that 'include' defaults to 'locale_field' so titles/contents come back readable, and enumerates exactly what the payload contains. It does not mention auth requirements, but that is a minor gap given the annotation.

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?

One front-loaded sentence that leads with the action and the returned fields; efficient overall. The trailing 'Kayako: GET /api/v1/articles/{id}.json' is mildly redundant for an agent but provides endpoint traceability without bloating the text.

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 carries the burden of describing the return shape and does so by enumerating the fields and the localization default. Combined with the readOnly annotation, an agent has enough to invoke it correctly, though it omits error/not-found behavior.

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 both parameters are already documented, and the description's statement that include defaults to 'locale_field' duplicates the schema's own wording. Baseline 3 is appropriate since the schema does the heavy lifting.

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 ('Fetch') and resource ('one knowledge-base article') and enumerates the fields returned (localized titles/contents, status, section, tags, votes, URL). The singular 'one ... article' cleanly distinguishes it from the sibling kayako_list_articles without needing the schema.

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?

Usage is only implied: the single-id fetch shape makes it obvious you call this when you already have an article id, but the description never says when to use it versus kayako_list_articles or kayako_search_help_center, nor does it list any prerequisites.

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.