Leanix MCP Integration

🚀 LeanIX MCP 集成

本項目是一個將 LeanIX 連接至 AI 助手的模型上下文協議 (MCP) 服務器。它能把 LeanIX 的 GraphQL API 暴露為 MCP 工具，供 AI 助手調用，為 LeanIX 與 AI 助手的交互搭建了橋樑。

🚀 快速開始

先決條件

• Node.js (v14 或更高版本)
• 一個 LeanIX 工作區和 API 令牌
• 對 GraphQL 和 MCP 的基本理解

操作步驟

1. 克隆此倉庫。
2. 安裝依賴項：

   npm install
   

3. 在根目錄下創建一個 .env 文件，其中包含您的 LeanIX 憑據：

   LEANIX_SUBDOMAIN=your-workspace-subdomain
   LEANIX_TOKEN=your-api-token
   

✨ 主要特性

此集成提供了五個用於 LeanIX 操作的 MCP 工具：

1. 事實表概覽：獲取工作區中事實表的數量和統計信息。
2. 搜索：通過名稱查找事實表。
3. 訂閱管理：查看特定事實表的訂閱者。
4. 創建事實表：向工作區添加新的事實表。
5. 更新事實表：修改現有事實表的信息。

📚 詳細文檔

項目結構

├── server.js            # 主 MCP 服務器設置和初始化
├── leanix-client.js     # LeanIX API 客戶端實現
├── api                  # LeanIX API 定義和端點
├── mutation            # GraphQL 變體定義
├── datamodel           # 數據模型和類型定義
├── .env                # 環境配置
└── src/
    ├── config/
    │   └── config.js         # 加載並驗證環境變量中的 LeanIX 憑據
    ├── graphql/
    │   └── queries/         # GraphQL 查詢和變體
    │       ├── factSheetQueries.js     # 事實表操作的查詢
    │       └── workspaceQueries.js     # 工作區級別操作的查詢
    ├── tools/
    │   └── workspaceTools.js # 定義並註冊五個 MCP 工具
    ├── types/
    │   └── schemas.js       # Zod 模式用於工具參數的驗證
    └── utils/
        └── responseHandler.js # 以 MCP 兼容結構格式化響應

常見問題及解決方案

1. GraphQL 架構不匹配：始終檢查當前 LeanIX API 架構。架構可能會隨時間變化。
2. 響應格式：所有 MCP 工具響應必須遵循以下格式：

   {
     content: [{
       type: "text",
       text: "your response here"
     }]
   }
   

3. 錯誤處理：始終使用 withErrorHandling 包裝工具實現，以確保正確的錯誤響應。
4. 環境變量：在進行任何 API 調用之前，確保正確加載和驗證環境變量。

Claude Desktop 配置

要將此 MCP 服務器與 Claude Desktop 使用，請將服務器配置添加到 Claude 的配置文件中。配置文件通常位於：

• Mac: ~/Library/Application Support/Claude/claude_desktop_config.json
• Windows: %APPDATA%\Claude\claude_desktop_config.json

添加以下配置：

{
    "mcpServers": {
      "myserver": {
        "command": "node",
        "args": [
          "/path/to/your/lean/server.js"
        ]
      }
    }
}

將 /path/to/your/lean/server.js 替換為 server.js 文件的絕對路徑。這會指示 Claude Desktop：

1. 在需要時啟動此 MCP 服務器。
2. 通過它進行 LeanIX 操作。
3. 使用 Node.js 運行它。

測試您的集成

1. 啟動服務器：

   node server.js
   

2. 打開瀏覽器並訪問 http://localhost:3000

調試技巧

• 確保所有環境變量都已正確設置。
• 檢查控制檯輸出以獲取任何錯誤或警告信息。
• 使用瀏覽器開發者工具檢查網絡請求和響應。

📦 資源

• LeanIX 文檔
• GraphQL 官方網站
• MCP 協議文檔