Jira Requester MCP Server

by scho-to

189 downloads
Not rated
GitHub

About

MCP Server using Jira Client v2 to handle Jira Issues

Details

Author
scho-to
Downloads
189
Categories
Developer Tools

- Fetch details for a specific Jira ticket using its ID.
- Optionally specify which fields to include in the response.
- Optionally expand Jira fields such as changelog or renderedFields.
- Built with TypeScript and compiled to JavaScript.

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

  1. Download and install Highlight from highlightai.com/download
  2. Navigate to the plugins tab and select "Add Custom Plugin"
  3. Configure the plugin with the settings below
    Plugin Name Jira Requester MCP Server
    Command (node, npx, python, etc.)

    Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.

  4. Enable "Start Automatically" if you want the plugin to start when Highlight launches

From the repository

Clone the repository, install dependencies (npm install or yarn install), and create a .env file with JIRA_BASE_URL, JIRA_USER_EMAIL, and JIRA_API_TOKEN. Start the server with npm start or yarn start, then clients call the get_jira_ticket tool with the required ticket_id parameter.

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "jira requester mcp server": {
            "jira-requester": {
                "command": "node",
                "args": [
                    "/path/to/mcp-jira-cloud-v2/build/index.js"
                ],
                "env": {
                    "JIRA_URL": "",
                    "JIRA_USER_EMAIL": "",
                    "JIRA_API_TOKEN": ""
                }
            }
        }
    }
}

McpServers

{
    "jira-requester": {
        "command": "node",
        "args": [
            "/path/to/mcp-jira-cloud-v2/build/index.js"
        ],
        "env": {
            "JIRA_URL": "",
            "JIRA_USER_EMAIL": "",
            "JIRA_API_TOKEN": ""
        }
    }
}

Jira Requester MCP Server

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

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 from your Atlassian account settings.

Create a .env file in the project root 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

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

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.

Testing

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

2. Run the test script:
Provide a Jira ticket ID as an argument.
Using npm:

    npm test <JIRA_TICKET_ID>
    

Or using yarn:

    yarn test <JIRA_TICKET_ID>
    

Replace <JIRA_TICKET_ID> with an actual ticket ID from your Jira instance.

3. Run the test script in development mode (with hot-reloading):
Using npm:

    npm run dev <JIRA_TICKET_ID>

Or using yarn:
    yarn dev <JIRA_TICKET_ID>

This is useful for rapid iteration during development.

Building

The project is built using the TypeScript compiler. This compiles the TypeScript source files (.ts) into JavaScript files (.js) in the build directory.

To build the project:

Using npm:

npm run build

Or using yarn:

yarn run build

MCP Server Configuration

To set up this server within an MCP environment, add the following configuration to your MCP config file:

{
  "mcpServers": {
    "jira-requester": {
      "command": "node",
      "env": {
        "JIRA_URL": "https://your-instance.atlassian.net",
        "JIRA_USER_EMAIL": "your-email@example.com",
        "JIRA_API_TOKEN": "your-api-token"
      },
      "args": ["/path/to/mcp-jira-cloud-v2/build/index.js"]
    }
  }
}

Note: Replace placeholders like https://your-instance.atlassian.net, your-email@example.com, your-api-token, and /path/to/mcp-jira-cloud-v2/build/index.js with your actual Jira instance URL, credentials, and the correct path to the built index.js file.

Security Warning: Avoid committing sensitive information like API tokens directly into your configuration files. Consider using environment variables or a secrets management system.

Available Tools

get_jira_ticket

Fetches details for a specific Jira ticket.

Parameters:

- ticket_id (string, required): The ID of the Jira ticket (e.g., PROJ-123).
- fields (array of strings, optional): Specify which fields to include in the response. If omitted, default fields might be returned.
- expand (array of strings, optional): Specify Jira fields to expand (e.g., changelog, renderedFields).

Example MCP Request:

{
  "tool_name": "get_jira_ticket",
  "parameters": {
    "ticket_id": "PROJ-123",
    "fields": ["summary", "status", "assignee"],
    "expand": ["renderedFields"]
  }
}
No reviews yet — be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.