vsponeblock_list_operations

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

Annotations already declare readOnlyHint=true and openWorldHint=false, but the description adds a genuinely non-derivable behavioral fact: '[write]' operations are blocked because the server runs read-only, which tells the agent some listed operations cannot be called. It also discloses that query results are BM25-ranked with a confidence rating and describes the returned fields for a tool with no output schema.

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?

Three sentences, zero filler, front-loaded with 'browse with no arguments' before the filtered mode and the follow-up workflow. Every sentence carries a distinct piece of information (default mode, filtered mode, routing).

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?

With no output schema, the description compensates by naming the returned fields and the confidence rating on query results, plus the read-only restriction on [write] operations. An agent has everything required to discover an operationId and route to the next sibling.

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 coverage is 100% with rich per-parameter descriptions (tag examples, limit max/default, BM25 query semantics), so the baseline is 3. The description goes beyond the schema by stating that 'tag' and 'query' can be combined ('and/or') and that omitting all arguments switches to tag-listing mode — call-pattern semantics the schema does not express.

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?

Specific verb+resource ('Browse the VSP One Block REST API') with two precisely enumerated modes: no-arg lists API areas/tags, tag/query lists matching operations. It names the exact return fields (operationId, method, path, summary), so an agent knows exactly what comes back without opening a schema.

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 sequencing: 'Use this first to find the operationId you need, then vsponeblock_describe_operation and vsponeblock_call_operation.' It names both siblings and the condition under which each is used, and explicitly excludes write operations from the workflow.

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