Download attachment content

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

Annotations already declare readOnlyHint=true, destructiveHint=false, and idempotentHint=true, so safety profile is clear. Description adds authorization class and endpoint details. However, it does not disclose error conditions, expected content type, or size limitations. With strong annotations, the description adds moderate value.

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?

Description is very concise (three lines) with front-loaded purpose. However, there is an empty line that could be removed for efficiency. Every sentence earns its place, but the brevity sacrifices completeness.

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?

Despite having an output schema (mentioned in context), the description is incomplete. It lacks details on error handling, content type, size limits, and prerequisite steps. For a tool with one parameter and no schema descriptions, the agent needs more context to use it correctly.

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%, and the description does not explain the 'attachmentId' parameter. It fails to add meaning beyond the schema structure, such as how to obtain the ID or what format it should be. The agent must infer from 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?

Title 'Download attachment content' and description clearly state the tool's purpose: downloading attachment content. It specifies the HTTP method and authorization class. It distinguishes from siblings like pc_get_issues_by_id_attachments (list) and pc_delete_attachments_by_attachment_id (delete). However, it could be more specific about the returned content type.

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 guidance on when to use this tool versus alternatives. It does not explain prerequisites (e.g., needing an attachment ID from a list operation) or when not to use it. Siblings like pc_get_issues_by_id_attachments are not mentioned as alternatives.

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