| name | atlassian-rest |
| description | Interact with Atlassian Jira and Confluence using REST APIs — no MCP server needed. Use this skill whenever the user mentions Jira, Confluence, Atlassian, tickets, issues, sprints, backlogs, epics, stories, or any project management task that involves creating/editing/searching/transitioning Jira issues, writing or reading Confluence pages, generating status reports, triaging bugs, converting specs to backlogs, capturing tasks from meeting notes, searching company knowledge, syncing local BMAD documents with Jira or Confluence, pushing docs to Jira, pulling from Jira, linking documents to tickets, downloading Confluence spaces to local markdown, or converting between Confluence storage format and markdown. Also trigger when the user says things like "move that ticket to done", "what's the status of PROJ-123", "create a bug for X", "search our wiki for Y", "file a ticket", "check for duplicates", "write a status update", "break this spec into stories", "sync this doc", "push to jira", "pull from jira", "sync to confluence", "link this to jira", "sync my epics", "download confluence pages", "sync confluence space", "convert confluence to markdown", or "pull docs from confluence". If there is even a chance the user wants to interact with Jira or Confluence, use this skill.
|
OMP / Multi-instance Usage
This skill is vendored from bmad-labs/skills with OMP-specific additions.
Pending PRs upstream: get-issue projection, search pagination offset.
If those PRs merge, replace this vendored copy with a clone-on-install approach in setup/APPS/omp.sh.
Use omp-atlassian.sh for all invocations — it resolves credentials per instance:
omp-atlassian.sh rp jira.mjs search "project = RP AND status != Done"
omp-atlassian.sh asu jira.mjs search "project = ASU"
omp-atlassian.sh rp confluence.mjs search "space = RP AND title ~ onboarding"
Credentials are read from env by convention: <INSTANCE>_EMAIL, <INSTANCE>_ATLASSIAN_TOKEN, <INSTANCE>_ATLASSIAN_URL.
Define these in ~/.doNotCommit.d/ — never in this skill.
Atlassian REST API Skill
Portable Jira & Confluence integration via REST APIs. Works in any agent environment with Node.js 18+ — zero dependencies, no MCP server required.
First-Use Setup
<skill-path> throughout this document refers to the directory where this skill is installed. Resolve it from the skill invocation context (e.g., the path shown by claude plugin list or the skill's directory in .claude/plugins/).
Before any operation, verify the user has credentials configured. Run:
node <skill-path>/scripts/setup.mjs
If it fails, guide the user through the setup — the script prints step-by-step instructions.
Required Environment Variables
| Variable | Description | Example |
|---|
ATLASSIAN_API_TOKEN | API token | (generated at Atlassian) |
ATLASSIAN_EMAIL | Account email | user@company.com |
ATLASSIAN_DOMAIN | Atlassian site domain | company.atlassian.net |
How to Use This Skill
When the user asks you to do something with Jira or Confluence, follow these principles:
-
Resolve ambiguity first. If the user says "create a ticket" but hasn't specified a project, run node <skill-path>/scripts/jira.mjs projects to list available projects, then ask which one. Same for issue types — run node <skill-path>/scripts/jira.mjs issue-types <projectKey> if unsure.
-
Confirm before mutating. Before creating issues, transitioning tickets, or publishing Confluence pages, show the user what you're about to do and get confirmation. Read operations (search, get, list) don't need confirmation.
-
Never delete. This skill does not support delete operations (issues, pages, attachments, boards, projects, accounts, etc.). If the user asks to delete something, direct them to the Atlassian web UI. This restriction is intentional and must not be bypassed.
-
Compose operations naturally. Many user requests require multiple script calls. For example, "assign PROJ-123 to Sarah" requires: (a) lookup-user "Sarah" to get the account ID, then (b) edit PROJ-123 --assignee <accountId>.
-
Prefer sync.mjs for document-based operations. When creating Jira issues from a local markdown file (story docs, specs, epics), use sync.mjs instead of raw jira.mjs create — it handles field mapping, link tracking, and sync state automatically. See the Document Sync Operations section below for details. Only use jira.mjs create for ad-hoc issues not backed by a local document.
-
Use workflows for complex tasks. If the user's request matches one of the workflows below, read the corresponding file and follow its step-by-step process.
-
Read reference docs when needed. Before writing JQL/CQL queries, consult references/query-languages.md. Before creating tickets, consult references/ticket-writing-guide.md. The reference docs exist to help you produce high-quality output — use them.
Passing Long Content to Scripts
For descriptions, comments, or page bodies longer than ~200 characters or containing special
characters (backticks, quotes, $, newlines), write the content to a temp file and use the
file-based flag:
| Inline Flag | File Flag | Commands |
|---|
--description "text" | --description-file /tmp/desc.md | jira create, jira edit |
<body> (positional) | --body-file /tmp/body.md | jira comment, confluence comment |
--body "text" | --body-file /tmp/body.md | confluence create-page, update-page |
--comment "text" | --comment-file /tmp/comment.md | jira worklog |
Write plain markdown to the file — scripts handle conversion to ADF (Jira) or storage format (Confluence) automatically. Prefer file-based input to avoid shell escaping issues.
Jira Operations
Script: node <skill-path>/scripts/jira.mjs <command> [args]
Search Issues
jira.mjs search 'project = PROJ AND status = "In Progress"' --max 20
Get Issue Details
jira.mjs get PROJ-123
jira.mjs get PROJ-123 --fields summary,status,assignee
Create Issue
jira.mjs create --project PROJ --type Task --summary "Implement feature X" \
--description "Details here" --priority High --assignee <accountId> \
--labels "backend,urgent" --components "API,Auth"
jira.mjs create --project PROJ --type Story --summary "User login" --parent PROJ-100
jira.mjs create --project PROJ --type Task --summary "Feature X" \
--description-file /tmp/desc.md --priority High
When creating child stories under an Epic, include --priority Medium unless the user specifies a different priority.
Edit Issue
jira.mjs edit PROJ-123 --summary "Updated title" --priority Medium
jira.mjs edit PROJ-123 --labels "backend,v2" --components "API"
jira.mjs edit PROJ-123 --description-file /tmp/desc.md
Comments
jira.mjs comment PROJ-123 "Fixed in PR #456"
jira.mjs comment PROJ-123 --body-file /tmp/comment.md
Transitions (move ticket status)
jira.mjs transitions PROJ-123
jira.mjs transition PROJ-123 31
Always list transitions first to get the correct ID — don't guess.
Projects & Issue Types
jira.mjs projects
jira.mjs issue-types PROJ
Issue Links
jira.mjs link-types
jira.mjs link PROJ-1 PROJ-2 --type "relates to"
User Lookup
jira.mjs lookup-user "john"
Worklog
jira.mjs worklog PROJ-123 --time 2h --comment "Code review"
Document Sync Operations
Script: node <skill-path>/scripts/sync.mjs <command> [args]
When creating Jira/Confluence items from local markdown documents, prefer sync.mjs over raw jira.mjs/confluence.mjs — it auto-updates the source document with links and maintains sync state.
Setup Field Mapping (first time per doc type)
sync.mjs setup-mapping --type story --sample PROJ-200
sync.mjs setup-mapping --type epic --sample PROJ-100
Field mappings are stored in <skill-path>/memory/ and define how markdown sections map to Jira fields. See references/sync-mapping-guide.md for the full schema.
Link & Create from Document
sync.mjs link <file> --type story --project PROJ --create
sync.mjs link <file> --type epic --project PROJ --create
sync.mjs link <file> --type story --ticket PROJ-123
Push/Pull Changes
sync.mjs push <file>
sync.mjs push <file> --delete-orphans
sync.mjs pull <file>
sync.mjs diff <file>
sync.mjs status <file>
When push reports orphaned subtasks (sections removed from local doc), ask the user if they want to delete them, then run with --delete-orphans. Only Sub-* issue types can be deleted — parent issues are skipped.
Custom Instructions in Mapping Config
The field mapping JSON (memory/jira-<docType>-field-mapping.json) supports an instructions field for additional agent guidance:
{
"instructions": "Always set priority to High. Add label 'team-alpha'. Use Sub-Imp type for child items."
}
When present, instructions are printed to stdout during push and link operations so the calling agent can follow them.
Batch Operations
sync.mjs batch
Confluence Operations
Script: node <skill-path>/scripts/confluence.mjs <command> [args]
Search Pages
confluence.mjs search 'type = page AND text ~ "architecture"' --max 10
Get Page
confluence.mjs get-page 12345
confluence.mjs get-page 12345 --format view
Create Page
confluence.mjs create-page --space TEAM --title "Sprint Report" --body "Report content"
confluence.mjs create-page --space TEAM --title "Sub Page" \
--body "<h2>Heading</h2><p>Content</p>" --parent 12345
confluence.mjs create-page --space TEAM --title "Full Doc" --body-file /tmp/body.md
The --body flag accepts markdown (recommended), plain text, or raw HTML storage format (if it starts with <). The script automatically converts markdown to Confluence storage format — headings, lists, tables, and code blocks (converted to ac:structured-macro ac:name="code" with language detection) are all handled. Prefer writing markdown and letting the script handle conversion rather than manually constructing storage format XHTML. Use --body-file for long documents that would exceed shell argument limits.
Update Page
confluence.mjs update-page 12345 --title "Updated Title" --body "New content"
confluence.mjs update-page 12345 --title "Updated Title" --body-file /tmp/body.md
Version is auto-incremented — no need to track it manually. Use --body-file for large page updates.
Comments
confluence.mjs comment 12345 "Reviewed and approved"
confluence.mjs comment 12345 --body-file /tmp/comment.md
Attachments
confluence.mjs attach 12345 ./screenshot.png --comment "Architecture diagram"
confluence.mjs list-attachments 12345 --max 10
Use attach to upload local files (images, PDFs, etc.) to a page. After uploading, embed images in the page body using <ac:image><ri:attachment ri:filename="screenshot.png" /></ac:image> — see references/confluence-formatting.md for sizing guidelines.
Sync Confluence Space to Local Markdown
node <skill-path>/scripts/sync-confluence-space.mjs --root <pageId> --output ./docs
node <skill-path>/scripts/sync-confluence-space.mjs --root <pageId> --output ./docs --dry-run
node <skill-path>/scripts/sync-confluence-space.mjs --root <pageId> --output ./docs --skip-attachments
Downloads an entire Confluence page tree to local markdown files with hierarchy, images, and linked titles. Rewrites both image references and file attachment links to point to local assets. See workflows/sync-confluence-space.md for full details and customization options.
Spaces & Navigation
confluence.mjs spaces --max 20
confluence.mjs descendants 12345
Format Conversion Utilities
Script: <skill-path>/scripts/confluence-format.mjs
This module provides bidirectional markdown ↔ Confluence storage format conversion. It's used internally by confluence.mjs but can also be imported directly for custom sync scripts.
Exported Functions
import { markdownToStorage, storageToMarkdown, htmlInlineToMarkdown } from '<skill-path>/scripts/confluence-format.mjs';
| Function | Direction | Use case |
|---|
markdownToStorage(md) | Markdown → XHTML | Publishing to Confluence (auto-used by confluence.mjs --body-file) |
storageToMarkdown(html) | XHTML → Markdown | Downloading/syncing Confluence pages to local markdown files |
htmlInlineToMarkdown(html) | Inline HTML → Markdown | Converting snippets (table cells, list items) that may contain <strong>, <em>, <a>, <code> |
What storageToMarkdown Handles
The converter handles real-world Confluence storage format patterns including:
- Structured macros: code blocks (with/without language), panels (info/tip/warning/note → GitHub alerts), expand →
<details><summary> collapsible sections, jira references, view-file → attachment links, toc/children (stripped)
- Unknown macros: Any unrecognized
ac:structured-macro types have their body content preserved (not silently dropped)
- Tables:
<colgroup>, <tbody>, <thead> wrappers stripped; attributes on <table>, <tr>, <th>, <td> handled
- Task lists:
<ac:task-list> with <ac:task-id> → markdown checkboxes
- Images: URL and attachment images →
 with filename as fallback alt text; parentheses and spaces in filenames URL-encoded
- Code blocks: Protected from HTML tag stripping via placeholder system — generic types like
Array<string> preserved inside fenced blocks
- Expand/collapsible bodies: Full content support inside expand macros — code blocks, images, tables, panels, task lists, and nested macros all convert correctly
- Entities: Full HTML entity decoding (
’, “, →, , numeric {)
- Block separation:
\n\n around headings, images, lists, <hr>, tables, code blocks
- Attribute tolerance: All HTML tag regexes accept optional attributes (handles Confluence's
local-id, data-layout, breakoutWidth, etc.)
- Bold/italic cleanup: Trailing spaces inside markers fixed (
**text ** → **text**)
- Stray angle brackets: Escaped outside code blocks to prevent markdown renderer confusion
Syncing a Confluence Space
For most use cases, use the built-in sync script directly:
node <skill-path>/scripts/sync-confluence-space.mjs --root <pageId> --output ./docs
For custom sync scripts, import storageToMarkdown and follow this pattern:
import { storageToMarkdown } from '<skill-path>/scripts/confluence-format.mjs';
const page = await apiGet(`/wiki/api/v2/pages/${pageId}`, { 'body-format': 'storage' });
const html = page.body.storage.value;
let markdown = storageToMarkdown(html);
const pageUrl = `${page._links.base}${page._links.webui}`;
markdown = `# [${page.title}](${pageUrl})\n\n${markdown}`;
Key gotchas discovered in production use:
- The v2 API
_links.webui is a relative path (e.g., /spaces/BTH/pages/123/Title). Combine with _links.base (e.g., https://company.atlassian.net/wiki) for the full URL — do NOT use env.domain + _links.webui directly (missing /wiki prefix).
- Attachment filenames with spaces and parentheses must be URL-encoded in markdown links:
.
- When writing a hierarchical sync, use
getChildrenTree() (recursive children API) to build the tree, then decide per-node: pages with children → directory/index.md, leaf pages → flat PageName.md.
- Keep attachments in a shared
assets/imgs/ and assets/pdfs/ directory. Use depth-aware relative paths (../assets/imgs/ at depth 1, ../../assets/imgs/ at depth 2, etc.).
- The sync script must rewrite both image references (
) and file attachment links ([filename](filename)) to local paths — Confluence view-file macros produce regular links, not image references.
- Confluence adds attributes (
local-id, breakoutWidth, data-layout) to most HTML tags. Any regex matching tags must use [^>]* for optional attributes.
- Expand macro bodies can contain any content (code blocks, images, tables). The inner HTML converter must handle the same set of elements as the main converter.
Running Tests
node <skill-path>/scripts/test-format.mjs
100+ tests covering forward conversion, reverse conversion, round-trip preservation, block element spacing, code block protection, image URL encoding, entity decoding, expand macros with nested content, view-file macros, unknown macro catch-all, and attribute tolerance on HTML tags.
Workflows
For complex multi-step operations that require user interaction across several turns, read the corresponding workflow file and follow its step-by-step process. For simple one-shot commands, use the operations sections above directly.
| Workflow | When to use | File |
|---|
| Capture Tasks from Meeting Notes | User provides meeting notes and wants Jira tasks created from action items | workflows/capture-tasks-from-meeting-notes.md |
| Generate Status Report | User wants a project status report, sprint summary, or weekly update | workflows/generate-status-report.md |
| Search Company Knowledge | User wants to find information across Confluence pages and Jira issues | workflows/search-company-knowledge.md |
| Spec to Backlog | User has a Confluence spec and wants it broken into an Epic + child tickets | workflows/spec-to-backlog.md |
| Triage Issue | User reports a bug and wants duplicate checking before filing | workflows/triage-issue.md |
| Create Confluence Document | User wants a professional Confluence page with macros, images, and structured formatting | workflows/create-confluence-document.md |
| Sync BMAD Documents | User wants to sync local BMAD docs (epics, tech specs, PRDs, architecture) with Jira or Confluence, or link a document to a ticket/page | workflows/sync-bmad-documents.md |
| Sync Confluence Space | User wants to download an entire Confluence space to local markdown files with hierarchy, images, and linked titles | workflows/sync-confluence-space.md |
Error Handling
| Error | Likely Cause | Resolution |
|---|
401 Unauthorized | Bad or expired API token | Regenerate at Atlassian security settings |
403 Forbidden | Insufficient permissions | Check project/space permissions for the user's account |
404 Not Found | Wrong issue key, page ID, or domain | Verify the resource exists and ATLASSIAN_DOMAIN is correct |
429 Too Many Requests | Rate limited | Wait briefly and retry; reduce batch sizes |
| Missing env vars | Not configured | Run node <skill-path>/scripts/setup.mjs |
Reference Documentation
Load these as needed — don't read them all upfront:
| Reference | When to consult |
|---|
references/jira-api.md | Need details on Jira API endpoints or request shapes |
references/confluence-api.md | Need details on Confluence API endpoints or storage format |
references/confluence-formatting.md | Building professional pages with macros, layouts, images, and document templates |
references/query-languages.md | Writing JQL or CQL queries |
references/jql-patterns.md | Need common JQL patterns for reports, searches, filters |
references/action-item-patterns.md | Parsing meeting notes for action items |
references/report-templates.md | Generating status reports |
references/bug-report-templates.md | Creating well-structured bug reports |
references/search-patterns.md | Multi-source search strategies |
references/epic-templates.md | Writing epic descriptions |
references/ticket-writing-guide.md | Writing clear ticket summaries and descriptions |
references/breakdown-examples.md | Breaking specs into stories and tasks |
references/sync-mapping-guide.md | Before first document sync, when mapping fields fail, or configuring custom field mappings |
