@mcpio/jira 1.0.0 → 2.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,19 +1,18 @@
1
- # Jira MCP Server with ADF Support
1
+ # Jira MCP Server v2.0
2
2
 
3
- Model Context Protocol (MCP) server for Jira API integration with enhanced Atlassian Document Format (ADF) support.
3
+ Model Context Protocol (MCP) server for Jira API integration with automatic Markdown-to-ADF conversion.
4
4
 
5
5
  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
6
6
  [![Node.js Version](https://img.shields.io/badge/node-%3E%3D18.0.0-brightgreen)](https://nodejs.org/)
7
+ [![TypeScript](https://img.shields.io/badge/TypeScript-5.9-blue)](https://www.typescriptlang.org/)
7
8
 
8
9
  ## Features
9
10
 
10
- - Full Jira API integration via MCP protocol
11
- - Enhanced ADF formatting with **clickable issue links**
12
- - Support for code blocks, lists, headers, and rich text formatting
13
- - Complete CRUD operations: create, read, update, delete issues
14
- - Issue linking, subtasks, comments, and JQL search
15
- - Built-in security: input validation, HTTPS enforcement, error sanitization
16
- - Automatic formatting prompts for AI models
11
+ - 23 Jira API tools via MCP protocol
12
+ - Automatic Markdown to ADF conversion (write Markdown, get proper Jira formatting)
13
+ - ADF to Markdown conversion when reading issues and comments
14
+ - Input validation, HTTPS enforcement, Jira error details in responses
15
+ - TypeScript source with full type definitions
17
16
 
18
17
  ## Installation
19
18
 
@@ -21,15 +20,9 @@ Model Context Protocol (MCP) server for Jira API integration with enhanced Atlas
21
20
  npm install @mcpio/jira
22
21
  ```
23
22
 
24
- Or install globally:
25
-
26
- ```bash
27
- npm install -g @mcpio/jira
28
- ```
29
-
30
23
  ## Setup
31
24
 
32
- 1. Create a `.env` file with your Jira credentials:
25
+ 1. Create a `.env` file:
33
26
 
34
27
  ```bash
35
28
  JIRA_HOST=https://your-domain.atlassian.net
@@ -38,70 +31,75 @@ JIRA_API_TOKEN=your-api-token
38
31
  JIRA_PROJECT_KEY=YOUR-PROJECT-KEY
39
32
  ```
40
33
 
41
- 2. Get your Jira API token from: https://id.atlassian.com/manage-profile/security/api-tokens
34
+ 2. Get your API token: https://id.atlassian.com/manage-profile/security/api-tokens
42
35
 
43
- 3. Run the server:
36
+ 3. Run:
44
37
 
45
38
  ```bash
46
39
  mcpio-jira
47
40
  ```
48
41
 
49
- Or if installed locally:
50
-
51
- ```bash
52
- npm start
53
- ```
42
+ ## Formatting
54
43
 
55
- ## Formatting Guide
44
+ All description and comment fields accept standard Markdown:
56
45
 
57
- ### Clickable Issue Links
58
-
59
- **Format for clickable links:**
60
- ```
61
- - [ISSUE-KEY|URL] Description
62
- ```
63
-
64
- **Example:**
65
- ```
66
- - [PROJ-123|https://your-domain.atlassian.net/browse/PROJ-123] Implement authentication
46
+ ```markdown
47
+ # Heading
48
+ **bold** *italic* ~~strike~~ `code`
49
+ [link text](https://example.com)
50
+ - bullet item
51
+ 1. numbered item
52
+ > blockquote
67
53
  ```
68
54
 
69
- ### Basic Formatting
70
-
71
- ```
72
- h1. Heading Level 1
73
- h2. Heading Level 2
74
-
75
- * Bullet item
76
- # Numbered item
77
-
78
- *bold text*
79
-
80
- ---- (horizontal rule)
81
-
82
- ​```
83
- Code block
84
- ​```
85
- ```
55
+ Automatically converted to Atlassian Document Format (ADF).
86
56
 
87
57
  ## Available Tools
88
58
 
59
+ ### Issue Management
89
60
  - `jira_create_issue` - Create new issue
90
61
  - `jira_get_issue` - Get issue details
91
62
  - `jira_search_issues` - Search with JQL
92
- - `jira_update_issue` - Update issue (description, status, summary)
93
- - `jira_add_comment` - Add comment to issue
94
- - `jira_link_issues` - Link two issues
95
- - `jira_get_project_info` - Get project information
63
+ - `jira_update_issue` - Update issue fields and status
96
64
  - `jira_delete_issue` - Delete issue
97
- - `jira_create_subtask` - Create subtask under parent
65
+ - `jira_create_subtask` - Create subtask
66
+ - `jira_assign_issue` - Assign/unassign user
67
+ - `jira_add_comment` - Add comment
68
+ - `jira_link_issues` - Link two issues
69
+ - `jira_list_transitions` - Get available status transitions
70
+ - `jira_get_comments` - Get issue comments
71
+ - `jira_add_worklog` - Add time tracking entry
72
+ - `jira_get_worklogs` - Get worklog entries
73
+
74
+ ### Project Management
75
+ - `jira_list_projects` - List all projects
76
+ - `jira_get_project_info` - Get project details
77
+ - `jira_get_project_components` - Get project components
78
+ - `jira_get_project_versions` - Get project versions/releases
79
+
80
+ ### Metadata
81
+ - `jira_get_fields` - Get all fields (find custom field IDs)
82
+ - `jira_get_issue_types` - Get issue types for project
83
+ - `jira_get_priorities` - Get available priorities
84
+ - `jira_get_link_types` - Get issue link types
85
+ - `jira_search_users` - Search users by name/email
98
86
 
99
87
  ## Environment Variables
100
88
 
101
- - `JIRA_HOST` - Jira instance URL (HTTPS required)
102
- - `JIRA_EMAIL` - Your email address
103
- - `JIRA_API_TOKEN` - API token from Atlassian
104
- - `JIRA_PROJECT_KEY` - Default project key (optional, defaults to "PROJ")
89
+ | Variable | Required | Description |
90
+ |----------|----------|-------------|
91
+ | `JIRA_HOST` | Yes | Jira instance URL (HTTPS) |
92
+ | `JIRA_EMAIL` | Yes | Your email address |
93
+ | `JIRA_API_TOKEN` | Yes | API token from Atlassian |
94
+ | `JIRA_PROJECT_KEY` | No | Default project key (defaults to "PROJ") |
95
+ | `JIRA_STORY_POINTS_FIELD` | No | Custom field ID for story points (defaults to "customfield_10016") |
96
+
97
+ ## Development
98
+
99
+ ```bash
100
+ npm run build # Compile TypeScript
101
+ npm start # Run compiled server
102
+ ```
105
103
 
106
104
  ## License
107
105
 
@@ -0,0 +1,2 @@
1
+ #!/usr/bin/env node
2
+ export {};