yapi_search_apis

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

No annotations provided, so description carries full burden. Discloses case-insensitive substring matching on title/path and optional method filter. But lacks details like pagination, result limits, or response structure (no output schema). Adequate but not thorough.

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?

Single sentence, front-loaded with action, minimal and efficient. Every word contributes to describing the tool's purpose and key options.

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?

Given 3 parameters and no output schema, the description adequately explains input behavior. Lacks output details but the return of a 'list of APIs' is mentioned. Could be more complete with pagination info, but still serves its purpose.

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 baseline is 3. Description adds context that search is 'within a project' (scope), but otherwise the parameter descriptions in schema already cover the search functionality. No significant additional meaning.

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?

Clearly states the tool searches APIs by keyword within a project, matching title/path with optional method filter. Distinguishes from sibling tools (e.g., yapi_get_api_details for details, yapi_save_api for saving) by specifying its unique search function.

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?

Implies usage context: when needing to find APIs by search criteria. However, does not explicitly state when not to use or mention alternatives, but the context is clear enough given sibling tool names.

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