Dixa MCP Server

🚀 Dixa MCP 服務器

Dixa MCP 服務器是一個 FastMCP 服務器，它提供了與 Dixa API 交互的實用工具。藉助該服務器，你能夠便捷地搜索對話、獲取對話詳細信息以及管理標籤等。

🚀 快速開始

📦 安裝指南

要運行此服務器，你需要按照以下步驟進行操作：

1. 安裝依賴：

npm install
npm install fastmcp

2. 設置環境變量：

cp .env.example .env

接著，編輯 .env 文件，並添加你的 Dixa API 密鑰：

DIXA_API_KEY=your_api_key_here

3. 啟動服務器：

# 使用 CLI 測試服務器示例：
npx fastmcp dev src/tools/index.ts

# 使用 MCP Inspector 測試服務器示例：
npx fastmcp inspect src/tools/index.ts

📚 詳細文檔

在 Claude 中設置

若要在 Claude 中使用此服務器，請按以下步驟操作：

1. 打開開發模式。
2. 在 Claude 中，轉到 設置 > 開發人員 > 編輯配置。
3. 添加以下配置：

{
  "mcpServers": {
    "dixa-mcp-server": {
      "command": "npx",
      "args": [
        "tsx",
        "/PATH/TO/FOLDER/dixa-mcp-server/src/tools/index.ts"
      ],
      "env": {
        "DIXA_API_KEY": "YOUR_API_KEY_TO_DIXA"
      }
    }
  }
}

Server - Sent Events (SSE)

你還可以使用 SSE 支持來運行服務器：

server.start({
  transportType: "sse",
  sse: {
    endpoint: "/sse",
    port: 8080,
  },
});

這將啟動服務器，並在 http://localhost:8080/sse 監聽 SSE 連接。

你可以使用 SSEClientTransport 連接到服務器：

import { SSEClientTransport } from "@modelcontextprotocol/sdk/client/sse.js";

const client = new Client(
  {
    name: "example-client",
    version: "1.0.0",
  },
  {
    capabilities: {},
  },
);

const transport = new SSEClientTransport(new URL(`http://localhost:8080/sse`));

await client.connect(transport);

💻 使用示例

實現的工具

該服務器實現了多種實用工具，以下為你詳細介紹：

對話管理

• searchConversations：在 Dixa 中搜索對話，支持分頁。
• getConversation：通過 ID 獲取單個對話。
• getConversationMessages：獲取特定對話的所有消息。
• getConversationTags：獲取與特定對話關聯的所有標籤。
• getConversationNotes：獲取特定對話的所有內部備註。
• getConversationRatings：獲取特定對話的所有評分。

標籤管理

• listTags：列出 Dixa 中所有可用的標籤。
• tagConversation：為特定對話添加標籤。
• removeConversationTag：從特定對話中移除標籤。

最終用戶管理

• getEndUser：獲取特定最終用戶的詳細信息。
• getEndUserConversations：獲取特定最終用戶的所有對話。

代理管理

• getAgent：獲取特定代理的詳細信息。
• listAgents：列出所有代理，可選過濾。

分析

• getAnalyticsMetric：獲取特定分析指標的詳細信息。
• getAnalyticsRecord：獲取特定分析記錄的詳細信息。
• listAnalyticsRecords：列出所有可用的分析記錄 ID。
• listAnalyticsMetrics：列出所有可用的分析指標 ID。
• getAnalyticsFilter：獲取給定分析過濾器屬性的可能值。
• getAnalyticsRecordsData：使用過濾器和時間段獲取特定記錄的分析數據。
• getAnalyticsMetricsData：使用過濾器、時間段和聚合獲取特定指標的分析數據。