Skip to content

Algotec/jira-mcp-server

 
 

Repository files navigation

Jira 9.12.14 MCP Server

This is a Model Context Protocol (MCP) server implementation for the Jira 9.12.14 API. It allows AI models like Claude to securely interact with Jira through well-defined tools.

Features

  • JQL Search: Execute JQL queries to find issues in Jira
  • Get Issue: Retrieve detailed information about a specific issue by ID or key

Prerequisites

  • Node.js (v16 or higher)
  • npm or yarn
  • A Jira instance
  • Authentication credentials for Jira API

Installation

Option 1: Using npx (Recommended)

The easiest way to use this MCP server is with npx:

# Create a directory for your configuration
mkdir jira-mcp && cd jira-mcp

# Create .env file with your credentials
cat > .env << EOL
JIRA_API_URL=https://your-domain.atlassian.net
JIRA_AUTH_TOKEN=your-token-here
EOL

# Run the server directly
npx @andrewyun/jira-9-12-14-mcp-server

Option 2: Manual Installation

  1. Clone the repository
  2. Install dependencies:
npm install
  1. Build the project:
npm run build

Configuration

Option 1: Environment Variables in .env File

The server reads configuration from a .env file in the current directory. Create a file named .env with the following settings:

JIRA_API_URL=https://your-domain.atlassian.net
JIRA_AUTH_TOKEN=your-jira-token

You must create this file in the directory where you run the server.

Option 2: MCP JSON Environment Variables

As an alternative to the .env file, you can configure the server using MCP JSON environment variables. Update your Claude for Desktop configuration in the mcpServers section:

{
  "mcpServers": {
    "jira": {
      "command": "node",
      "args": [
        "/ABSOLUTE/PATH/TO/jira-9.12.14-mcp-server/dist/index.js"
      ],
      "env": {
        "MCP_JIRA_API_URL": "https://your-domain.atlassian.net",
        "MCP_JIRA_AUTH_TOKEN": "your-jira-token"
      }
    }
  }
}

Using the MCP JSON environment variables means you don't need to create a .env file.

Environment Variable Details

  • JIRA_API_URL or MCP_JIRA_API_URL: The base URL of your Jira instance (e.g., https://your-domain.atlassian.net)
  • JIRA_AUTH_TOKEN or MCP_JIRA_AUTH_TOKEN: Your Jira API token or Personal Access Token (PAT)

Getting a Jira API Token

  1. Log in to your Atlassian account
  2. Go to Account Settings > Security > Create and manage API tokens
  3. Click "Create API token"
  4. Give it a name like "MCP Server"
  5. Copy the generated token to your .env file or MCP JSON configuration

Usage

Running the server

npm start

Integration with Claude for Desktop

  1. Open your Claude for Desktop App configuration at ~/Library/Application Support/Claude/claude_desktop_config.json (MacOS) or %AppData%\Claude\claude_desktop_config.json (Windows)
  2. Add the server configuration:
{
  "mcpServers": {
    "jira": {
      "command": "node",
      "args": [
        "/ABSOLUTE/PATH/TO/jira-9.12.14-mcp-server/dist/index.js"
      ],
      "env": {
        "MCP_JIRA_API_URL": "https://your-domain.atlassian.net",
        "MCP_JIRA_AUTH_TOKEN": "your-jira-token"
      }
    }
  }
}

Replace /ABSOLUTE/PATH/TO/ with the actual path to the server on your system.

Using With npx

If you installed via npx, your Claude configuration would look like:

{
  "mcpServers": {
    "jira": {
      "command": "npx",
      "args": [
        "--yes",
        "@andrewyun/jira-9-12-14-mcp-server"
      ],
      "env": {
        "MCP_JIRA_API_URL": "https://your-domain.atlassian.net",
        "MCP_JIRA_AUTH_TOKEN": "your-jira-token"
      }
    }
  }
}

Important: If you're using the MCP JSON environment variables, you don't need a .env file. If you're not using MCP JSON environment variables, make sure you have a .env file in your home directory or in the directory where Claude for Desktop is installed when using npx.

Available Tools

JQL Search (mcp_jira_jql_search)

Executes JQL queries to find issues in Jira.

Parameters:

  • jql (required): JQL query string
  • fields (optional): List of fields to return for each issue
  • maxResults (optional): Maximum number of results to return
  • startAt (optional): Index of the first result to return
  • expand (optional): Additional information to include in the response

Get Issue (mcp_jira_get_issue)

Retrieves detailed information about a specific issue by ID or key.

Parameters:

  • issueIdOrKey (required): ID or key of the issue
  • fields (optional): List of fields to include in the response
  • expand (optional): Additional information to include in the response
  • properties (optional): Properties to include in the response
  • failFast (optional): Whether to fail quickly on errors (default: false)

Troubleshooting

If you see errors like JIRA_API_URL environment variable is required, make sure you:

  1. Have created a .env file in the directory where you're running the server, OR
  2. Have provided MCP_JIRA_API_URL and MCP_JIRA_AUTH_TOKEN in your Claude for Desktop configuration MIT

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 66.1%
  • TypeScript 20.2%
  • Batchfile 7.0%
  • Shell 6.7%