Skip to content

docs(apps-mcp): highlight install command in README #4010

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 27, 2025
Merged

docs(apps-mcp): highlight install command in README #4010

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 42 additions & 20 deletions experimental/apps-mcp/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Perfect for data engineers and developers who want to build Databricks apps with

## Getting Started

### Quick Setup
### Quick Setup (Recommended)

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

2. **Configure your MCP client** (e.g., Claude Code):

Add to your MCP config file (e.g., `~/.claude.json`):
```json
{
"mcpServers": {
"databricks": {
"command": "databricks",
"args": ["experimental", "apps-mcp"],
"env": {
"DATABRICKS_HOST": "https://your-workspace.databricks.com",
"DATABRICKS_TOKEN": "dapi...",
"DATABRICKS_WAREHOUSE_ID": "your-warehouse-id"
}
}
}
}
2. **Install the MCP server automatically:**
```bash
databricks experimental apps-mcp install
```

3. **Create your first Databricks app:**
This interactive command will:
- Automatically detect Claude Code and Cursor installations
- Configure the MCP server with proper settings
- Set up the server at user scope (available in all projects)
- Show manual instructions for other agents if needed

3. **Restart your MCP client** (Claude Code, Cursor, etc.) for changes to take effect.

4. **Create your first Databricks app:**

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

---

### Manual Setup (Alternative)

If you prefer to configure manually or the automatic installation doesn't work:

**Add to your MCP config file** (e.g., `~/.claude.json` for global scope):
```json
{
"mcpServers": {
"databricks": {
"command": "databricks",
"args": ["experimental", "apps-mcp"],
"env": {
"DATABRICKS_HOST": "https://your-workspace.databricks.com",
"DATABRICKS_TOKEN": "dapi...",
"DATABRICKS_WAREHOUSE_ID": "your-warehouse-id"
}
}
}
}
```

Then restart your MCP client for changes to take effect

---

## Features

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

```bash
# Install MCP server in coding agents (Claude Code, Cursor, etc.)
databricks experimental apps-mcp install

# Start MCP server (default mode)
databricks experimental apps-mcp --warehouse-id <warehouse-id>

Expand Down