@iris-eval/mcp-server 0.1.7 → 0.1.8

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 CHANGED
@@ -32,9 +32,11 @@ Iris evaluates all of it.
32
32
  | **Cost Visibility** | Aggregate cost across all agents over any time window. Set budget thresholds. Get flagged when agents overspend. |
33
33
  | **Web Dashboard** | Real-time dark-mode UI with trace visualization, eval results, and cost breakdowns. |
34
34
 
35
+ **Requires Node.js 20 or later.** Check with `node --version`.
36
+
35
37
  ## Quickstart
36
38
 
37
- Add Iris to your Claude Desktop (or Cursor, Claude Code, Windsurf) MCP config:
39
+ Add Iris to your MCP config. Works with Claude Desktop, Cursor, Windsurf, and any MCP-compatible agent.
38
40
 
39
41
  ```json
40
42
  {
@@ -56,10 +58,37 @@ npx @iris-eval/mcp-server --dashboard
56
58
  # Open http://localhost:6920
57
59
  ```
58
60
 
61
+ <details>
62
+ <summary><strong>Setup by tool</strong></summary>
63
+
64
+ #### Claude Desktop
65
+
66
+ Edit your MCP config file:
67
+ - **macOS:** `~/Library/Application Support/Claude/claude_desktop_config.json`
68
+ - **Windows:** `%APPDATA%\Claude\claude_desktop_config.json`
69
+
70
+ Add the JSON config above, then restart Claude Desktop.
71
+
72
+ #### Claude Code
73
+
74
+ ```bash
75
+ claude mcp add --transport stdio iris-eval -- npx @iris-eval/mcp-server
76
+ ```
77
+
78
+ Then restart the session (`/clear` or relaunch) for tools to load.
79
+
80
+ > **Windows note:** Do *not* use `cmd /c` wrapper — it causes path parsing issues. The `npx` command works directly.
81
+
82
+ #### Cursor / Windsurf
83
+
84
+ Add to your workspace `.cursor/mcp.json` or global MCP settings using the JSON config above.
85
+
86
+ </details>
87
+
59
88
  ### Other Install Methods
60
89
 
61
90
  ```bash
62
- # Global install
91
+ # Global install (recommended for persistent data and faster startup)
63
92
  npm install -g @iris-eval/mcp-server
64
93
  iris-mcp --dashboard
65
94
 
@@ -67,6 +96,8 @@ iris-mcp --dashboard
67
96
  docker run -p 3000:3000 -v iris-data:/data ghcr.io/iris-eval/mcp-server
68
97
  ```
69
98
 
99
+ > **Tip:** Global install (`npm install -g`) stores traces persistently at `~/.iris/iris.db`. With `npx`, traces persist in the same location, but startup is slower due to package resolution.
100
+
70
101
  ## MCP Tools
71
102
 
72
103
  Iris registers three tools that any MCP-compatible agent can invoke:
@@ -143,6 +174,68 @@ iris-mcp --transport http --port 3000 --api-key "$(openssl rand -hex 32)" --dash
143
174
 
144
175
  </details>
145
176
 
177
+ <details>
178
+ <summary><strong>Troubleshooting</strong></summary>
179
+
180
+ ### Iris won't start / `ERR_MODULE_NOT_FOUND`
181
+
182
+ You may have a cached older version. Clear the npx cache and retry:
183
+
184
+ ```bash
185
+ npx --yes @iris-eval/mcp-server@latest
186
+ ```
187
+
188
+ Or install globally to avoid cache issues entirely:
189
+
190
+ ```bash
191
+ npm install -g @iris-eval/mcp-server@latest
192
+ ```
193
+
194
+ ### Tools not showing up in Claude Code
195
+
196
+ MCP tools only load at session start. After adding iris-eval, restart the session with `/clear` or relaunch the terminal.
197
+
198
+ ### Version check
199
+
200
+ Verify which version is running:
201
+
202
+ ```bash
203
+ npx @iris-eval/mcp-server --help
204
+ # Shows "Iris MCP-Native Agent Eval & Observability Server vX.Y.Z"
205
+ ```
206
+
207
+ ### Updating
208
+
209
+ ```bash
210
+ # If using npx (clears cache and fetches latest)
211
+ npx --yes @iris-eval/mcp-server@latest
212
+
213
+ # If installed globally
214
+ npm update -g @iris-eval/mcp-server
215
+ ```
216
+
217
+ ### Node.js version
218
+
219
+ Iris requires Node.js 20 or later. Node 18 reached EOL in April 2025 and is not supported.
220
+
221
+ ```bash
222
+ node --version # Must be v20.x or v22.x+
223
+ ```
224
+
225
+ ### Windows: `cmd /c` not needed
226
+
227
+ Claude Code's `/doctor` may suggest wrapping npx with `cmd /c`. This is not needed and causes path parsing issues. Use `npx` directly:
228
+
229
+ ```bash
230
+ # Correct
231
+ claude mcp add --transport stdio iris-eval -- npx @iris-eval/mcp-server
232
+
233
+ # Wrong (causes /c to be parsed as a path)
234
+ claude mcp add --transport stdio iris-eval -- cmd /c "npx @iris-eval/mcp-server"
235
+ ```
236
+
237
+ </details>
238
+
146
239
  ---
147
240
 
148
241
  If Iris is useful to you, [consider starring the repo](https://github.com/iris-eval/mcp-server) — it helps others find it.
@@ -3,7 +3,7 @@ import { readFileSync } from 'node:fs';
3
3
  import { homedir } from 'node:os';
4
4
  const irisHome = join(homedir(), '.iris');
5
5
  // Read version from package.json to avoid hardcoded drift
6
- let pkgVersion = '0.1.7';
6
+ let pkgVersion = '0.1.8';
7
7
  try {
8
8
  const pkg = JSON.parse(readFileSync(new URL('../../package.json', import.meta.url), 'utf8'));
9
9
  pkgVersion = pkg.version;