Skip to main content
Glama

List help articles

list_articles
Read-onlyIdempotent

List a hosted product's help articles, drafts and archived ones included, with each collection. Filter by collection, status or words in the title or description. Use it to find an article's slug before reading or editing it.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoHow many articles, 1-500. Defaults to 100.
searchNoWords in the title or description.
statusNoOnly articles with this status.
productIdYesProduct id from list_products.
collectionNoOnly this collection id.

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?

Annotations already declare readOnlyHint, idempotentHint and non-destructive, so the safety profile is covered. The description adds genuinely useful behavior beyond that: drafts and archived articles are included by default, which is a non-obvious scoping detail an agent would otherwise assume away.

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 tight sentences, front-loaded with the resource and scope before the filtering and use-case guidance. The phrase 'with each collection' is slightly vague and costs a little clarity, but there is no wasted 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?

No output schema exists, but the description implies the return includes slugs and that all statuses are represented, which is the key thing an agent needs. Pagination behavior is covered by the limit parameter's default in the schema, so the remaining gap is minor.

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 all five parameters (including limit, productId, and the status enum) are already documented in the schema. The description echoes the filter dimensions (collection, status, title/description words) but adds no syntax or format detail beyond what the schema states.

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 names a specific verb and resource ('List a hosted product's help articles') and explicitly widens scope to include drafts and archived articles. It stops short of differentiating itself from the sibling search_articles, which covers the same 'words in the title or description' territory, so an agent can't fully disambiguate the two from text alone.

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?

It gives a concrete use case ('find an article's slug before reading or editing it'), which routes the agent toward read_article/update_article downstream. It offers no exclusion guidance against search_articles, so the when-not is left to inference.

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.

Resources