A2UI Atomic Catalog docs

search_docs

Read-onlyIdempotent

Use this to answer a question about the product (auth, versioning, pricing, API surface, runbook catalog) from its own documentation, given a plain-English query. Returns {results}: ranked sections, each with title, section, a text snippet, a score and the real source URL, never fabricated content; empty if nothing matches.

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": {
      "query": "<query>"
    },
    "name": "search_docs"
  }
}

Input Schema

Name	Required	Description	Default
`query`	Yes	Plain-English question or keywords.
`max_results`	No	Max results to return. Default 5.

Output Schema

Name	Required	Description	Default
`note`	No	Set when nothing matched.
`results`	Yes	Ranked sections, best first.

Schema Changelog

Changes observed during successful MCP inspections.

First observedNov 10, 2026

TDQS

A3.9/5.0

Behavior4/5

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

Annotations already declare read-only, idempotent, closed-world and non-destructive behavior, so the bar is lower. The description usefully adds that results are ranked sections with score and real source URL, that content is 'never fabricated', and that an empty result set is possible — meaningful behavioral context beyond the structured fields.

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?

A single front-loaded sentence that leads with the use case, then the return shape. The parenthetical topic list is slightly dense but earns its place by scoping the documentation domain.

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 an output schema present the description needn't fully explain returns, yet it still summarizes the result structure. Annotations cover the safety profile and both parameters are documented, leaving only minor gaps such as pagination or scoring semantics.

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 query and max_results are already documented. The description only echoes 'plain-English query' and says nothing about max_results behavior like truncation or ranking cutoff, so it adds little beyond 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?

States a specific verb ('answer a question') and resource ('its own documentation'), and scopes the domain with examples (auth, versioning, pricing, API surface, runbook catalog). It does not explicitly differentiate from the sibling list_docs, but the question-answering framing is distinct enough in practice.

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?

The opening 'Use this to answer a question about X from its own documentation' gives clear when-to-use guidance and implicitly excludes generic listing. No explicit when-not conditions or alternative tools are named, so it falls short of a 5.

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.