Jira Y9t

🚀 JIRA MCP Server

A MCP server that enables Large Language Models (LLMs) to interact with JIRA through standardized tools and context. This server provides the functionality to search for issues using JQL and retrieve detailed information about specific issues.

✨ Features

• JQL Search: Perform complex JQL queries with pagination support.
• Issue Details: Retrieve detailed information about specific JIRA issues.

📦 Prerequisites

• npm installed.
• A JIRA instance with API access.
• A JIRA API token or personal access token.
• The JIRA user email address associated with the API token.

Obtaining JIRA API Credentials

1. Log in to your Atlassian account at https://id.atlassian.com.
2. Go to the security settings.
3. Under API tokens, select "Create API token".
4. Provide a meaningful name for the token (e.g., "MCP Server").
5. Copy the generated token—you won't be able to see it again!
6. Use this token as your JIRA_API_KEY.
7. Use the email address associated with your Atlassian account as JIRA_USER_EMAIL.

🚀 Quick Start

Integrating with Claude Desktop

1. Add the server configuration to Claude Desktop's configuration file:

macOS: ~/Library/Application Support/Claude/claude_desktop_config.json Windows: %APPDATA%\Claude\claude_desktop_config.json

{
  "mcpServers": {
    "jira": {
      "command": "npx",
      "args": ["-y", "jira-mcp"],
      "env": {
        "JIRA_INSTANCE_URL": "https://your-instance.atlassian.net",
        "JIRA_USER_EMAIL": "your-email@company.com",
        "JIRA_API_KEY": "your-api-token"
      }
    }
  }
}

2. Restart Claude Desktop to load the new configuration.

💻 Usage Examples

1. JQL Search (jql_search)

Perform a JQL query with custom parameters.

Input Example:

{
  "command": "jql_search",
  "issueQuery": "project = ABC AND status = 'In Progress'",
  "maxResults": 50,
  "startIndex": 0
}

Output Example:

{
  "issues": [
    {
      "id": "1234",
      "key": "ABC-123",
      "title": "Implement New Feature",
      "status": "In Progress",
      "priority": "High",
      "assignee": "张三"
    },
    // Other issues...
  ],
  "total": 100
}

2. Retrieving Issue Details (get_issue)

Retrieve detailed information about a specific issue.

Input Example:

{
  "command": "get_issue",
  "issueIdOrKey": "ABC-123"
}

Output Example:

{
  "id": "1234",
  "key": "ABC-123",
  "title": "Implement New Feature",
  "status": "In Progress",
  "priority": "High",
  "assignee": "张三",
  "description": "需要实现新功能...",
  "labels": ["feature", "urgent"],
  "comments": [
    {
      "id": "5678",
      "author": "李四",
      "content": "请优先处理此问题。",
      "createdAt": "2023-10-01T12:00:00Z"
    },
    // Other comments...
  ],
  "history": [
    {
      "actionDate": "2023-10-01T10:00:00Z",
      "action": "status changed to 'In Progress'"
    },
    // Other records...
  ]
}

📚 Documentation

Installation Guide

Installing with npm

npm install jira-mcp-server

Manual Installation

1. Download the latest version of the compressed package.
2. Extract the files to the target directory.
3. Run the server:

node index.js

Configuration

Environment Variables

Create a .env file and add the following content:

JIRA_INSTANCE_URL=https://your-instance.atlassian.net
JIRA_USER_EMAIL=your-email@company.com
JIRA_API_KEY=your-api-token

📄 License

MIT

🤝 Contribution Guidelines

Contributions are welcome! Please feel free to submit PRs.