Patch Managed Object Relationship

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

Annotations already convey destructive and open-world behavior. Description adds the custom_ prefix constraint and schema service usage, but no additional behavioral traits like permissions or side effects are disclosed.

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?

Two sentences, zero wasted words. All essential information is presented efficiently and front-loaded.

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?

Covers key aspects: operation, prefix requirement, definition needs, and reference schema. Lacks explicit error handling or return value description, but no output schema exists.

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 has 100% parameter description coverage. Description adds value by reinforcing the custom_ prefix for propertyName and directing users to getManagedObjectSchema for the propertyDefinition structure.

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 clearly states the tool adds, updates, or removes a custom relationship property on a managed object type. It distinguishes from siblings like patchManagedObject by focusing specifically on relationship properties.

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?

Explicitly states the custom_ prefix requirement and that a full property definition is needed for add/update. Lacks explicit when-not-to-use or alternative tools, but the context is clear enough.

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