Kfnzero Mantis MCP Server

🚀 Mantis Project Cobra Service Documentation

This documentation provides a detailed guide on configuring, using, and developing the Mantis Project Cobra service. It covers aspects such as environment variable configuration, high - order functions, error handling, API interfaces, and more.

🚀 Quick Start

Before starting the service, you need to configure the service through environment variables or configuration files. Then, you can install dependencies, build, and start the service according to the development steps.

✨ Features

• Flexible Configuration: Support configuration through environment variables and config.json files.
• High - order Function: Use withMantisConfigured high - order function for common check logic processing.
• Complete Error Handling: Provide comprehensive error handling mechanisms, including Mantis API error handling and general error handling.
• Rich API Interfaces: Offer multiple API interfaces for querying Mantis issues, users, projects, etc.

📦 Installation

Environment Variable Configuration

Configure the service by setting the following environment variables:

• MANTIS_API_BASE_URL: The base URL of the Mantis API (required).
• MANTIS_USER: The username for accessing the Mantis API (required).
• MANTIS_PASSWORD: The corresponding user's password (required).
• PORT (default: 3000): The port on which the service runs.
• ENV (optional, default: production): The environment mode, supporting development and production.

Configuration File

You can also configure through the config.json file:

{
  "mantis": {
    "apiUrl": "https://your-mantis-url.com",
    "username": "admin",
    "password": "secret"
  },
  "port": 3000,
  "env": "development"
}

💻 Usage Examples

Development

# Install dependencies
npm install

# Build
npm run build

# Start the service
npm start

Logging

The log output format is as follows:

time=2023-10-26T15:34:12.879Z level=INFO message="Starting the service" port=3000 env=development
time=2023-10-26T15:34:13.000Z level=ERROR message="Unable to connect to the Mantis API" error="connection timeout"

Release Guide

Packaging

npm run build && npm pack

Installation

npm install mantis-cobra-service-0.1.0.tgz

Configuration Example

const withMantisConfigured = require('mantis-cobra-service');

const config = {
  apiUrl: 'https://your-mantis-url.com',
  username: 'admin',
  password: 'secret'
};

withMantisConfigured(config);

📚 Documentation

Higher - order Function

The service uses the withMantisConfigured higher - order function to handle common check logic, ensuring:

• Mantis API configuration check.
• Unified error handling.
• Standardized response format.
• Automatic logging.

Error Handling

The complete error handling mechanism includes:

• Mantis API error handling (including HTTP status codes).
• General error handling.
• Structured error responses.
• Detailed logging of resource usage.

Code Structure

API Tool Description

The service provides the following API interfaces:

1. Get Issue List (get_issues)

Get the Mantis issue list, which can be filtered according to multiple conditions. Parameters:

• projectId (optional): Project ID.
• statusId (optional): Status ID.
• handlerId (optional): Handler ID.
• reporterId (optional): Reporter ID.
• search (optional): Search keyword.
• pageSize (optional, default 20): Page size.
• page (optional, default 0): Pagination starting position, starting from 1.
• select (optional): Returned data fields, e.g., ['id', 'summary', 'description']. Can be used to reduce the amount of returned data.

2. Get Issue Details (get_issue_by_id)

Get the details of a Mantis issue by ID. Parameters:

• issueId: Issue ID.

3. Query User (get_user)

Query a Mantis user by username. Parameters:

• username: Username.

4. Get Project List (get_projects)

Get the Mantis project list. Parameters: None.

5. Get Issue Statistics (get_issue_statistics)

Get Mantis issue statistics, which can be analyzed according to different dimensions. Parameters:

• projectId (optional): Project ID.
• groupBy: Grouping basis, optional values: 'status', 'priority', 'severity', 'handler', 'reporter'.
• period (default 'all'): Time range, optional values: 'all', 'today', 'week', 'month'.

6. Get Assignment Statistics (get_assignment_statistics)

Get Mantis issue assignment statistics to analyze the assignment situation of different users. Parameters:

• projectId (optional): Project ID.
• includeUnassigned (default true): Whether to include unassigned issues.
• statusFilter (optional): Status filter, only calculate issues in specific statuses.

7. Get All Users (get_users)

Get the list of all users in a brute - force way. Parameters: None.

📄 Appendix

Environment Variable List

Frequently Asked Questions

1. How to handle authentication failure?

   • Check if the username and password are correct.
   • Ensure that the credentials in the environment variables or configuration file are correct.

2. Unable to connect to the API?

   • Check the network connection.
   • Confirm that the API service is running normally.