athena_diagnose_error

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

With no annotations provided, the description carries full burden. It discloses the tool's diagnostic nature, the types of errors handled, and the output (causes, fixes, KB links). It implies a read-only operation with no side effects, which is transparent. However, it does not mention any limitations or edge cases.

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?

Three sentences, each contributing unique value: first sentence states the main function, second describes the output, third lists supported error categories. No redundancy or unnecessary details. Front-loaded.

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 adequately covers the tool's purpose, input, output, and error scope. No output schema exists, but the description mentions what is returned. It does not specify whether all error types are covered or mention related sibling tools for context, but overall it is sufficient for understanding the tool's functionality.

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 100%, with both parameters described. The description adds no additional information about parameter usage beyond what the schema provides (errorMessage and context). Baseline 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 diagnoses athenahealth API or Snowflake DataView errors. It specifies the verb 'diagnose' and the resource 'error', and lists the types of errors handled (HTTP status codes, error strings, OAuth/scope, SQL errors). This distinguishes it from sibling tools like athena_search_kb, which is a general knowledge base search.

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 explicit guidance on when to use this tool versus alternatives. The description implies it is for error diagnosis, but does not mention when not to use it or provide comparisons to siblings like athena_explain_view or athena_search_kb.

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