You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+22-7Lines changed: 22 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,7 @@ Table of Contents
17
17
18
18
# Introduction
19
19
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.
21
21
22
22
```mermaid
23
23
%%{init:
@@ -50,8 +50,12 @@ architecture-beta
50
50
The MCP server runs locally on the machine that runs the LLM frontend (eg Claude). The installation steps are simple
51
51
52
52
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.
55
59
56
60
```shell
57
61
# 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.
85
89
86
90
The quickest way to do this setup is -
87
91
88
-
1. Create the dremio config file using
92
+
1. Create the dremio config file as outlined below and be prepared with these values
89
93
90
94
```shell
91
95
$ uv run dremio-mcp-server config create dremioai \
92
96
--uri <dremio uri> \
97
+
# the endpoint portion of the URL for your environment
# optional: add your project ID if setting up for dremio cloud
95
101
# --project-id <dremio project id>
96
102
```
97
103
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:
99
107
100
108
```shell
101
109
$ uv run dremio-mcp-server config create dremioai \
102
110
--uri <dremio uri> \
103
111
--pat @/path/to/tokenfile \
104
112
```
105
113
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
107
122
108
123
```shell
109
124
$ uv run dremio-mcp-server config create claude
110
125
```
111
126
112
-
3. Validate the config files using
127
+
4. Validate the config files using
113
128
114
129
```shell
115
130
$ uv run dremio-mcp-server config list --type claude
0 commit comments