Update Article

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

Description adds behavioral context about optimistic locking ('must include the version field'), which is beyond annotations. Annotations already indicate idempotent hint and non-destructive, so bar is lowered; description enriches understanding.

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 concise sentences: first states purpose, second adds critical requirement. No wasted words; front-loaded with key information.

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 2-parameter tool with annotations and no output schema, the description provides essential behavioral context (optimistic locking). It does not explain the full return or error handling, but that is acceptable.

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% with descriptions for both parameters. The description adds value by emphasizing the version field requirement for optimistic locking, which is not fully captured in the schema propertyNames or description.

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?

Clearly states 'Update an existing article' with specific verb and resource, and is distinct from sibling tools like create, delete, and get.

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?

Implies usage for updating articles but provides no explicit guidance on when to use vs alternatives (e.g., when to use update vs create). No exclusions or when-not-to-use indicated.

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