A2UI Atomic Catalog docs

list_docs

Read-onlyIdempotent

Use this to browse everything the documentation index holds when you have no specific query, or to see what topics exist before searching. Returns the indexed sections as entries of title, section and url, up to max_results.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "list_docs"
  }
}

Input Schema

Name	Required	Description	Default
`max_results`	No	Max entries to return. Omit for all.

Output Schema

Name	Required	Description	Default
`docs`	Yes	Indexed sections.
`total`	Yes	Total sections in the index.

Schema Changelog

Changes observed during successful MCP inspections.

First observedNov 10, 2026

TDQS

A4.3/5.0

Behavior4/5

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

Annotations already declare readOnly, idempotent, openWorld=false and non-destructive, so safety is covered. The description adds that the result set is capped 'up to max_results' and that entries are indexed sections with title/section/url, which is partly duplicated by the output schema but still clarifies listing semantics.

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?

One front-loaded sentence opening with 'Use this to', followed by the return shape. No filler, no repetition, and the primary use case comes first.

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

Completeness5/5

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

For a zero-required-param read-only list tool with rich annotations and an output schema, nothing an agent needs is missing: purpose, default behavior for the one parameter, and result shape are all stated.

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 coverage is 100% and the single parameter's own description already says 'Omit for all.' The description's 'up to max_results' restates that same cap/default behavior without adding new format or boundary detail, 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 ('browse everything the documentation index holds') and explicitly contrasts the unfiltered browse case with query-driven lookup ('when you have no specific query'), which cleanly separates it from search_docs.

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?

Gives two concrete usage scenarios: no specific query, and orientation before searching. It implies the alternative path ('before searching') without naming search_docs or stating an explicit exclusion, so it falls just short of a full when/when-not rule.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

All A2UI Atomic Catalog docs tools Inspect

Try in Browser

One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.