Skip to main content

MCP server for Databricks Genie API

Project description

Databricks Genie API MCP Server

This project implements a Model Context Protocol (MCP) server that exposes Databricks Genie API capabilities as tools. It allows you to integrate Databricks' no-code AI/BI assistant features with other applications through a standardized interface, enabling powerful natural language querying of your Databricks data.

For a detailed explanation and example use cases, please see the accompanying blog post.

Features

  • Expose Databricks Genie API functions as MCP tools.
  • Enable natural language querying of Databricks data.
  • Start and manage Genie conversations.
  • Create and retrieve messages.
  • Execute and fetch SQL query results generated by Genie.
  • Secure authentication with Databricks.

Prerequisites

  • Python 3.10+
  • Databricks workspace with Genie access and System Tables enabled (if using them).
  • Databricks Assistant enabled.
  • CAN USE permission on a Pro or Serverless SQL warehouse.
  • Access to Unity Catalog data relevant to your Genie Space.
  • An MCP-compatible client application, such as Claude Desktop.

Setup Instructions

  1. Clone the Repository (if you haven't already)

    # Add clone command if needed
    
  2. Navigate to the Server Directory

    cd genie_api 
    
  3. Install Dependencies

    pip install -r requirements.txt
    
  4. Configure Authentication

    Set the required environment variables for the Databricks SDK to connect to your workspace. Create a .env file in this directory (genie_api/) or set them globally:

    # --- .env file content ---
    
    # For PAT authentication (recommended for development)
    # DATABRICKS_HOST=https://your-workspace.cloud.databricks.com
    # DATABRICKS_TOKEN=your-personal-access-token
    
    # Or for OAuth with service principal (recommended for production)
    DATABRICKS_HOST=https://your-workspace.cloud.databricks.com
    DATABRICKS_CLIENT_ID=your-client-id
    DATABRICKS_CLIENT_SECRET=your-client-secret
    
    # --- end .env file content ---
    

    Ensure the .env file is added to your `.gitignore!

  5. Run the Server Locally

    python server.py
    

    The server will start and listen for connections via standard input/output (stdio).

Using with Claude Desktop

This MCP server is designed to be used with MCP clients like Claude Desktop. Follow these steps to connect:

  1. Install Claude Desktop: Download and install from the official website.

  2. Configure Claude Desktop:

    • Open Claude Desktop settings (Menu Bar -> Claude -> Settings...).
    • Go to Developer -> Edit Config.
    • Add the following entry to the mcpServers object in the claude_desktop_config.json file, adjusting paths as needed:
    {
      "mcpServers": {
        "databricks-genie": {
          "command": "python", // Or python3, or the full path to your python executable
          "args": [
            "/full/absolute/path/to/your/project/genie_api/server.py" 
          ],
          "workingDirectory": "/full/absolute/path/to/your/project/genie_api/" 
        }
        // ... potentially other servers ...
      }
    }
    
    • Important: Use the full absolute path to server.py and the genie_api directory.
    • Ensure the Python command is accessible by Claude Desktop.
    • The workingDirectory ensures the server can find auth.py and your .env file.
  3. Restart Claude Desktop: Close and reopen the application.

  4. Verify: Click the hammer icon (Tools) in the chat input. You should see the databricks-genie tools listed (e.g., start_conversation, create_message).

Now you can ask Claude questions like "What was our DBU consumption last month?" or "Who accessed the PII table yesterday?", and it will use the tools provided by your local server.

For more details on configuring Claude Desktop, see the MCP Quickstart for Claude Desktop Users.

Available Tools

  • start_conversation: Start a new conversation in a Genie space.
  • create_message: Create a new message in an existing conversation.
  • get_message: Retrieve a message from a conversation.
  • get_message_attachment_query_result: Get SQL query results from a message attachment.
  • execute_message_attachment_query: Execute SQL for a message query attachment.
  • get_space: Get details about a Genie space.
  • generate_download_full_query_result: Initiate a full query result download.
  • poll_message_until_complete: Poll a message until it reaches a terminal state.

Troubleshooting

  • Authentication Issues: Verify Databricks credentials (.env file or environment variables) and required permissions in Databricks.
  • Connection Problems (Claude Desktop):
    • Ensure absolute paths in claude_desktop_config.json are correct.
    • Verify the command points to a valid Python interpreter.
    • Check Claude Desktop logs (~/Library/Logs/Claude/ or %APPDATA%\Claude\logs). Look for mcp.log and mcp-server-databricks-genie.log.
    • Try running python server.py manually in your terminal from the genie_api directory to check for errors.
  • SQL Execution Errors: Ensure the service principal or user has CAN USE on a SQL warehouse and access to the relevant Unity Catalog data.

Security Considerations

  • Credentials: Never hardcode credentials. Use environment variables (.env) or secure credential stores. Ensure .env is in your .gitignore. Use OAuth with service principals for production.
  • MCP Security: This server runs locally with your user's permissions and Databricks credentials. Clients like Claude Desktop MUST obtain user consent before executing tools (MCP Security Specification).
  • Production Deployment: Running this server for broader use requires a secure hosting strategy. Do not simply expose this local server. Work with security/DevOps to determine appropriate hosting, network controls, and potentially MCP server-level authentication. The hosting environment needs secure access to Databricks credentials (e.g., instance profiles, managed secrets). See the blog post for more discussion.
  • Input Sanitization: Trust the Databricks SDK/API for input handling passed via tools.

Contributing

Contributions are welcome! Please open an issue or submit a pull request.

License

This software is provided under a specific license granted by Databricks, Inc. Please see the LICENSE file for the full terms and conditions governing your use of this software.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file iflow_mcp_alexxx_db_databricks_genie_mcp-0.1.1.tar.gz.

File metadata

  • Download URL: iflow_mcp_alexxx_db_databricks_genie_mcp-0.1.1.tar.gz
  • Upload date:
  • Size: 11.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.2 {"installer":{"name":"uv","version":"0.10.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"13","id":"trixie","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for iflow_mcp_alexxx_db_databricks_genie_mcp-0.1.1.tar.gz
Algorithm Hash digest
SHA256 5960b9b683f97f43ca5229c6ae34ec6cd943772635b32b081b0e0e62f968da34
MD5 b23e18710f460842ef045d76ca4b6902
BLAKE2b-256 a884021f7b6f8915b0a57fc09b570b5c4a9aab976cba7f09e6b2cd396208915d

See more details on using hashes here.

File details

Details for the file iflow_mcp_alexxx_db_databricks_genie_mcp-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: iflow_mcp_alexxx_db_databricks_genie_mcp-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 18.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.2 {"installer":{"name":"uv","version":"0.10.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"13","id":"trixie","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for iflow_mcp_alexxx_db_databricks_genie_mcp-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0c49b2a171d54d11d8012f8e4fac400834d554971055d2d1dc189f7bbf931c61
MD5 378a58f7380737966dc539e7c682ef6f
BLAKE2b-256 80d126d3d8b85ab5d904edd8b34dfd13cca5ad4964bd94bda5ebff7c7486e561

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page