Skip to content

Commit 2ba3cc1

Browse files
Style updates to dbt-ai directory (#8081)
2 parents f42f215 + be0bfd1 commit 2ba3cc1

File tree

6 files changed

+28
-28
lines changed

6 files changed

+28
-28
lines changed

website/docs/docs/dbt-ai/about-mcp.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,7 @@ You can install dbt MCP locally or remotely:
3232
## Available Tools
3333

3434
### Supported
35-
The dbt MCP server has access to many parts of the dbt experience related to development, deployment, and discovery.
36-
Here are the categories of tools supported based on what form of the MCP Server you connect to as well as detailed information on exact commands or queries available to the LLM.
35+
The dbt MCP server has access to many parts of the dbt experience related to development, deployment, and discovery. Here are the categories of tools supported based on what form of the MCP server you connect to as well as detailed information on exact commands or queries available to the LLM.
3736

3837
| Tools | Local | Remote |
3938
| --- | --- | --- |
@@ -108,7 +107,7 @@ To learn more about the dbt Administrative API, click [here](/docs/dbt-cloud-api
108107

109108
### Codegen tools
110109

111-
These tools help automate boilerplate code generation for dbt projects files. To use them, install the [dbt-codegen](https://hub.getdbt.com/dbt-labs/codegen/latest/) in your dbt project. These tools are disabled by default. To enable them, set the `DISABLE_DBT_CODEGEN` environment variable to `false`.
110+
These tools help automate boilerplate code generation for dbt project files. To use them, install the [dbt-codegen](https://hub.getdbt.com/dbt-labs/codegen/latest/) in your dbt project. These tools are disabled by default. To enable them, set the `DISABLE_DBT_CODEGEN` environment variable to `false`.
112111

113112
- `generate_source`: Creates source YAML definitions from database schemas.
114113
- `generate_model_yaml`: Generates documentation YAML for existing dbt models, including column names, data types, and description placeholders.
@@ -125,10 +124,10 @@ import MCPCreditUsage from '/snippets/_mcp-credit-usage.md';
125124

126125
<MCPCreditUsage />
127126

128-
### Fusion tools (Local)
127+
### Fusion tools (local)
129128
A set of tools that leverage the <Constant name="fusion" /> engine through a locally running <Constant name="fusion" /> Language Server Protocol (LSP) in VS Code or Cursor with the dbt VS Code extension.
130129

131-
- `get_column_lineage`: <Constant name="fusion" /> exclusive! Gets column lineage information across a project DAG for a specific column.
130+
- `get_column_lineage`: <Constant name="fusion" /> exclusive! Get column lineage information across a project DAG for a specific column.
132131

133132
## MCP integrations
134133

@@ -144,4 +143,4 @@ We have also created integration guides for the following clients:
144143
- Some MCP clients may be unable to find `uvx` from the JSON config. This will result in error messages like `Could not connect to MCP server dbt-mcp`. If this happens, try finding the full path to `uvx` with `which uvx` on Unix systems and placing this full path in the JSON. For instance: `"command": "/the/full/path/to/uvx"`.
145144

146145
## Resources
147-
- Refer to our blog on [Introducing the dbt MCP Server](/blog/introducing-dbt-mcp-server#getting-started) for more information.
146+
- For more information, refer to our blog on [Introducing the dbt MCP Server](/blog/introducing-dbt-mcp-server#getting-started).

website/docs/docs/dbt-ai/integrate-mcp-claude.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ id: "integrate-mcp-claude"
88
import MCPExample from '/snippets/_mcp-config-files.md';
99

1010
Claude is an AI assistant from Anthropic with two primary interfaces:
11-
- [Claude Code](https://www.anthropic.com/claude-code): a terminal/IDE tool for development
12-
- [Claude for desktop](https://claude.ai/download): a GUI with MCP support for file access and commands as well as basic coding features
11+
- [Claude Code](https://www.anthropic.com/claude-code): A terminal/IDE tool for development
12+
- [Claude for desktop](https://claude.ai/download): A GUI with MCP support for file access and commands as well as basic coding features
1313

1414
## Claude Code
1515

@@ -18,7 +18,7 @@ You can set up Claude Code with both the local and remote `dbt-mcp` server. We r
1818
### Setup with local dbt MCP server
1919

2020
Prerequisites:
21-
- Have an .env file with your environment variables
21+
- Have an `.env` file with your environment variables
2222
- Local dbt-mcp setup
2323

2424
1. Run the following command to add the MCP server to Claude Code:
@@ -41,7 +41,7 @@ To install it in the project scope, run the following and commit the `.mcp.json`
4141
claude mcp add dbt -s project -- uvx --env-file <path-to-.env-file> dbt-mcp
4242
```
4343

44-
More info on scopes [here](https://docs.anthropic.com/en/docs/claude-code/mcp#understanding-mcp-server-scopes)
44+
For more information on scopes, refer to [Understanding MCP server scopes](https://docs.anthropic.com/en/docs/claude-code/mcp#understanding-mcp-server-scopes).
4545

4646

4747
## Claude for desktop
@@ -82,3 +82,4 @@ For debugging, you can find the Claude desktop logs at `~/Library/Logs/Claude` f
8282

8383
- Claude desktop may return errors such as `Error: spawn uvx ENOENT` or `Could not connect to MCP server dbt-mcp`. Try replacing the command
8484
and environment variables file path with the full path. For `ux`, find the full path to `uvx` by running `which uvx` on Unix systems and placing this full path in the JSON. For instance: `"command": "/the/full/path/to/uvx"`.
85+

website/docs/docs/dbt-ai/integrate-mcp-cursor.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ After setting up your MCP server, you connect it to Cursor. Log in to Cursor and
1919
3. Update inputs in the template.
2020
4. Save, and now you have access to the dbt-mcp!
2121

22-
#### Set up with dbt platform authentication <Lifecycle status="managed, managed_plus" />
22+
### Set up with dbt platform authentication <Lifecycle status="managed, managed_plus" />
2323
You can configure the local MCP server for use with the dbt platform via OAuth:
2424

2525
1. Click one of the following application links with Cursor open:

website/docs/docs/dbt-ai/integrate-mcp-vscode.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ These instructions are for integrating dbt MCP and VS Code. To get started, in V
4545
}
4646
```
4747

48-
`<path-to-.env-file>` is where you saved the `.env` file from the Setup step
48+
`<path-to-.env-file>` is where you saved the `.env` file from the setup step.
4949

5050
</TabItem>
5151

@@ -72,7 +72,7 @@ These instructions are for integrating dbt MCP and VS Code. To get started, in V
7272

7373
#### Local MCP with dbt platform authentication <Lifecycle status="managed, managed_plus" />
7474

75-
Additionally, you can configure the local MCP server to authenticate against your dbt platform environment using OAuth. Substitute the previous local MCP JSON with one of the following::
75+
Additionally, you can configure the local MCP server to authenticate against your dbt platform environment using OAuth. Substitute the previous local MCP JSON with one of the following:
7676

7777
<MCPExample />
7878

@@ -86,4 +86,4 @@ Now you will be able to access the local dbt MCP server on VS Code through inter
8686

8787
## Resources
8888

89-
- Microsoft VS Code MCP [docs](https://code.visualstudio.com/docs/copilot/chat/mcp-servers).
89+
- [Microsoft VS Code MCP documentation](https://code.visualstudio.com/docs/copilot/chat/mcp-servers)

website/docs/docs/dbt-ai/setup-local-mcp.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,10 @@ import MCPExample from '/snippets/_mcp-config-files.md';
3434
<TabItem value="API and SQL tool settings">
3535
| Environment Variable | Required | Description |
3636
| --- | --- | --- |
37-
| DBT_HOST | Required | Your dbt platform [instance hostname](/docs/cloud/about-cloud/access-regions-ip-addresses). If you're using Multi-cell, exclude the `ACCOUNT_PREFIX` from the hostname. The default is `cloud.getdbt.com` |
38-
| MULTICELL_ACCOUNT_PREFIX | Only required for Multi-cell instances | Set your Multi-cell `ACCOUNT_PREFIX`. If you are not using Multi-cell, don't set this value. You can learn more about regions and hosting [here](https://docs.getdbt.com/docs/cloud/about-cloud/access-regions-ip-addresses). |
37+
| DBT_HOST | Required | Your dbt platform [instance hostname](/docs/cloud/about-cloud/access-regions-ip-addresses). If you're using Multi-cell, exclude the `ACCOUNT_PREFIX` from the hostname. The default is `cloud.getdbt.com`. |
38+
| MULTICELL_ACCOUNT_PREFIX | Only required for Multi-cell instances | Set your Multi-cell `ACCOUNT_PREFIX`. If you are not using Multi-cell, don't set this value. You can learn more about regions and hosting [here](https://docs.getdbt.com/docs/cloud/about-cloud/access-regions-ip-addresses). |
3939
| DBT_TOKEN | Required | Your personal access token or service token from the dbt platform. <br/>**Note**: When using the Semantic Layer, it is recommended to use a personal access token. If you're using a service token, make sure that it has at least `Semantic Layer Only`, `Metadata Only`, and `Developer` permissions. |
40-
| DBT_ACCOUNT_ID | Required for Admininstrative API tools | Your [dbt account ID](https://docs.getdbt.com/faqs/Accounts/find-user-id) |
40+
| DBT_ACCOUNT_ID | Required for Administrative API tools | Your [dbt account ID](https://docs.getdbt.com/faqs/Accounts/find-user-id) |
4141
| DBT_PROD_ENV_ID | Required | Your dbt Cloud production environment ID |
4242
| DBT_DEV_ENV_ID | Optional | Your dbt Cloud development environment ID |
4343
| DBT_USER_ID | Optional | Your dbt Cloud user ID ([docs](https://docs.getdbt.com/faqs/Accounts/find-user-id)) |
@@ -66,7 +66,7 @@ import MCPExample from '/snippets/_mcp-config-files.md';
6666
| `DISABLE_DBT_CLI` | `false` | Set this to `true` to disable dbt Core, dbt Cloud CLI, and dbt Fusion MCP tools |
6767
| `DISABLE_SEMANTIC_LAYER` | `false` | Set this to `true` to disable dbt Semantic Layer MCP tools |
6868
| `DISABLE_DISCOVERY` | `false` | Set this to `true` to disable dbt Discovery API MCP tools |
69-
| `DISABLE_ADMIN_API` | `false` | Set this to `true` to disable dbt Admininistrative API MCP tools |
69+
| `DISABLE_ADMIN_API` | `false` | Set this to `true` to disable dbt Administrative API MCP tools |
7070
| `DISABLE_SQL` | `true` | Set this to `false` to enable SQL MCP tools |
7171
| `DISABLE_DBT_CODEGEN` | `true` | Set this to `false` to enable [dbt codegen MCP tools](/docs/dbt-ai/about-mcp#codegen-tools) (requires dbt-codegen package) |
7272
| `DISABLE_TOOLS` | "" | Set this to a list of tool names delimited by a `,` to disable specific tools |
@@ -85,7 +85,7 @@ import MCPExample from '/snippets/_mcp-config-files.md';
8585

8686
4. Set up your MCP client:
8787

88-
After creating your `.env` file, you can move on to our guides on connecting dbt-mcp to tools like Claude Desktop or Cursor or to creating aconfiguration file. This is dependent on what tools you want to integrate with.
88+
After creating your `.env` file, you can move on to our guides on connecting dbt-mcp to tools like Claude Desktop or Cursor or to creating a configuration file. This is dependent on what tools you want to integrate with.
8989

9090

9191
#### Example configuration
@@ -107,15 +107,15 @@ import MCPExample from '/snippets/_mcp-config-files.md';
107107
}
108108
```
109109

110-
`<path-to-.env-file>` is where you saved the `.env` file from the Setup step.
110+
`<path-to-.env-file>` is where you saved the `.env` file from the setup step.
111111

112112
## dbt platform authentication
113113

114114
The local MCP server integrates with your existing cloud-based dbt platform OAuth integration with a simple configuration file in the client. Reference the following sample configurations (configs may vary depending on the client):
115115

116-
:::info static subdomains
116+
:::info Static subdomains
117117

118-
Only accounts with static subdomains (for example, abc123.us1.dbt.com) can use OAuth with MCP servers. All accounts are in the process of being migrated to static subdomains by Dec 2025. Please contact support for more information.
118+
Only accounts with static subdomains (for example, abc123.us1.dbt.com) can use OAuth with MCP servers. All accounts are in the process of being migrated to static subdomains by December 2025. Please contact support for more information.
119119

120120
:::
121121

website/docs/docs/dbt-ai/setup-remote-mcp.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@ import MCPCreditUsage from '/snippets/_mcp-credit-usage.md';
1111

1212
<MCPCreditUsage />
1313

14-
1. Ensure that you have [AI Features](https://docs.getdbt.com/docs/cloud/enable-dbt-copilot) turned on.
15-
2. Obtain the following information from dbt Platform:
14+
1. Ensure that you have [AI features](https://docs.getdbt.com/docs/cloud/enable-dbt-copilot) turned on.
15+
2. Obtain the following information from dbt platform:
1616

17-
- **dbt Cloud host**: Use this to form the full URL. For example, replace `<host>` here: `https://<host>/api/ai/v1/mcp/`. It may look like: `https://cloud.getdbt.com/api/ai/v1/mcp/`. If you have a multi-cell account, the host URL will be in the `<ACCOUNT_PREFIX>.us1.dbt.com` format. For more information, [check out our docs.](/docs/cloud/about-cloud/access-regions-ip-addresses)
18-
- **Production environment ID**: This can be found on the `Orchestration` page of dbt Cloud. Use this to set an `x-dbt-prod-environment-id` header.
19-
- **Token**: Please generate either a personal access token or a service token. In terms of permissions, to fully utilize remote MCP, it must be configured with Semantic Layer and Developer permissions.
17+
- **dbt Cloud host**: Use this to form the full URL. For example, replace `<host>` here: `https://<host>/api/ai/v1/mcp/`. It may look like: `https://cloud.getdbt.com/api/ai/v1/mcp/`. If you have a multi-cell account, the host URL will be in the `<ACCOUNT_PREFIX>.us1.dbt.com` format. For more information, refer to [Access, Regions, & IP addresses](/docs/cloud/about-cloud/access-regions-ip-addresses).
18+
- **Production environment ID**: This can be found on the **Orchestration** page of dbt Cloud. Use this to set an `x-dbt-prod-environment-id` header.
19+
- **Token**: Generate either a personal access token or a service token. In terms of permissions, to fully utilize remote MCP, it must be configured with Semantic Layer and Developer permissions.
2020

2121
3. For the remote MCP, you will pass on headers through the JSON blob to configure required fields:
2222

@@ -50,7 +50,7 @@ Fusion tools, by default, defer to the environment provided via `x-dbt-prod-envi
5050
| x-dbt-disable-tools | Optional | A comma-separated list of tools to disable. For instance: `get_all_models,text_to_sql,list_entities` |
5151
| x-dbt-disable-toolsets | Optional | A comma-separated list of toolsets to disable. For instance: `semantic_layer,sql,discovery` |
5252

53-
4. After establishing which headers you need, you can follow the examples [here](https://github.com/dbt-labs/dbt-mcp/tree/main/examples) to create your own agent.
53+
4. After establishing which headers you need, you can follow the [examples](https://github.com/dbt-labs/dbt-mcp/tree/main/examples) to create your own agent.
5454

5555
The MCP protocol is programming language and framework agnostic, so use whatever helps you build agents. Alternatively, you can connect the remote dbt MCP server to MCP clients that support header-based authentication. You can use this example Cursor configuration, replacing `<host>`, `<token>`, `<prod-id>`, `<user-id>`, and `<dev-id>` with your information:
5656

0 commit comments

Comments
 (0)