get_epic

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

Indicates it is a read operation ('Gets detailed information') but does not elaborate on potential side effects, authentication requirements, or rate limits. Without annotations, more disclosure about safety or permissions would be beneficial.

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 concise sentences that front-load the main purpose, then provide usage alternatives and parameter details. No unnecessary information.

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?

Given the presence of an output schema (so return values need not be described), the description covers key aspects: ID type differentiation, verbosity, session handling. Adequate for a simple retrieval tool.

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?

Compensates for 0% schema coverage by explaining that epic_id is the internal ID (not the ref number), describing the verbosity options and their defaults, and noting the session_id default. Could add more detail about possible verbosity values.

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?

Clearly states it retrieves detailed information about a specific epic using its internal ID. Explicitly distinguishes from get_epic_by_ref, which uses the reference number shown in Taiga UI.

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?

Provides explicit guidance on when to use this tool (internal ID) versus get_epic_by_ref (reference number). Also explains default session behavior and verbosity levels.

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