项目简介

DreamFactory MCP 是一个基于 Model Context Protocol (MCP) 标准构建的服务器实现。它旨在将 DreamFactory 后端即服务 (BaaS) 平台的强大数据集成和API管理能力，以结构化的方式暴露给大型语言模型 (LLM) 客户端，例如 Anthropic 的 Claude Desktop。通过提供对数据库表、存储过程和函数的工具化访问，LLM 能够理解和操作企业数据，从而实现更智能、更自动化的数据交互和工作流程。

主要功能点

数据库数据访问： 能够获取数据库中所有表的列表、查询特定表的结构（Schema）和数据。
存储过程调用： 支持列出并调用数据库中定义的存储过程，执行复杂业务逻辑。
存储函数调用： 支持列出并调用数据库中定义的存储函数。
LLM集成： 通过标准MCP协议与支持该协议的LLM客户端（如Claude Desktop）无缝集成，允许LLM直接调用这些功能。
上下文提供： 为LLM提供结构化的上下文信息，使其能够更准确地理解数据和业务操作。

安装步骤

本服务器支持两种主要的安装方式：

桌面扩展安装（适用于Claude Desktop）

下载扩展： 访问项目的 Releases 页面，下载最新的桌面扩展文件（'.DXT' 格式）。
安装Claude Desktop： 确保您已经安装了 Claude Desktop。
双击安装： 双击下载的 '.DXT' 文件，按照提示完成安装。
配置API密钥： 安装过程中会提示您输入 DreamFactory API Key 和 Service URL。如果没有，可以先取消，稍后在Claude Desktop设置的“Extensions”选项卡中点击“Configure”进行配置。
启用扩展： 在Claude Desktop设置的“Extensions”选项卡中，将 DreamFactory MCP 扩展的状态从“Disabled”切换到“Enabled”。

手动安装

克隆仓库： 打开终端或命令行工具，执行以下命令：

git clone https://github.com/dreamfactorysoftware/df-mcp.git
cd df-mcp

安装依赖： 在项目根目录执行：
```
npm install
```
构建项目： 接着执行构建命令：
```
npm run build
```

服务器配置

MCP服务器通过JSON-RPC协议与客户端通信。对于Claude Desktop这样的MCP客户端，您需要在其配置文件中添加以下JSON结构，以启动并连接到此MCP服务器。

配置示例（请添加到您的Claude Desktop配置文件中，例如 'claude_desktop_config.json'）：

{
  "mcpServers": {
    "dreamfactory-mcp": {
      "command": "node",
      "args": [
        "/Users/your_username/path/to/df-mcp/build/index.js"
      ],
      "env": {
        "DREAMFACTORY_URL": "https://your-dreamfactory-instance.com/api/v2/<service-name>",
        "DREAMFACTORY_API_KEY": "your-dreamfactory-api-key"
      }
    }
  }
}

配置说明：

'mcpServers'：这是Claude Desktop配置文件中用于定义MCP服务器的部分。
'dreamfactory-mcp'：这是您为这个特定的MCP服务器实例定义的名称，可以根据需要更改。
'command'：指定用于启动MCP服务器进程的命令，例如 'node'。
'args'：一个字符串数组，包含传递给 'command' 的参数。这里应指定DreamFactory MCP服务器构建后 'index.js' 文件的完整路径。请务必将 '/Users/your_username/path/to/df-mcp/build/index.js' 替换为您本地文件系统的实际路径。
'env'：一个包含环境变量的JSON对象，这些变量将在MCP服务器启动时加载。
- 'DREAMFACTORY_URL'：您的DreamFactory实例的API端点URL。请务必替换为您的实际服务URL，通常包含服务名称，例如 'https://your-dreamfactory-instance.com/api/v2/your_db_service'。
- 'DREAMFACTORY_API_KEY'：您的DreamFactory API密钥，用于身份验证。请替换为您的实际密钥。

配置后操作： 修改并保存 'claude_desktop_config.json' 文件后，请务必重启 Claude Desktop，以便它能加载新的配置并启动DreamFactory MCP服务器。

基本使用方法

一旦DreamFactory MCP服务器配置并成功启动，您就可以在 Claude Desktop 中通过自然语言与DreamFactory服务进行交互。例如，您可以向Claude提出以下请求：

获取数据信息： “列出数据库中的所有表。”
查询数据结构： “获取'Customers'表的详细结构。”
检索表数据： “从'Products'表中检索前10条数据。”
调用数据库函数： “调用名为'CalculateTotalRevenue'的存储函数。”

Claude会利用DreamFactory MCP服务器提供的工具来理解并执行您的请求，并将结果通过其界面返回给您。

关键词