set_metadata

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

With no annotations, the description must disclose behavioral traits. It states 'Set' (mutation) but does not mention whether existing values are overwritten or merged, error handling, or authorization requirements. Returns only 'Success or error message' without details.

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 concise, front-loads the purpose, and uses a structured list for parameters. However, the 'Returns' line could be merged or omitted given the output schema exists.

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?

With 6 optional parameters, no annotations, and an output schema (though not detailed), the description lacks completeness. It does not explain the return value structure, error behaviors, or how missing parameters are handled. The agent may need to infer behavior from the schema.

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?

The description lists parameter names (title, author, etc.) with minimal elaboration (e.g., 'Document title'), adding little beyond the schema. Schema description coverage is 0%, so the description should provide more context, such as format constraints or expected behavior when multiple fields are set.

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 tool's action ('Set') and resource ('document metadata/properties'), distinguishing it from the sibling 'get_metadata' which retrieves metadata.

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 on when to use this tool versus alternatives (e.g., specific set_* tools for individual properties) or prerequisites (e.g., document must be open). The description assumes the agent knows the context.

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