Repository navigation
Commit a4b9fa8
authored
feat(mcp): improve MCP tool quality — error hints, shared helpers, better messages (#2337)
## What
Targeted improvements to MCP tool quality, identified and validated through performance evals against real agent workflows. These changes reduce tool-call failures, improve agent self-correction, and make tool outputs more actionable.
### Query tools: top-level `where` + orderBy resolution
**Table & Timeseries** now accept a top-level `where` / `whereLanguage` that scopes the entire query. A shared `mergeWhereIntoSelectItems()` helper injects it into each select item's aggCondition (ANDed with any per-item where). No more duplicated merge logic.
**Table** gets an `orderBy` resolver: agents frequently write `orderBy: "count"`, which generates `ORDER BY count ASC` — but ClickHouse can't resolve bare `count` since it's a function. The resolver maps aggFn names to aliases or synthesized expressions (`count()`, `avg(Duration)`, etc.).
**Timeseries** now detects single-bucket collapse (1 row returned with explicit granularity) and adds a hint to adjust the time range or granularity.
### Event patterns: topN, trendBuckets, restructured output
- `topN` (1-100, default 20) — control how many patterns are returned
- `trendBuckets` (0-60, default 24) — set to 0 to disable trend sparklines (smaller response)
- Output restructured: top-level `summary` + `patterns` array + `usage` guide
- Each pattern now includes `rank` and `shareOfTotal` for easier analysis
### Schema & description improvements
- Richer tool descriptions with concrete examples, common mistakes, and expression tips
- `MCP_AGG_FN_OPTIONS` extracted as shared constant (single source of truth for aggFn names)
- `whereLanguage` description now includes syntax matching guidance and common mistakes
- `groupBy` documents multi-column comma-delimited input and arbitrary ClickHouse expressions
- `valueExpression` description shows useful patterns (duration conversion, attribute casting, boolean→numeric)
### Infrastructure
- **Error hints**: Duplicated ClickHouse catch blocks extracted into `clickHouseErrorResult()` with pattern-matched hints for DateTime64 casting, AS alias quoting, and response size overflow
- **`trimToolResponse`**: Now returns `{ data, isTrimmed }` so callers detect trimming without re-serializing
- **Dashboard schemas**: `granularity` added to line/stacked_bar external dashboard zod schemas
- **`describeSource`**: Switched to compact JSON output (saves context tokens)
- **Better not-found messages**: Source/connection not-found errors suggest calling `hyperdx_list_sources`
- **Regex fix**: `errorHint` AS-alias regex uses `\bAS\b` word boundary to avoid false matches on words like DATABASE, ALIAS
## Why
These changes came out of running MCP performance evals against real agent tasks. The combined effect:
- Error hints cut agent confusion loops on ClickHouse-specific errors
- orderBy resolution eliminates the most common ClickHouse ORDER BY failure mode
- Top-level where reduces multi-step filter workarounds
- Restructured event pattern output makes pattern analysis workflows significantly more reliable
> **Coming soon:** We're building out a structured eval framework for MCP tool performance. Stay tuned — we'll be sharing the harness, benchmark suite, and results publicly.
## Files changed (12)
| File | Change |
|------|--------|
| `helpers.ts` | `mergeWhereIntoSelectItems()`, `clickHouseErrorResult()`, error hints, better not-found messages |
| `table.ts` | Top-level where, orderBy resolver, updated descriptions |
| `timeseries.ts` | Top-level where, single-bucket collapse detection |
| `schemas.ts` | `MCP_AGG_FN_OPTIONS`, richer descriptions for all fields |
| `eventPatterns.ts` | `topN`, `trendBuckets` parameters |
| `runEventPatterns.ts` | Restructured output format, shareOfTotal, rank |
| `describeSource.ts` | Compact JSON, trimToolResponse API update |
| `dashboards.ts` | `granularity` in `convertToInternalTileConfig` |
| `trimToolResponse.ts` | Returns `{ data, isTrimmed }` |
| `trimToolResponse.test.ts` | Updated tests for new return shape |
| `queryTool.test.ts` | Test for `topN` property |
| `zod.ts` | `SQLIntervalSchema` + `granularity` on time chart schemas |1 parent 3123db5 commit a4b9fa8
13 files changed
Lines changed: 848 additions & 158 deletions
File tree
- .changeset
- packages/api/src
- mcp
- __tests__
- tools
- query
- sources
- utils
- __tests__
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | | - | |
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
2 | 15 | | |
3 | 16 | | |
4 | 17 | | |
| |||
72 | 85 | | |
73 | 86 | | |
74 | 87 | | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
| 137 | + | |
| 138 | + | |
| 139 | + | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
| 151 | + | |
| 152 | + | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
| 158 | + | |
| 159 | + | |
| 160 | + | |
| 161 | + | |
| 162 | + | |
| 163 | + | |
| 164 | + | |
| 165 | + | |
| 166 | + | |
| 167 | + | |
| 168 | + | |
| 169 | + | |
| 170 | + | |
| 171 | + | |
| 172 | + | |
| 173 | + | |
| 174 | + | |
| 175 | + | |
| 176 | + | |
| 177 | + | |
| 178 | + | |
| 179 | + | |
| 180 | + | |
| 181 | + | |
| 182 | + | |
| 183 | + | |
| 184 | + | |
| 185 | + | |
| 186 | + | |
| 187 | + | |
| 188 | + | |
| 189 | + | |
| 190 | + | |
| 191 | + | |
| 192 | + | |
| 193 | + | |
| 194 | + | |
| 195 | + | |
| 196 | + | |
| 197 | + | |
| 198 | + | |
| 199 | + | |
| 200 | + | |
| 201 | + | |
| 202 | + | |
| 203 | + | |
| 204 | + | |
| 205 | + | |
| 206 | + | |
| 207 | + | |
| 208 | + | |
| 209 | + | |
| 210 | + | |
| 211 | + | |
| 212 | + | |
| 213 | + | |
| 214 | + | |
| 215 | + | |
| 216 | + | |
| 217 | + | |
| 218 | + | |
| 219 | + | |
| 220 | + | |
| 221 | + | |
| 222 | + | |
| 223 | + | |
| 224 | + | |
| 225 | + | |
| 226 | + | |
| 227 | + | |
| 228 | + | |
| 229 | + | |
| 230 | + | |
| 231 | + | |
| 232 | + | |
| 233 | + | |
| 234 | + | |
| 235 | + | |
| 236 | + | |
| 237 | + | |
| 238 | + | |
| 239 | + | |
| 240 | + | |
| 241 | + | |
| 242 | + | |
| 243 | + | |
| 244 | + | |
| 245 | + | |
| 246 | + | |
| 247 | + | |
| 248 | + | |
| 249 | + | |
| 250 | + | |
| 251 | + | |
| 252 | + | |
| 253 | + | |
| 254 | + | |
| 255 | + | |
| 256 | + | |
| 257 | + | |
| 258 | + | |
| 259 | + | |
| 260 | + | |
| 261 | + | |
| 262 | + | |
| 263 | + | |
| 264 | + | |
| 265 | + | |
| 266 | + | |
| 267 | + | |
| 268 | + | |
| 269 | + | |
| 270 | + | |
| 271 | + | |
| 272 | + | |
| 273 | + | |
| 274 | + | |
| 275 | + | |
| 276 | + | |
| 277 | + | |
| 278 | + | |
| 279 | + | |
| 280 | + | |
| 281 | + | |
| 282 | + | |
| 283 | + | |
| 284 | + | |
| 285 | + | |
| 286 | + | |
| 287 | + | |
| 288 | + | |
| 289 | + | |
| 290 | + | |
| 291 | + | |
| 292 | + | |
| 293 | + | |
| 294 | + | |
| 295 | + | |
| 296 | + | |
| 297 | + | |
| 298 | + | |
| 299 | + | |
| 300 | + | |
| 301 | + | |
| 302 | + | |
| 303 | + | |
| 304 | + | |
| 305 | + | |
| 306 | + | |
| 307 | + | |
| 308 | + | |
| 309 | + | |
| 310 | + | |
| 311 | + | |
| 312 | + | |
| 313 | + | |
| 314 | + | |
| 315 | + | |
| 316 | + | |
| 317 | + | |
| 318 | + | |
| 319 | + | |
| 320 | + | |
| 321 | + | |
| 322 | + | |
| 323 | + | |
| 324 | + | |
| 325 | + | |
| 326 | + | |
| 327 | + | |
| 328 | + | |
| 329 | + | |
| 330 | + | |
| 331 | + | |
| 332 | + | |
| 333 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
138 | 138 | | |
139 | 139 | | |
140 | 140 | | |
| 141 | + | |
141 | 142 | | |
142 | 143 | | |
143 | 144 | | |
| |||
370 | 371 | | |
371 | 372 | | |
372 | 373 | | |
373 | | - | |
374 | | - | |
375 | | - | |
376 | | - | |
377 | | - | |
378 | | - | |
379 | | - | |
380 | | - | |
| 374 | + | |
| 375 | + | |
| 376 | + | |
| 377 | + | |
| 378 | + | |
| 379 | + | |
| 380 | + | |
| 381 | + | |
381 | 382 | | |
382 | 383 | | |
383 | 384 | | |
| |||
391 | 392 | | |
392 | 393 | | |
393 | 394 | | |
394 | | - | |
395 | | - | |
396 | | - | |
| 395 | + | |
| 396 | + | |
| 397 | + | |
397 | 398 | | |
398 | 399 | | |
399 | 400 | | |
| |||
407 | 408 | | |
408 | 409 | | |
409 | 410 | | |
410 | | - | |
| 411 | + | |
411 | 412 | | |
412 | 413 | | |
413 | 414 | | |
| |||
503 | 504 | | |
504 | 505 | | |
505 | 506 | | |
506 | | - | |
| 507 | + | |
| 508 | + | |
507 | 509 | | |
508 | 510 | | |
509 | | - | |
| 511 | + | |
510 | 512 | | |
511 | 513 | | |
512 | 514 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
526 | 526 | | |
527 | 527 | | |
528 | 528 | | |
529 | | - | |
| 529 | + | |
| 530 | + | |
| 531 | + | |
| 532 | + | |
| 533 | + | |
| 534 | + | |
| 535 | + | |
| 536 | + | |
530 | 537 | | |
531 | 538 | | |
532 | 539 | | |
533 | 540 | | |
534 | 541 | | |
535 | | - | |
| 542 | + | |
536 | 543 | | |
537 | 544 | | |
538 | 545 | | |
| |||
0 commit comments