DreamFactory MCP

DreamFactory MCP

用于将 DreamFactory 集成到 Claude 的模型上下文协议（MCP）服务。

概述

DreamFactory 是一个安全、可自托管的企业数据访问平台，可为任何数据源提供受治理的 API 访问，通过基于角色的访问控制和身份透传连接企业应用与本地部署的大模型。

桌面扩展安装（仅限 Claude Desktop）

开始使用 DreamFactory 的 MCP 服务，最简单的方法是前往此仓库的发布页，下载最新的桌面扩展文件。桌面扩展是 Anthropic（Claude.ai 背后的公司）创建的一种新文件格式。下载后，双击 DXT 文件即可开始安装。请注意，安装前需要先安装 Claude Desktop。开始安装后，你会看到以下提示：

点击 Install 按钮，你会看到：

点击 Install，如果一切顺利，系统会提示你输入 DreamFactory API 密钥和服务 URL：

如果你暂时没有这些信息，点击 Cancel 即可。之后可以在 Settings 中点击 Extensions 选项卡，再点击 Configure 来添加：

无论哪种情况，在使用 DreamFactory MCP 服务之前，都需要手动将 Disabled 开关切换为 Enabled，以启用该服务：

手动安装

1. 克隆此仓库，然后安装依赖项：

   cd df-mcp
   npm install
   

2. 构建项目：

   npm run build
   

配置 Claude Desktop

1. 从 https://claude.ai/download 安装 Claude Desktop。

2. 打开 Claude Desktop 并前往 Settings。

3. 在 Settings 菜单中，前往 “Developer” 部分。

4. 点击 “Edit Config” 以修改 Claude 的配置。

5. 添加以下配置以启用 DreamFactory MCP 服务：

   {
       "mcpServers": {
           "add": {
               "command": "node",
               "args": [
                   "/Users/dreamfactory/Documents/df-mcp/build/index.js"
               ],
               "env": {
                   "DREAMFACTORY_URL": "https://example.dreamfactory.com/api/v2/<service-name>",
                   "DREAMFACTORY_API_KEY": ""
               }
           }
       }
   }
   

6. 重要：如果本地安装路径与 /Users/dreamfactory/Documents/df-mcp/ 不同，请修改 args 数组中的路径，使其与你的本地安装路径一致。

7. 根据需要，将 DreamFactory URL 和 API 密钥添加到 DREAMFACTORY_URL、DREAMFACTORY_API_KEY 环境变量中。

8. 保存配置并重启 Claude Desktop。

关于 Claude Desktop、NodeJS 和 NVM 的说明

DreamFactory MCP 需要 Node 22.10.0 或更高版本。即使你运行的是 Node 22.10 或更高版本，如果使用 NVM（Node Version Manager），也可能遇到影响安装的棘手问题。如果还使用 Laravel Herd 等其他开发工具来修改 Node 路径，这些问题有时会更加复杂。

如果 MCP 服务日志显示 Claude Desktop 使用了错误版本的 Node，你可以创建类似以下内容的 shell 脚本，轻松强制其使用所需版本：

#!/bin/zsh
source ~/.zshrc
exec /Applications/Herd/config/nvm/versions/node/v22.17.1/bin/node

将脚本命名为 node-for-claude.sh 或类似名称，并将其放在 /usr/local/bin 中。然后赋予其可执行权限：

$ chmod +x node-for-claude.sh

最后，更新 claude_desktop_config.json 文件，使其指向此脚本：

{
  "mcpServers": {
        "df-mcp": {
            "command": "/usr/local/bin/node-for-claude.sh",
            "args": [
                "/Users/wjgilmore/Software/df-mcp/build/index.js"
            ],
            "env": {
               "DREAMFACTORY_URL": "<URL>",
                "DREAMFACTORY_API_KEY": "<API_KEY>"
            }
        }
  }
}

使用方法

配置完成后，Claude Desktop 即可使用 DreamFactory MCP 服务。你可以通过 Claude 的界面使用 DreamFactory 的功能。

Claude Desktop 的 Docker MCP 设置

构建 Docker 镜像

docker build -t df-mcp .

配置 Claude Desktop

将此配置添加到 Claude Desktop 配置文件中：

位置：

• macOS： ~/Library/Application Support/Claude/claude_desktop_config.json
• Windows： %APPDATA%\Claude\claude_desktop_config.json
• Linux： ~/.config/Claude/claude_desktop_config.json

配置

{
  "mcpServers": {
    "dreamfactory-mcp": {
      "command": "docker",
      "args": [
        "run",
        "--rm",
        "-i",
        "--env", "DREAMFACTORY_URL=https://your-dreamfactory-instance.com/api/v2/<service-name>",
        "--env", "DREAMFACTORY_API_KEY=your-api-key-here",
        "dreamfactory-mcp:latest"
      ]
    }
  }
}

重启 Claude Desktop

更新配置后，重启 Claude Desktop 以加载 MCP 服务。

测试 Docker 容器

运行随附的测试脚本以验证 Docker 设置：

./test-docker.sh

这将验证容器能否正确构建、能否响应 MCP 命令，以及所有工具是否均已正确注册。

开发

• 源代码位于 src 目录中
• 构建文件位于 build 目录中
• 使用 npm start 直接运行构建后的服务

安全

发现安全问题？请发送邮件至 [email protected]。