使用说明

项目简介

Directus MCP 服务器是一个桥梁,它使得 AI 客户端(如 Cursor, Claude Desktop 等)能够通过 Model Context Protocol (MCP) 标准协议,安全、便捷地访问和操作 Directus CMS 中的数据和功能。它将 Directus 的 API 能力封装成一系列易于 AI 调用的工具,使得 AI 应用可以利用 Directus CMS 作为强大的后端数据和内容管理系统。

主要功能点

  • 数据访问: 提供多种工具,允许 AI 客户端查询、读取、创建、更新和删除 Directus CMS 中 Collections (集合) 中的 Items (条目)。
  • 文件管理: 支持 AI 客户端从 Directus 获取文件信息,以及上传文件到 Directus。
  • 用户和权限管理: 允许 AI 客户端进行 Directus 用户登录,获取用户信息、角色和权限等。
  • 系统信息: 提供获取 Directus 系统信息的工具,例如系统配置、活动日志等。
  • 工具发现: AI 客户端可以动态发现服务器提供的所有工具及其详细描述和参数定义。

安装步骤

  1. 前提条件: 确保已安装 Node.js 和 NPM,并拥有一个可访问的 Directus 实例。
  2. 获取 Directus API 凭据: 登录您的 Directus 后台,创建静态访问令牌或准备好邮箱和密码用于API认证。
  3. 添加到 AI 编辑器: 在您的 MCP 客户端(如 Cursor 或 Claude Desktop)中添加新的 MCP 服务器配置。

服务器配置

以下是在 MCP 客户端中配置 Directus MCP 服务器的 JSON 格式配置信息。您需要根据您的 Directus 实例信息进行相应的配置。

使用访问令牌 (Access Token) 认证 (推荐):

{
  "mcpServers": {
    "directus": {  //  服务器名称,可以自定义
      "command": "npx",
      "args": ["-y", "@pixelsock/directus-mcp@latest"],
      "env": {
        "DIRECTUS_URL": "https://your-directus-instance.com",  //  替换为您的 Directus 实例 URL
        "DIRECTUS_ACCESS_TOKEN": "YOUR_ACCESS_TOKEN"  //  替换为您的 Directus 访问令牌
      }
    }
  }
}

使用邮箱和密码认证:

{
  "mcpServers": {
    "directus": {  //  服务器名称,可以自定义
      "command": "npx",
      "args": ["-y", "@pixelsock/directus-mcp@latest"],
      "env": {
        "DIRECTUS_URL": "https://your-directus-instance.com",  //  替换为您的 Directus 实例 URL
        "DIRECTUS_EMAIL": "[email protected]",  //  替换为您的 Directus 用户邮箱
        "DIRECTUS_PASSWORD": "your-password"  //  替换为您的 Directus 用户密码
      }
    }
  }
}

配置说明:

  • '"server name"': 为您的 MCP 服务器自定义一个名称,例如 "directus"。
  • '"command": "npx"': 指定启动服务器的命令为 'npx',它会自动下载并执行 '@pixelsock/directus-mcp' 包。
  • '"args": ["-y", "@pixelsock/directus-mcp@latest"]': 'npx' 命令的参数,'-y' 表示自动确认安装,'@pixelsock/directus-mcp@latest' 指定要运行的 MCP 服务器包及其版本 (latest 表示最新版本)。
  • '"env"': 环境变量配置,用于向 Directus MCP 服务器传递必要的配置信息:
    • '"DIRECTUS_URL"': 您的 Directus 实例的 API URL,例如 'https://your-directus-instance.com'。
    • '"DIRECTUS_ACCESS_TOKEN"' (或 '"DIRECTUS_EMAIL"' 和 '"DIRECTUS_PASSWORD"'): Directus API 的认证凭据,推荐使用访问令牌以提高安全性。

在 MCP 客户端中添加配置 (以 Cursor 和 Claude Desktop 为例):

  • Cursor: 打开 Cursor 设置 -> Cursor 设置 -> MCP,点击 "+ Add New Global MCP Server",粘贴上述 JSON 配置,替换占位符,保存并重启 Cursor。
  • Claude Desktop: 打开 设置 -> 开发者,点击 "Edit Config",编辑 'claude_desktop_config.json' 文件,粘贴上述 JSON 配置到 '"mcpServers"' 字段下,替换占位符,保存并重启 Claude。

基本使用方法

配置完成后,Directus MCP 服务器会在后台运行。在您的 AI 客户端中,您可以通过自然语言指令或图形界面调用服务器提供的工具,例如:

  • 查询商品数据: 指示 AI 客户端调用 'getItems' 工具,指定 collection 名称为 "products",即可从 Directus 中获取商品数据。
  • 上传文件: 指示 AI 客户端调用 'uploadFile' 工具,提供文件 URL 或文件数据,即可将文件上传到 Directus 的文件库中。
  • 获取用户信息: 指示 AI 客户端调用 'getCurrentUser' 工具,即可获取当前 Directus 用户的信息。

AI 客户端会根据工具的 'inputSchema' 提示您提供必要的参数。服务器会将 Directus API 返回的数据以 JSON 格式返回给 AI 客户端,供其理解和使用。

信息

分类

商业系统