Skip to main content
Glama

list_articles

Read-only

A site's help articles: what customers read on the workspace's own site, suggested in the form while they write. Each has a title, the words customers use (keywords), whether it is published, whether a change is waiting (changed), whether it is paused (over the plan's number, so shown to nobody), and how often it was opened and answered someone's question in the last thirty days. help_url is the page of the customer's site that shows them: an article's link is that address followed by #help-article= and its slug. Pro and higher.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "product_id": "<product_id>"
    },
    "name": "list_articles"
  }
}

Input Schema

NameRequiredDescriptionDefault
product_idYesThe site's id (a uuid), from list_products.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.4/5.0
Behavior4/5

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

Annotations already establish readOnly and closed-world behavior, and the description goes well beyond that by enumerating returned fields (title, keywords, published, changed, paused, engagement stats) and explaining what paused and changed mean. It also discloses the help_url construction, which is useful operational context not present in the schema.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The content is front-loaded with the core resource definition, but the field list is packed into a dense run-on sentence and could be organized more clearly. It is informative but not maximally concise.

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, so the description carries the burden of explaining return values; it does this well by naming the fields and clarifying status indicators and help_url format. It stops short of describing pagination, ordering, or limits, which leaves a small gap for a list 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?

There is one parameter and schema coverage is 100%; the schema already says product_id is the site's uuid and comes from list_products. The description adds no parameter-specific meaning beyond that, so the baseline of 3 applies.

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 defines the resource clearly as a site's help articles and explains what they are and how they surface, which lets an agent distinguish this from get_article or save_article. The listing verb itself is only implied by the name, not stated in the description, so it falls short of a perfect 5.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The only usage-relevant guidance is the plan prerequisite 'Pro and higher'; there is no explicit statement of when to call this instead of get_article or other article tools, and no exclusions. The agent must infer the listing use case from the name and resource description.

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