Get Workflows

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

Annotations already declare readOnlyHint=true and idempotentHint=true, so the description's job is to add context beyond that. It adds conceptual background on workflows and API endpoints but does not disclose operational details like pagination or return format, which is acceptable given the output schema exists.

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 first sentence is front-loaded with the core action. The following two sentences provide background context on workflows, which adds some value but is not strictly necessary. The description is appropriately sized, not overly verbose.

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 simple read-only list tool with no parameters and an output schema, the description adequately states its purpose. It does not need to explain return values due to the output schema. The background context helps a bit, but operational details like pagination are not mentioned, which is acceptable for this simplicity.

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 tool has zero parameters, and the schema coverage is 100% as there is nothing to document. The baseline for 0 params is 4, and the description does not need to add parameter semantics.

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 'Get all workflow API endpoints from Itential Platform' with a specific verb and resource. It distinguishes this from sibling tools like start_workflow or expose_workflow by focusing on retrieval of endpoint definitions rather than execution or exposure.

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 implies usage for listing all workflow API endpoints and provides context on why workflows are important. However, it does not explicitly mention alternatives or exclusions, such as when to use start_workflow or expose_workflow instead.

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