add_journal_attachment

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

Annotations indicate this is a write operation (readOnlyHint=false) and may have side effects (openWorldHint=true). The description adds useful behavioral details: supported file types, 10MB size limit, and directory restrictions, which go beyond annotations and help the agent understand constraints.

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 concise (4 sentences), front-loaded with the main action, and provides details in a logical order. Every sentence adds value, though it could be slightly tighter.

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 file constraints and use cases but does not mention return values or what happens after upload (e.g., success message, attachment ID). Given no output schema and modest complexity, it is adequate but has gaps.

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 100% schema description coverage, the schema already clearly documents parameters. The description does not add new semantic meaning beyond what is in the schema (e.g., env var fallback for organization_id is mentioned in schema). Baseline score of 3 is appropriate.

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 file attachment to a journal entry, listing supported file types and use cases. It distinguishes from siblings by specifying 'journal entry' but does not explicitly contrast with other add_attachment tools like add_bill_attachment or add_invoice_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 gives usage context: attaching invoices/receipts to journal entries, and provides constraints (file types, size, directories). However, it lacks explicit when-not-to-use guidance or alternatives such as using add_bill_attachment for bills.

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