# VS Code

Source: https://dbmcp.haymon.ai/clients/vs-code/

Add dbmcp to VS Code with the one-click install buttons or in .vscode/mcp.json

## One-click install

VS Code asks for the backend, host, user, password, and database name when you install. The password prompt hides its input.

<a href="https://vscode.dev/redirect?url=vscode%3Amcp%2Finstall%3F%257B%2522name%2522%253A%2522dbmcp%2522%252C%2522type%2522%253A%2522stdio%2522%252C%2522command%2522%253A%2522npx%2522%252C%2522args%2522%253A%255B%2522-y%2522%252C%2522%2540haymon-ai%252Fdbmcp%2522%255D%252C%2522env%2522%253A%257B%2522DBMCP_DB_BACKEND%2522%253A%2522%2524%257Binput%253Adb-backend%257D%2522%252C%2522DBMCP_DB_HOST%2522%253A%2522%2524%257Binput%253Adb-host%257D%2522%252C%2522DBMCP_DB_USER%2522%253A%2522%2524%257Binput%253Adb-user%257D%2522%252C%2522DBMCP_DB_PASSWORD%2522%253A%2522%2524%257Binput%253Adb-password%257D%2522%252C%2522DBMCP_DB_NAME%2522%253A%2522%2524%257Binput%253Adb-name%257D%2522%257D%252C%2522inputs%2522%253A%255B%257B%2522type%2522%253A%2522pickString%2522%252C%2522id%2522%253A%2522db-backend%2522%252C%2522description%2522%253A%2522Database%2520backend%2522%252C%2522options%2522%253A%255B%2522mysql%2522%252C%2522mariadb%2522%252C%2522postgres%2522%252C%2522sqlite%2522%255D%252C%2522default%2522%253A%2522mysql%2522%257D%252C%257B%2522type%2522%253A%2522promptString%2522%252C%2522id%2522%253A%2522db-host%2522%252C%2522description%2522%253A%2522Database%2520host%2520%2528blank%2520for%2520default%2529%2522%252C%2522default%2522%253A%2522127.0.0.1%2522%257D%252C%257B%2522type%2522%253A%2522promptString%2522%252C%2522id%2522%253A%2522db-user%2522%252C%2522description%2522%253A%2522Database%2520user%2522%257D%252C%257B%2522type%2522%253A%2522promptString%2522%252C%2522id%2522%253A%2522db-password%2522%252C%2522description%2522%253A%2522Database%2520password%2522%252C%2522password%2522%253Atrue%257D%252C%257B%2522type%2522%253A%2522promptString%2522%252C%2522id%2522%253A%2522db-name%2522%252C%2522description%2522%253A%2522Database%2520name%2520%2528SQLite%253A%2520file%2520path%2529%2522%257D%255D%257D" target="_blank" rel="noreferrer noopener"><img src="https://img.shields.io/badge/VS_Code-Install_Server-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white" alt="Install in VS Code" /></a> <a href="https://insiders.vscode.dev/redirect?url=vscode-insiders%3Amcp%2Finstall%3F%257B%2522name%2522%253A%2522dbmcp%2522%252C%2522type%2522%253A%2522stdio%2522%252C%2522command%2522%253A%2522npx%2522%252C%2522args%2522%253A%255B%2522-y%2522%252C%2522%2540haymon-ai%252Fdbmcp%2522%255D%252C%2522env%2522%253A%257B%2522DBMCP_DB_BACKEND%2522%253A%2522%2524%257Binput%253Adb-backend%257D%2522%252C%2522DBMCP_DB_HOST%2522%253A%2522%2524%257Binput%253Adb-host%257D%2522%252C%2522DBMCP_DB_USER%2522%253A%2522%2524%257Binput%253Adb-user%257D%2522%252C%2522DBMCP_DB_PASSWORD%2522%253A%2522%2524%257Binput%253Adb-password%257D%2522%252C%2522DBMCP_DB_NAME%2522%253A%2522%2524%257Binput%253Adb-name%257D%2522%257D%252C%2522inputs%2522%253A%255B%257B%2522type%2522%253A%2522pickString%2522%252C%2522id%2522%253A%2522db-backend%2522%252C%2522description%2522%253A%2522Database%2520backend%2522%252C%2522options%2522%253A%255B%2522mysql%2522%252C%2522mariadb%2522%252C%2522postgres%2522%252C%2522sqlite%2522%255D%252C%2522default%2522%253A%2522mysql%2522%257D%252C%257B%2522type%2522%253A%2522promptString%2522%252C%2522id%2522%253A%2522db-host%2522%252C%2522description%2522%253A%2522Database%2520host%2520%2528blank%2520for%2520default%2529%2522%252C%2522default%2522%253A%2522127.0.0.1%2522%257D%252C%257B%2522type%2522%253A%2522promptString%2522%252C%2522id%2522%253A%2522db-user%2522%252C%2522description%2522%253A%2522Database%2520user%2522%257D%252C%257B%2522type%2522%253A%2522promptString%2522%252C%2522id%2522%253A%2522db-password%2522%252C%2522description%2522%253A%2522Database%2520password%2522%252C%2522password%2522%253Atrue%257D%252C%257B%2522type%2522%253A%2522promptString%2522%252C%2522id%2522%253A%2522db-name%2522%252C%2522description%2522%253A%2522Database%2520name%2520%2528SQLite%253A%2520file%2520path%2529%2522%257D%255D%257D" target="_blank" rel="noreferrer noopener"><img src="https://img.shields.io/badge/VS_Code_Insiders-Install_Server-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white" alt="Install in VS Code Insiders" /></a>

