Set Document Property

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

The annotations already establish that this is a non-read-only, non-destructive, open-world, non-idempotent operation. The description adds useful behavioral detail that the value is validated against the property type, but it does not explain why the operation is marked non-idempotent, what permissions may be required, or what happens when validation fails.

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 concise sentence with the core operation and validation behavior front-loaded. There is no wasted text.

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 and annotations covering its safety profile, which reduces what the description must carry. Still, it lacks guidance on how this mutation differs from related property tools and leaves workspaceId semantics unexplained.

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 only 50%, and the description mostly repeats what the schema already documents for value and property. It does not explain docId or the optional workspaceId, and does not compensate for the undocumented 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 states a specific verb and resource: setting a document's custom property value. It also clarifies that the property can be identified by id or name. However, it does not differentiate this tool from nearby siblings such as clear_doc_property, list_doc_properties, or create_custom_property.

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 explicit guidance on when to use this tool versus alternatives. The description does not mention clear_doc_property for clearing a value, create_custom_property for defining a new property, or list_doc_properties for inspection. Usage is only implied by the verb 'set'.

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