List Workflow Instances (Company)

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

Annotations already indicate readOnlyHint=true, destructiveHint=false, idempotentHint=true, and openWorldHint=true. The description adds value by stating that the tool returns a paginated JSON array with metadata, and does not contradict any annotations. It provides additional context about pagination behavior.

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 concise, front-loaded with purpose, and covers usage, response format, required parameters, and API reference in a few sentences without redundancy.

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 has 10 parameters, no output schema, and good annotations, the description provides a complete overview. It mentions pagination metadata and required parameters. However, it could elaborate on the structure of the returned workflow instances.

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?

The input schema has 10 parameters with 100% description coverage. The description reinforces pagination parameters and lists required ones. It adds marginal value by explaining the purpose of pagination and mentioning the endpoint, but the schema already covers all parameters.

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 returns a list of workflow instances for a given company, using specific verb 'Returns' and resource 'workflow instances'. It distinguishes from siblings like 'list_workflow_instances_project' by specifying 'for a given company' and mentions pagination and filtering.

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 explicitly says 'Use this to enumerate Workflows when you need a paginated overview, to find IDs, or to filter by query parameters.' It provides clear context for when to use the tool, though it does not explicitly state when not to use it or offer alternatives.

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