get_issue
Gets one issue's full content and comments by its key (e.g. 'BRD-42').
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| issueKey | Yes | The issue's key, e.g. 'BRD-42'. |
Gets one issue's full content and comments by its key (e.g. 'BRD-42').
| Name | Required | Description | Default |
|---|---|---|---|
| issueKey | Yes | The issue's key, e.g. 'BRD-42'. |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, but 'Gets' makes clear this is a read-only retrieval, and 'full content and comments' specifies the return scope. It does not discuss auth, errors, or edge cases like missing keys, though for a simple get-by-key tool this is generally sufficient.
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?
One tightly worded sentence with an example; no filler. The key operation and scope are 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 low-complexity single-key tool, the description provides the necessary input and return context even without an output schema or annotations. It omits not-found/error behavior but that is minor for this 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?
Schema already covers the only parameter with the same example, so the description adds little beyond restating the key format. The 100% schema coverage means the description doesn't need to compensate.
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?
States a specific verb ('Gets') and resource ('one issue's full content and comments') and identifies the input key with an example. This clearly distinguishes it from sibling list_issues (which returns multiple) and comment mutation tools.
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?
Implies use for retrieving a single issue's details, but does not explicitly say when to prefer it over list_issues or how it relates to comment tools. No exclusions or alternative routing are given.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.