devops_wiki_page_create_or_update

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

No annotations are provided, so the description must fully disclose behaviors. It does not mention permissions, auth requirements, idempotency, or that updating will overwrite existing content. The description is insufficient for a write tool.

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 a single sentence of 12 words, efficiently conveying the main purpose. It is front-loaded with the action. While concise, it could be structured with more detail for clarity, but it earns its place without waste.

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 has 6 parameters, no annotations, and multiple sibling tools, the description is incomplete. It does not mention output, usage scenarios, or differentiate from related tools like 'devops_wiki_page_update'. More context is needed for proper selection and invocation.

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 input schema covers 83% of parameters with descriptions. The description adds no additional parameter-level meaning beyond what the schema already provides. The baseline of 3 is appropriate as the schema does the heavy lifting.

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 action (create or update) and resource (wiki page) under a parent. However, it does not explicitly explain when an update occurs versus creation, which is detailed only in the parameter schema. This leaves slight ambiguity but still distinguishes it from pure read or delete siblings.

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 'devops_wiki_page_update' or 'devops_wiki_page_get_by_url'. The description lacks context on when to prefer this tool over siblings, such as for update by title vs. update by ID.

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