Skip to content

Commit 2f618fe

Browse files
committed
docs: update readme
1 parent 2b624e5 commit 2f618fe

File tree

1 file changed

+20
-13
lines changed

1 file changed

+20
-13
lines changed

README.md

Lines changed: 20 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,12 @@ A Model Context Protocol (MCP) server that provides MetricFlow CLI tools through
1919
- [Setup](#setup)
2020
- [Configuration](#configuration)
2121
- [Running the MCP Server](#running-the-mcp-server)
22-
- [STDIO Mode](#stdio-mode)
23-
- [SSE Mode](#sse-mode)
22+
- [STDIO Mode](#stdio-mode-)
23+
- [SSE Mode 🚧](#sse-mode-)
2424
- [API Key Authentication](#api-key-authentication)
2525
- [Available Tools](#available-tools)
2626
- [Project Structure](#project-structure)
2727
- [Contributing ✨](#contributing-)
28-
- [TODO](#todo)
2928

3029
## Overview
3130

@@ -50,9 +49,9 @@ Edit the `.env` file with your specific configuration:
5049
DBT_PROJECT_DIR=/path/to/your/dbt/project e.g. /Users/dat/repos/il/jaffle-shop
5150

5251
# Optional: Other configurations
53-
DBT_PROFILES_DIR=~/.dbt
52+
DBT_PROFILES_DIR=/path/to/.dbt
5453
MF_PATH=mf
55-
MF_TMP_DIR=/tmp
54+
MF_TMP_DIR=/path/to/tmp
5655

5756
# SSE server configuration (optional)
5857
MCP_HOST=localhost
@@ -65,13 +64,20 @@ MCP_REQUIRE_AUTH=false
6564

6665
## Running the MCP Server
6766

68-
### STDIO Mode
67+
### STDIO Mode
6968

7069
For integration with Claude Desktop (or any other MCP Client tool), use STDIO mode with the following `uvx` command:
7170

7271
```bash
73-
uvx --env-file /path/to/.env mcp-metricflow
72+
uvx --env-file /path/to/.env --with "mcp-metricflow[snowflake]" mcp-metricflow
73+
```
74+
75+
Sample `.env` file:
7476

77+
```bash
78+
DBT_PROJECT_DIR=/Users/xxx/sources/jaffle-shop
79+
DBT_PROFILES_DIR=/Users/xxx/.dbt
80+
MF_TMP_DIR=/Users/xxx/.dbt/tmp
7581
```
7682

7783
Add this configuration to the respective client's config file:
@@ -82,16 +88,20 @@ Add this configuration to the respective client's config file:
8288
"mcp-metricflow": {
8389
"command": "uvx",
8490
"args": [
85-
"--env-file",
86-
"<path-to-.env-file>",
91+
"--env-file", "<path-to-.env-file>",
92+
"--with", "mcp-metricflow[snowflake]",
8793
"mcp-metricflow"
8894
]
8995
},
9096
}
9197
}
9298
```
9399

94-
### SSE Mode
100+
> NOTE: Currently only support Snowflake with this extra dependency specified: `"--with", "mcp-metricflow[snowflake]"`
101+
102+
> NOTE: We might have to use absolute path for example: `/Users/xxx/.local/bin/uvx` instead of `uvx` alone. Use `which uvx` to get the full path
103+
104+
### SSE Mode 🚧
95105

96106
For web-based integration or direct HTTP access:
97107

@@ -192,6 +202,3 @@ Finally, super thanks to our *Contributors*:
192202
<a href="https://github.com/datnguye/mcp-metricflow/graphs/contributors">
193203
<img src="https://contrib.rocks/image?repo=datnguye/mcp-metricflow" />
194204
</a>
195-
196-
## TODO
197-
- Test STDIO mode

0 commit comments

Comments
 (0)