yapi_clear_cache

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

With no annotations, the description carries the burden of behavioral disclosure. It states the effect ('force fresh data retrieval') but does not mention potential side effects such as performance impact, scope (global vs per-user), or whether the operation is safe/idempotent. The information is minimal but not misleading.

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 sentence, immediate and to the point: 'Clear the internal cache to force fresh data retrieval.' It states both the action and the rationale without padding, earning a top score for conciseness.

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 zero-parameter cache-clearing utility, the description provides the core purpose and effect, which is sufficient for basic invocation. It lacks finer contextual guidance (e.g., when this is needed relative to other operations), but given the simplicity of the tool, the description is nearly complete.

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?

The tool has zero parameters, so the description is not required to explain parameter meaning. The baseline for no parameters is 4, and the description appropriately avoids fabricating parameter details. The empty schema is fully covered by the absence of parameters.

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 uses a specific verb+resource ('Clear the internal cache') and clearly states the intended effect ('force fresh data retrieval'). It is distinct from sibling tools that perform CRUD or import operations, leaving no ambiguity about what this tool does.

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 does not provide any guidance on when to use this tool versus alternatives. It does not mention typical scenarios like 'after updates' or 'to verify changes', nor does it advise against overuse. Without this context, an agent may not know the appropriate timing for invoking cache clearing.

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