Skip to content

Commit d22a5ab

Browse files
keugenekclaude
andauthored
docs(apps-mcp): highlight install command in README (#4010)
Update the apps-mcp README to feature the `databricks experimental apps-mcp install` command as the recommended setup method. This interactive command automatically configures the MCP server in Claude Code and Cursor. Changes: - Move install command to Quick Setup (Recommended) section - Relocate manual JSON configuration to Manual Setup (Alternative) - Add install command to CLI Commands reference - Improve setup instructions clarity Co-authored-by: Claude <[email protected]>
1 parent 33fadff commit d22a5ab

File tree

1 file changed

+42
-20
lines changed

1 file changed

+42
-20
lines changed

experimental/apps-mcp/README.md

Lines changed: 42 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Perfect for data engineers and developers who want to build Databricks apps with
2626

2727
## Getting Started
2828

29-
### Quick Setup
29+
### Quick Setup (Recommended)
3030

3131
1. **Set up Databricks credentials** (required for Databricks tools):
3232
```bash
@@ -35,28 +35,22 @@ Perfect for data engineers and developers who want to build Databricks apps with
3535
export DATABRICKS_WAREHOUSE_ID="your-warehouse-id"
3636
```
3737

38-
2. **Configure your MCP client** (e.g., Claude Code):
39-
40-
Add to your MCP config file (e.g., `~/.claude.json`):
41-
```json
42-
{
43-
"mcpServers": {
44-
"databricks": {
45-
"command": "databricks",
46-
"args": ["experimental", "apps-mcp"],
47-
"env": {
48-
"DATABRICKS_HOST": "https://your-workspace.databricks.com",
49-
"DATABRICKS_TOKEN": "dapi...",
50-
"DATABRICKS_WAREHOUSE_ID": "your-warehouse-id"
51-
}
52-
}
53-
}
54-
}
38+
2. **Install the MCP server automatically:**
39+
```bash
40+
databricks experimental apps-mcp install
5541
```
5642

57-
3. **Create your first Databricks app:**
43+
This interactive command will:
44+
- Automatically detect Claude Code and Cursor installations
45+
- Configure the MCP server with proper settings
46+
- Set up the server at user scope (available in all projects)
47+
- Show manual instructions for other agents if needed
48+
49+
3. **Restart your MCP client** (Claude Code, Cursor, etc.) for changes to take effect.
50+
51+
4. **Create your first Databricks app:**
5852

59-
Restart your MCP client and try:
53+
Try this in your MCP client:
6054
```
6155
Create a Databricks app that shows sales data from main.sales.transactions
6256
with a chart showing revenue by region. Deploy it as "sales-dashboard".
@@ -71,6 +65,31 @@ Perfect for data engineers and developers who want to build Databricks apps with
7165

7266
---
7367

68+
### Manual Setup (Alternative)
69+
70+
If you prefer to configure manually or the automatic installation doesn't work:
71+
72+
**Add to your MCP config file** (e.g., `~/.claude.json` for global scope):
73+
```json
74+
{
75+
"mcpServers": {
76+
"databricks": {
77+
"command": "databricks",
78+
"args": ["experimental", "apps-mcp"],
79+
"env": {
80+
"DATABRICKS_HOST": "https://your-workspace.databricks.com",
81+
"DATABRICKS_TOKEN": "dapi...",
82+
"DATABRICKS_WAREHOUSE_ID": "your-warehouse-id"
83+
}
84+
}
85+
}
86+
}
87+
```
88+
89+
Then restart your MCP client for changes to take effect
90+
91+
---
92+
7493
## Features
7594

7695
All features are designed to support the end-to-end workflow of creating production-ready Databricks applications:
@@ -285,6 +304,9 @@ The Databricks MCP server doesn't just generate code—it ensures quality:
285304
### CLI Commands
286305

287306
```bash
307+
# Install MCP server in coding agents (Claude Code, Cursor, etc.)
308+
databricks experimental apps-mcp install
309+
288310
# Start MCP server (default mode)
289311
databricks experimental apps-mcp --warehouse-id <warehouse-id>
290312

0 commit comments

Comments
 (0)