Skip to main content
Glama

List help-center articles

kayako_list_articles
Read-only

List knowledge-base articles, optionally by section, tags, or PUBLISHED / PINNED. Titles and contents are locale references unless include='locale_field'. Kayako: GET /api/v1/articles.json.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
tagsNoComma-separated tags.
limitNoItems per page, 1-100. Kayako's default is 10.
filterNoOnly pinned or only published articles.
offsetNoOffset into the collection (0-based). Default 0.
includeNoComma-separated resource types to expand instead of returning {id, resource_type} references, e.g. 'user,case_status,case_priority,team', or '*' for all.
section_idNoOnly articles in this section.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  2. First observed

TDQS

A3.8/5.0
Behavior4/5

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

readOnlyHint=true already tells the agent this is a safe read. The description adds real context beyond that: titles and contents come back as locale references unless include='locale_field', which affects how results must be interpreted, plus the underlying endpoint. It still says nothing about pagination or result volume, so not a 5.

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?

Two sentences with the primary purpose front-loaded and no filler; the endpoint reference is arguably redundant but compact. Efficient and readable without wasted words.

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 annotations covering the safety profile, full schema coverage, and no output schema to explain, the description supplies the one non-obvious behavior (locale-reference returns). The only gap is pagination/return-volume guidance, which is minor here.

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 earns extra credit by clarifying the semantics of include (locale reference expansion) and filter (PUBLISHED/PINNED), which the schema documents only tersely. The section/tags/limit parameters are left entirely to the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description opens with a specific verb+resource ('List knowledge-base articles') and enumerates the optional scoping facets, distinguishing it from the singular kayako_get_article and from search tools. It stops short of explicitly naming a sibling it should be preferred over, so it lands at a clear-but-undifferentiated 4.

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?

It sketches usage ('optionally by section, tags, or PUBLISHED / PINNED'), which implies when the filter facets apply, but it never states when to reach for this list versus kayako_search_help_center or kayako_get_article, and gives no exclusions or prerequisites. Implied usage only.

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.