cmdb_list

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

No annotations provided. The description discloses the return format (full FortiOS JSON with results array and metadata) and that it is a GET operation. However, it lacks details on error handling, authentication, or limitations beyond what parameters imply.

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?

Extremely concise: two sentences, first stating purpose and second explaining coverage and return format. Every sentence adds value, no waste.

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 generic nature, output schema exists, and 6 parameters with high schema coverage, the description adequately covers the main use. It could mention that the response structure varies per resource and that resource_path must be valid, but overall it is complete enough.

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 baseline of 3 is appropriate. The description does not add additional meaning to parameters; the schema already provides detailed examples and syntax.

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 it lists CMDB resource objects, with a specific verb 'list' and resource 'CMDB object'. It distinguishes itself from sibling list tools by noting it covers any GET on /api/v2/cmdb/{resource_path}, implying generic usage.

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 says when to use it (for any CMDB GET), but does not provide explicit guidance on when not to use it or mention alternative dedicated list tools like firewall_policy_list for specific resources.

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