Dixa

🚀 Dixa MCP 服務器

Dixa MCP 服務器是一個快速實現的 Dixa API MCP 服務器，它提供了用於管理對話和標籤的資源與工具，能有效助力相關業務流程的開展。

✨ 主要特性

資源

• 搜索對話
• 獲取對話詳情
• 獲取對話筆記
• 獲取對話消息
• 獲取可用標籤

工具

• 向對話添加標籤
• 從對話中移除標籤

📦 安裝指南

服務器需要以下環境變量：

• DIXA_API_KEY：你的 Dixa API 密鑰
• DIXA_API_BASE_URL（可選）：覆蓋默認 API URL（默認為'https://dev.dixa.io/v1'）

設置環境變量示例：

export DIXA_API_KEY='your-api-key'

💻 使用示例

基礎用法

1. 設置環境變量：

export DIXA_API_KEY='your-api-key'

2. 啟動服務器：

npm start

高級用法

使用 mcp-cli 測試

最快捷的測試和調試服務器的方法是使用 fastmcp dev：

npx fastmcp dev server.js
npx fastmcp dev server.ts

這將使用 mcp-cli 在終端中運行你的 MCP 服務器進行測試和調試。

使用 MCP Inspector 檢查

另一種方法是使用官方的 MCP Inspector 通過 Web UI 檢查你的服務器：

npx fastmcp inspect server.ts

📚 詳細文檔

項目結構

/src
├── dixa.ts             # 主服務器設置
├── config.ts           # 配置和環境設置
├── types.ts            # 共享類型和錯誤處理
├── resources/          # 資源實現
├── schemas/           # Zod 模式用於驗證
└── tools/             # 工具實現

常見問題解答

如何與 Claude Desktop 使用？

請參考指南 鏈接，並在配置中添加以下內容：

{
  "mcpServers": {
    "my-mcp-server": {
      "command": "npx",
      "args": [
        "tsx",
        "/PATH/TO/YOUR_PROJECT/src/index.ts"
      ],
      "env": {
        "YOUR_ENV_VAR": "value"
      }
    }
  }
}

開發

添加新資源

1. 在 src/schemas/ 中創建一個模式
2. 在 src/resources/ 中創建資源
3. 將資源添加到 src/dixa.ts

示例資源：

export const myResource = {
  uri: "dixa://my-resource",
  name: "我的資源",
  description: "描述",
  load: async (args: MyResourceArgs, props: MyResourceProps) => {
    // 實現邏輯
  }
}

添加新工具

1. 在 src/tools/ 中創建一個工具
2. 將工具添加到 src/dixa.ts

示例工具：

export const myTool = {
  name: "我的工具",
  description: "這是一個用於執行特定任務的工具。",
  args: {
    type: "object" as const,
    properties: {
      // 定義參數
    }
  },
  fn: async (args: MyToolArgs, props: MyToolProps) => {
    // 實現邏輯
  }
}

展示

• Project A：一個展示如何使用 Dixa MCP 服務器的項目。
• Project B：另一個展示集成 Dixa API 的項目。

致謝

我們感謝以下項目的貢獻：

• FastMCP 項目（鏈接）為我們的實現提供了基礎。
• Zod 庫（鏈接）用於數據驗證和類型安全。

貢獻指南

我們歡迎社區的貢獻！請按照以下步驟參與：

1. 問題報告：在 GitHub 倉庫 中提交任何遇到的問題或功能請求。
2. 功能實現：查看 Issues 標籤，找到需要實現的功能並進行開發。
3. 代碼審查：積極參與 Pull Request 的審查，確保代碼質量和一致性。
4. 文檔貢獻：幫助完善文檔，使其更加清晰和易於理解。

請在提交 Pull Request 前閱讀我們的 貢獻指南，以瞭解更多信息。