MCP Server Atlassian Jira

🚀 Atlassian Jira MCP Server

This project offers a Model Context Protocol (MCP) server that serves as a bridge between AI assistants (such as Anthropic's Claude, Cursor AI, or other MCP-compatible clients) and your Atlassian Jira instance. It enables AI to securely access and interact with your projects, issues, and other Jira resources in real-time.

🚀 Quick Start

Prerequisites

• Node.js and npm: Node.js 14 or higher and npm 5+ are required.
• Jira API Access: Ensure that your Jira instance allows API access.
• Administrator Privileges: Administrator privileges may be required to configure API access and credentials.

Obtain an Atlassian API Token

To interact with Jira, you need an API token for authentication:

1. Log in to your Jira account.
2. Navigate to Jira Settings > User profile.
3. Locate and click on the API tokens section.
4. Create a new API token and save it.

Configure Credentials

Method A: Using a Configuration File

Create or edit the ~/.jira/config file and add the following content:

{
    "environments": {
        "default": {
            "url": "https://your-domain.atlassian.net",
            "email": "your.email@example.com",
            "api-token": "your_api_token"
        }
    }
}

Method B: Command-line Configuration

Run the following command and enter the information as prompted:

mcp-atlassian-jira config

Connect an AI Assistant

Integrate the server with your AI assistant as follows:

1. Install and Run the Server:

npm install -g @aashari/mcp-server-atlassian-jira
mcp-atlassian-jira start

2. Configure the API Endpoint: Set the Jira data source in your AI assistant to point to the address of the MCP server.
3. Start Interacting:

# Example: Get project information
mcp-atlassian-jira get-project --project-key-or-id YOUR_PROJECT_KEY

✨ Features

What is MCP?

The Model Context Protocol (MCP) is an open standard that enables AI systems to securely and contextually connect to external tools and data sources. This server implements MCP for Jira Cloud, bridging your Jira data with AI assistants.

Why Use This Server?

• Minimal Input, Maximum Output: Obtain rich information with simple identifiers (e.g., project names or issue IDs).
• Direct Data Retrieval from Jira: Supports JQL queries and direct issue/project retrieval.
• Powerful Integration: Seamlessly integrates with AI assistants to provide real-time Jira context.

📦 Installation

Obtain an Atlassian API Token

To interact with Jira, you need an API token for authentication:

1. Log in to your Jira account.
2. Navigate to Jira Settings > User profile.
3. Locate and click on the API tokens section.
4. Create a new API token and save it.

Configure Credentials

Method A: Using a Configuration File

Create or edit the ~/.jira/config file and add the following content:

{
    "environments": {
        "default": {
            "url": "https://your-domain.atlassian.net",
            "email": "your.email@example.com",
            "api-token": "your_api_token"
        }
    }
}

Method B: Command-line Configuration

Run the following command and enter the information as prompted:

mcp-atlassian-jira config

💻 Usage Examples

Basic Usage

# List all projects
mcp-atlassian-jira ls-projects

Advanced Usage

# List issues based on a JQL query
mcp-atlassian-jira ls-issues --jql "project = DEV AND status = 'In Progress'"

📚 Documentation

Available Tools

• ls-projects: List all projects.

mcp-atlassian-jira ls-projects

• get-project: Get detailed project information.

mcp-atlassian-jira get-project --project-key-or-id YOUR_PROJECT_KEY

• ls-issues: List issues based on a JQL query.

mcp-atlassian-jira ls-issues --jql "project = DEV AND status = 'In Progress'"

• get-issue: Get detailed issue information.

mcp-atlassian-jira get-issue --issue-id-or-key PROJ-123

Command-line Interface (CLI)

Quick Usage (via npx)

npx -y @aashari/mcp-server-atlassian-jira ls-projects
npx -y @aashari/mcp-server-atlassian-jira get-issue --issue-id-or-key PROJ-123

Global Installation

npm install -g @aashari/mcp-server-atlassian-jira
mcp-atlassian-jira ls-projects

Get Help

Use --help to view options and usage for all commands:

mcp-atlassian-jira --help
mcp-atlassian-jira ls-projects --help

📄 License

ISC License