wetrack_add_ticket_attachment

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

No annotations are provided, so the description carries the burden. It discloses the S3 precondition and the required fields, but does not state what happens on success/failure, whether the attachment is immediately visible, or any side effects. The precondition is useful behavioral context, but the description is otherwise thin on runtime behavior.

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 compact and front-loaded with the core action and precondition, followed by a concise parameter list. The parameter list is slightly redundant with the schema but earns its place by adding semantic detail. No wasted sentences.

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?

For a 5-parameter tool with no annotations and 0% schema coverage, the description covers the key workflow (upload first, then attach) and all parameter meanings. It doesn't describe the output schema, but an output schema exists, so the description needn't explain return values. Minor gap: no error/edge-case guidance, but the core call is well specified.

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 0%, so the description must compensate. It does: it explains ticket_id is a UUID, url is the S3 URL of the uploaded file, file_name is the original name, file_size is in bytes, and file_type is a MIME type. This adds meaning beyond the bare schema titles, though it doesn't clarify why file_type is optional/nullable.

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 states a specific verb ('Add'), a specific resource ('file attachment to a ticket'), and a critical precondition ('the file must already be uploaded to S3'). It is clearly distinguishable from sibling tools like wetrack_add_ticket_comment and wetrack_delete_ticket_attachment.

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 explicitly tells the agent to use wetrack_get_upload_presign_url to upload to S3 first, then call this tool. This is a clear when-to-use instruction and names the prerequisite alternative. It also implies this is the correct tool after upload, distinguishing it from the delete/comment siblings.

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