haops_upload_help_image

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

Without annotations, the description carries the burden of behavioral disclosure. It states it uploads (mutation), requires admin privileges, accepts base64 data, and returns an attachment record with a URL. This is clear and adequate, though it does not mention potential side effects or limits.

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 only three sentences, no redundant words, and front-loads the main purpose. Every sentence adds value without being verbose.

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?

The description covers the action, input format, access restriction, and return value. Without an output schema, it provides enough context for a simple upload tool. However, it does not differentiate from similar sibling tools or mention any limitations (e.g., file size), leaving some uncertainty.

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%, so the baseline is 3. The description does not add significant meaning beyond what the schema already provides for each parameter. The mention of 'base64-encoded image data' and 'Admin-only' provides context but not parameter-specific details beyond the schema.

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 and resource ('Upload an image to a help article'), but does not differentiate from the sibling tool 'haops_upload_doc_image', which could cause confusion for an AI agent selecting between them.

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?

The description mentions 'Admin-only' as a prerequisite and specifies that it accepts base64 data, but does not provide guidance on when to use this tool versus alternatives like 'haops_upload_doc_image' or when not to use it.

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