umami-compass 0.1.1 → 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +23 -13
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +1 -1
- package/server.json +2 -2
package/README.md
CHANGED
|
@@ -12,9 +12,9 @@
|
|
|
12
12
|
|
|
13
13
|
Umami Compass is a secure, read-only [Model Context Protocol](https://modelcontextprotocol.io/) server for [Umami Analytics](https://umami.is/). It gives MCP clients accurate Umami 3.2 analytics without exposing a database or allowing arbitrary network requests.
|
|
14
14
|
|
|
15
|
-
Version `0.1.
|
|
15
|
+
Version `0.1.2` is the current patch release. See [Compatibility](#compatibility) before using it with older Umami versions.
|
|
16
16
|
|
|
17
|
-
> The `npx` examples
|
|
17
|
+
> The `npx` examples follow the stable npm release channel and check it whenever the MCP process starts. For source-based evaluation, clone this repository, run `pnpm install --frozen-lockfile && pnpm build`, and use `node /absolute/path/to/umami-compass/dist/cli.js` as the MCP command.
|
|
18
18
|
|
|
19
19
|
## Why this project
|
|
20
20
|
|
|
@@ -33,6 +33,16 @@ See the dated [landscape review](docs/research/umami-mcp-landscape-2026-07.md) f
|
|
|
33
33
|
|
|
34
34
|
Requirements: Node.js 22 or newer and an Umami identity with view-only access where possible.
|
|
35
35
|
|
|
36
|
+
The examples use the auto-updating stable launcher:
|
|
37
|
+
|
|
38
|
+
```sh
|
|
39
|
+
npx --yes --prefer-online umami-compass@latest
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
`@latest` selects the stable npm channel and `--prefer-online` makes npm check the registry even when package metadata is cached. npm still reuses the cached package when that exact release is already present. Updates take effect the next time the MCP process starts; an already running local server cannot replace itself.
|
|
43
|
+
|
|
44
|
+
Use `umami-compass@next` instead to opt into preview releases. For reproducible CI or centrally managed environments, pin an exact release and omit the online check, for example `npx --yes umami-compass@0.1.2`. Never use the preview channel for an unattended production setup.
|
|
45
|
+
|
|
36
46
|
### Umami Cloud
|
|
37
47
|
|
|
38
48
|
```json
|
|
@@ -40,7 +50,7 @@ Requirements: Node.js 22 or newer and an Umami identity with view-only access wh
|
|
|
40
50
|
"mcpServers": {
|
|
41
51
|
"umami": {
|
|
42
52
|
"command": "npx",
|
|
43
|
-
"args": ["-
|
|
53
|
+
"args": ["--yes", "--prefer-online", "umami-compass@latest"],
|
|
44
54
|
"env": {
|
|
45
55
|
"UMAMI_API_KEY": "replace-with-your-api-key"
|
|
46
56
|
}
|
|
@@ -58,7 +68,7 @@ With `UMAMI_API_KEY` and no URL, the API root defaults to `https://api.umami.is/
|
|
|
58
68
|
"mcpServers": {
|
|
59
69
|
"umami": {
|
|
60
70
|
"command": "npx",
|
|
61
|
-
"args": ["-
|
|
71
|
+
"args": ["--yes", "--prefer-online", "umami-compass@latest"],
|
|
62
72
|
"env": {
|
|
63
73
|
"UMAMI_URL": "https://analytics.example.com",
|
|
64
74
|
"UMAMI_USERNAME": "mcp-viewer",
|
|
@@ -138,11 +148,11 @@ Codex clients and ChatGPT desktop on the same host share `~/.codex/config.toml`.
|
|
|
138
148
|
```toml
|
|
139
149
|
[mcp_servers.umami-compass]
|
|
140
150
|
command = "npx"
|
|
141
|
-
args = ["-
|
|
151
|
+
args = ["--yes", "--prefer-online", "umami-compass@latest"]
|
|
142
152
|
env_vars = ["UMAMI_API_KEY"]
|
|
143
153
|
```
|
|
144
154
|
|
|
145
|
-
Run `codex mcp list` or `/mcp` to verify it. In the Codex IDE extension or ChatGPT desktop, you can also open **MCP servers**, add a **STDIO** server with command `npx -
|
|
155
|
+
Run `codex mcp list` or `/mcp` to verify it. In the Codex IDE extension or ChatGPT desktop, you can also open **MCP servers**, add a **STDIO** server with command `npx --yes --prefer-online umami-compass@latest`, then restart the client. See the official [Codex and ChatGPT MCP guide](https://developers.openai.com/codex/mcp/).
|
|
146
156
|
|
|
147
157
|
ChatGPT web does not read local Codex config. The current package is local stdio; a hosted plugin requires the future authenticated remote transport.
|
|
148
158
|
|
|
@@ -153,7 +163,7 @@ Use user scope to keep the personal server outside the repository:
|
|
|
153
163
|
```sh
|
|
154
164
|
claude mcp add --scope user --transport stdio \
|
|
155
165
|
--env UMAMI_API_KEY="$UMAMI_API_KEY" \
|
|
156
|
-
umami-compass -- npx -
|
|
166
|
+
umami-compass -- npx --yes --prefer-online umami-compass@latest
|
|
157
167
|
```
|
|
158
168
|
|
|
159
169
|
Verify with `claude mcp list` or `/mcp`. For a team-safe `.mcp.json`, Claude Code supports `${UMAMI_API_KEY}` expansion; never commit the actual value. See the official [Claude Code MCP guide](https://code.claude.com/docs/en/mcp).
|
|
@@ -167,7 +177,7 @@ Open **Settings → Developer → Edit Config**. On macOS the file is `~/Library
|
|
|
167
177
|
"mcpServers": {
|
|
168
178
|
"umami-compass": {
|
|
169
179
|
"command": "npx",
|
|
170
|
-
"args": ["-
|
|
180
|
+
"args": ["--yes", "--prefer-online", "umami-compass@latest"],
|
|
171
181
|
"env": {
|
|
172
182
|
"UMAMI_API_KEY": "replace-with-your-api-key"
|
|
173
183
|
}
|
|
@@ -187,7 +197,7 @@ Put this in the private global `~/.cursor/mcp.json`, or in `.cursor/mcp.json` on
|
|
|
187
197
|
"mcpServers": {
|
|
188
198
|
"umami-compass": {
|
|
189
199
|
"command": "npx",
|
|
190
|
-
"args": ["-
|
|
200
|
+
"args": ["--yes", "--prefer-online", "umami-compass@latest"],
|
|
191
201
|
"env": {
|
|
192
202
|
"UMAMI_API_KEY": "replace-with-your-api-key"
|
|
193
203
|
}
|
|
@@ -216,7 +226,7 @@ Use **MCP: Open User Configuration** for a personal config, or `.vscode/mcp.json
|
|
|
216
226
|
"umami-compass": {
|
|
217
227
|
"type": "stdio",
|
|
218
228
|
"command": "npx",
|
|
219
|
-
"args": ["-
|
|
229
|
+
"args": ["--yes", "--prefer-online", "umami-compass@latest"],
|
|
220
230
|
"env": {
|
|
221
231
|
"UMAMI_API_KEY": "${input:umami-api-key}"
|
|
222
232
|
}
|
|
@@ -236,7 +246,7 @@ Add this to the user-level `~/.gemini/settings.json` (or project `.gemini/settin
|
|
|
236
246
|
"mcpServers": {
|
|
237
247
|
"umami-compass": {
|
|
238
248
|
"command": "npx",
|
|
239
|
-
"args": ["-
|
|
249
|
+
"args": ["--yes", "--prefer-online", "umami-compass@latest"],
|
|
240
250
|
"env": {
|
|
241
251
|
"UMAMI_API_KEY": "$UMAMI_API_KEY"
|
|
242
252
|
},
|
|
@@ -250,8 +260,8 @@ Verify with `gemini mcp list` or `/mcp`. See the official [Gemini CLI MCP guide]
|
|
|
250
260
|
|
|
251
261
|
### Troubleshooting
|
|
252
262
|
|
|
253
|
-
- Run `npx -
|
|
254
|
-
- A client showing
|
|
263
|
+
- Run `npx --yes --prefer-online umami-compass@latest --version` first; Node.js 22+ is required.
|
|
264
|
+
- After a package update, restart the MCP server so the client requests the new tool list. A client still showing an old or empty list may also need its cached tools cleared.
|
|
255
265
|
- `401` means the credential or auth mode is wrong; `403` can mean the Umami account lacks permission for that website section.
|
|
256
266
|
- For self-hosted local development, `http://localhost:3000` is allowed. Other plain HTTP origins require the explicit unsafe opt-in.
|
|
257
267
|
- Start with the default toolsets. Enable `performance`, `reports`, `revenue`, `replay`, or `heatmaps` only as needed.
|
package/dist/version.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export declare const VERSION = "0.1.
|
|
1
|
+
export declare const VERSION = "0.1.2";
|
|
2
2
|
//# sourceMappingURL=version.d.ts.map
|
package/dist/version.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export const VERSION = "0.1.
|
|
1
|
+
export const VERSION = "0.1.2";
|
|
2
2
|
//# sourceMappingURL=version.js.map
|
package/package.json
CHANGED
package/server.json
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
"name": "io.github.webcredo/umami-compass",
|
|
4
4
|
"title": "Umami Compass",
|
|
5
5
|
"description": "Secure Umami Analytics MCP server for Cloud and self-hosted deployments",
|
|
6
|
-
"version": "0.1.
|
|
6
|
+
"version": "0.1.2",
|
|
7
7
|
"websiteUrl": "https://github.com/webcredo/umami-compass",
|
|
8
8
|
"repository": {
|
|
9
9
|
"url": "https://github.com/webcredo/umami-compass",
|
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
"registryType": "npm",
|
|
16
16
|
"registryBaseUrl": "https://registry.npmjs.org",
|
|
17
17
|
"identifier": "umami-compass",
|
|
18
|
-
"version": "0.1.
|
|
18
|
+
"version": "0.1.2",
|
|
19
19
|
"runtimeHint": "npx",
|
|
20
20
|
"transport": {
|
|
21
21
|
"type": "stdio"
|