update_wiki_page

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

No annotations, so description carries full burden. Details PATCH behavior (only provided fields change), base64 handling, risk of rename, and return of updated page. Could include error handling or permissions but covers major behaviors.

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?

Five sentences, front-loaded with key info (PATCH, content handling, risk). No wasted words; every sentence adds value.

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?

Covers main aspects for a 6-param tool with no output schema: behavior, risk, and return type. Lacks explanation of error scenarios or owner/repo defaults, but schema descriptions suffice.

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?

Adds significant value beyond 100% schema coverage: explains content as plain Markdown with automatic base64, explicitly states title renames the page, and clarifies pageName as wiki URL form.

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 the tool edits an existing wiki page via PATCH, specifying the resource (wiki page) and verb (edit). Differentiates from siblings like get_wiki_page and create_wiki_page by focusing on editing and advising to read first.

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?

Provides explicit guidance: use to edit a wiki page, with warning about renaming breaking links. Advises to read with get_wiki_page first if uncertain. Lacks explicit when-not-to-use but covers key context.

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