Skip to content

Commit e6177f7

Browse files
committed
fix readme
1 parent 848ecd0 commit e6177f7

File tree

1 file changed

+40
-6
lines changed

1 file changed

+40
-6
lines changed

README.md

Lines changed: 40 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,45 @@
22

33
![Test Status](https://github.com/databrickslabs/mcp/actions/workflows/unit_tests.yml/badge.svg)
44

5+
Table of Contents
6+
=================
7+
8+
- [Databricks MCP servers](#databricks-mcp-servers)
9+
- [Table of Contents](#table-of-contents)
10+
- [Overview](#overview)
11+
- [Unity Catalog Server](#unity-catalog-server)
12+
- [Overview](#overview-1)
13+
- [Usage](#usage)
14+
- [Supported tools](#supported-tools)
15+
- [Developer Tools Server](#developer-tools-server)
16+
- [Support](#support)
17+
- [Contributing](#contributing)
18+
519
## Overview
620
An experimental collection of [MCP](https://modelcontextprotocol.io/introduction) servers to help AI agents fetch enterprise data from Databricks, automate common developer actions on Databricks, etc:
721

822
* ![status: Beta](https://img.shields.io/badge/status-Beta-yellow?style=flat-square&logo=databricks)
923
[Databricks Unity Catalog server](./servers/unity_catalog/README.md): Fetch data and run tools registered in from Unity Catalog, making agents aware of your enterprise data
1024
* ![status: Under construction](https://img.shields.io/badge/status-Under_construction-red?style=flat-square&logo=databricks)
11-
[Databricks developer tools server](./servers/developer_tools/README.md): Perform common developer actions in Databricks, like creating and updating notebooks, running jobs, etc. This server is not yet usable, but contributions are welcome!
25+
[Databricks developer tools server](): Perform common developer actions in Databricks, like creating and updating notebooks, running jobs, etc. This server is not yet usable, but contributions are welcome!
1226

1327
The set of servers and tools in this repo is fluid and will evolve over time. We welcome contributions to this repo - please first
1428
read the [contributor guidelines](CONTRIBUTING.md) to streamline the process and discover areas where help is needed.
1529

16-
## Usage
17-
See the `README.md` in each server's directory for detailed instructions.
18-
For most servers, the following steps work:
30+
## Unity Catalog Server
31+
32+
![status: Beta](https://img.shields.io/badge/status-Beta-yellow?style=flat-square&logo=databricks)
33+
34+
### Overview
35+
A Model Context Protocol server that exposes structured and unstructured data in Unity Catalog ([vector search indexes](https://docs.databricks.com/gcp/en/generative-ai/vector-search), [functions](https://docs.databricks.com/aws/en/generative-ai/agent-framework/create-custom-tool), and [Genie spaces](https://docs.databricks.com/aws/en/genie/)), as tools.
36+
37+
<img src="docs/images/demo.png" alt="Demo image" height="400px">
1938

39+
### Usage
2040
1. Install [uv](https://docs.astral.sh/uv/getting-started/installation/)
2141
1. Install Python using `uv python install 3.12`
2242
1. [Configure Databricks credentials](https://docs.databricks.com/aws/en/dev-tools/cli/authentication) with access to the required APIs
23-
1. Add the server to your MCP client configuration. For example, to use the Databricks Unity Catalog MCP server with Claude Desktop, add the following to your `claude_desktop_config.json`:
43+
1. Add the server to your MCP client configuration. For example, to use this server with Claude Desktop, add the following to your `claude_desktop_config.json`:
2444

2545
```json
2646
{
@@ -29,7 +49,7 @@ For most servers, the following steps work:
2949
"command": "/path/to/uv/executable/uv",
3050
"args": [
3151
"--directory",
32-
"/path/to/this/repo/servers/unity_catalog",
52+
"/path/to/this/repo",
3353
"run",
3454
"unitycatalog-mcp",
3555
"-s",
@@ -42,6 +62,20 @@ For most servers, the following steps work:
4262
}
4363
```
4464

65+
### Supported tools
66+
67+
The list of tools supported by this server is dynamically inferred at startup time based on the functions and vector search indexes
68+
within the specified Unity Catalog schema, as well as any specified Genie spaces. In particular, the server exposes
69+
the following tools:
70+
71+
* **UC Functions**: for each UC function, the server exposes a tool with the same name, arguments, and return type as the function
72+
* **Vector search indexes**: for each vector search index, the server exposes a tool for querying that vector search index
73+
* **Genie spaces**: for each Genie space, the server exposes tools for managing conversations and sending questions to the space
74+
75+
## Developer Tools Server
76+
77+
This server is currently under construction. It is not yet usable, but contributions are welcome!
78+
4579
## Support
4680
Please note that all projects in the `databrickslabs` GitHub organization are provided for your exploration only, and are not formally supported by Databricks with Service Level Agreements (SLAs). They are provided AS-IS and we do not make any guarantees of any kind. Please do not submit a support ticket relating to any issues arising from the use of these projects.
4781

0 commit comments

Comments
 (0)