List Company Vendor Insurances

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

Annotations already provide readOnlyHint, destructiveHint, idempotentHint, and openWorldHint, establishing safety and data freshness. The description adds pagination behavior and return type, but does not disclose additional traits beyond what annotations cover. It contributes moderate value.

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 four concise sentences, starting with the primary action. Every sentence adds useful information (purpose, use case, pagination, required params, API reference). 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?

For a list endpoint with 4 parameters and no output schema, the description covers purpose, parameters, pagination, and API details. However, it lacks details about the return record fields (e.g., what constitutes an 'Insurance' record) and could confuse by mentioning 'Directory records' instead of 'Insurance records'. Still well-rounded.

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%, and the description adds value by explaining pagination parameters ('Use page and per_page to control pagination; the response includes pagination metadata.') and highlighting required parameters. This goes beyond the schema descriptions 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 returns a list of insurances for a specified company vendor. It specifies the resource and action, and mentions pagination and filtering. However, it does not explicitly differentiate from sibling tools like 'list_company_insurances' or 'list_project_vendor_insurances', which limits clarity.

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 a use case: 'enumerate Directory records... to find IDs, or to filter by query parameters.' It implies pagination usage but does not state when to avoid this tool or mention alternatives (e.g., for all company insurances). The guidance is adequate but lacks exclusions.

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