update_article

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

The description discloses that the tool returns previous values for rollback and explains that empty strings for summary and content mean keep the existing value. However, with no annotations, the burden is higher; it lacks information on side effects, permissions, or error behavior.

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 extremely concise with a single explanatory sentence and a clear bulleted list of arguments. No extraneous words or redundant 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?

Given the tool's simplicity (4 parameters, output schema exists), the description covers purpose, parameter semantics, and return behavior. It could be more complete by mentioning any constraints like required permissions or behavior on error, but it is generally adequate.

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 adds significant meaning beyond the schema property names. It explains each parameter's purpose and behavior (e.g., 'New title (empty = keep)', 'instance (optional)'), compensating for zero schema description coverage.

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 'Update a Knowledge Base article' with a specific verb and resource, and explicitly mentions returning previous values for rollback, which distinguishes it from sibling tools like create_article and get_article.

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 alternatives like create_article or search_articles. The description does not include any context about prerequisites, when not to use, or comparison with siblings.

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