Kfnzero Mantis MCP Server

🚀 Mantis プロジェクト Cobra サービスドキュメント

Mantis プロジェクトの Cobra サービスに関するドキュメントです。このサービスは、Mantis API を利用した様々な機能を提供します。

🚀 クイックスタート

このサービスを使い始めるには、まず環境変数または設定ファイルを使ってサービスを構成する必要があります。その後、開発手順に従ってサービスを起動できます。

✨ 主な機能

• サービスは withMantisConfigured 高階関数を使用して、共通のチェックロジックを処理します。
• 完璧なエラーハンドリングメカニズムが備わっています。
• 様々な API インターフェースを提供して、Mantis の問題リストや詳細、ユーザー情報などを取得できます。

📦 インストール

依存関係のインストール

# 依存関係をインストールする
npm install

ビルド

# ビルドを実行する
npm run build

サービスの起動

# サービスを起動する
npm start

パッケージング

npm run build && npm pack

インストール

npm install mantis-cobra-service-0.1.0.tgz

💻 使用例

基本的な使用法

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

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

withMantisConfigured(config);

📚 ドキュメント

設定

環境変数設定

以下の環境変数を設定することで、サービスを構成できます。

設定ファイル

config.json ファイルを使用して設定することもできます。

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

高階関数

サービスは withMantisConfigured 高階関数を使用して、共通のチェックロジックを処理し、以下のことを保証します。

• Mantis API の設定チェック
• 統一されたエラーハンドリング
• 標準化された応答形式
• 自動的なログ記録

エラーハンドリング

完璧なエラーハンドリングメカニズムには以下が含まれます。

• Mantis API のエラーハンドリング（HTTP ステータスコードを含む）
• 一般的なエラーハンドリング
• 構造化されたエラー応答
• リソース使用状況の詳細なログ

コード構造

API ツールの説明

サービスは以下の API インターフェースを提供します。

1. 問題リストの取得 (get_issues)

Mantis の問題リストを取得し、複数の条件でフィルタリングできます。 パラメータ:

• projectId (オプション): プロジェクト ID
• statusId (オプション): ステータス ID
• handlerId (オプション): 担当者 ID
• reporterId (オプション): 報告者 ID
• search (オプション): 検索キーワード
• pageSize (オプション、デフォルト 20): ページサイズ
• page (オプション、デフォルト 0): ページングの開始位置（1 から始まります）
• select (オプション): 返されるデータフィールド。例: ['id', 'summary', 'description']。返されるデータ量を減らすために使用できます。

2. 問題詳細の取得 (get_issue_by_id)

ID を指定して Mantis の問題詳細を取得します。 パラメータ:

• issueId: 問題 ID

3. ユーザーの検索 (get_user)

ユーザー名を指定して Mantis のユーザーを検索します。 パラメータ:

• username: ユーザー名

4. プロジェクトリストの取得 (get_projects)

Mantis のプロジェクトリストを取得します。 パラメータ: なし

5. 問題統計の取得 (get_issue_statistics)

Mantis の問題統計データを取得し、さまざまな次元で分析できます。 パラメータ:

• projectId (オプション): プロジェクト ID
• groupBy: グループ化の基準。選択肢: 'status', 'priority', 'severity', 'handler', 'reporter'
• period (デフォルト 'all'): 時間範囲。選択肢: 'all', 'today', 'week', 'month'

6. 割り当て統計の取得 (get_assignment_statistics)

Mantis の問題割り当て統計データを取得し、異なるユーザーの割り当て状況を分析します。 パラメータ:

• projectId (オプション): プロジェクト ID
• includeUnassigned (デフォルト true): 未割り当ての問題を含めるかどうか
• statusFilter (オプション): ステータスフィルター。特定のステータスの問題のみを計算します。

7. すべてのユーザーの取得 (get_users)

すべてのユーザーリストを取得します。 パラメータ: なし

ログ記録

ログ出力形式は次のとおりです。

time=2023-10-26T15:34:12.879Z level=INFO message="サービスを起動します" port=3000 env=development
time=2023-10-26T15:34:13.000Z level=ERROR message="Mantis API に接続できません" error="connection timeout"

リリースガイド

パッケージング

npm run build && npm pack

インストール

npm install mantis-cobra-service-0.1.0.tgz

設定例

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

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

withMantisConfigured(config);

付録

環境変数リスト

よくある質問

1. 認証に失敗した場合はどうすればいいですか？
   • ユーザー名とパスワードが正しいことを確認してください。
   • 環境変数または設定ファイルの資格情報が正しいことを確認してください。
2. API に接続できない場合はどうすればいいですか？
   • ネットワーク接続を確認してください。
   • API サービスが正常に動作していることを確認してください。