get_approval

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

With no annotations, the description implies a read operation but does not disclose side effects, authentication needs, error behavior, or any restrictions. It minimally covers the purpose but lacks depth.

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: one sentence for purpose followed by a short parameter list. It is front-loaded but could benefit from structured formatting (e.g., bullets) for readability.

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 simple retrieval tool with an output schema, the description covers the essential: what is retrieved (approval details including decisions) and required parameters. It is adequate but does not mention error cases or data scope.

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?

Despite 0% schema coverage, the description adds meaning: issue_id_or_key is explained as 'issue key (e.g. 'X000') or numeric issue ID', and approval_id as 'numeric approval ID'. This clarifies the format beyond the schema's generic 'string' type.

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 'Get details of a specific approval including approver decisions.' It specifies the verb (get) and resource (approval details), and distinguishes from siblings like list_approvals (list all) and answer_approval (action).

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 like list_approvals. No prerequisites, context, or exclusions are mentioned.

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