Add the SurrealDB MCP server to VS Code

Config last verified Jun 1, 2026

The exact config to run SurrealDB in VS Code — paste it in, restart, and the tools load.

Prerequisites

VS Code installed.
SURREALDB_URL — Connection URL for the SurrealDB instance (ws://, http://, memory, file, rocksdb, or a SurrealDB Cloud endpoint).

Setup

1. Open `.vscode/mcp.json`

2. Add this configuration

Add to .vscode/mcp.json

.vscode/mcp.json

json

{
  "servers": {
    "surrealdb": {
      "type": "stdio",
      "command": "docker",
      "args": [
        "run",
        "--rm",
        "-i",
        "surrealdb/surrealmcp:latest",
        "start"
      ],
      "env": {
        "SURREALDB_URL": "<SURREALDB_URL>",
        "SURREALDB_NS": "<SURREALDB_NS>",
        "SURREALDB_DB": "<SURREALDB_DB>",
        "SURREALDB_USER": "<SURREALDB_USER>",
        "SURREALDB_PASS": "<SURREALDB_PASS>"
      }
    }
  }
}

Heads up

VS Code uses the `servers` key (not `mcpServers`) and requires `type`.

3. Restart VS Code and confirm the SurrealDB tools load.

Gotchas

VS Code uses the `servers` key (not `mcpServers`) and requires `type`.

VS Code is the exception to every other client: its top-level key is "servers", not "mcpServers", and each entry needs an explicit "type" (for example "http" or "stdio"). Secrets are not inlined; instead you declare an "inputs" array and reference each value as ${input:id}, so VS Code prompts for it once and never writes it to disk. Remote servers connect natively with OAuth.

← Back to the SurrealDB MCP server