火山引擎数据库工作台 DBW MCP

Name: 火山引擎数据库工作台 DBW MCP
Author: 火山引擎

火山引擎OfficialChina

Get started Repository

Generate SQL from natural language and manage databases through Volcengine Database Workbench (DBW).

Setup

Choose your client, copy the config, then fill in any required environment variables.

Add to Cursor Add to VS Code

claude mcp add dbw --env VOLCENGINE_ACCESS_KEY='<VOLCENGINE_ACCESS_KEY>' --env VOLCENGINE_DATABASE='<VOLCENGINE_DATABASE>' --env VOLCENGINE_INSTANCE_ID='<VOLCENGINE_INSTANCE_ID>' --env VOLCENGINE_INSTANCE_TYPE='<VOLCENGINE_INSTANCE_TYPE>' --env VOLCENGINE_REGION='<VOLCENGINE_REGION>' --env VOLCENGINE_SECRET_KEY='<VOLCENGINE_SECRET_KEY>' -- uvx --from 'git+https://github.com/volcengine/mcp-server.git#subdirectory=server/mcp_server_dbw' mcp-server-dbw

~/.codex/config.toml

[mcp_servers.dbw]
command = "uvx"
args = ["--from", "git+https://github.com/volcengine/mcp-server.git#subdirectory=server/mcp_server_dbw", "mcp-server-dbw"]
env = { VOLCENGINE_ACCESS_KEY = "<VOLCENGINE_ACCESS_KEY>", VOLCENGINE_DATABASE = "<VOLCENGINE_DATABASE>", VOLCENGINE_INSTANCE_ID = "<VOLCENGINE_INSTANCE_ID>", VOLCENGINE_INSTANCE_TYPE = "<VOLCENGINE_INSTANCE_TYPE>", VOLCENGINE_REGION = "<VOLCENGINE_REGION>", VOLCENGINE_SECRET_KEY = "<VOLCENGINE_SECRET_KEY>" }

# codex mcp add dbw --env VOLCENGINE_ACCESS_KEY='<VOLCENGINE_ACCESS_KEY>' --env VOLCENGINE_DATABASE='<VOLCENGINE_DATABASE>' --env VOLCENGINE_INSTANCE_ID='<VOLCENGINE_INSTANCE_ID>' --env VOLCENGINE_INSTANCE_TYPE='<VOLCENGINE_INSTANCE_TYPE>' --env VOLCENGINE_REGION='<VOLCENGINE_REGION>' --env VOLCENGINE_SECRET_KEY='<VOLCENGINE_SECRET_KEY>' -- uvx --from 'git+https://github.com/volcengine/mcp-server.git#subdirectory=server/mcp_server_dbw' mcp-server-dbw

~/.cursor/mcp.json

{
  "mcpServers": {
    "dbw": {
      "command": "uvx",
      "args": [
        "--from",
        "git+https://github.com/volcengine/mcp-server.git#subdirectory=server/mcp_server_dbw",
        "mcp-server-dbw"
      ],
      "env": {
        "VOLCENGINE_ACCESS_KEY": "<VOLCENGINE_ACCESS_KEY>",
        "VOLCENGINE_DATABASE": "<VOLCENGINE_DATABASE>",
        "VOLCENGINE_INSTANCE_ID": "<VOLCENGINE_INSTANCE_ID>",
        "VOLCENGINE_INSTANCE_TYPE": "<VOLCENGINE_INSTANCE_TYPE>",
        "VOLCENGINE_REGION": "<VOLCENGINE_REGION>",
        "VOLCENGINE_SECRET_KEY": "<VOLCENGINE_SECRET_KEY>"
      }
    }
  }
}

.vscode/mcp.json

