项目简介
Directus MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器,它作为 Directus CMS 和 AI 工具之间的桥梁。通过此服务器,AI 工具可以安全、便捷地访问和利用 Directus CMS 中存储的内容和功能,实现更智能的应用场景。
主要功能点
- 数据访问能力: 允许 AI 工具读取 Directus CMS 中存储的数据集合(Collections),例如文章、产品信息等。服务器会为每个数据集合自动生成对应的 "读取集合项" 工具。
- 用户信息获取: 提供 "读取当前用户" 工具,允许 AI 工具获取当前 Directus 用户的信息,例如用户角色、权限等。
- 集合信息查询: 提供 "读取集合列表" 工具,返回 Directus 实例的 Schema 信息,包括所有可用的数据集合及其字段,方便 AI 工具理解数据结构。
- 标准化 MCP 协议: 完全遵循 Model Context Protocol 协议,使用 JSON-RPC 进行通信,确保与各类 MCP 客户端的兼容性和互操作性。
- 灵活的查询参数: "读取集合项" 工具支持 'fields', 'sort', 'limit' 等常用查询参数,方便 AI 工具根据需求精确获取数据。
安装步骤
-
全局安装 (推荐): 打开终端,运行以下 npm 命令进行全局安装:
npm install -g @rijk/directus-mcp-server -
配置 MCP 客户端: 在您的 MCP 客户端(例如 Claude AI)中配置 Directus MCP Server 连接信息。以下是一个配置示例,您需要根据您的实际情况修改 'DIRECTUS_URL' 和 'DIRECTUS_TOKEN'。
{ "mcpServers": { "directus": { "command": "directus-mcp-server", "env": { "DIRECTUS_URL": "<your Directus instance URL>", // [必填] 您的 Directus 实例 URL,例如:https://your-directus-instance.com "DIRECTUS_TOKEN": "<your Directus user token>" // [必填] 用于访问 Directus API 的用户 Token,请在 Directus 后台创建并获取 } } } }- 'command': 指定启动 MCP 服务器的命令,全局安装后可以直接使用 'directus-mcp-server'。
- 'env': 设置环境变量。
- 'DIRECTUS_URL': [必填] 您的 Directus CMS 实例的完整 URL 地址。
- 'DIRECTUS_TOKEN': [必填] 一个有效的 Directus 用户 Token,用于服务器鉴权访问 Directus API。请确保该用户具有访问您希望通过 MCP 服务器暴露的数据集合的权限。
基本使用方法
-
启动 MCP 服务器: 当 MCP 客户端尝试连接到名为 "directus" 的服务器时,配置的 'directus-mcp-server' 命令将自动在后台启动 MCP 服务器。
-
在 AI 工具中使用工具: 配置完成后,您可以在支持 MCP 协议的 AI 工具中调用 Directus MCP Server 提供的工具。主要的工具包括:
- 'read-<collection-name>': 用于读取指定 '<collection-name>' 数据集合中的条目。例如,读取 "articles" 集合的工具名为 'read-articles'。您可以根据集合的字段设置 'fields', 'sort', 'limit' 等参数来查询数据。
- 'read-current-user': 用于获取当前 Directus 用户的详细信息。
- 'read-collections': 用于获取 Directus 实例中所有数据集合的 schema 信息。
具体工具的使用方法和参数请参考您使用的 AI 工具的文档。
信息
分类
数据库与文件