Netbox Get Changelogs

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

Annotations already declare read-only, idempotent, non-destructive, so the safety profile is covered. The description adds real value beyond that: result ordering, the per-entry field set, request_id grouping semantics, and a cost warning that include_data returns several KB per entry and should be paired with a narrow filter.

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?

Three sentences, front-loaded with the core purpose and ordering, then entry structure, then the one behavioral caveat. No filler; every sentence carries information.

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 an output schema present, the description needn't detail return values, and it still helpfully summarizes entry shape. It is complete enough to call correctly, though it says nothing about pagination behavior or how filters combine, which a multi-filter list tool could benefit from.

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 100%, so all four parameters are already documented in the schema, including examples for filters and the size caveat for include_data. The description restates include_data's purpose ('see what exactly changed') without adding syntax or semantics beyond the schema, so baseline 3 applies.

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+resource ('List change log entries') with the key differentiating content ('who changed what and when') and ordering ('newest first'). It is clearly distinguishable from sibling tools like netbox_get_objects or netbox_search_objects.

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?

Usage is implied (audit/history lookup), and the description hints at narrowing filters for include_data, but it never states when to use this tool versus alternatives such as netbox_get_object or the list tools. No exclusions or prerequisites are given.

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