cml_update_relationship

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

With no annotations, the description must disclose behavioral traits such as idempotency, partial vs full update, or required permissions. It provides none, leaving the agent without critical safety or side-effect information.

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?

Extremely short but under-specified. A single sentence that fails to convey necessary information; this is not conciseness but omission. A good description front-loads key details, which is absent here.

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?

Given no output schema and 5 parameters with enums, the description provides no explanation of return values, side effects, or how the update interacts with the model. It is severely incomplete for a mutation 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 coverage is 100% (all parameters described in schema), so baseline is 3. The description adds no additional meaning beyond what the schema already provides, such as explaining how 'upstreamPatterns' or 'exposedAggregates' affect the relationship.

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?

Description is 'Update a relationship' which merely restates the tool name without specifying what kind of relationship (e.g., CML relationship between bounded contexts). It lacks a verb+resource that clarifies the tool's scope, making it a tautology.

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?

No guidance is provided on when to use this tool versus siblings like cml_create_relationship or cml_delete_relationship. The description offers no context on appropriate use cases or prerequisites.

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