Skip to main content
Glama

jira_read

Fetch a JIRA issue by key and return its content as JFM markdown or raw ADF JSON. Optionally write output to file for large issues.

Instructions

Fetch a JIRA issue by key (e.g. PROJ-123). Returns JFM markdown (default, AI-friendly GitHub-style markdown — see resource omni-dev://specs/jfm) or the raw ADF description JSON when format = "adf". When output_file is set, the content is written to that path and the tool returns a short YAML summary (path/bytes/format) — useful for large issues. Assignee/reporter and other people fields are Atlassian account IDs — resolve them to display names with jira_user_get.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
keyYesJIRA issue key (e.g., `PROJ-123`).
formatNoOutput format — `jfm` (default) returns JFM markdown with YAML frontmatter; `adf` returns the raw ADF description payload as JSON.
output_fileNoWhen set, writes the rendered content to this path and returns a short YAML summary (path/bytes/format) instead of the inline body. Useful for large issues that would otherwise blow past the context window — the assistant can then read the file with offset/limit.
Behavior4/5

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

No annotations, so description carries full burden. Discloses return formats, output_file behavior, and notes that people fields are account IDs. Lacks mention of error conditions, but overall good for a read tool.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two sentences, front-loaded with main purpose, no fluff. Each sentence adds information.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Covers main behavior, output_file edge case, and format explanation. Returns are described (JFM/ADF or YAML summary), but JFM details are deferred to an external spec. Missing inline structure could be a minor gap.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema already covers all parameters (100% coverage). Description adds significant context: default format, effect of output_file, and rationale for its use (avoid context blowup). Also explains ADF vs JFM.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Clearly states verb 'Fetch' + resource 'JIRA issue' + identifier 'by key (e.g. PROJ-123)'. Distinguishes from sibling search and write tools. Also covers alternative output formats and file usage.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly explains when to use default JFM markdown vs ADF JSON, and when to use output_file for large issues. Provides sibling reference (jira_user_get) for resolving account IDs.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/rust-works/omni-dev'

If you have feedback or need assistance with the MCP directory API, please join our Discord server