返回 MCP 目录
public公开dns本地运行

Dixa

Dixa MCP Server是一个基于FastMCP框架实现的API服务,提供对话管理和标签操作功能。

article

README

🚀 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'

💻 使用示例

基础用法

启动服务器:

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 前阅读我们的 贡献指南,以了解更多信息。

help

运行方式说明

cloud

托管运行

托管运行通常表示这个 MCP Server 由服务方环境承载,用户一般按页面提供的连接方式或授权流程接入,不需要在本地长期启动一个 MCP 进程

  1. 打开服务方连接页
  2. 完成授权或复制端点
  3. 在 MCP 客户端中连接
terminal

本地运行 / 其它方式

本地运行通常需要用户在自己的电脑或服务器上安装依赖,把 server_config 复制到 MCP 客户端,并按 env_schema 补齐环境变量、密钥或其它配置

  1. 复制 server_config
  2. 安装所需依赖
  3. 补齐环境变量后重启客户端