update_wiki_page

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

With no annotations, the description carries burden but only adds concurrency control and default session info. It does not disclose whether the update is partial or full replacement, error behavior on version conflict, or authorization needs.

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 that front-load the action and concurrency requirement, with no wasted words.

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 5-parameter tool with output schema, the description covers the essential concurrency and session behavior but omits semantics of kwargs and verbosity. Partial update behavior is not clarified, though output schema may explain return values.

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 0%, so description must compensate, but it only explains wiki_page_id and version. The crucial kwargs parameter (likely for other fields) and verbosity are not described, leaving ambiguity.

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 updates an existing wiki page's content, slug, or other fields. It distinguishes from sibling tools like create_wiki_page or delete_wiki_page by specifying the update action.

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?

Mentions the requirement for the current version number for optimistic concurrency and default session behavior. However, it does not explicitly state when to use this tool over alternatives like create_wiki_page for modifications or provide context on prerequisites.

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