yapi_get_api_details

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

The description lists what data the tool returns (params, headers, body, response), which is useful behavioral context. However, with no annotations, it fails to disclose whether the operation is read-only, requires authentication, or has any side effects. A more explicit statement would improve clarity.

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 a single, concise sentence that effectively conveys the tool's purpose without unnecessary words. It is front-loaded with the key action and details, though it could benefit from slight restructuring (e.g., listing items) for even better readability.

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 the simple single-parameter tool and no output schema, the description provides adequate context by listing the types of details returned. However, it uses '等' (etc.) implying incompleteness and does not specify the response format or any limitations, leaving some ambiguity.

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% with a clear description of the api_id parameter. The tool description does not add additional meaning beyond the schema, meeting the baseline expectation.

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 tool retrieves detailed API information including request parameters, headers, body structure, and response. It uses a specific verb ('获取...详细信息') and resource ('接口'), and distinguishes from sibling tools like search_apis (search) and get_categories (list categories).

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 parameter description for api_id explicitly mentions it can be obtained from search_apis or get_categories, providing a clear usage context. However, the main description does not include explicit when-to-use or when-not-to-use guidance, but the parameter hint suffices.

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