Jama MCP Server

🚀 简体中文接続ガイド

このプロジェクトは、Jama Connectとの接続に関する操作を提供します。以下に、プロジェクトの構成、実行方法、テスト方法、利用可能なツール、トラブルシューティング、およびライセンスについて説明します。

🚀 クイックスタート

このセクションでは、プロジェクトの構成と実行方法について説明します。

✨ プロジェクト構成

1. プロジェクトファイル：

   • jama_mcp_server/server.py：Jama Connectの関連操作を処理するメインサービスモジュールです。
   • test_mcp_client.py：サーバーツールを直接呼び出してデバッグするためのテストクライアントスクリプトです。

2. 実行環境：

   • 必要な依存関係（Pythonやuvなど）がインストールされていることを確認してください。
   • プロジェクトに必要な環境変数を設定してください。

📦 サービスの実行

直接実行

ターミナルで以下のコマンドを実行してサービスを起動します：

# jama-mcp-serverディレクトリに移動
uv run python -m jama_mcp_server.server

Docker構成

Dockerを使用してサービスを実行する場合、以下のJSON構成例（mcp_settings.json）を参考にできます：

{
  "mcpServers": {
    "jama-mcp": {
      "command": "docker",
      "args": ["run", "--rm", "-i",
        "-e", "JAMA_URL", "-e", "JAMA_CLIENT_ID", "-e", "JAMA_CLIENT_SECRET", "-e", "JAMA_MOCK_MODE",
        "jama-mcp-server"
      ],
      "env": {
        "JAMA_URL": "https://your-jama-instance.com",
        "JAMA_CLIENT_ID": "your-client-id",
        "JAMA_CLIENT_SECRET": ""
      }
    }
  }
}

環境変数の構成

必須環境変数

• JAMA_URL：Jama ConnectインスタンスのURLアドレスです。
• JAMA_CLIENT_ID と JAMA_CLIENT_SECRET：認証に使用するクライアントIDとシークレットです。

オプション環境変数

• JAMA_AWS_SECRET_PATH：AWSパラメータストアを使用する場合、シークレットパスを指定します。
• JAMA_AWS_PROFILE：使用するAWS構成ファイルの名前を指定します。
• JAMA_MOCK_MODE：trueに設定すると、モックモードが有効になります（デフォルトは無効）。

サービス起動例

uvコマンドでサービスを実行する場合のJSON構成例：

{
  "mcpServers": {
    "jama-mcp": {
      "command": "uv",
      "args": [
        "run",
        "python",
        "-m",
        "jama_mcp_server.server"
      ],
      
      "cwd": "/path/to/your/clone/jama-mcp-server",
      "env": {
        "JAMA_URL": "https://your.jama.instance.com",
        "JAMA_CLIENT_ID": "your_client_id",
        "JAMA_CLIENT_SECRET": "your_client_secret",
        "JAMA_AWS_SECRET_PATH": "/path/to/your/jama/secret",
        "JAMA_AWS_PROFILE": "your-aws-profile-name",
        "JAMA_MOCK_MODE": "false"
      }
    }
  }
}

💻 使用例

基本的な使用法

テストクライアントを実行するには、以下のコマンドを使用します：

# jama-mcp-serverディレクトリに移動
uv run python test_mcp_client.py

このスクリプトは、サーバーを起動し、事前定義されたツールを呼び出してテストを行います。成功および予期される失敗ケースを含み、結果を出力した後にまとめを提供します。

🔧 トラブルシューティング

一般的な問題

1. 環境変数が構成されていない：

   • JAMA_URL、JAMA_CLIENT_ID、およびJAMA_CLIENT_SECRETが正しく設定されていることを確認してください。

2. Dockerの実行に失敗した：

   • Dockerサービスがインストールされ、有効になっていることを確認してください。
   • コンテナを実行するための十分な権限があることを確認してください。

3. モックモードが機能しない：

   • JAMA_MOCK_MODEがtrueに設定されていることを確認してください。

解決策

1. 環境変数を検証する：

   echo $JAMA_URL
   echo $JAMA_CLIENT_ID
   echo $JAMA_CLIENT_SECRET
   

2. ログ出力を確認する：

   • サービス起動時の詳細なログを確認し、エラーメッセージがないかを確認してください。

3. 環境変数を再構成する：

   export JAMA_MOCK_MODE=true
   uv run python -m jama_mcp_server.server
   

📄 ライセンス

このプロジェクトの使用と配布は、プロジェクトライセンスの条項に従う必要があります。

何か問題や提案がある場合は、メンテナンスチームに連絡してください。