upload_attachment

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

Discloses directory creation and return value, but omissions include: what happens if the page doesn't exist, file size limits, overwrite behavior, permissions needed. With no annotations, the description should provide more behavioral details.

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, front-loaded with the action and key outcomes. No irrelevant 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?

Covers main action and return value, but lacks details on error handling, size limits, idempotency, and prerequisites. Adequate for basic usage but not fully complete given no output schema.

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 description coverage is 60%, but the description does not add meaning to undocumented parameters (collectiveId, pageId). The example of markdown path is helpful but does not compensate fully for the lack of parameter context.

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 (upload an attachment to a page) and distinguishes it from sibling tools like delete_attachment or list_attachments. It also adds value by mentioning directory creation and returned markdown path.

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 explicit guidance on when to use vs alternatives (e.g., delete_attachment, list_attachments). The purpose is clear but lacks context for appropriate usage scenarios.

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