taiga_issues_get_by_ref

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

No annotations are provided, so the description carries the full behavioral disclosure burden. It only states 'Get an issue', which is a read operation, but it does not describe what data is returned, whether it fails for invalid refs, or any authentication requirements. The description adds minimal behavioral context beyond the obvious.

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 an eight-word sentence that immediately conveys the operation and its key scope. There is no filler, redundant phrasing, or unnecessary detail, making it highly concise and 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?

For a simple getter with two well-specified parameters, the description is adequate but not complete. It does not describe the return value (e.g., 'returns the full issue object') or any failure behavior, and there is no output schema to compensate. However, the operation is straightforward, so a minimal description is somewhat acceptable.

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?

The schema already provides descriptions for both parameters: 'Issue ref number' for ref and 'Project ID' for project. The description 'by ref and project' reinforces that these are lookup keys but adds no new meaning beyond the schema. With 100% schema coverage, the baseline 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 'Get an issue by ref and project' clearly states the verb (get), the resource (issue), and the key identifiers (ref and project). This distinguishes it from taiga_issues_get, which presumably fetches by internal ID, and from list/create/update/delete operations.

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 implies usage is appropriate when you have an issue's ref and project ID, but it does not explicitly contrast with alternatives like taiga_issues_get (which likely uses the issue ID). No exclusions or 'when not to use' guidance is provided, leaving the agent to infer the distinction from naming.

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