get_pipeline_definition

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

With no annotations provided, the description carries the full burden. It conveys that this is a read-only 'Get' operation, that it returns a dictionary with decoded activities and dependencies, and that workspace falls back to context. It does not detail error behavior or permissions, but the non-mutating nature is reasonably clear.

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 compact and well-organized into Args, Returns, and an Example. Every section adds useful information, and the example demonstrates realistic invocation. There is no filler or 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?

For a simple two-parameter getter, the description provides enough context: it explains the return value, the meaning of each parameter, and an example. Since there is no output schema, the Returns section is valuable. The main gaps are lack of explicit error/not-found behavior and any mention of permissions, but these are not critical for this tool.

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 description coverage is 0%, so the description must compensate. It does so by explaining that pipeline accepts a name or ID and that workspace is an optional name or ID that uses context when omitted. However, it also lists 'ctx' as an argument even though it is absent from the input schema, which could cause confusion.

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 and resource: 'Get the definition of an existing Data Pipeline including activities and dependencies.' This clearly distinguishes it from sibling tools like create_data_pipeline, pipeline_run, and pipeline_status.

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 makes the purpose clear and notes that workspace is optional, but it does not explicitly state when to use this tool versus alternatives such as create_data_pipeline or pipeline_logs. The word 'existing' implies it is for reading, not creating, but no explicit exclusions or alternative routing are provided.

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