DX MCP Server

DX MCP Server

使用自然语言在 DX Data Cloud 中编写并执行组织数据查询！

关于

DX MCP Server 是一个基于 Python 的工具，可让 Claude for Desktop 和 Cursor 等 AI 应用与 DX Data Cloud 数据库交互。该服务包含以下工具：

• 与 Postgres 数据库建立连接，让 AI 能够主动编写并执行数据库查询
• 通过 DX 目录工具，查找和利用有关软件实体及其关系和记分卡的上下文

详细了解 Model Context Protocol (MCP)。

注意：DX 计划将命令行工具作为 AI Agent 的主要接口，并将其作为 MCP 服务长期发展的方向进行投资。我们仍会继续支持这两种接口。

演示

https://github.com/user-attachments/assets/c6ce12a5-4562-4b44-b235-2d04871c3142

开始使用

使用 DX MCP Server 有两种方式：

1. 远程托管（推荐）：连接到我们的托管服务 https://ai.getdx.com/mcp
2. 本地托管：在你的计算机上运行服务

前提条件

• 拥有可访问 Data Cloud 的 DX 账号

• 远程托管：

  • DX API 令牌，可在 DX 账号设置中生成
    • 管理员用户可以创建具有读取权限范围的组织 API 令牌；非管理员用户可以生成个人访问令牌，以通过身份验证连接到 MCP 服务。

• 本地托管：

  • Python 3.10 或更高版本
  • 数据库连接 URL（在 DX 的数据库用户设置页面中配置）
  • DX API 令牌，可在 DX 账号设置中生成
    • 管理员用户可以创建具有读取权限范围的组织 API 令牌；非管理员用户可以生成个人访问令牌，以通过身份验证连接到 MCP 服务。

---

选项 1：远程托管（推荐）

托管的 MCP 服务使用可流式 HTTP 传输，可通过 https://ai.getdx.com/mcp 访问。此选项无需本地安装；只需将 AI 客户端配置为使用 HTTP 传输的 MCP，并提供有效的 DX API 令牌即可。

Claude Code

在终端中运行此命令：

claude mcp add --transport http dx-mcp https://ai.getdx.com/mcp --header "Authorization: Bearer [YOUR_DX_API_TOKEN]"

Cursor

将此配置添加到 MCP 设置中（Cursor > Settings > Cursor Settings > MCP）：

{
  "mcpServers": {
    "dx-mcp": {
      "url": "https://ai.getdx.com/mcp",
      "headers": {
        "Authorization": "Bearer [YOUR_DX_API_TOKEN]"
      }
    }
  }
}

---

选项 2：本地安装

如果你希望在本地运行 DX MCP Server，可以通过 PyPI 安装，也可以从源代码运行。

安装方法 1：从 PyPI 安装

使用 pip 安装软件包：

pip install dx-mcp-server

macOS 用户注意：如果遇到“externally-managed-environment”错误，请改用 pipx：

pipx install dx-mcp-server

安装方法 2：从源代码克隆

克隆此仓库以从源代码运行：

git clone https://github.com/get-dx/dx-mcp-server
cd dx-mcp-server

配置

安装后，使用相应设置配置 AI 客户端：

Claude Code

在终端中运行此命令（根据你的安装方式进行调整）：

# If installed via pip/pipx
claude mcp add dx-mcp-server --env DB_URL=YOUR_DB_URL --env WEB_API_TOKEN=YOUR_DX_API_TOKEN -- $(which dx-mcp-server)

Claude for Desktop

点击 Claude > Settings > Developer > Edit Config，然后添加：

如果通过 pip 安装：

{
  "mcpServers": {
    "dx-mcp": {
      "command": "dx-mcp-server", 
      "args": ["run"],
      "env": {
        "DB_URL": "YOUR-DATABASE-URL",
        "WEB_API_TOKEN": "YOUR_DX_API_TOKEN"
      }
    }
  }
}

如果从源代码运行：

{
  "mcpServers": {
    "dx-mcp": {
      "command": "uv",
      "args": ["--directory", "/path/to/dx-mcp-server", "run", "-m", "dx_mcp_server", "run"],
      "env": {
        "DB_URL": "YOUR-DATABASE-URL",
        "WEB_API_TOKEN": "YOUR-DX-API-TOKEN"
      }
    }
  }
}

Cursor

点击 Cursor > Settings > Cursor Settings > MCP > Add new global MCP Server，然后添加：

如果通过 pip 安装：

{
  "mcpServers": {
    "dx-mcp": {
      "command": "dx-mcp-server", 
      "args": ["run"],
      "env": {
        "DB_URL": "YOUR-DATABASE-URL",
        "WEB_API_TOKEN": "YOUR-DX-API-TOKEN"
      }
    }
  }
}

如果从源代码运行：

{
  "mcpServers": {
    "dx-mcp": {
      "command": "uv",
      "args": ["--directory", "/path/to/dx-mcp-server", "run", "-m", "dx_mcp_server", "run"],
      "env": {
        "DB_URL": "YOUR-DATABASE-URL",
        "WEB_API_TOKEN": "YOUR-DX-API-TOKEN"
      }
    }
  }
}

配置参数

• DB_URL（必需）：DX Data Cloud Postgres 连接字符串。请从 DX DB Users 设置获取。
  • 格式：postgresql://username:password@host:port/database
• WEB_API_TOKEN：DX API Token（组织令牌或个人访问令牌）。此令牌可启用其他目录和实体工具。请在 DX 账户设置中查找。

使用方法

保存配置后，重启 AI 客户端。你应该会在可用的 MCP 服务中看到“dx-mcp”。当你询问有关数据或目录的问题时，AI 会使用这些工具查询数据库或调用相关 Web API。

---

故障排除

路径解析问题

最常见的问题是 MCP 客户端找不到 dx-mcp-server/uv 命令，因为 GUI 应用不会继承与终端相同的 PATH 环境变量。解决方法是在 json 配置中使用可执行文件的完整路径。

对于 pip/pipx 安装：

查找 dx-mcp-server 的完整路径：

# Find the path on macOS/Linux
which dx-mcp-server

# Find the path on Windows (in Command Prompt)
where dx-mcp-server

然后在配置中使用完整路径：

{
  "mcpServers": {
    "dx-mcp": {
      "command": "/full/path/to/dx-mcp-server",
      "args": ["run"],
      "env": {
        "DB_URL": "YOUR-DATABASE-URL",
        "WEB_API_TOKEN": "YOUR-DX-API-TOKEN"
      }
    }
  }
}

对于源码安装：

查找 uv 的完整路径：

# Find the path on macOS/Linux
which uv

# Find the path on Windows (in Command Prompt)
where uv

然后在配置中使用完整路径：

{
  "mcpServers": {
    "dx-mcp": {
      "command": "/full/path/to/uv",
      "args": ["--directory", "/absolute/path/to/dx-mcp-server", "run", "-m", "dx_mcp_server", "run"],
      "env": {
        "DB_URL": "YOUR-DATABASE-URL",
        "WEB_API_TOKEN": "YOUR-DX-API-TOKEN"
      }
    }
  }
}

查看日志

如果问题仍未解决：

• Claude Desktop：查看以下位置的日志：

  • macOS：~/Library/Logs/Claude/
  • Windows：%APPDATA%\Claude\logs\

• Cursor：查看以下位置的日志：

  • macOS：~/Library/Application Support/Cursor/logs/[SESSION_ID]
  • Windows：%APPDATA%\Cursor\logs\[SESSION_ID]

日志会显示启动或运行 MCP 服务时的警告和错误消息。