get_etl_pipeline

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

No annotations are present, so the description carries the full burden. The verb 'Return' weakly implies a read‑only operation, but the description does not explicitly declare read-only status, failed-handling, permission requirements, rate‑limits, or any other behavioral trait. This is a bare minimum and offers no real transparency for an unannotated tool.

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 sentence that wastes no words; it clearly states the main action and object. It is front-loaded and easy to parse. It could have included more useful detail, but that would not negatively affect conciseness; therefore it is an effective but minimal structure.

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?

The tool has an output schema, so the return shape is covered. However, the description does not establish why this tool is the correct one among the many list_* and get_* inputs in the sibling set. It also does not define the scope of the retrieved document (e.g., whether it includes steps, dependencies, lineage) making the tool's capabilities ambiguous. The context is therefore not complete for reliable tool selection and invocation.

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 input schema has 0% description coverage, and the description adds no meaning to pipeline_id. It does not explain what a pipeline_id is, whose identifier it is, the format, or how to obtain it. With such low schema coverage, the description must compensate completely, but it fails to tell the agent how to populate the only required parameter correctly.

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 the action (Return) and the resource ('the producer-owned normalized ETL metadata document'), giving a specific enough purpose to distinguish it from immediate siblings like get_etl_pipeline_steps or get_etl_table_lineage. However, 'producer-owned' is domain-specific and not explicitly put in contrast with other pipeline tools, so it is clear but not fully self-contained.

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?

There is no guidance on when to choose this tool over list_etl_pipelines, get_etl_pipeline_steps, get_etl_pipeline_dependencies, or other related tools. The description alone does not say which scenario calls for the full metadata document rather than a subset or a search result, so the agent is left with incomplete routing information.

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