Netbox Get Available

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

Annotations already declare readOnlyHint, idempotentHint, openWorldHint and destructiveHint=false, so the safety profile is covered. The description adds valid parent/kind combinations, which is useful, but says nothing about what 'free' means, how results are computed, or pagination behavior.

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?

Purpose is front-loaded in the first sentence, followed by three compact, illustrative examples. No filler; the examples earn their place by clarifying invocation. Slightly verbose in example repetition but well organized.

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 read-only annotations covering safety and an output schema covering return values, the description only needs to convey purpose and invocation, which it does. The remaining gap is sibling differentiation versus netbox_allocate_available.

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%, so baseline would be 3. The description earns above baseline by mapping valid parent_type/kind pairings (e.g., 'ips'/'prefixes' with ipam.prefix, 'vlans' with ipam.vlangroup), which the flat schema does not encode as constraints.

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 (list) and resource (free IPs, child prefixes, VLAN IDs, ASNs in a pool), which is clearly distinct from generic readers like netbox_get_objects. However, it never names or contrasts the closely related sibling netbox_allocate_available, so the agent must infer the boundary between listing and allocating.

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 examples imply usage (free IPs in a prefix, free /24s in a prefix, free VLAN IDs in a group), giving the agent a sense of when this applies. But there is no explicit when-to-use / when-not guidance and no direction toward netbox_allocate_available for the consuming operation.

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