List Shared Steps

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

No annotations are present. The description does not disclose behavioral traits such as authentication requirements, rate limits, or whether the list is paginated. For a read operation, minimal risk is implied but not stated.

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?

Two sentences front-load the purpose and concisely add key details. No unnecessary words.

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 and 100% parameter documentation, the description adequately covers the tool's functionality. It could mention pagination or default ordering, but the core user needs are addressed.

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 schema covers all parameters. The description adds meaning by explaining the `include` parameter (for test case usage counts) and the `sortField` parameter (sort by title or creation date), enhancing understanding beyond the schema.

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 lists reusable shared steps for a project, specifying optional sorting and inclusion of test case usage counts. It does not explicitly distinguish from sibling tools like list_shared_preconditions, but the purpose is distinct.

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?

Describes how to use the returned `id` as `sharedStepId` in other tools, providing some usage context. However, it lacks guidance on when to choose this tool over alternatives like get_shared_step or list_shared_preconditions.

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