search_api

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

No annotations are provided, so the description must carry the full burden. It states the search scope (function names, class names, documentation) but does not mention that it is read-only, any limits, or what happens if no results.

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?

Two short sentences in Chinese, approximately 30 characters, no filler. Front-loaded with action and purpose.

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 simple tool with no output schema, the description explains purpose and usage but omits what the search returns (e.g., list of API names or full docs). Could provide more context on output format.

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?

Input schema covers 100% of parameters with descriptions. The tool description adds value by explaining the search scope, which gives meaning to the 'query' parameter by hinting it matches against multiple fields.

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?

Description states '按关键词搜索 API，覆盖函数名、类名和文档说明' (search APIs by keyword covering function names, class names, and documentation), with a clear verb and resource. It also distinguishes from sibling tools by adding '当不确定功能在哪个模块时使用' (use when unsure of the module).

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?

Explicit usage context is given: '当不确定功能在哪个模块时使用' (use when unsure of which module). While it doesn't list alternatives or when not to use, this single condition provides clear guidance.

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