Jama MCP Server

🚀 簡體中文連接指南

本項目提供了與Jama Connect連接的相關服務配置與運行指引，幫助你快速搭建並使用服務。

🚀 快速開始

項目配置與運行

項目結構

• 項目文件：
  • jama_mcp_server/server.py：主服務模塊，負責處理Jama Connect的相關操作。
  • test_mcp_client.py：測試客戶端腳本，用於直接調用服務器工具進行調試。
• 運行環境：
  • 確保安裝了必要的依賴項（如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

該腳本會啟動服務器並調用預定義的工具進行測試，包括成功和預期失敗案例。輸出結果後還會提供總結。

✨ 主要特性

• 提供了與Jama Connect連接的主服務模塊，方便處理相關操作。
• 具備測試客戶端腳本，可直接調用服務器工具進行調試。
• 支持直接運行和Docker容器化運行兩種方式。
• 提供多種環境變量配置選項，滿足不同的使用場景。

📚 詳細文檔

可用工具

此服務提供了多種只讀工具，具體功能請參考 MCP 客戶端界面或相關文檔。

故障排除

常見問題

• 環境變量未配置：
  • 檢查是否正確設置了JAMA_URL、JAMA_CLIENT_ID和JAMA_CLIENT_SECRET。
• Docker運行失敗：
  • 確保已安裝並啟用了 Docker 服務。
  • 檢查是否有足夠的權限運行容器。
• 模擬模式未生效：
  • 確認JAMA_MOCK_MODE是否設置為true。

解決方法

• 驗證環境變量：

echo $JAMA_URL
echo $JAMA_CLIENT_ID
echo $JAMA_CLIENT_SECRET

• 檢查日誌輸出：
  • 查看服務啟動時的詳細日誌，確認是否有錯誤信息。
• 重新配置環境變量：

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

📄 許可證

本項目的使用和分發需遵循項目許可證的條款。

如有任何問題或建議，請聯繫維護團隊。