{
  "servers": {
    "dbw": {
      "type": "stdio",
      "command": "uvx",
      "args": [
        "--from",
        "git+https://github.com/volcengine/mcp-server.git#subdirectory=server/mcp_server_dbw",
        "mcp-server-dbw"
      ],
      "env": {
        "VOLCENGINE_ACCESS_KEY": "<VOLCENGINE_ACCESS_KEY>",
        "VOLCENGINE_DATABASE": "<VOLCENGINE_DATABASE>",
        "VOLCENGINE_INSTANCE_ID": "<VOLCENGINE_INSTANCE_ID>",
        "VOLCENGINE_INSTANCE_TYPE": "<VOLCENGINE_INSTANCE_TYPE>",
        "VOLCENGINE_REGION": "<VOLCENGINE_REGION>",
        "VOLCENGINE_SECRET_KEY": "<VOLCENGINE_SECRET_KEY>"
      }
    }
  }
}

~/.gemini/settings.json

{
  "mcpServers": {
    "dbw": {
      "command": "uvx",
      "args": [
        "--from",
        "git+https://github.com/volcengine/mcp-server.git#subdirectory=server/mcp_server_dbw",
        "mcp-server-dbw"
      ],
      "env": {
        "VOLCENGINE_ACCESS_KEY": "<VOLCENGINE_ACCESS_KEY>",
        "VOLCENGINE_DATABASE": "<VOLCENGINE_DATABASE>",
        "VOLCENGINE_INSTANCE_ID": "<VOLCENGINE_INSTANCE_ID>",
        "VOLCENGINE_INSTANCE_TYPE": "<VOLCENGINE_INSTANCE_TYPE>",
        "VOLCENGINE_REGION": "<VOLCENGINE_REGION>",
        "VOLCENGINE_SECRET_KEY": "<VOLCENGINE_SECRET_KEY>"
      }
    }
  }
}

claude_desktop_config.json

{
  "mcpServers": {
    "dbw": {
      "command": "uvx",
      "args": [
        "--from",
        "git+https://github.com/volcengine/mcp-server.git#subdirectory=server/mcp_server_dbw",
        "mcp-server-dbw"
      ],
      "env": {
        "VOLCENGINE_ACCESS_KEY": "<VOLCENGINE_ACCESS_KEY>",
        "VOLCENGINE_DATABASE": "<VOLCENGINE_DATABASE>",
        "VOLCENGINE_INSTANCE_ID": "<VOLCENGINE_INSTANCE_ID>",
        "VOLCENGINE_INSTANCE_TYPE": "<VOLCENGINE_INSTANCE_TYPE>",
        "VOLCENGINE_REGION": "<VOLCENGINE_REGION>",
        "VOLCENGINE_SECRET_KEY": "<VOLCENGINE_SECRET_KEY>"
      }
    }
  }
}

.trae/mcp.json

{
  "mcpServers": {
    "dbw": {
      "command": "uvx",
      "args": [
        "--from",
        "git+https://github.com/volcengine/mcp-server.git#subdirectory=server/mcp_server_dbw",
        "mcp-server-dbw"
      ],
      "env": {
        "VOLCENGINE_ACCESS_KEY": "<VOLCENGINE_ACCESS_KEY>",
        "VOLCENGINE_DATABASE": "<VOLCENGINE_DATABASE>",
        "VOLCENGINE_INSTANCE_ID": "<VOLCENGINE_INSTANCE_ID>",
        "VOLCENGINE_INSTANCE_TYPE": "<VOLCENGINE_INSTANCE_TYPE>",
        "VOLCENGINE_REGION": "<VOLCENGINE_REGION>",
        "VOLCENGINE_SECRET_KEY": "<VOLCENGINE_SECRET_KEY>"
      }
    }
  }
}

Environment variables

VOLCENGINE_ACCESS_KEY
VOLCENGINE_DATABASE
VOLCENGINE_INSTANCE_ID
VOLCENGINE_INSTANCE_TYPE
VOLCENGINE_REGION
VOLCENGINE_SECRET_KEY

Replace the placeholders with your own credentials and keep them out of version control.

Setup

Environment variables

Related