Get Provider_network

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

Annotations already indicate readOnlyHint=true, idempotentHint=true, destructiveHint=false, and openWorldHint=true. The description adds value by specifying the return formats ('Markdown detail or JSON') and clarifying the output includes 'the full NetBox object including nested references.' No contradictions with annotations.

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 extremely concise: one sentence for core purpose, one for usage guidelines, and one for return behavior. Every sentence earns its place. Information is front-loaded with the primary action.

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 simple get operation with two parameters and no output schema, the description completely covers what an agent needs: how to invoke (by id), output format options, and what the response contains (full object with nested references). No gaps.

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 the baseline is 3. The description adds semantic value by explaining the response_format parameter's use: 'Use 'json' when chaining follow-up tool calls.' This provides actionable guidance beyond the schema's description.

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 clearly states 'Get a single provider_network from NetBox by numeric id', which specifies the verb, resource, and method. It distinguishes itself from sibling tools like netbox_list_provider_networks by indicating the prerequisite use of the list tool.

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 advises 'Use after netbox_list_provider_networks has located the object, or when you already have the id.' This gives clear when-to-use guidance and implies when not to use it (without an id), and names the alternative tool.

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