Dixa MCP 服务器

一个用于 Dixa API 的 FastMCP 服务器实现，提供用于管理对话和标签的资源和工具。

功能

• 资源

  • 搜索对话
  • 获取对话详情
  • 获取对话备注
  • 获取对话消息
  • 获取可用标签

• 工具

  • 向对话添加标签
  • 从对话移除标签

项目结构

/src
├── dixa.ts              # 主要服务器设置
├── config.ts            # 配置和环境变量设置
├── types.ts             # 共享类型和错误处理
├── resources/           # 资源实现
├── schemas/            # 用于验证的 Zod 模式
└── tools/             # 工具实现

配置

服务器需要以下环境变量：

• DIXA_API_KEY: 您的 Dixa API 密钥
• DIXA_API_BASE_URL (可选): 覆盖默认 API URL (默认为 'https://dev.dixa.io/v1')

用法

1. 设置环境变量：

   export DIXA_API_KEY='your-api-key'

2. 启动服务器：

   npm start
   

## 运行您的服务器

### 使用 `mcp-cli` 测试

测试和调试服务器的最快方法是使用 `fastmcp dev`：

```bash
npx fastmcp dev server.js
npx fastmcp dev server.ts

这将使用 mcp-cli 运行您的服务器，以便在终端中测试和调试您的 MCP 服务器。

使用 MCP Inspector 检查

另一种方法是使用官方的 MCP Inspector 使用 Web UI 检查您的服务器：

npx fastmcp inspect server.ts

FAQ

如何与 Claude Desktop 一起使用？

按照指南 https://modelcontextprotocol.io/quickstart/user 并添加以下配置：

{
  "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: "My Resource",
  description: "Description",
  load: async (args: MyArgs, apiKey: string) => {
    // 实现
  }
};

添加新工具

1. 在 src/tools/ 中创建工具
2. 将工具添加到 src/dixa.ts

示例工具：

export const myTool = {
  name: "My Tool",
  description: "Description",
  execute: async (args: MyArgs, apiKey: string) => {
    // 实现
  }
};

错误处理

该项目使用自定义错误类：

• DixaError: API 错误的基类
• DixaValidationError: 用于响应验证失败

展示

[!NOTE]

如果您使用 FastMCP 开发了一个服务器，请提交 PR 在此处展示它！

• https://github.com/apinetwork/piapi-mcp-server
• https://github.com/Meeting-Baas/meeting-mcp - Meeting BaaS MCP 服务器，使 AI 助手能够创建会议机器人、搜索记录并管理录音数据

致谢

• FastMCP 的灵感来自 Jonathan Lowin 的 Python 实现。
• 部分代码库采用自 LiteMCP。
• 部分代码库采用自 Model Context protocolでSSEをやってみる。

贡献

1. 遵循现有资源和工具的模式
2. 添加适当的 JSDoc 文档
3. 使用 types.ts 和 config.ts 中的共享实用程序
4. 如果添加新功能，请更新 README