Skip to content

Commit ec02255

Browse files
Update README.md
Clarified install instructions
1 parent 45ab7d6 commit ec02255

1 file changed

Lines changed: 22 additions & 7 deletions

File tree

README.md

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Table of Contents
1717

1818
# Introduction
1919

20-
An **M**odel **C**ontext **P**rotocol ([MCP](https://docs.anthropic.com/en/docs/welcome)) server for easing LLM integration with Dremio.
20+
This repo provides an **M**odel **C**ontext **P**rotocol ([MCP](https://docs.anthropic.com/en/docs/welcome)) server for easing LLM integration with Dremio. If you are new to MCP and MCP Servers take our Dremio MCP Server course on Dremio University ([DremioU](https://university.dremio.com/course/dremio-mcp)). If you are familiar with these concepts already please proceed below.
2121

2222
```mermaid
2323
%%{init:
@@ -50,8 +50,12 @@ architecture-beta
5050
The MCP server runs locally on the machine that runs the LLM frontend (eg Claude). The installation steps are simple
5151

5252
1. Clone or download this repository.
53-
2. Install the [uv](https://docs.astral.sh/uv/guides/install-python/) package manager. The MCP server requires python (3.11 or later)
54-
3. Do a sanity check by doing
53+
2. Install the [uv](https://docs.astral.sh/uv/guides/install-python/) package manager.
54+
```shell
55+
brew install uv
56+
```
57+
NOTE: The MCP server requires python (3.11 or later)
58+
3. Do a sanity check by running the command and validating the output as shown below.
5559

5660
```shell
5761
# cd <toplevel git dir> or add `--directory <toplevel git dir>`
@@ -85,31 +89,42 @@ There are two configurations necessary before the MCP server can be invoked.
8589

8690
The quickest way to do this setup is -
8791

88-
1. Create the dremio config file using
92+
1. Create the dremio config file as outlined below and be prepared with these values
8993

9094
```shell
9195
$ uv run dremio-mcp-server config create dremioai \
9296
--uri <dremio uri> \
97+
# the endpoint portion of the URL for your environment
9398
--pat <dremio pat> \
99+
# https://docs.dremio.com/current/security/authentication/personal-access-tokens/#using-a-pat
94100
# optional: add your project ID if setting up for dremio cloud
95101
# --project-id <dremio project id>
96102
```
97103

98-
Note: For security purposes, if you don't want the PAT to leak into your shell history file, create a file with your PAT in it and give it as an argument to the dremio config. Example:
104+
Note: For security purposes, if you don't want the PAT to leak into your shell history file, create a file with your PAT in it and give it as an argument to the dremio config.
105+
106+
Example:
99107

100108
```shell
101109
$ uv run dremio-mcp-server config create dremioai \
102110
--uri <dremio uri> \
103111
--pat @/path/to/tokenfile \
104112
```
105113

106-
2. Download and install Claude desktop. And then create the Claude config file using
114+
2. Download and install Claude desktop.
115+
```shell
116+
brew install --cask claude
117+
```
118+
119+
Note: Claude has system requirements, such as node.js, please validate your system requirements with Claude official documentation.
120+
121+
3. Create the Claude config file using
107122

108123
```shell
109124
$ uv run dremio-mcp-server config create claude
110125
```
111126

112-
3. Validate the config files using
127+
4. Validate the config files using
113128

114129
```shell
115130
$ uv run dremio-mcp-server config list --type claude

0 commit comments

Comments
 (0)