trmnl_pipeline_read

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

Annotations already cover read-only, idempotent and non-destructive, so the description's added claim that the definition contains environment-variable references rather than resolved credentials is genuine value — it tells the agent up front that secrets cannot be retrieved this way. It doesn't cover error behavior or whether the definition is editable in place, keeping it below a 5.

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?

One sentence, front-loaded with the verb and resource, and the credential caveat is placed prominently. It is arguably under-sized rather than padded, which is the right failure mode but still leaves gaps.

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 one-parameter read tool with full annotation coverage and no output schema, the description conveys the shape of the returned payload conceptually (references, not secrets). It lacks any statement about the id's meaning or failure behavior on a missing pipeline, so it is adequate but not complete.

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% and the description never explains the single 'id' parameter — not whether it is the pipeline id, a slug, or the same identifier used by trmnl_pipeline_run. The pattern constraint exists only in the schema and the description adds nothing to it.

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?

States a specific verb ('Read') and resource ('a pipeline definition'), which is clearly distinct from the pipeline siblings that save, list, enable, or run. It stops short of naming those siblings, so differentiation is by inference rather than explicit routing.

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?

Usage is only implied: an agent can infer this is the fetch-by-id counterpart to trmnl_pipeline_save/pipeline_list. There is no explicit statement of when to prefer it over trmnl_pipeline_list or what happens if the id is unknown.

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