netbox_list_objects

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

With no annotations present, the description carries the behavioral burden itself. It discloses that filters are applied server-side, documents the default limit of 50, and explains the special '0 for no limit' behavior. It could add more about auth or response shape, but the output schema exists and 'list/search' implies a read operation.

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 compact and front-loaded with the core purpose, followed by a tight Arg-style breakdown. Each parameter explanation earns its place, with no redundant or filler content.

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 list/search tool, the description covers the essential call details: endpoint selection, optional server-side filters, and result limiting. It also points to netbox_list_endpoints for valid values, and return-shape concerns are handled by the output schema. The definition is complete enough for an agent to invoke the tool correctly.

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 description coverage is 0%, yet the description compensates thoroughly for all three parameters. It explains the 'app.endpoint' format with an example, provides a concrete filter-object example, and gives the limit's default and zero-meaning. This is far more helpful than the bare 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 opens with a specific verb-resource pair, 'List/search objects at a NetBox endpoint', and clarifies the endpoint format with an example ('ipam.prefixes'). This makes it easy to distinguish from siblings like netbox_get_object (single object retrieval) or netbox_list_endpoints (listing endpoints).

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 clear context for how to use filters and limit ('Omit to list all objects'), but it never explicitly states when to choose this tool over alternatives such as netbox_get_object or netbox_create_object. The intended use is implied by the name and verb, but no direct when-to-use/when-not-to-use guidance is provided.

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