Especificacao OpenAPI

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

Annotations already declare readOnlyHint=true and openWorldHint=true, so the safety profile is established. The description confirms a non-mutating download operation ('Baixa... em execucao') and adds the context that it reflects the currently running API. It does not disclose output format or size, but for a read-only metadata tool, annotations plus description cover the key behavioral traits.

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 compact sentences in Portuguese, front-loaded with the core purpose and immediately followed by the use-case trigger. Zero filler, every sentence earns its place.

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 parameter-free, read-only tool with no output schema, the description is complete. The agent knows what it does, when to use it, and that it is safe (via annotations). Nothing essential is missing.

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?

There are 0 parameters and schema description coverage is 100%, so there is nothing for the description to document. The description correctly omits param detail. Baseline 4 is warranted because with no parameters, the description needs no compensating semantic information.

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 states a specific action (downloads/downloads) and resource (the OpenAPI spec of the running Solibri REST API). It is immediately clear what the tool returns and it is easily distinguishable from the sibling tools, none of which retrieve API specifications.

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 explicitly states when to use this tool: to discover exact parameters of less-used endpoints. This gives the agent a clear trigger condition. It does not reference alternatives explicitly, but with 24 siblings and 0 overlapping purpose, the intended context is sufficiently directive.

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