Jira Insights MCP

Jira Insights Asset Management MCP Service

Developer tools Knowledge management and memory #Jira management #Asset modeling #MCP protocol #AQL query Local .TypeScript

rating : 2 points

downloads : 7

update time : 2025-04-28

What is the Jira Insights MCP Server?

The Jira Insights MCP Server is a powerful tool for managing and operating Jira Insights asset schemas. It allows you to create, read, update, and delete object schemas, object types, and objects themselves. Additionally, you can query assets using the Atlassian Query Language (AQL).

How to use the Jira Insights MCP Server?

To get started, make sure you have Node.js version 20 or higher installed, and prepare your Jira API token and email address. Then, follow the instructions to configure environment variables and start the server.

Applicable scenarios

Suitable for enterprise users who need to efficiently manage Jira Insights asset schemas, especially those who want to automate their asset management processes.

Main features

Manage object schemasSupports creating, reading, updating, and deleting object schemas.

Manage object typesSupports creating, reading, updating, and deleting object types.

Manage objectsSupports creating, reading, updating, and deleting objects.

AQL queryAllows users to query assets using the Atlassian Query Language.

Advantages and limitations

Advantages

Simplify complex asset management processes.

Improve work efficiency and reduce manual operation time.

Support multiple query methods for convenient and flexible use.

Limitations

Requires a certain technical background to fully master.

Some advanced features may require additional configuration and learning costs.

How to use

Clone the project repository

Use Git to clone the code repository of the Jira Insights MCP Server.

Install dependencies

Run npm install in the cloned directory to install the required dependencies.

Build the project

Use the npm run build command to build the project.

Start the local server

Start the local development server via npm run start.

Usage examples

Query all object schemasDemonstrate how to get all object schemas in the system.

Create a new object typeShow how to add a new object type to an existing schema.

Frequently Asked Questions

How to ensure the security of my API token?

What should I do if I encounter an AQL query error?

Related resources

Official GitHub repository

Get the latest version and source code.

Atlassian Query Language (AQL) documentation

Gain an in - depth understanding of AQL and its usage.

🚀 Jira Insight MCP Server

This is a Model Context Protocol (MCP) server for managing Jira Insights asset schemas. It offers CRUD operations for asset schemas, object types, and attributes, and supports data retrieval via AQL queries.

🚀 Quick Start

This server is designed to manage Jira Insights asset schemas, providing CRUD operations for asset schemas, object types, and attributes. It also supports data retrieval through AQL queries.

✨ Features

Asset Schema Management: Supports creating, reading, updating, and deleting asset schemas.
Object Type Management: Provides full and incremental information about object types, including attribute expansion.
Attribute Management: Allows retrieving detailed information of a single attribute or multiple attributes and supports searching for attributes by name.
AQL Query: Enables complex data retrieval using AQL syntax.

📦 Prerequisites

Install Node.js and npm (Node 16.x or higher is recommended).
Install Docker (for Docker deployment).
Obtain a Jira API access token and ensure it has the necessary permissions.

📦 Installation

Local Development Installation

Clone the repository:

git clone [Repository URL]
cd jira-insight-mcp-server

Install dependencies:
```
npm install
```
Start the server:
```
npm start
```

Docker Deployment

Build the Docker image:
```
./scripts/build-local.sh
```
Run the container:
```
./scripts/run-local.sh
```

💻 Usage Examples

Server Configuration

You can set the following parameters via environment variables or configuration files:

JIRA_API_TOKEN: Jira API access token.
JIRA_HOST_URL: URL of the Jira instance.

Example Usage

# Set environment variables and start the container
export JIRA_API_TOKEN="your_token_here"
export JIRA_HOST_URL="https://your-jira-instance.atlassian.com"
docker-compose up

🛠️ Toolset

Asset Schema Management Tool

Command: manage_jira_insight_schema
Functions:
- Create a new asset schema.
- Retrieve detailed information of an asset schema with a specified ID.
- Update an existing asset schema.
- Delete an asset schema with a specified ID.

Object Type Management Tool

Command: manage_jira_object_type
Functions:
- Retrieve complete or incremental information of all object types, supporting the expand=attributes parameter.

Attribute Management Tool

Command: manage_jira_attribute
Functions:
- Retrieve detailed information of a single attribute.
- Search for multiple attributes matching a specified name.

📊 Resource Overview

Property	Details
/jira/insight/schemas	Manage asset schemas
/jira/objects	Retrieve complete information of object types
/jira/objects/incremental	Retrieve incremental update information of object types
/jira/object-types	Operate on object types (retrieve single or multiple)
/jira/object-type/{id}/attributes	Retrieve the attribute list of a specified object type

📈 Planned Improvements

High-Priority Improvements

Enhanced Error Handling:
- Provide more detailed error information, including specific problem descriptions.
- Add error repair suggestions and operation examples.
Optimized AQL Query Function:
- Add query validation and formatting tools.
- Provide example queries customized by schema.
Improved Attribute Discovery Mechanism:
- Optimize attribute retrieval performance and add cache support.
- Improve the processing logic of the expand parameter.

Medium-Priority Improvements

Object Template Generation:
- Automatically generate creation templates based on object types.
- Provide placeholder examples and validation rules.
Query Library Optimization:
- Establish a query example library related to schemas.
- Implement context-aware query suggestion functionality.

🛠️ Development Guide

Script Usage

npm run build: Build TypeScript code.
npm run lint: Run ESLint to check code style.
npm run test: Execute unit tests.
npm run watch: Enable real-time code monitoring and automatic building.

🚧 Troubleshooting

Common Issues

AQL Query Error:
- Ensure values containing spaces are enclosed in double quotes, e.g., Name = "John Doe".
- Use uppercase logical operators like AND, OR.
Attribute Retrieval Failure:
- Check if the API access token is valid and has sufficient permissions.
- Confirm if the object type ID is correct.

📂 Project Files

Configuration file: config/default.json
Log files: logs/

⚠️ Important Note

After modifying the code, you need to rebuild the Docker image for the changes to take effect.
Use environment variables to avoid hard - coding sensitive information.

For more detailed information, please refer to the project documentation or contact the development team.