Skip to content
GitHub (opens in a new tab)

Databases · Integration guide

How to connect Databricks SQL to any AI IDE (Claude/Codex/Cursor/VS Code/Antigravity)

Before you start, install GateRook and connect it to your AI development environment: Claude Desktop, Codex, Cursor, Antigravity or VS Code.

Connect your AI app

Unity Catalog tables and Databricks SQL queries on a SQL warehouse. Changes wait for approval.

The screenshots show GateRook 2.0.0: the Databricks SQL form, the endpoint selector, and this connector’s actual tool preview. The form and preview have not been saved. Select a screenshot to open it at full size.

1. Create a connection and enter the settings

In GateRook, open Connections, select Add connection, search for Databricks SQL, choose its card and select Continue to configure.

Open the SQL warehouse’s connection details and copy the workspace URL and warehouse ID. The ID is the final part of its /sql/1.0/warehouses/ HTTP path.

Prepare an OAuth machine-to-machine service principal or a personal access token. The identity needs permission to use the warehouse and read the chosen catalogs, schemas and tables.

Enter a Name, for example databricks-demo. Your AI app uses this name to choose the connection.

Enter Workspace URL including https:// and the SQL warehouse ID. This is the warehouse ID, not the full HTTP path.

Under Sign in with, choose the service-principal option and enter Client ID and Client secret, or choose A personal access token and enter Personal access token.

Use Default catalog and Default schema for unqualified names. Narrow Catalogs and Schemas to the datasets you intend the AI to use.

Choose Development, Staging or Production to match the service. Review the connector’s limit and access settings before continuing.

GateRook 2.0.0 Configure Databricks SQL form before saving.
The Databricks SQL configuration form. Enter your own connection settings before testing.

2. Test the connection and add it to an endpoint

Select Continue to test. GateRook checks the settings from your computer. Review the result and resolve any connection, certificate or permission error before continuing.

If a query is refused, verify CAN USE on the warehouse and the applicable USE CATALOG, USE SCHEMA and SELECT grants. Check that the token or OAuth secret belongs to the workspace in Workspace URL.

After the test passes, select Continue to add to an endpoint. Choose the endpoint your AI app uses, review its tool modes, then select Save connection. GateRook offers default as the starter endpoint.

GateRook endpoint selector with default selected; no connector tool list is shown.
Choose the endpoint your AI app uses. This selector is shared across connector types; the next screenshot shows this connector’s own tools.

3. Use the connection from your AI IDE

After saving Databricks SQL on the endpoint and passing its connection test, ask your AI app to use databricks-demo, or the name you chose. If its tools are missing, confirm the endpoint assignment and refresh the MCP connection or start a new chat.

The preview below shows this connector’s default tools before saving. The table explains what each tool can do; connection settings, credentials and endpoint policies can restrict access further.

Databricks SQL connector tool names and default modes in the GateRook 2.0.0 endpoint preview.
Databricks SQL tools in the Development endpoint preview. This is an unsaved preview, not a successful service call.

Start with a small read request. Replace example resource names with existing resources your connection may access. Open Activity after the call to inspect its connection, tool, arguments, policy decision and result metadata.

Ask your AI, for example

  • “List the catalogs available through databricks-demo.”
  • “Describe the columns of main.analytics.orders on databricks-demo.”
  • “Using databricks-demo, count orders by status in main.analytics.orders.”
Tools your AI gets
ToolWhat it doesStarts as
databricks_list_catalogsUnity Catalog catalogs agents may use.Read only
databricks_list_schemasSchemas agents may use in one catalog.Read only
databricks_list_tablesTables, views and their kinds in one schema.Read only
databricks_describe_tableColumns with their types, partitioning, format and comment of one table or view.Read only
databricks_queryOne SELECT, WITH, VALUES, SHOW, DESCRIBE or EXPLAIN on the connection's SQL warehouse. Values as :name parameters. Pages with nextCursor.Read only
databricks_executeOne INSERT, UPDATE, DELETE, MERGE, DDL or table maintenance statement. You approve the exact text.Approval

You can change each tool’s mode on the endpoint. Every call your AI makes appears in Activity.

Service documentation

Keep exploring

Azure Databricks

Connect Azure Databricks to Claude, Codex, Cursor, VS Code or Antigravity with GateRook. Follow setup, connection testing and tool access with screenshots.

PostgreSQL

Connect PostgreSQL to Claude, Codex, Cursor, VS Code or Antigravity in three steps. Your AI runs read queries; changes wait for your approval.

MySQL

Connect MySQL to Claude, Codex, Cursor, VS Code or Antigravity in three steps. GateRook keeps the password; your AI reads data and asks before changes.

Browse all integration guides

Your local MCP gateway and firewall.

Connect Databricks SQL to your AI IDE.

Choose a connector. Start with read-only access. Approve changes and inspect the audit trail.

Read the getting started guide

Get GateRook

Download GateRook 2.0.0 for your Mac, or get the Windows app from Microsoft Store.

macOS

Version 2.0.0 for Apple Silicon (arm64). This download does not support Intel Macs.

Open the DMG and drag GateRook to Applications.

Windows

Available for free from Microsoft Store. Install GateRook and receive updates through the Store.

macOS release notes and checksums (opens in a new tab)