get-pipeline

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

No annotations exist, so the description bears full responsibility for disclosing behavior. It fails to mention handling of deleted pipelines (though the 'include' parameter hints at this), error responses, or response structure. Minimal disclosure.

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?

A single, well-structured sentence with no unnecessary words. While very concise, it could afford a bit more detail without becoming 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?

No output schema is provided, and the description does not explain return values or how parameters like 'fields' and 'extractFields' affect output. Lacks completeness for a tool with moderate complexity.

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 75%, and the description adds no additional parameter context. The schema descriptions for id, fields, include, and extractFields are sufficient, so the description does not add value 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 'Get pipeline details by UUID' clearly specifies the action (get), resource (pipeline details), and identifier (UUID). It distinguishes from sibling tools like 'get-pipeline-by-name' and 'list-pipelines'.

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 use for retrieving a single pipeline by UUID but gives no explicit guidance on when to prefer this over alternatives like 'get-pipeline-by-name' or 'list-pipelines'. No when-not-to-use context.

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