configuring-dbt-mcp-server
npx skills add https://github.com/dbt-labs/dbt-agent-skills --skill configuring-dbt-mcp-server
Agent 安装分布
Skill 文档
Configure dbt MCP Server
Overview
The dbt MCP server connects AI tools to dbt’s CLI, Semantic Layer, Discovery API, and Admin API. This skill guides users through setup with the correct configuration for their use case.
Decision Flow
flowchart TB
start([User wants dbt MCP]) --> q1{Local or Remote?}
q1 -->|dev workflows,<br>CLI access needed| local[Local Server<br>uvx dbt-mcp]
q1 -->|consumption only,<br>no local install| remote[Remote Server<br>HTTP endpoint]
local --> q2{Which client?}
remote --> q2
q2 --> claude_desktop[Claude Desktop]
q2 --> claude_code[Claude Code]
q2 --> cursor[Cursor]
q2 --> vscode[VS Code]
claude_desktop --> config[Generate config<br>+ test setup]
claude_code --> config
cursor --> config
vscode --> config
Questions to Ask
1. Server Type
Ask: “Do you want to use the local or remote dbt MCP server?”
| Local Server | Remote Server |
|---|---|
Runs on your machine via uvx |
Connects via HTTP to dbt platform |
| Required for development (authoring models, tests, docs) but can also connect to the dbt platform for consumption (querying metrics, exploring metadata) | Best for consumption (querying metrics, exploring metadata) |
| Supports dbt CLI commands (run, build, test, show) | No CLI commands (run, build, test) |
| Works without a dbt platform account but can also connect to the dbt platform for development (authoring models, tests, docs) | Requires dbt platform account |
| No credit consumption | Consumes dbt Copilot credits |
2. MCP Client
Ask: “Which MCP client are you using?”
- Claude Desktop
- Claude Code (CLI)
- Cursor
- VS Code
3. Use Case (Local Server Only)
Ask: “What’s your use case?”
| CLI Only | Platform Only | Platform + CLI |
|---|---|---|
| dbt Core/Fusion users | dbt Cloud without local project | Full access to both |
| No platform account needed | OAuth or token auth | Requires paths + credentials |
4. Tools to Enable
Ask: “Which tools do you want enabled?” (show defaults)
| Tool Category | Default | Environment Variable |
|---|---|---|
| dbt CLI (run, build, test, compile) | Enabled | DISABLE_DBT_CLI=true to disable |
| Semantic Layer (metrics, dimensions) | Enabled | DISABLE_SEMANTIC_LAYER=true to disable |
| Discovery API (models, lineage) | Enabled | DISABLE_DISCOVERY=true to disable |
| Admin API (jobs, runs) | Enabled | DISABLE_ADMIN_API=true to disable |
| SQL (text_to_sql, execute_sql) | Disabled | DISABLE_SQL=false to enable |
| Codegen (generate models/sources) | Disabled | DISABLE_DBT_CODEGEN=false to enable |
Prerequisites
Local Server
- Install
uv: https://docs.astral.sh/uv/getting-started/installation/ - Have a dbt project (for CLI commands)
- Find paths:
DBT_PROJECT_DIR: Folder containingdbt_project.yml- macOS/Linux:
pwdfrom project folder - Windows: Full path with forward slashes (e.g.,
C:/Users/name/project)
- macOS/Linux:
DBT_PATH: Path to dbt executable- macOS/Linux:
which dbt - Windows:
where dbt
- macOS/Linux:
Remote Server
- dbt Cloud account with AI features enabled
- Production environment ID (from Orchestration page)
- Personal access token or service token
How to Find Your Credentials
Which Token Type Should I Use?
| Use Case | Token Type | Why |
|---|---|---|
| Personal development setup | Personal Access Token (PAT) | Inherits your permissions, works with all APIs including execute_sql |
| Shared team setup | Service Token | Multiple users, controlled permissions, separate from individual accounts |
| Using execute_sql tool | PAT (required) | SQL tools that require x-dbt-user-id need a PAT |
| CI/CD or automation | Service Token | System-level access, not tied to a person |
Personal Access Token (PAT)
- Go to Account Settings â expand API tokens â click Personal tokens
- Click Create personal access token
- Enter a descriptive name and click Save
- Copy the token immediately â it won’t be shown again
Notes:
- Requires a Developer license
- Inherits all permissions from your user account
- Account-scoped: create separate tokens for each dbt account you access
- Rotate regularly for security
Service Token
Use service tokens for system-level integrations (CI/CD, automation) rather than user-specific access.
- Go to Account Settings â Service Tokens (in left sidebar)
- Click + New Token
- Select the appropriate permission set for your use case
- Save the token immediately â it won’t be shown again
Permission sets for MCP:
- Semantic Layer Only: For querying metrics only
- Metadata Only: For Discovery API access
- Job Admin: For Admin API (triggering jobs)
- Developer: For broader access
Notes:
- Requires Developer license + account admin permissions to create
- Service tokens belong to the account, not a user
- Cannot use service tokens for
execute_sqlâ use PAT instead
Account ID
- Sign in to dbt Cloud
- Look at the URL in your browser â the Account ID is the number after
/accounts/
Example: In https://cloud.getdbt.com/settings/accounts/12345/..., the Account ID is 12345
Alternative: Go to Settings â Account Settings and check the URL.
Environment ID (Production or Development)
- In dbt Cloud, go to Deploy â Environments
- Click on the environment (Production or Development)
- Look at the URL â the Environment ID is the last number
URL pattern: https://cloud.getdbt.com/deploy/<account_id>/projects/<project_id>/environments/<environment_id>
Example: In .../environments/98765, the Environment ID is 98765
User ID
- Go to Account Settings â Team â Users
- Click on your user profile
- Look at the URL â the number after
/users/is your User ID
Example: In https://cloud.getdbt.com/settings/accounts/12345/users/67891, the User ID is 67891
Configuration Templates
Local Server – CLI Only
{
"mcpServers": {
"dbt": {
"command": "uvx",
"args": ["dbt-mcp"],
"env": {
"DBT_PROJECT_DIR": "/path/to/your/dbt/project",
"DBT_PATH": "/path/to/dbt"
}
}
}
}
Local Server – Platform + CLI (OAuth)
{
"mcpServers": {
"dbt": {
"command": "uvx",
"args": ["dbt-mcp"],
"env": {
"DBT_HOST": "https://your-subdomain.us1.dbt.com",
"DBT_PROJECT_DIR": "/path/to/project",
"DBT_PATH": "/path/to/dbt"
}
}
}
}
Local Server – Platform + CLI (Token Auth)
{
"mcpServers": {
"dbt": {
"command": "uvx",
"args": ["dbt-mcp"],
"env": {
"DBT_HOST": "cloud.getdbt.com",
"DBT_TOKEN": "your-token",
"DBT_ACCOUNT_ID": "your-account-id",
"DBT_PROD_ENV_ID": "your-prod-env-id",
"DBT_PROJECT_DIR": "/path/to/project",
"DBT_PATH": "/path/to/dbt"
}
}
}
}
Local Server – Using .env File
{
"mcpServers": {
"dbt": {
"command": "uvx",
"args": ["--env-file", "/path/to/.env", "dbt-mcp"]
}
}
}
.env file contents:
DBT_HOST=cloud.getdbt.com
DBT_TOKEN=your-token
DBT_ACCOUNT_ID=your-account-id
DBT_PROD_ENV_ID=your-prod-env-id
DBT_DEV_ENV_ID=your-dev-env-id
DBT_USER_ID=your-user-id
DBT_PROJECT_DIR=/path/to/project
DBT_PATH=/path/to/dbt
Remote Server
{
"mcpServers": {
"dbt": {
"url": "https://cloud.getdbt.com/api/ai/v1/mcp/",
"headers": {
"Authorization": "Token your-token",
"x-dbt-prod-environment-id": "your-prod-env-id"
}
}
}
}
Additional headers for SQL/Fusion tools:
{
"headers": {
"Authorization": "Token your-token",
"x-dbt-prod-environment-id": "your-prod-env-id",
"x-dbt-dev-environment-id": "your-dev-env-id",
"x-dbt-user-id": "your-user-id"
}
}
Client-Specific Setup
Claude Desktop
- Click Claude menu in system menu bar (not in-app)
- Select Settings…
- Go to Developer tab
- Click Edit Config
- Add the JSON configuration
- Save and restart Claude Desktop
- Verify: Look for MCP server indicator in bottom-right of input box
Config location:
- macOS:
~/Library/Application Support/Claude/claude_desktop_config.json - Windows:
%APPDATA%\Claude\claude_desktop_config.json
Claude Code (CLI)
Run:
claude mcp add dbt -s user -- uvx dbt-mcp
This adds the server to your user scope/config (on this system: ~/.claude.json).
For a project-specific setup, run:
claude mcp add dbt -s project -- uvx dbt-mcp
This adds the server to .mcp.json in your project root.
Alternatively, you can use the manual configuration below.
Manual configuration:
Edit ~/.claude.json (user scope) or create .mcp.json (project scope) in your project root:
~/.claude.json: Global across all projects.mcp.json: Project-specific, committed to version control for team sharing
For project-specific dbt setups, use .mcp.json so your team shares the same configuration.
Once the config is created, make sure to add the JSON configuration under the mcpServers key.
Cursor
- Open Cursor menu â Settings â Cursor Settings â MCP
- Add the JSON configuration
- Update paths and credentials
- Save
VS Code
- Open Command Palette (Cmd/Ctrl + Shift + P)
- Run “MCP: Open User Configuration” (or Workspace for project-specific)
- Add the JSON configuration (note: VS Code uses
serversnotmcpServers):
{
"servers": {
"dbt": {
"command": "uvx",
"args": ["dbt-mcp"],
"env": {
"DBT_PROJECT_DIR": "/path/to/project",
"DBT_PATH": "/path/to/dbt"
}
}
}
}
- Open Settings â Features â Chat â Enable MCP
- Verify: Run “MCP: List Servers” from Command Palette
WSL Users: Configure in Remote settings, not local user settings:
- Run “Preferences: Open Remote Settings” from Command Palette
- Use full Linux paths (e.g.,
/home/user/project, not Windows paths)
Verification Steps
Test Local Server Config
Recommended: Use .env file
- Create a .env file in your project root directory and add minimum environment variables for the CLI tools:
DBT_PROJECT_DIR=/path/to/project
DBT_PATH=/path/to/dbt
- Test the server:
uvx --env-file .env dbt-mcp
Alternative: Environment variables
# Temporary test (variables only last for this session)
export DBT_PROJECT_DIR=/path/to/project
export DBT_PATH=/path/to/dbt
uvx dbt-mcp
No errors = successful configuration.
Verify in Client
After setup, ask the AI:
- “What dbt tools do you have access to?”
- “List my dbt metrics” (if Semantic Layer enabled)
- “Show my dbt models” (if Discovery enabled)
Troubleshooting
“uvx not found” or “spawn uvx ENOENT”
Find full path and use it in config:
# macOS/Linux
which uvx
# Use output like: /opt/homebrew/bin/uvx
# Windows
where uvx
Update config:
{
"command": "/opt/homebrew/bin/uvx",
"args": ["dbt-mcp"]
}
“Could not connect to MCP server”
- Check
uvxis installed:uvx --version - Verify paths exist:
ls $DBT_PROJECT_DIR/dbt_project.yml - Check dbt works:
$DBT_PATH --version
OAuth Not Working
Only accounts with static subdomains (e.g., abc123.us1.dbt.com) support OAuth. Check your Access URLs in dbt platform settings.
Remote Server Returns 401/403
- Verify token has Semantic Layer and Developer permissions
- For
execute_sql: Use personal access token, not service token - Check environment ID is correct (from Orchestration page)
Common Mistakes
| Mistake | Fix |
|---|---|
| Using npm/npx instead of uvx | The package is dbt-mcp via uvx, not npm |
| Wrong env var names (DBT_CLOUD_*) | Use DBT_TOKEN, DBT_PROD_ENV_ID, etc. |
Using mcpServers in VS Code |
VS Code uses servers key in mcp.json |
| Service token for execute_sql | Use personal access token for SQL tools |
| Windows paths in WSL | Use Linux paths (/home/...) not Windows |
| Local user settings in WSL | Must use Remote settings in VS Code |
Missing uv installation |
Install uv first: https://docs.astral.sh/uv/ |
Environment Variable Reference
| Variable | Required For | Description |
|---|---|---|
DBT_PROJECT_DIR |
CLI commands | Path to folder with dbt_project.yml |
DBT_PATH |
CLI commands | Path to dbt executable |
DBT_HOST |
Platform access | Default: cloud.getdbt.com |
DBT_TOKEN |
Platform (non-OAuth) | Personal or service token |
DBT_ACCOUNT_ID |
Admin API | Your dbt account ID |
DBT_PROD_ENV_ID |
Platform access | Production environment ID |
DBT_DEV_ENV_ID |
SQL/Fusion tools | Development environment ID |
DBT_USER_ID |
SQL/Fusion tools | Your dbt user ID |
MULTICELL_ACCOUNT_PREFIX |
Multi-cell accounts | Account prefix (exclude from DBT_HOST) |
DBT_CLI_TIMEOUT |
CLI commands | Timeout in seconds (default: 60) |
DBT_MCP_LOG_LEVEL |
Debugging | DEBUG, INFO, WARNING, ERROR, CRITICAL |