Skip to main content
Glama
phuc-nt

MCP Jira Server

by phuc-nt
README.md
# MCP Jira Server

> **AI meets Jira** - Connect AI assistants to your Jira workspace with modular architecture and enhanced compatibility

<p align="center">
  <img src="assets/atlassian_logo_icon.png" alt="Jira Logo" width="120" />
</p>

[![Tools](https://img.shields.io/badge/Tools-46%20Optimized-blue)](#features)
[![Modules](https://img.shields.io/badge/Architecture-4%20Modules-orange)](#modular-architecture)
[![License](https://img.shields.io/badge/License-MIT-green)](#license)
[![Status](https://img.shields.io/badge/Status-Production%20Ready-brightgreen)](#production-status)

## šŸš€ What is this?

**MCP Jira Server** enables AI assistants like **Claude**, **Cline**, **Cursor**, and other MCP-compatible tools to interact with Atlassian Jira using **API token authentication** - featuring **modular architecture**, enhanced AI client compatibility, and enterprise-ready performance. Choose only the modules you need for optimized memory usage.

## ✨ Features

### šŸ”§ **46 Optimized Tools Across 4 Modules:**

- **Core Module** (14): Essential CRUD operations, user management, project operations
- **Agile Module** (10): Sprint & board management, workflow operations  
- **Dashboard Module** (8): Analytics, reporting, dashboard management
- **Search Module** (14): Enhanced search & Epic discovery, universal user search

### šŸŽÆ **Key Capabilities:**

- āœ… **Modern JQL API** - Enhanced search with full issue data retrieval (no IDs-only limitation)
- āœ… **Modular Architecture** - Up to 64% memory reduction with selective loading
- āœ… **Enhanced AI Client Compatibility** - Comprehensive usage patterns & error prevention
- āœ… **Production Ready** - 100% test success rate across all 46 tools

## šŸš€ Quick Start

### šŸ“¦ Install from NPM (Recommended)

```bash
npm install -g mcp-jira-cloud-server
```

> **Note:** the npm package name is `mcp-jira-cloud-server`, which differs from this repo's name
> (`jira-cloud-mcp-server`). The name predates the repo rename and is kept as-is on publish —
> renaming the package would create a new npm listing and lose install history / existing users.

**šŸ“– [Complete Installation Guide](INSTALL.md)** - Follow the step-by-step setup guide

## Architecture

### Module Distribution (46 Total Tools - Optimized)

| Module | Tools | Success Rate | Use Case |
|--------|-------|--------------|-----------|
| **Core** | 14 | 100% | Essential CRUD operations |
| **Agile** | 10 | 100% | Sprint & workflow management |
| **Dashboard** | 8 | 100% | Analytics & reporting |
| **Search** | 14 | 100% | Enhanced search & Epic discovery |

### Configuration Options

**4 Deployment Options:**
- **Essential Stack** (28 tools): Core + Search modules
- **Complete Agile** (38 tools): Core + Agile + Search modules  
- **Analytics Focus** (22 tools): Search + Dashboard modules
- **Legacy Compatibility** (46 tools): All modules in single server

**šŸ“– [Complete Configuration Guide](INSTALL.md)** - Detailed setup instructions with working configs

## šŸ’” Usage Examples

**Create Issues with Natural Language:**

```
Human: Create a new Epic called "User Authentication System" in the DEMO project

AI Assistant: I'll create that Epic for you using the createIssue tool:
ā–” Project: DEMO
ā–” Issue Type: Epic (auto-detected)
ā–” Summary: "User Authentication System"
ā–” Creating issue now...

āœ… Created Epic DEMO-142: "User Authentication System"
```

**Advanced Search & Analysis:**

```
Human: Find all high-priority bugs assigned to me that were created last week

AI Assistant: I'll search for your high-priority bugs from last week:
ā–” Use enhancedSearchIssues with modern JQL API: "assignee = currentUser() AND priority = High AND issueType = Bug AND created >= -7d"
ā–” Enhanced API returns full issue details (no IDs-only limitation)
ā–” Found 3 matching issues with complete data in single API call
ā–” Analyzing priority, status, and resolution timeframes...

Found 3 high-priority bugs: DEMO-140, DEMO-138, DEMO-135 - details attached.
```

**Sprint Management & Agile Workflows:**

```
Human: Show me the current sprint status and add issue DEMO-123 to the active sprint

AI Assistant: I'll check your sprint status and add the issue:
ā–” Use listSprints to find active sprint for your board
ā–” Use getSprintIssues to see current sprint contents  
ā–” Use addIssueToSprint to add DEMO-123
ā–” Provide sprint summary with updated issue count

Current Sprint "Sprint 24" has 12 issues, adding DEMO-123 now... āœ… Added successfully!
```

## šŸ› ļø Tech Stack

- **TypeScript** - Type-safe development with strict mode
- **Node.js** - Runtime environment (16.x+)
- **MCP Protocol** - Model Context Protocol for AI integration
- **Jira APIs** - Native Jira Platform API v3 + Agile API v1.0
- **Modular Architecture** - Specialized modules for optimized performance

## šŸ“„ License

MIT License - see [LICENSE](LICENSE) for details.

---

**šŸŽ‰ Connect your AI assistant to Jira with modular architecture and enhanced compatibility!**