搜索 Swagger 接口

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

Annotations already declare readOnly, idempotent, non-destructive hints. The description adds a behavioral note: '回答用户时必须明确保留 sourceNotice' (must keep sourceNotice when answering the user), which is critical for proper response handling. No contradictions with annotations.

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

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

The description is two sentences with no wasted words. The first sentence provides the core purpose, and the second adds a specific usage instruction. It is concise and front-loaded.

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

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

For a search tool with 5 parameters (2 required) and no output schema, the description covers purpose, scope (real-time Swagger doc), and a behavioral requirement. It lacks a description of the return format or pagination details, but those are partially covered by schema. Overall, it is sufficiently complete for correct invocation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema already documents each parameter. The description does not add additional parameter-level semantics beyond the schema, maintaining the baseline of 3.

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

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

The description clearly states the verb '搜索' (search) and the resource 'Swagger 接口', and lists specific searchable fields (path, summary, description, tag, operationId). It also differentiates from sibling tools like inspect_api_docs or get_api_by_path by specifying that the search is across a real-time Swagger document.

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

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

The description implies usage when searching across Swagger APIs, but does not explicitly state when to use this tool versus alternatives like inspect_api_docs or list_api_categories. No explicit when-not or alternative guidance is provided.

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