Claude Skill

jira-syntax

Use when writing or formatting Jira descriptions, comments, or any text destined for Jira. Converts Markdown to Jira wiki markup, provides templates (bug reports, feature requests), and validates syntax before submission. Trigger on any Jira content authoring task.

LLM Mart · 0 points · 1 views 0 listing impressions 0 install-command copies
Download netresearch-jira-skill-skills_jira-syntax-af38783.zip · 28 KB

Install

skills CLI npx skills add https://github.com/netresearch/jira-skill/tree/main/skills/jira-syntax
Claude Code claude plugin marketplace add https://llmmart.ai/marketplace.json && claude plugin install netresearch-jira-skill@llmmart
Git git clone https://github.com/netresearch/jira-skill.git

The skills CLI installs just this skill, for any of its supported agents. Claude Code installs the whole netresearch/jira-skill collection as a plugin from our marketplace. Git is the plain clone.

Skill manifest

Jira Syntax

Jira wiki markup syntax, templates, and validation. For API operations, use the jira-communication skill.

Quick Syntax Reference

Jira Syntax Purpose NOT this (Markdown)
h2. Title Heading ## Title
*bold* Bold **bold**
_italic_ Italic *italic*
{{code}} Inline code `code`
{code:java}...{code} Code block java ```
[text\|url] Link [text](url)
[PROJ-123] Issue link -
[~username] User mention @username
* item Bullet list - item
# item Numbered list 1. item
\|\|Header\|\| Table header \|Header\|

See references/jira-syntax-quick-reference.md for complete syntax documentation.

Available Templates

Bug Report

Path: templates/bug-report-template.md

Sections: Environment, Steps to Reproduce, Expected/Actual Behavior, Error Messages, Technical Notes

Feature Request

Path: templates/feature-request-template.md

Sections: Overview, User Stories, Acceptance Criteria, Technical Approach, Success Metrics

Syntax Validation

Run before submitting to Jira:

${CLAUDE_SKILL_DIR}/scripts/validate-jira-syntax.sh path/to/content.txt

It gates the post — run it as its own step, never chained with the posting command.

Validation Checklist

  • Headings: h2. Title (space after period)
  • Bold: *text* (single asterisk)
  • Code blocks: {code:language}...{code}
  • Lists: * for bullets, # for numbers
  • Links: [label|url] or [PROJ-123]
  • Tables: ||Header|| and |Cell|
  • Colors: {color:red}text{color}
  • Panels: {panel:title=X}...{panel}

Common Mistakes

❌ Wrong ✅ Correct
## Heading h2. Heading
**bold** *bold*
`code` {{code}}
[text](url) [text\|url]
- bullet * bullet
** child after a blank line, heading or paragraph a * parent line, or a line continuing it, directly above ** child — otherwise Jira renders an empty bullet
h2.Title h2. Title
MR !42 (bare GitLab ref) [MR 42\|url] or full group/project!42 — a bare !…! is image markup
(/) on an open/proposed item (x) — (/) renders as a green check (done); use (x) for open items
( ) as a checkbox (x) — ( ) is not a macro and renders literally
(-) or (x) on a pending step in a review (i) pending: … — (-) renders as a red no-entry sign, and in a review (x) means a failure

Integration with jira-communication Skill

Workflow:

  1. Get template from jira-syntax
  2. Fill content using Jira wiki markup
  3. Validate with ${CLAUDE_SKILL_DIR}/scripts/validate-jira-syntax.sh
  4. Submit via jira-communication skill

References

  • references/jira-syntax-quick-reference.md - Complete syntax documentation Includes Ask the renderer instead of reasoning about it: POST /rest/api/1.0/render returns the HTML Jira will produce for any markup, before anything is posted. Use it to settle a markup question rather than deriving the answer.
  • references/cross-project-refs.md - GitLab cross-project ref convention (group/project!N, group/project#N, group/project@tag) when linking to GitLab from Jira
  • templates/bug-report-template.md - Bug report template
  • templates/feature-request-template.md - Feature request template
  • ${CLAUDE_SKILL_DIR}/scripts/validate-jira-syntax.sh - Automated syntax checker
  • Official Jira Wiki Markup
Files (jira-skill)
  • evals
    • evals.json 7.2 KB
      Loading…
  • references
    • cross-project-refs.md 2.5 KB
      Loading…
    • jira-syntax-quick-reference.md 17.2 KB
      Loading…
  • scripts
    • validate-jira-syntax.sh 27.6 KB
      Loading…
  • templates
    • bug-report-template.md 4 KB
      Loading…
    • feature-request-template.md 7.9 KB
      Loading…
  • AGENTS.md 1.9 KB
    Loading…
  • SKILL.md 4.2 KB
    ---
    # SPDX-License-Identifier: CC-BY-SA-4.0
    # SPDX-FileCopyrightText: Netresearch DTT GmbH
    name: jira-syntax
    description: "Use when writing or formatting Jira descriptions, comments, or any text destined for Jira. Converts Markdown to Jira wiki markup, provides templates (bug reports, feature requests), and validates syntax before submission. Trigger on any Jira content authoring task."
    license: "(MIT AND CC-BY-SA-4.0). See LICENSE-MIT and LICENSE-CC-BY-SA-4.0"
    metadata:
      author: Netresearch DTT GmbH
      version: "5.2.0"
      repository: https://github.com/netresearch/jira-skill
    ---
    
    # Jira Syntax
    
    Jira wiki markup syntax, templates, and validation. For API operations, use the **jira-communication** skill.
    
    ## Quick Syntax Reference
    
    | Jira Syntax | Purpose | NOT this (Markdown) |
    |-------------|---------|---------------------|
    | `h2. Title` | Heading | `## Title` |
    | `*bold*` | Bold | `**bold**` |
    | `_italic_` | Italic | `*italic*` |
    | `{{code}}` | Inline code | `` `code` `` |
    | `{code:java}...{code}` | Code block | ``` ```java ``` |
    | `[text\|url]` | Link | `[text](url)` |
    | `[PROJ-123]` | Issue link | - |
    | `[~username]` | User mention | `@username` |
    | `* item` | Bullet list | `- item` |
    | `# item` | Numbered list | `1. item` |
    | `\|\|Header\|\|` | Table header | `\|Header\|` |
    
    See `references/jira-syntax-quick-reference.md` for complete syntax documentation.
    
    ## Available Templates
    
    ### Bug Report
    **Path**: `templates/bug-report-template.md`
    
    Sections: Environment, Steps to Reproduce, Expected/Actual Behavior, Error Messages, Technical Notes
    
    ### Feature Request
    **Path**: `templates/feature-request-template.md`
    
    Sections: Overview, User Stories, Acceptance Criteria, Technical Approach, Success Metrics
    
    ## Syntax Validation
    
    Run before submitting to Jira:
    ```bash
    ${CLAUDE_SKILL_DIR}/scripts/validate-jira-syntax.sh path/to/content.txt
    ```
    
    **It gates the post** — run it as its own step, never chained with the
    posting command.
    
    ### Validation Checklist
    - [ ] Headings: `h2. Title` (space after period)
    - [ ] Bold: `*text*` (single asterisk)
    - [ ] Code blocks: `{code:language}...{code}`
    - [ ] Lists: `*` for bullets, `#` for numbers
    - [ ] Links: `[label|url]` or `[PROJ-123]`
    - [ ] Tables: `||Header||` and `|Cell|`
    - [ ] Colors: `{color:red}text{color}`
    - [ ] Panels: `{panel:title=X}...{panel}`
    
    ### Common Mistakes
    
    | ❌ Wrong | ✅ Correct |
    |---------|-----------|
    | `## Heading` | `h2. Heading` |
    | `**bold**` | `*bold*` |
    | `` `code` `` | `{{code}}` |
    | `[text](url)` | `[text\|url]` |
    | `- bullet` | `* bullet` |
    | `** child` after a blank line, heading or paragraph | a `* parent` line, or a line continuing it, directly above `** child` — otherwise Jira renders an empty bullet |
    | `h2.Title` | `h2. Title` |
    | `MR !42` (bare GitLab ref) | `[MR 42\|url]` or full `group/project!42` — a bare `!…!` is image markup |
    | `(/)` on an open/proposed item | `(x)` — `(/)` renders as a green check (done); use `(x)` for open items |
    | `( )` as a checkbox | `(x)` — `( )` is not a macro and renders literally |
    | `(-)` or `(x)` on a pending step in a review | `(i) pending: …` — `(-)` renders as a red no-entry sign, and in a review `(x)` means a failure |
    
    ## Integration with jira-communication Skill
    
    **Workflow:**
    1. Get template from jira-syntax
    2. Fill content using Jira wiki markup
    3. Validate with `${CLAUDE_SKILL_DIR}/scripts/validate-jira-syntax.sh`
    4. Submit via jira-communication skill
    
    ## References
    
    - `references/jira-syntax-quick-reference.md` - Complete syntax documentation
      Includes **Ask the renderer instead of reasoning about it**: `POST /rest/api/1.0/render` returns the HTML Jira will produce for any markup, before anything is posted. Use it to settle a markup question rather than deriving the answer.
    - `references/cross-project-refs.md` - GitLab cross-project ref convention (`group/project!N`, `group/project#N`, `group/project@tag`) when linking to GitLab from Jira
    - `templates/bug-report-template.md` - Bug report template
    - `templates/feature-request-template.md` - Feature request template
    - `${CLAUDE_SKILL_DIR}/scripts/validate-jira-syntax.sh` - Automated syntax checker
    - [Official Jira Wiki Markup](https://jira.atlassian.com/secure/WikiRendererHelpAction.jspa?section=all)
    

Comments (0)

Sign in to join the conversation.

No comments yet.

Reviews (0)

No reviews yet.