MCP Jira Cloud V2

🚀 Jira Requester MCP Server

This is a Message Communication Protocol (MCP) server designed to interact with the Jira API (v2 client) to retrieve ticket information.

🚀 Quick Start

Prerequisites

• Node.js (Recommended version: >= 18.x)
• npm or yarn
• Jira Cloud instance
• Jira API token

📦 Installation

1. Clone the repository:

   git clone https://github.com/scho-to/mcp-jira-cloud-v2.git
   cd mcp-jira-cloud-v2
   

2. Install dependencies: Using npm:

   npm install
   

   Or using yarn:

   yarn install
   

Configuration

This server requires environment variables for Jira authentication and connection:

• JIRA_BASE_URL: The base URL of your Jira instance (e.g., https://your-domain.atlassian.net).
• JIRA_USER_EMAIL: The email address associated with your Jira account.
• JIRA_API_TOKEN: Your Jira API token. You can generate one in your Atlassian account settings.

Create a .env file in the project root directory and add these variables:

JIRA_BASE_URL=https://your-domain.atlassian.net
JIRA_USER_EMAIL=your-email@example.com
JIRA_API_TOKEN=your-api-token

Note: Add .env to your .gitignore file to avoid committing sensitive credentials.

💻 Usage Examples

Basic Usage

1. Start the server: Using npm:

   npm start
   

   Or using yarn:

   yarn start
   

2. Interact via MCP: Once the server is running, it will listen for MCP requests. Clients can interact with it by sending tool calls.

Advanced Usage

You can directly use the simpleTest.ts script to test the Jira client functionality.

1. Run the test script: Provide a Jira ticket ID as a parameter. Using npm:

   npm test <JIRA_TICKET_ID>
   

   Or using yarn:

   yarn test <JIRA_TICKET_ID>
   

Build

1. Install dependencies:

   npm install
   

2. Run the test script:

   npm test
   

3. Build the project:

   npm run build
   

MCP Server Configuration

Add the following content to your MCP configuration file:

{
  "servers": {
    "JiraServer": {
      "url": "http://localhost:8080",
      "token": "your-jira-token"
    }
  }
}

Example Requests

The following is the structure of an example request sent via MCP:

{
  "ticket_id": "T12345",
  "summary": "Server error report",
  "description": "Unable to connect to the database.",
  "priority": "High"
}

Tool Call Syntax

The following are examples of how to construct tool calls:

Create a Ticket

{
  "command": "create_ticket",
  "data": {
    "summary": "New issue report",
    "description": "Encountered a new issue that needs to be addressed.",
    "priority": "Medium"
  }
}

Query Tickets

{
  "command": "query_tickets",
  "data": {
    "status": "Unresolved",
    "assignee": "Zhang San"
  }
}

Update a Ticket

{
  "command": "update_ticket",
  "data": {
    "ticket_id": "T12345",
    "new_status": "Resolved",
    "comments": ["The issue has been resolved."]
  }
}

Important Notes

• Ensure the server is always running to receive real-time requests.
• Regularly check the log files to promptly identify and resolve issues.
• Configure monitoring tools to ensure high availability.

By following the above steps, you can successfully set up and run an MCP server that interacts with the Jira API to automate ticket management.