@@ -19,13 +19,12 @@ A Model Context Protocol (MCP) server that provides MetricFlow CLI tools through
19
19
- [ Setup] ( #setup )
20
20
- [ Configuration] ( #configuration )
21
21
- [ 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- )
24
24
- [ API Key Authentication] ( #api-key-authentication )
25
25
- [ Available Tools] ( #available-tools )
26
26
- [ Project Structure] ( #project-structure )
27
27
- [ Contributing ✨] ( #contributing- )
28
- - [ TODO] ( #todo )
29
28
30
29
## Overview
31
30
@@ -50,9 +49,9 @@ Edit the `.env` file with your specific configuration:
50
49
DBT_PROJECT_DIR=/path/to/your/dbt/project e.g. /Users/dat/repos/il/jaffle-shop
51
50
52
51
# Optional: Other configurations
53
- DBT_PROFILES_DIR=~ /.dbt
52
+ DBT_PROFILES_DIR=/path/to /.dbt
54
53
MF_PATH=mf
55
- MF_TMP_DIR=/tmp
54
+ MF_TMP_DIR=/path/to/ tmp
56
55
57
56
# SSE server configuration (optional)
58
57
MCP_HOST=localhost
@@ -65,13 +64,20 @@ MCP_REQUIRE_AUTH=false
65
64
66
65
## Running the MCP Server
67
66
68
- ### STDIO Mode
67
+ ### STDIO Mode ✅
69
68
70
69
For integration with Claude Desktop (or any other MCP Client tool), use STDIO mode with the following ` uvx ` command:
71
70
72
71
``` 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:
74
76
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
75
81
```
76
82
77
83
Add this configuration to the respective client's config file:
@@ -82,16 +88,20 @@ Add this configuration to the respective client's config file:
82
88
"mcp-metricflow" : {
83
89
"command" : " uvx" ,
84
90
"args" : [
85
- " --env-file" ,
86
- " <path-to-.env-file> " ,
91
+ " --env-file" , " <path-to-.env-file> " ,
92
+ " --with " , " mcp-metricflow[snowflake] " ,
87
93
" mcp-metricflow"
88
94
]
89
95
},
90
96
}
91
97
}
92
98
```
93
99
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 🚧
95
105
96
106
For web-based integration or direct HTTP access:
97
107
@@ -192,6 +202,3 @@ Finally, super thanks to our *Contributors*:
192
202
<a href =" https://github.com/datnguye/mcp-metricflow/graphs/contributors " >
193
203
<img src =" https://contrib.rocks/image?repo=datnguye/mcp-metricflow " />
194
204
</a >
195
-
196
- ## TODO
197
- - Test STDIO mode
0 commit comments