Mantis MCP Server

🚀 Mantis MCP サーバー

Mantis MCP サーバーは、Mantis 問題追跡システムと連携して、問題管理を効率化するためのサーバーアプリケーションです。API を通じて問題の取得、作成、更新、削除などの操作を行うことができます。

🚀 クイックスタート

依存関係のインストール

npm install

ビルド

npm run build

開発モード（変更を監視）

npm run watch

実行

npm start

📦 設定ファイルの例

module.exports = {
    mantis: {
        url: 'http://your-mantis-server.com',
        username: 'admin', // Mantis 管理者アカウント名
        password: 'password' // Mantis 管理者パスワード
    },
    log: {
        level: 'info', // ログレベル：debug, info, warning, error
        dir: './logs/' // ログファイルの保存ディレクトリ
    },
    pages: {
        pageSize: 20, // デフォルトのページサイズ
        defaultPage: 1 // デフォルトの開始ページ番号
    }
}

✨ 高階関数

withMantisConfigured

この高階関数は、共通の検証ロジックを処理するために使用されます。以下のことを保証します：

• Mantis API の設定チェック
• 統一されたエラー処理
• 標準化されたレスポンス形式
• 自動ログ記録

✨ エラー処理

完全なエラー処理メカニズムには、以下が含まれます：

• Mantis API エラー処理（HTTP ステータスコードを含む）
• 一般的なエラー処理
• 構造化されたエラーレスポンス
• 詳細なエラーログ記録

✨ コード構造

ディレクトリ構造

src/
├── config/                 # 設定フォルダ
│   ├── mantis.config.ts    # Mantis サーバー設定
│   └── log.config.ts      # ログ設定
├── services/               # サービスモジュール
│   ├── issue.service.ts    # 問題処理ロジック
│   ├── user.service.ts     # ユーザー処理ロジック
│   └── project.service.ts  # プロジェクト処理ロジック
├── controllers/           # コントローラー層
│   ├── issue.controller.ts # 問題インターフェース定義
│   ├── user.controller.ts  # ユーザーインターフェース定義
│   └── project.controller.ts # プロジェクトインターフェース定義
└── utils/                 # ユーティリティ関数
    ├── logger.ts          # ログユーティリティ
    └── errorHandling.ts   # エラー処理ユーティリティ

💻 開発

依存関係のインストール

npm install

ビルド

npm run build

開発モード（変更を監視）

npm run watch

実行

npm start

💻 ログ

ファイルログ記録が有効になっている場合 (ENABLE_FILE_LOGGING=true)、ログファイルは以下に保存されます：

• logs/mantis-mcp-server-combined.log: すべてのレベルのログ
• logs/mantis-mcp-server-error.log: エラーレベルのログのみ

ログファイルのサイズ上限は 5MB で、最大 5 個の履歴ファイルが保持されます。

📚 リリースノート

インストール

npm install mantis-mcp-server --save

使用例

新しいプロジェクトの作成

import { createServer } from 'mantis-mcp-server'

const server = createServer({
    mantis: {
        url: 'http://your-mantis-server.com',
        username: 'admin',
        password: 'password'
    },
    log: {
        level: 'info',
        dir: './logs/'
    }
})

server.listen(3000, () => {
    console.log('サーバーが http://localhost:3000 で起動しました')
})

設定

{
    "name": "mantis-mcp-server",
    "version": "1.0.0",
    "description": "Mantis 問題追跡システム MCP サーバー",
    "main": "dist/index.js",
    "scripts": {
        "start": "node dist/index.js",
        "build": "webpack --config webpack.config.js"
    },
    "dependencies": {
        "express": "^4.18.2",
        "axios": "^1.5.0",
        "lodash": "^4.17.15",
        "moment": "^2.29.1"
    }
}

リリース

ローカルインストール

npm install mantis-mcp-server --save

グローバルインストール

npm install -g mantis-mcp-server

新しいプロジェクトの作成

npx mantis-mcp-server init my-project
cd my-project && npm install

更新

npm から更新

npm update mantis-mcp-server

アンインストール

npm uninstall mantis-mcp-server

💻 コマンドラインツール

CLI のインストール

npm install -g mantis-mcp-cli

CLI の使用

mantis-mcp --version # バージョン番号を表示
mantis-mcp help # ヘルプ情報を表示

📚 API ツールの説明

getIssues

問題リストを取得します。

パラメーター

• projectId (number): プロジェクト ID
• pageIndex (number): 現在のページ番号、デフォルトは 1
• pageSize (number): ページあたりの件数、デフォルトは 20

戻り値

{
    issues: Array<Issue>, // 問題リスト
    totalPages: number,   // 総ページ数
    totalItems: number   // 総レコード数
}

getIssue

単一の問題を取得します。

パラメーター

• issueId (number): 問題 ID

戻り値

{
    id: number,       // 問題 ID
    title: string,    // 問題タイトル
    description: string, // 問題の説明
    status: string,   // 問題の状態
    priority: string, // 問題の優先度
    assignee: string, // 担当者
    reporter: string  // 報告者
}

createIssue

新しい問題を作成します。

パラメーター

{
    title: string,       // 必須、問題タイトル
    description: string, // オプション、問題の説明
    projectId: number,   // 必須、プロジェクト ID
    status: string,      // オプション、デフォルトは 'new'
    priority: string,    // オプション、デフォルトは 'normal'
    assignee: string     // オプション、デフォルトは空
}

戻り値

{
    id: number         // 新しく作成された問題 ID
}

updateIssue

問題を更新します。

パラメーター

{
    issueId: number,   // 必須、問題 ID
    title?: string,    // オプション、新しいタイトル
    description?: string, // オプション、新しい説明
    status?: string,   // オプション、新しい状態
    priority?: string, // オプション、新しい優先度
    assignee?: string  // オプション、新しい担当者
}

deleteIssue

問題を削除します。

パラメーター

• issueId (number): 必須、問題 ID

🚫 エラー処理

すべての API 呼び出しは標準的な HTTP ステータスコードを返します：

• 成功: 200 OK
• 作成成功: 201 Created
• 更新成功: 204 No Content
• 削除成功: 204 No Content
• 失敗: 4xx または 5xx のエラーステータスコード

エラーレスポンス形式:

{
    code: number,     // エラーコード
    message: string   // エラーメッセージ
}

⚠️ 注意事項

1. すべての API 呼び出しには有効な認証トークンが必要です。
2. 更新および削除操作には追加の権限検証が必要です。
3. サーバーの時間が Mantis の時間と同期していることを確認し、クロックオフセットの問題を避けてください。

📄 ライセンス

MIT License

🤝 貢献ガイド

Fork と Pull Request を歓迎します！