Unity Catalog

What is mcp-server-unitycatalog?

mcp-server-unitycatalog is an MCP server designed to bridge the gap between Large Language Models (LLMs) and Unity Catalog AI. It allows LLMs to seamlessly interact with Unity Catalog Functions, treating them as callable tools within an MCP environment.

How to use mcp-server-unitycatalog?

To use mcp-server-unitycatalog, you can either install it using uv or run it via Docker. Configuration involves setting required arguments such as the Unity Catalog server URL, catalog name, and schema name, which can be done via CLI options or environment variables. The project also provides examples for integration with Claude Desktop or VSCode Cline by modifying their respective configuration files to include the mcp-server-unitycatalog as an MCP server.

Key Features of mcp-server-unitycatalog

• Unity Catalog Function Integration: Provides all Unity Catalog Functions as MCP tools.
• Predefined Tools: Includes specific tools for managing Unity Catalog Functions:
  • uc_list_functions: Lists functions within a specified catalog and schema.
  • uc_get_function: Retrieves details of a specific function.
  • uc_create_function: Creates a new function (experimental API).
  • uc_delete_function: Deletes an existing function.
• Flexible Configuration: Supports configuration via command-line arguments and environment variables.
• Docker Support: Provides a Docker image for easy deployment.

Use Cases of mcp-server-unitycatalog

• LLM-driven Data Management: Enable LLMs to programmatically manage and interact with Unity Catalog functions, such as creating, listing, and deleting them.
• Automated Data Operations: Automate data-related tasks by allowing LLMs to execute Unity Catalog functions as part of a larger workflow.
• AI-powered Data Exploration: Facilitate AI-driven exploration of data within Unity Catalog by providing LLMs with direct access to functions.

FAQ about mcp-server-unitycatalog

• What is the Model Context Protocol (MCP)? The Model Context Protocol is a standard that allows AI models to interact with external tools and services.
• What are Unity Catalog Functions? Unity Catalog Functions are user-defined functions stored and managed within Unity Catalog, allowing for reusable logic and data transformations.
• Is uc_create_function stable? No, the uc_create_function API is experimental and may change in future versions.
• How can I configure the server? You can configure the server using CLI arguments (-u, -c, -s, etc.) or environment variables (UC_SERVER, UC_CATALOG, UC_SCHEMA, etc.).
• What are the future plans for mcp-server-unitycatalog? Future plans include implementing semantic catalog explorer tools and use_xxx methods for dynamic catalog and schema updates.

mcp-server-unitycatalog: An Unity Catalog MCP server

Overview

A Model Context Protocol server for Unity Catalog. This server provides Unity Catalog Functions as MCP tools.

Tools

You can use all Unity Catalog Functions registered in Unity Catalog alongside the following predefined Unity Catalog AI tools:

1. uc_list_functions

   • Lists functions within the specified parent catalog and schema.
   • Returns: A list of functions retrieved from Unity Catalog.

2. uc_get_function

   • Gets a function within a parent catalog and schema.
   • Input:
     • name (string): The name of the function (not fully-qualified).
   • Returns: A function details retrieved from Unity Catalog.

3. uc_create_function

   • Creates a function within a parent catalog and schema. WARNING: This API is experimental and will change in future versions.
   • Input:
     • name (string): The name of the function (not fully-qualified).
     • script (string): The Python script including the function to be registered.
   • Returns: A function details created within Unity Catalog.

4. uc_delete_function

   • Deletes a function within a parent catalog and schema.
   • Input:
     • name (string): The name of the function (not fully-qualified).
   • Returns: None.

Installation

Using uv

When using uv no specific installation is needed. We will use uvx to directly run mcp-server-git.

Configuration

These values can also be set via CLI options or .env environment variables. Required arguments are the Unity Catalog server, catalog, and schema, while the access token and verbosity level are optional. Run uv run mcp-server-unitycatalog --help for more detailed configuration options.

Argument	Environment Variable	Description	Required/Optional
-u, --uc_server	UC_SERVER	The base URL of the Unity Catalog server.	Required
-c, --uc_catalog	UC_CATALOG	The name of the Unity Catalog catalog.	Required
-s, --uc_schema	UC_SCHEMA	The name of the schema within a Unity Catalog catalog.	Required
-t, --uc_token	UC_TOKEN	The access token used to authorize API requests to the Unity Catalog server.	Optional
-v, --uc_verbosity	UC_VERBOSITY	The verbosity level for logging. Default: warn.	Optional
-l, --uc_log_directory	UC_LOG_DIRECTORY	The directory where log files will be stored. Default: .mcp_server_unitycatalog.	Optional

Usage with Claude Desktop or VSCode Cline

Add this to your claude_desktop_config.json (or cline_mcp_settings.json):

{
  "mcpServers": {
    "unitycatalog": {
      "command": "uv",
      "args": [
        "--directory",
        "/<path to your local git repository>/mcp-server-unitycatalog",
        "run",
        "mcp-server-unitycatalog",
        "--uc_server",
        "<your unity catalog url>",
        "--uc_catalog",
        "<your catalog name>",
        "--uc_schema",
        "<your schema name>"
      ]
    }
  }
}

• Note: replace '/Users/username' with the a path that you want to be accessible by this tool

{
  "mcpServers": {
    "unitycatalog": {
      "command": "docker",
      "args": [
        "run",
        "--rm",
        "-i",
        "mcp/unitycatalog",
        "--uc_server",
        "<your unity catalog url>",
        "--uc_catalog",
        "<your catalog name>",
        "--uc_schema",
        "<your schema name>"
      ]
    }
  }
}

Building

Docker:

docker build -t mcp/unitycatalog .   

Future Plans

• Implement support for list_functions.
• Implement support for get_function.
• Implement support for create_python_function.
• Implement support for execute_function.
• Implement support for delete_function.
• Implement semantic catalog explorer tools.
• Add Docker image.
• Implement use_xxx methods. In the current implementation, catalog and schema need to be defined when starting the server. However, they will be implemented as use_catalog and use_schema functions, dynamically updating the list of available functions when the use_xxx is executed.

License

This MCP server is licensed under the MIT License. This means you are free to use, modify, and distribute the software, subject to the terms and conditions of the MIT License. For more details, please see the LICENSE file in the project repository.