Skip to content

Commit 87ca5a9

Browse files
committed
regroup readme doc
1 parent ebf72cf commit 87ca5a9

File tree

1 file changed

+14
-10
lines changed

1 file changed

+14
-10
lines changed

README.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,11 @@ Table of Contents
1010
- [Overview](#overview)
1111
- [Unity Catalog Server](#unity-catalog-server)
1212
- [Overview](#overview-1)
13-
- [Usage](#usage)
13+
- [Usage (locally via `stdio` transport)](#usage-locally-via-stdio-transport)
1414
- [Supported tools](#supported-tools)
15+
- [Deploying UC MCP server on Databricks Apps](#deploying-uc-mcp-server-on-databricks-apps)
16+
- [Connecting to the UC MCP server deployed on Databricks Apps](#connecting-to-the-uc-mcp-server-deployed-on-databricks-apps)
1517
- [Developer Tools Server](#developer-tools-server)
16-
- [Deploying MCP servers on Databricks Apps](#deploying-mcp-servers-on-databricks-apps)
1718
- [Support](#support)
1819
- [Contributing](#contributing)
1920

@@ -38,7 +39,8 @@ A Model Context Protocol server that exposes structured and unstructured data in
3839

3940
<img src="docs/images/demo.png" alt="Demo image" height="400px">
4041

41-
### Usage
42+
### Usage (locally via `stdio` transport)
43+
4244
1. Install [uv](https://docs.astral.sh/uv/getting-started/installation/)
4345
1. Install Python using `uv python install 3.12`
4446
1. [Configure Databricks credentials](https://docs.databricks.com/aws/en/dev-tools/cli/authentication) with access to the required APIs
@@ -74,11 +76,7 @@ the following tools:
7476
* **Vector search indexes**: for each vector search index, the server exposes a tool for querying that vector search index
7577
* **Genie spaces**: for each Genie space, the server exposes tools for managing conversations and sending questions to the space
7678

77-
## Developer Tools Server
78-
79-
This server is currently under construction. It is not yet usable, but contributions are welcome!
80-
81-
## Deploying MCP servers on Databricks Apps
79+
### Deploying UC MCP server on Databricks Apps
8280

8381
You can deploy the Unity Catalog MCP server as a Databricks app. To do so, follow the instructions below:
8482

@@ -120,13 +118,15 @@ If you are a developer iterating on the server implementation, you can repeat st
120118

121119
Please note that both variables should be provided in both `deploy` and `run` commands. The `schema_full_name` variable is used to determine the schema to use for the server, while the `genie_space_ids` variable is used to determine which Genie spaces to use.
122120

121+
### Connecting to the UC MCP server deployed on Databricks Apps
122+
123123
After the app is deployed, you can connect to it using the `Streamable HTTP` transport in your MCP client, such as Claude Desktop or MCP inspector.
124-
To do this, you need to set the transport URL to the URL of your app, which should look like this:
124+
To do this, you need to set the target URL to the URL of your app + `/api/mcp/` postfix. Full URL example:
125125
```
126126
https://your-app-url.usually.ends.with.databricksapps.com/api/mcp/
127127
```
128128

129-
Please note that the URL should end with `/api/mcp/` (including the trailing slash), as this is required for the server to work correctly.
129+
**Please note that the URL should end with `/api/mcp/` (including the trailing slash), as this is required for the server to work correctly.**
130130
To connect to the app, you also need to set the `Authorization` header to `Bearer <your_token>`, where `<your_token>` is the token you can get by running the following command:
131131

132132
```bash
@@ -135,6 +135,10 @@ databricks auth token -p your-profile-name
135135

136136
Please note that app service principal should be entitled with necessary permissions to access the Unity Catalog schema and Genie spaces. You can do this by assigning the appropriate permissions to the service principal in Unity Catalog and Genie.
137137

138+
## Developer Tools Server
139+
140+
This server is currently under construction. It is not yet usable, but contributions are welcome!
141+
138142
## Support
139143
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.
140144

0 commit comments

Comments
 (0)