discover_vdoms

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

With no annotations, the description carries the full behavioral burden. It conveys the read-only nature ('queries', 'retrieve') and what comes back (status, resource allocation), but omits error behavior when the device is unreachable/unknown device_id, auth requirements, and explicit confirmation that nothing is modified.

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?

Front-loaded one-line purpose, followed by compact Parameters and Returns sections. The Returns breakdown is genuinely useful because no output schema exists; no filler sentences.

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?

No output schema, so the description appropriately enumerates the returned data (VDOM configuration, enabled/disabled status, resource allocation). With a single parameter and no annotations, the only meaningful gap is failure behavior for invalid or unreachable devices.

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% and the single parameter is already documented in the schema. The description restates its meaning ('Identifier of the FortiGate device to query'), which adds the intent of querying without exceeding the schema. Baseline 3 exceeded marginally by clarifying query semantics.

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?

States a specific verb and resource: 'Discover and list all Virtual Domains (VDOMs) on a FortiGate device.' No sibling tool covers VDOMs, so the target is unambiguous even without an explicit contrast. Slightly redundant ('Discover and list') but clear.

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 establishes the context (query a specific FortiGate device to enumerate its configured VDOMs) but never says when to prefer this over generic siblings like cmdb_list, nor any prerequisites such as the device first being registered via add_device. Usage is implied rather than prescribed.

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