The buttons add the `npx` entry from below, with an input for each `DBMCP_DB_*` value.

## Manual setup

Add the server to `.vscode/mcp.json` in your workspace, or to your user profile with **MCP: Open User Configuration**. VS Code uses `servers`, not `mcpServers`, and prompts for each `${input:...}` value on first start:

```json tab="bin" title=".vscode/mcp.json"
{
  "inputs": [
    {
      "type": "promptString",
      "id": "db-password",
      "description": "Database password",
      "password": true
    }
  ],
  "servers": {
    "dbmcp": {
      "type": "stdio",
      "command": "dbmcp",
      "args": [],
      "env": {
        "DBMCP_DB_BACKEND": "mysql",
        "DBMCP_DB_HOST": "127.0.0.1",
        "DBMCP_DB_USER": "root",
        "DBMCP_DB_PASSWORD": "${input:db-password}",
        "DBMCP_DB_NAME": "mydb"
      }
    }
  }
}
```

```json tab="npx" title=".vscode/mcp.json"
{
  "inputs": [
    {
      "type": "promptString",
      "id": "db-password",
      "description": "Database password",
      "password": true
    }
  ],
  "servers": {
    "dbmcp": {
      "type": "stdio",
      "command": "npx",
      "args": ["-y", "@haymon-ai/dbmcp"],
      "env": {
        "DBMCP_DB_BACKEND": "mysql",
        "DBMCP_DB_HOST": "127.0.0.1",
        "DBMCP_DB_USER": "root",
        "DBMCP_DB_PASSWORD": "${input:db-password}",
        "DBMCP_DB_NAME": "mydb"
      }
    }
  }
}
```

For a server you started with `DBMCP_TRANSPORT=http`:

```json title=".vscode/mcp.json"
{
  "inputs": [
    {
      "type": "promptString",
      "id": "dbmcp-token",
      "description": "dbmcp bearer token",
      "password": true
    }
  ],
  "servers": {
    "dbmcp": {
      "type": "http",
      "url": "http://127.0.0.1:9001/mcp",
      "headers": { "Authorization": "Bearer ${input:dbmcp-token}" }
    }
  }
}
```