upload_attachment

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

Annotations already indicate non-destructive write behavior; the description adds reassurance by stating it 'never touches the parent item's own fields or version'. It also explains why content_base64 is required (remote server, no local filesystem access), which is valuable context beyond the schema.

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 well-structured: a one-sentence purpose, a safety note, and a clean parameter list. Every sentence adds value, and the parameter explanations are concise yet informative.

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 core behavioral aspects and parameter semantics, but misses explicit mention of parent_key and what the response contains (e.g., the new item key). Given no output schema, stating the response would improve completeness, but the tool is still adequately described for 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?

With 0% schema description coverage, the description compensates by explaining filename (extension for contentType), content_base64 (base64-encoded bytes, remote server reason), and title (defaults to filename). However, parent_key is not explicitly described, though its role as the parent item identifier is inferable.

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 uploads a new file attachment as a child of an existing item, with an example (attaching a PDF to a journalArticle). This distinguishes it from sibling tools like download_attachment, list_attachments, and create_item.

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 implies usage context through the example and explicit mention of 'child of an existing item', but does not explicitly contrast with alternatives. Sibling tool names provide some differentiation, though excluding 'download_attachment' or 'list_attachments' would make it clearer.

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