deployment_pipeline_update

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

The annotations already indicate readOnlyHint=false and destructiveHint=false, so the description adds no new behavioral context beyond the fact that this is an update. It doesn't disclose side effects, whether changes are immediately visible, whether existing settings are preserved, or any permission requirements. No contradiction exists, but there is also no added transparency.

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 a single front-loaded sentence that conveys the essential operation with no wasted words. It is appropriately sized for a simple update tool with three well-documented parameters.

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 update operation with three flat parameters and full schema coverage, the description is largely sufficient to understand what the tool does. It could be marginally improved by noting that only the specified fields are changed and others remain intact, but the core invocation context is 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 100%, so the schema fully documents all three parameters. The description adds minimal semantic value by mentioning 'name or description', which maps to displayName and description, but it does not provide additional details about formats, constraints, or relationships between parameters.

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 clearly states the action ('Update') and the resource ('a deployment pipeline'), and identifies the mutable fields ('name or description'). It does not explicitly differentiate from sibling tools like deployment_pipeline_get or deployment_pipeline_create, but the verb and resource scope are unambiguous.

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 use this tool versus alternatives, nor any mention of when not to use it. For example, it doesn't note that deployment_pipeline_get should be used to retrieve a pipeline, or that creating/deleting pipelines requires different tools. The usage context is only implied by the tool name and description.

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