Query NetBox endpoint

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

Beyond the annotations (readOnlyHint, destructiveHint, openWorldHint), the description discloses path validation ('path is validated to a NetBox app/model shape before proxying'), return format ('raw NetBox JSON response'), pagination behavior ('count, next, previous and results, with limit and offset accepted in params'), and the optional nature of NetBox as a subsystem. These details add significant behavioral context not captured in 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 appropriately sized for a generic endpoint-query tool. Every sentence earns its place: it covers purpose, alternatives, validation, return format, pagination, and deployment dependency in a logical flow without redundancy. The structure front-loads the primary action and then builds context efficiently.

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?

Given the tool's complexity as a generic endpoint query with pagination and optional subsystem dependencies, the description is complete. It explains return values (raw NetBox JSON, paginated lists), error behavior (bad path fails locally), and how to interpret empty results via malcolm_service_status. The presence of an output schema further reduces the burden, but the description covers essential context thoroughly.

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% for both parameters, so baseline is 3. The description adds extra semantics by noting that 'limit and offset' can be passed via the params object for pagination, and clarifies the path validation behavior ('bad path fails here rather than upstream'). It also reinforces the schema's examples with contextual use cases, providing more value than the schema alone.

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 the tool queries any NetBox REST endpoint via a read-only GET proxy. It distinguishes itself from the sibling tools malcolm_netbox_lookup and malcolm_netbox_sites by positioning itself as the general escape hatch for endpoints those shortcuts don't cover, with specific examples like services, VLANs, interfaces, VMs, and contacts.

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 gives explicit when-to-use guidance: use for endpoints not covered by shortcuts, prefer malcolm_netbox_lookup for common ip/device/prefix lookups, and use malcolm_netbox_sites to list sites (while noting this tool can return a site's full record via 'dcim/sites/'). It also mentions checking malcolm_service_status to determine if NetBox is deployed, which is valuable contextual guidance.

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