ennbou/jiramcpserver

JIRA MCP Server

The JIRA MCP Server is designed to simplify the integration of JIRA with Model Context Protocol.

Overview

The JIRA MCP Server is a utility that bridges JIRA project management tools with Model Context Protocol capabilities, allowing for enhanced context awareness in development workflows. It provides a set of tools to interact with JIRA data programmatically, enabling developers to fetch and manage JIRA resources efficiently.

Available MCP Tools

The following tools are available in the JIRA MCP Server:

• get-jira-issue-details-by-key: Fetch JIRA issue details by key.
• get-jira-users-in-project: Fetch JIRA users in a project.
• get-jira-issues-by-jql: Fetch JIRA issues using JQL.
• get-jira-components-in-project: Fetch JIRA components in a project.
• get-jira-status-in-project: Fetch JIRA status in a project.
• get-jira-priorities: Fetch JIRA priorities.
• get-jira-projects: Fetch JIRA projects.
• get-jira-boards-using-project-id-or-project-key: Fetch JIRA boards in a project by ID or key.
• get-jira-boards-using-board-name: Fetch JIRA boards by name.
• get-jira-issue-types-in-project: Fetch JIRA issue types in a project.
• get-jira-sprints-in-board: Fetch JIRA sprints in a board.

Since it's under testing, it's read-only and doesn't support other HTTP actions (like: PUT, POST, DELETE).

Prerequisites

Before you begin, ensure you have the following installed:

• Node.js (v16 or higher)
• npm (v8 or higher)
• brew (to install gitleaks, only for macOS)

Installation

1. Clone the repository:

   git clone <repository-url>
   cd jriamcpserver
   

2. Install dependencies:

   npm install
   

3. Build the project:

   npm run build
   

Configuration

Create a .env file in the root directory with the following environment variables:

JIRA_HOSTNAME="jira.xxxx.com"
JIRA_AUTH_TOKEN="XXXXXXX+token+EYVzV"

Build the server

npm run build

Running the Server

There are two ways to run the server:

npm start

Inspector Mode

To run with the MCP inspector for debugging:

npm run inspector

For more details (read)

VS Code Integration

To add this MCP server to Visual Studio Code, the first way is recommended.

To add this MCP server to Visual Studio Code, run the following command:

code --add-mcp '{"name":"jiramcpserver", "envFile": "{$JIRA_MCP_SERVER_PATH/.env","type": "stdio","command": "node","args": ["$JIRA_MCP_SERVER_PATH/build/"]}'

Don't forget to change $JIRA_MCP_SERVER_PATH

Alternatively, you can add it through the VS Code interface:

1. Press Cmd+Shift+P

2. Type MCP: List servers, click Enter

3. Click on + add server

4. Select Command (stdio)

5. Enter node "$JIRA_MCP_SERVER_PATH/build/index.js"

You still need the JIRA server credentials. Try to add them to your environment, or try to open VS Code settings JSON and add envFile to the mcp.servers.jiramcpserver:

  "mcp": {
    "servers": {
        "my-jira-mcp-server": {
            "envFile": "PATH_OF_.env",
            "type": "stdio",
            "command": "node",
            "args": [
                "...../build/"
            ]
        }
    }
  }

License

This project is licensed under the MIT License. See the file for details.