Get Pipeline

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

With no annotations provided, the description carries the full burden. It discloses the exact return scope (name, icon, statuses, permissions, sharing settings) and explicitly excludes pipeline items. It does not mention potential errors or permission requirements, but covers the core behavior well.

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 with no filler. First sentence states purpose, second sentence lists return contents and explicitly names an alternative for excluded data. Efficient and well-structured.

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 operation with one parameter and no output schema, the description fully explains what the tool returns and what it does not return, and provides an alternative for the excluded case. It is complete and self-contained.

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 already documents the single parameter (pipeline_id) with 100% coverage. The description adds minimal semantic value by referring to 'pipeline configuration', but the schema description is sufficient and the description doesn't introduce additional nuance.

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 states a specific verb ('Get') and a specific resource ('pipeline configuration'), with details on what information is returned (name, icon, statuses, permissions, sharing settings). It also explicitly distinguishes itself from related tools like search_pipeline_items and get_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 explicitly states what the tool does NOT return and directs users to an alternative ('Does not return pipeline items - use search_pipeline_items for that'). This provides clear when-to-use versus when-not-to-use guidance.

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