@pipeworx/mcp-chrome-ux-report 0.1.0
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/LICENSE +21 -0
- package/README.md +169 -0
- package/bin/cli.js +17 -0
- package/package.json +32 -0
- package/server.json +18 -0
- package/src/index.ts +1047 -0
- package/src/server.ts +45 -0
- package/tsconfig.json +18 -0
package/src/index.ts
ADDED
|
@@ -0,0 +1,1047 @@
|
|
|
1
|
+
interface McpToolDefinition {
|
|
2
|
+
name: string;
|
|
3
|
+
description: string;
|
|
4
|
+
/** Human-facing one-liner (fleet #1967). Optional; consumers fall back to
|
|
5
|
+
* description. Kept in step with shared/src/types.ts — scripts/lib/
|
|
6
|
+
* check-inlined-types.mjs reports drift at publish time. */
|
|
7
|
+
summary?: string;
|
|
8
|
+
inputSchema: {
|
|
9
|
+
type: 'object';
|
|
10
|
+
properties: Record<string, unknown>;
|
|
11
|
+
required?: string[];
|
|
12
|
+
anyOf?: Array<{ required: string[] }>;
|
|
13
|
+
oneOf?: Array<{ required: string[] }>;
|
|
14
|
+
allOf?: Array<{ required: string[] }>;
|
|
15
|
+
};
|
|
16
|
+
outputSchema?: Record<string, unknown>;
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
interface McpToolExport {
|
|
20
|
+
tools: McpToolDefinition[];
|
|
21
|
+
callTool: (name: string, args: Record<string, unknown>) => Promise<unknown>;
|
|
22
|
+
meter?: { credits: number };
|
|
23
|
+
cost?: Record<string, unknown>;
|
|
24
|
+
provider?: string;
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
/**
|
|
28
|
+
* Was this failure OUR OWN web service? — the other half of `internal-db-class.ts`.
|
|
29
|
+
*
|
|
30
|
+
* fleet #1089 pulled failures from our own Postgres out of `upstream_down` by
|
|
31
|
+
* keying on the SQLSTATE inside PostgREST's four-key error envelope. That
|
|
32
|
+
* covered the majority and structurally could not cover the rest: the rest
|
|
33
|
+
* never reach Postgres, so they carry no SQLSTATE. What was left, measured over
|
|
34
|
+
* the 24h to 2026-09-02T15:00Z (fleet #1096):
|
|
35
|
+
*
|
|
36
|
+
* 5 pipeworx-catalog get_pack_tools Pipeworx catalog error: 522 — error code: 522
|
|
37
|
+
* 3 fleet fleet_list_open … upstream_down: Fleet task queue did not respond within 25s
|
|
38
|
+
*
|
|
39
|
+
* 521/522/523/526 are Cloudflare saying its edge could not reach an ORIGIN, and
|
|
40
|
+
* in both of those rows the origin is ours — `gateway.pipeworx.io` for the
|
|
41
|
+
* catalog pack (it self-fetches when the gateway hasn't injected a manifest),
|
|
42
|
+
* our own Supabase for fleet. There is no third party anywhere in either call.
|
|
43
|
+
* Same defect as #1089: our own outage filed under `upstream_down`, the one
|
|
44
|
+
* class that means "the source is unreachable and there is nothing for us to
|
|
45
|
+
* fix", which is why the problem-tools triage skips it.
|
|
46
|
+
*
|
|
47
|
+
* WHY NOT A WORDING RULE. The obvious fix is to match `fleet db error:` and
|
|
48
|
+
* `Pipeworx catalog error:` in classifyToolError. Each is emitted from exactly
|
|
49
|
+
* one site today, so it would work today. It would also rot the first time
|
|
50
|
+
* somebody rewords a label — silently, and in the direction of hiding our own
|
|
51
|
+
* outage, which is worse than the bug being fixed. Every prose rule in
|
|
52
|
+
* error-class.ts has needed widening as packs invented new wording (#409/#450/
|
|
53
|
+
* #584); that history is most of that file's comment budget.
|
|
54
|
+
*
|
|
55
|
+
* WHAT THIS KEYS ON INSTEAD: **the host the call actually reached.** A URL's
|
|
56
|
+
* hostname is a fact about the call, not a guess about its prose. Two
|
|
57
|
+
* consequences that a pack-level flag could not give us, and the reason the
|
|
58
|
+
* flag was rejected:
|
|
59
|
+
*
|
|
60
|
+
* - It describes the CALL, not the pack. `govcon-intel` fans out to our own
|
|
61
|
+
* Supabase AND to genuine third parties; `court-listener` holds our cache
|
|
62
|
+
* in Supabase and fetches courtlistener.com. An `internallyHosted: true` on
|
|
63
|
+
* either pack would relabel a real third-party outage as ours — inventing
|
|
64
|
+
* work, which is the same class of error in the opposite direction.
|
|
65
|
+
* - It covers every future internal pack for free, instead of one declared
|
|
66
|
+
* slug at a time.
|
|
67
|
+
*
|
|
68
|
+
* WHY IT SURVIVES A REWORD. The marker below is not matched as a literal by two
|
|
69
|
+
* separate files. `markInternalOrigin()` writes it and `internalHostMetricsClass()`
|
|
70
|
+
* reads it, both from the single exported `INTERNAL_ORIGIN_MARKER` constant in
|
|
71
|
+
* this module — so changing the wording changes both sides in the same edit and
|
|
72
|
+
* cannot desynchronise them. The pack's own label (`fleet db error:`,
|
|
73
|
+
* `Pipeworx catalog error:`) is not read at all: reword it freely, the class is
|
|
74
|
+
* unaffected. That is the property `stripClassPrefix` lacked when it drifted
|
|
75
|
+
* from its own classifier three times and needed a CI gate to hold them
|
|
76
|
+
* together.
|
|
77
|
+
*
|
|
78
|
+
* WHERE THE 5xx TEST LIVES. `markInternalOrigin` is called from the places that
|
|
79
|
+
* hold the real `Response` — `httpError`/`httpErrorMessage` and the timeout
|
|
80
|
+
* branch of `fetchWithTimeout` in `shared/src/http.ts` — so "is this an
|
|
81
|
+
* availability failure" is decided from the actual status code, never re-derived
|
|
82
|
+
* by scraping a number out of a sentence. A 404 from our own registry for a slug
|
|
83
|
+
* that does not exist is a caller's bad argument and is deliberately NOT marked.
|
|
84
|
+
*/
|
|
85
|
+
|
|
86
|
+
/**
|
|
87
|
+
* OUR OWN web service was unreachable — not an upstream, and never `upstream_down`.
|
|
88
|
+
*
|
|
89
|
+
* ONE value, not three, unlike `internal_db_*`. That split existed because a
|
|
90
|
+
* slow query, an exhausted pool and an unknown SQLSTATE have different owners
|
|
91
|
+
* and different fixes. Here there is only one story to tell — an origin we run
|
|
92
|
+
* did not answer the edge — and one owner. A bucket with no distinct owner per
|
|
93
|
+
* value is decoration; #724 is what happens when a class holds several
|
|
94
|
+
* situations, and inventing sub-values ahead of a reason to act on them
|
|
95
|
+
* differently is the same mistake with the sign flipped.
|
|
96
|
+
*
|
|
97
|
+
* METRICS ONLY, exactly like PLATFORM_KEY_ERROR_CLASS and the internal_db
|
|
98
|
+
* values. `classifyToolError` still answers `upstream_down` for the retry and
|
|
99
|
+
* hint paths, which only care whether retrying or a sibling tool might work —
|
|
100
|
+
* and it might. Nothing a caller sees or is charged changes here.
|
|
101
|
+
*
|
|
102
|
+
* READ SIDE: this value is in BROKEN_TOOL_CLASSES, FAULT_CLASSES and
|
|
103
|
+
* ALL_ERROR_CLASSES in `workers/registry-api/src/index.ts`. All three, or it
|
|
104
|
+
* lands on no dashboard — fleet #721 is the warning, where the #719 split
|
|
105
|
+
* worked on the write side and was invisible for weeks.
|
|
106
|
+
*/
|
|
107
|
+
const INTERNAL_SERVICE_UNREACHABLE_CLASS = 'internal_service_unreachable';
|
|
108
|
+
|
|
109
|
+
/**
|
|
110
|
+
* The token that carries "this origin is ours" from the call site to the
|
|
111
|
+
* classifier.
|
|
112
|
+
*
|
|
113
|
+
* Appended to the error message rather than attached to the Error object,
|
|
114
|
+
* because the object does not survive the trip: 275 packs return `{ error:
|
|
115
|
+
* string }` instead of throwing, the gateway reads `observedError` as a string,
|
|
116
|
+
* and the fleet pack rebuilds its error from a captured status + body across a
|
|
117
|
+
* retry loop. A property on an Error would be dropped by every one of those
|
|
118
|
+
* paths and the class would work in tests and vanish in production.
|
|
119
|
+
*
|
|
120
|
+
* WORDING IS LOAD-BEARING, same rule as labelAge's note in authority.ts. This
|
|
121
|
+
* string is appended to a pack's thrown Error message (shared/src/http.ts),
|
|
122
|
+
* and a thrown Error's message is exactly what the gateway hands back to the
|
|
123
|
+
* caller as `content[0].text` when nothing rewrites it (workers/gateway/src
|
|
124
|
+
* catches the throw and sets `rawResult.message = stripClassPrefix(error)`,
|
|
125
|
+
* which does not touch this suffix) — so the original wording,
|
|
126
|
+
* " [pipeworx-hosted origin — our own service, not a third party]", was not a
|
|
127
|
+
* theoretical leak: it shipped live on pipeworx-catalog's 522s, 7 times in 6
|
|
128
|
+
* hours on 2026-09-02 (see tests/golden-internal-service.test.ts), verbatim
|
|
129
|
+
* naming Pipeworx as the host. check:hosting-claims never caught it because it
|
|
130
|
+
* did not scan shared/ at all (task #2009). Reworded to describe the
|
|
131
|
+
* OBSERVATION (the origin did not answer) without a claim about who runs it —
|
|
132
|
+
* the identical fix labelAge got: drop the possessive, keep the fact.
|
|
133
|
+
*/
|
|
134
|
+
const INTERNAL_ORIGIN_MARKER = ' [origin did not respond — retry before concluding the named source is down]';
|
|
135
|
+
|
|
136
|
+
/**
|
|
137
|
+
* Supabase's data plane for a project is `<ref>.supabase.co`, where the ref is
|
|
138
|
+
* exactly twenty lowercase letters (ours is `pqauisounztsgdgfkhke`).
|
|
139
|
+
*
|
|
140
|
+
* Matching the shape rather than listing the ref keeps this correct when we add
|
|
141
|
+
* a project — `supabaseEnv` on a pack entry already points some packs at a
|
|
142
|
+
* second one — while still excluding `status.supabase.co`, which is Supabase's
|
|
143
|
+
* own status page and emphatically not our database. Verified 2026-09-02 by
|
|
144
|
+
* `grep -rhoE '[a-z0-9-]+\.supabase\.(co|in)' mcps shared workers scripts`: the
|
|
145
|
+
* only real project ref anywhere in the tree is ours, the rest are doc
|
|
146
|
+
* placeholders (`abc`, `xyz`, `example`) which this pattern also excludes. Same
|
|
147
|
+
* finding internal-db-class.ts relies on for the PostgREST envelope being ours
|
|
148
|
+
* by construction.
|
|
149
|
+
*/
|
|
150
|
+
const SUPABASE_PROJECT_HOST = /^[a-z]{20}\.supabase\.(co|in)$/;
|
|
151
|
+
|
|
152
|
+
/**
|
|
153
|
+
* Is this a host WE run?
|
|
154
|
+
*
|
|
155
|
+
* Deliberately NOT including `*.workers.dev`: plenty of third-party APIs are
|
|
156
|
+
* hosted on workers.dev, so the suffix says where something runs and not who
|
|
157
|
+
* owns it. Every internal call we actually make goes to a `pipeworx.io`
|
|
158
|
+
* hostname or to our Supabase project, both of which are ownership facts.
|
|
159
|
+
*
|
|
160
|
+
* `workers/gateway/src/provenance.ts`'s `OUR_HOSTS` answers the same
|
|
161
|
+
* question and DOES include `workers.dev` — a documented divergence
|
|
162
|
+
* (task #2051), not a bug to converge. That list decides what a response may
|
|
163
|
+
* cite as a data SOURCE, where a false negative (citing our own worker as an
|
|
164
|
+
* external source) is the hosting-disclosure leak this whole file exists to
|
|
165
|
+
* prevent, so it errs broad. This one decides who gets BLAMED for a 5xx in
|
|
166
|
+
* outage metrics read by on-call, where a false positive (crediting our own
|
|
167
|
+
* infra with a third party's outage) hides the real failure, so it errs
|
|
168
|
+
* narrow. Same suffix, opposite direction, because they are never called for
|
|
169
|
+
* the same reason.
|
|
170
|
+
*
|
|
171
|
+
* Returns false on anything unparseable rather than throwing — this runs inside
|
|
172
|
+
* an error path, and an error path that can itself throw turns a diagnosable
|
|
173
|
+
* failure into a mystery.
|
|
174
|
+
*/
|
|
175
|
+
function isPipeworxOrigin(url: string | URL | undefined | null): boolean {
|
|
176
|
+
if (!url) return false;
|
|
177
|
+
let host: string;
|
|
178
|
+
try {
|
|
179
|
+
host = new URL(url instanceof URL ? url.href : url).hostname.toLowerCase();
|
|
180
|
+
} catch {
|
|
181
|
+
return false;
|
|
182
|
+
}
|
|
183
|
+
if (host === 'pipeworx.io' || host.endsWith('.pipeworx.io')) return true;
|
|
184
|
+
return SUPABASE_PROJECT_HOST.test(host);
|
|
185
|
+
}
|
|
186
|
+
|
|
187
|
+
/**
|
|
188
|
+
* Append the marker when this failure was OUR origin failing to answer.
|
|
189
|
+
*
|
|
190
|
+
* `status` is the HTTP status when there is one, and omitted for a timeout —
|
|
191
|
+
* where there is no response at all, and "the origin did not answer" is the
|
|
192
|
+
* whole observation. Statuses below 500 are left alone: a 404 from our own
|
|
193
|
+
* registry for a slug that does not exist is the caller's argument, not our
|
|
194
|
+
* outage, and marking it would put ordinary 404s on the incident dashboard.
|
|
195
|
+
*
|
|
196
|
+
* Idempotent, so a message that is wrapped and re-marked on the way up (the
|
|
197
|
+
* fleet pack's retry loop re-throws through two layers) carries the marker once.
|
|
198
|
+
*/
|
|
199
|
+
function markInternalOrigin(
|
|
200
|
+
message: string,
|
|
201
|
+
url: string | URL | undefined | null,
|
|
202
|
+
status?: number,
|
|
203
|
+
): string {
|
|
204
|
+
if (status !== undefined && status < 500) return message;
|
|
205
|
+
if (!isPipeworxOrigin(url)) return message;
|
|
206
|
+
if (message.includes(INTERNAL_ORIGIN_MARKER)) return message;
|
|
207
|
+
return message + INTERNAL_ORIGIN_MARKER;
|
|
208
|
+
}
|
|
209
|
+
|
|
210
|
+
/**
|
|
211
|
+
* Which blob4 value a failure from our own web services books as, or undefined
|
|
212
|
+
* if this is not one.
|
|
213
|
+
*
|
|
214
|
+
* Ordered AFTER `internalDbMetricsClass` at the call site: a PostgREST envelope
|
|
215
|
+
* from our own Supabase is a strictly more specific statement about the same
|
|
216
|
+
* row (which of our services, and why), and the two cannot disagree about
|
|
217
|
+
* whether the failure is ours.
|
|
218
|
+
*/
|
|
219
|
+
function internalHostMetricsClass(error: string): string | undefined {
|
|
220
|
+
return error.includes(INTERNAL_ORIGIN_MARKER) ? INTERNAL_SERVICE_UNREACHABLE_CLASS : undefined;
|
|
221
|
+
}
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
/**
|
|
225
|
+
* One place to turn a failed `fetch` into an error a caller can act on.
|
|
226
|
+
*
|
|
227
|
+
* Nearly every pack was written the same way:
|
|
228
|
+
*
|
|
229
|
+
* if (!res.ok) throw new Error(`Unsplash: ${res.status}`);
|
|
230
|
+
*
|
|
231
|
+
* which discards the response body — and the body is usually where the upstream
|
|
232
|
+
* says what was actually wrong ("**symbol** not found: GBP", "parameter `year`
|
|
233
|
+
* out of range", "unknown taxonomy id"). The caller gets a number, cannot
|
|
234
|
+
* self-correct, and retries the same broken call. A 2026-07-31 sweep found this
|
|
235
|
+
* shape in 481 of 1,400 packs, 47 of them PLATFORM-keyed.
|
|
236
|
+
*
|
|
237
|
+
* It also hides bugs one level down. Two of the first three packs audited had a
|
|
238
|
+
* second defect that only existed because of this line: unsplash's rate-limit
|
|
239
|
+
* branch sat BELOW a catch-all and was unreachable, and bea-gov parsed
|
|
240
|
+
* `BEAAPI.Error.APIErrorDescription` below a `!res.ok` throw that made the
|
|
241
|
+
* parsing dead code for every non-200.
|
|
242
|
+
*
|
|
243
|
+
* DELIBERATELY NOT A CLASSIFIER. It does not add `user_error:` /
|
|
244
|
+
* `upstream_down:` prefixes. Those decide which tier a failure lands in, and the
|
|
245
|
+
* `error` tier is what the daily problem-tools list is built from — it means
|
|
246
|
+
* "Pipeworx has a defect". A 400 is genuinely ambiguous: often a caller's bad
|
|
247
|
+
* argument, but sometimes a query WE built wrong (ted-eu comma-joined its CPV
|
|
248
|
+
* values into something TED rejected, and that bug was found only because it sat
|
|
249
|
+
* in `error`). Blanket-classifying 400s as caller mistakes would have hidden it.
|
|
250
|
+
* A pack that KNOWS which it is should keep saying so explicitly; this helper is
|
|
251
|
+
* for the 481 that say nothing at all.
|
|
252
|
+
*/
|
|
253
|
+
|
|
254
|
+
/** Longest upstream explanation we'll pass through. Enough for a real message,
|
|
255
|
+
* short enough that an HTML page or a stack trace can't swamp the error. */
|
|
256
|
+
|
|
257
|
+
const MAX_DETAIL = 300;
|
|
258
|
+
|
|
259
|
+
/**
|
|
260
|
+
* Default bound for `fetchWithTimeout` when a pack doesn't state its own.
|
|
261
|
+
*
|
|
262
|
+
* 25s mirrors the number `epo-ops` landed on after measuring the real failure:
|
|
263
|
+
* a degraded upstream that doesn't error, it just never answers, and a Worker
|
|
264
|
+
* sits in `await fetch()` until ITS OWN execution budget kills the request —
|
|
265
|
+
* which can take minutes, not seconds (epo_ops_search_patents measured 4-8
|
|
266
|
+
* MINUTE hangs before this existed). 25s is short enough that a caller gets a
|
|
267
|
+
* fast, actionable error instead of holding the connection, and long enough
|
|
268
|
+
* that it doesn't false-trip on a merely-slow-but-alive upstream.
|
|
269
|
+
*/
|
|
270
|
+
const DEFAULT_FETCH_TIMEOUT_MS = 25_000;
|
|
271
|
+
|
|
272
|
+
/**
|
|
273
|
+
* Read the body of a failed response and fold it into a throwable Error.
|
|
274
|
+
*
|
|
275
|
+
* Usage — note the `await`, which is the one thing that makes this a mechanical
|
|
276
|
+
* change rather than a drop-in:
|
|
277
|
+
*
|
|
278
|
+
* if (!res.ok) throw await httpError(res, 'Unsplash');
|
|
279
|
+
*
|
|
280
|
+
* Safe to call on any non-ok response: a body that is missing, empty, unreadable
|
|
281
|
+
* or HTML degrades to exactly the old `Name: 404` string rather than throwing
|
|
282
|
+
* something new from inside the error path.
|
|
283
|
+
*/
|
|
284
|
+
async function httpError(res: Response, name: string): Promise<Error> {
|
|
285
|
+
return new Error(await httpErrorMessage(res, name));
|
|
286
|
+
}
|
|
287
|
+
|
|
288
|
+
/** The message text without constructing an Error — for packs that need to wrap
|
|
289
|
+
* it in their own envelope or add an explicit classification prefix. */
|
|
290
|
+
async function httpErrorMessage(res: Response, name: string): Promise<string> {
|
|
291
|
+
// The one place a 5xx from a host WE run gets stamped as ours. `res.url` is
|
|
292
|
+
// the URL the fetch actually resolved to (after redirects), so this is a fact
|
|
293
|
+
// about the call rather than a guess from the `name` the pack passed in —
|
|
294
|
+
// reword that label freely, the class does not move. See
|
|
295
|
+
// internal-host-class.ts; no-op for every third-party upstream, which is why
|
|
296
|
+
// this touches 481 packs' error text and changes none of it.
|
|
297
|
+
return markInternalOrigin(
|
|
298
|
+
`${name}: ${res.status}${detailSuffix(await readDetail(res))}`,
|
|
299
|
+
res.url,
|
|
300
|
+
res.status,
|
|
301
|
+
);
|
|
302
|
+
}
|
|
303
|
+
|
|
304
|
+
/**
|
|
305
|
+
* Just the upstream's own explanation — no name, no status.
|
|
306
|
+
*
|
|
307
|
+
* For a pack that has already said both in its own sentence. epo-ops reads
|
|
308
|
+
* `EPO rejected this search as too large (HTTP 413) — ${httpErrorMessage(…)}`,
|
|
309
|
+
* which rendered as `… (HTTP 413) — EPO: 413.` once the XML detail was being
|
|
310
|
+
* dropped: the upstream named twice, the status twice, and the one thing EPO
|
|
311
|
+
* actually said ("Not enough characters before truncation character") nowhere
|
|
312
|
+
* (fleet #712). Returns '' when the body carries nothing readable, so a caller
|
|
313
|
+
* can fall back to its own wording.
|
|
314
|
+
*/
|
|
315
|
+
async function upstreamDetail(res: Response): Promise<string> {
|
|
316
|
+
return readDetail(res);
|
|
317
|
+
}
|
|
318
|
+
|
|
319
|
+
/**
|
|
320
|
+
* Read a SUCCESSFUL response as JSON, failing loudly when it isn't JSON.
|
|
321
|
+
*
|
|
322
|
+
* `httpError` above only ever runs on `!res.ok`, which leaves the nastier half
|
|
323
|
+
* of the problem unhandled: an upstream that answers **HTTP 200 with an HTML
|
|
324
|
+
* page**. A bot wall, a login redirect, a maintenance interstitial and a CDN
|
|
325
|
+
* error page are all 200s, so `res.ok` is true, and `res.json()` then throws
|
|
326
|
+
* `Unexpected token '<', "<!DOCTYPE "... is not valid JSON`.
|
|
327
|
+
*
|
|
328
|
+
* That string is the problem. It names no upstream, carries no status, and
|
|
329
|
+
* reads like a parser bug in Pipeworx — so it lands in the `error` tier, which
|
|
330
|
+
* means "we have a defect", and the caller is told nothing they can act on.
|
|
331
|
+
* data.govt.nz sat dead behind an Imperva challenge this way and every
|
|
332
|
+
* status-code health check we own reported it green (7889a845). A zero-length
|
|
333
|
+
* body has the same shape: `Unexpected end of JSON input`, seen this week on
|
|
334
|
+
* uk-gazette (83% of external calls) and census.
|
|
335
|
+
*
|
|
336
|
+
* UNLIKE `httpError`, this one DOES classify, and the asymmetry is deliberate.
|
|
337
|
+
* A 400 is genuinely ambiguous — often the caller's bad argument, sometimes a
|
|
338
|
+
* query we built wrong — so blanket-classifying it would hide our own bugs.
|
|
339
|
+
* There is no such ambiguity here: **no argument a caller can pass makes a JSON
|
|
340
|
+
* API return an HTML page.** It is always the upstream, so `upstream_down:` is
|
|
341
|
+
* a statement of fact rather than a guess, and it keeps these out of the
|
|
342
|
+
* problem-tools list where they crowd out real defects.
|
|
343
|
+
*
|
|
344
|
+
* const data = await parseJson<Feed>(res, 'UK Gazette');
|
|
345
|
+
*
|
|
346
|
+
* Call it only after the `!res.ok` check — on a failed response you want
|
|
347
|
+
* `httpError`, which mines the body for the upstream's own explanation.
|
|
348
|
+
*/
|
|
349
|
+
async function parseJson<T>(res: Response, name: string): Promise<T> {
|
|
350
|
+
let raw: string;
|
|
351
|
+
try {
|
|
352
|
+
raw = await res.text();
|
|
353
|
+
} catch {
|
|
354
|
+
throw new Error(
|
|
355
|
+
`upstream_down: ${name} returned a body that could not be read (HTTP ${res.status}). ` +
|
|
356
|
+
'The connection most likely dropped mid-response; retrying is reasonable.',
|
|
357
|
+
);
|
|
358
|
+
}
|
|
359
|
+
|
|
360
|
+
const type = res.headers.get('content-type') ?? 'no content-type';
|
|
361
|
+
|
|
362
|
+
if (!raw.trim()) {
|
|
363
|
+
throw new Error(
|
|
364
|
+
`upstream_down: ${name} answered HTTP ${res.status} with an EMPTY body where JSON was expected (${type}). ` +
|
|
365
|
+
'Nothing about the request can cause this — it is an upstream fault, and the same call may well work on retry.',
|
|
366
|
+
);
|
|
367
|
+
}
|
|
368
|
+
|
|
369
|
+
// Checked before parsing rather than in the catch, because knowing it is
|
|
370
|
+
// markup is what turns "we failed to parse something" into "they served a
|
|
371
|
+
// web page" — the second is diagnosable, the first is not.
|
|
372
|
+
const head = raw.slice(0, 200).trimStart().toLowerCase();
|
|
373
|
+
if (head.startsWith('<!doctype') || head.startsWith('<html') || head.startsWith('<?xml')) {
|
|
374
|
+
const kind = head.startsWith('<?xml') ? 'an XML document' : 'an HTML page';
|
|
375
|
+
// The summary, not the source. Pasting the first 120 characters of a web
|
|
376
|
+
// page handed the agent `<!DOCTYPE html><html lang="en"…` — the same leak
|
|
377
|
+
// this branch exists to describe (fleet #712).
|
|
378
|
+
throw new Error(
|
|
379
|
+
`upstream_down: ${name} answered HTTP ${res.status} with ${kind} instead of JSON (${type}). ` +
|
|
380
|
+
'That is typically a bot wall, a login redirect or a maintenance page — it is returned as a SUCCESS, ' +
|
|
381
|
+
`so status-code health checks read it as fine. No argument change will get past it. ` +
|
|
382
|
+
`The page says: ${summarizeErrorBody(raw) || 'nothing readable'}`,
|
|
383
|
+
);
|
|
384
|
+
}
|
|
385
|
+
|
|
386
|
+
try {
|
|
387
|
+
return JSON.parse(raw) as T;
|
|
388
|
+
} catch {
|
|
389
|
+
throw new Error(
|
|
390
|
+
`upstream_down: ${name} answered HTTP ${res.status} with a body that is not valid JSON (${type}). ` +
|
|
391
|
+
`It begins: ${stripMarkup(raw).slice(0, 120) || '(unreadable)'}`,
|
|
392
|
+
);
|
|
393
|
+
}
|
|
394
|
+
}
|
|
395
|
+
|
|
396
|
+
/**
|
|
397
|
+
* `fetch`, but bounded — the fix for a systemic gap found 2026-08-30: a grep
|
|
398
|
+
* audit of every pack's `mcps/*\/src/index.ts` found 1,339 of ~1,500 call
|
|
399
|
+
* `fetch()` with NO timeout guard anywhere in the file. Two of those
|
|
400
|
+
* (epo-ops, statcan) were confirmed live-hanging for 4-8 minutes before this
|
|
401
|
+
* existed — every unguarded call carries the same risk, just unconfirmed.
|
|
402
|
+
*
|
|
403
|
+
* Mirrors the `epoFetch` wrapper `mcps/epo-ops/src/index.ts` shipped first:
|
|
404
|
+
* bound the request with `AbortSignal.timeout`, and on a timeout/abort throw
|
|
405
|
+
* an `upstream_down:` error that names the upstream and the bound rather than
|
|
406
|
+
* letting the raw `TimeoutError`/`AbortError` (which names neither) propagate.
|
|
407
|
+
* `upstream_down:` is deliberate, same reasoning as `parseJson` above — no
|
|
408
|
+
* argument a caller passes can make an upstream hang, so it is always the
|
|
409
|
+
* upstream's fault, and marking it that way keeps a slow API off the
|
|
410
|
+
* problem-tools list where it would crowd out our own defects.
|
|
411
|
+
*
|
|
412
|
+
* Usage — a mechanical swap for a bare `fetch(url, init)`:
|
|
413
|
+
*
|
|
414
|
+
* const res = await fetchWithTimeout(url, init, 'Some API');
|
|
415
|
+
*
|
|
416
|
+
* Pass `timeoutMs` as a fourth argument to override the default for a pack
|
|
417
|
+
* with a known-slower upstream; the label should be the same short name you'd
|
|
418
|
+
* pass to `httpError`/`httpErrorMessage` for that call.
|
|
419
|
+
*/
|
|
420
|
+
async function fetchWithTimeout(
|
|
421
|
+
url: string | URL,
|
|
422
|
+
init: RequestInit = {},
|
|
423
|
+
name: string,
|
|
424
|
+
timeoutMs: number = DEFAULT_FETCH_TIMEOUT_MS,
|
|
425
|
+
): Promise<Response> {
|
|
426
|
+
try {
|
|
427
|
+
return await fetch(url, { ...init, signal: AbortSignal.timeout(timeoutMs) });
|
|
428
|
+
} catch (err) {
|
|
429
|
+
if (err instanceof Error && (err.name === 'TimeoutError' || err.name === 'AbortError')) {
|
|
430
|
+
// States the OBSERVATION (no response in N seconds), not a diagnosis.
|
|
431
|
+
// "appears to be degraded" is an inference about the vendor that we have
|
|
432
|
+
// not checked, and it is wrong in a way that misdirects whoever reads it:
|
|
433
|
+
// a timeout from a Worker can equally mean OUR egress is blocked.
|
|
434
|
+
//
|
|
435
|
+
// Measured today (2026-09-01, fleet #1047): every call to
|
|
436
|
+
// mainnet.base.org failed from the x402 facilitator while the identical
|
|
437
|
+
// request from a laptop returned 200. Base was entirely healthy; the
|
|
438
|
+
// public RPC refuses Cloudflare Worker egress. Had this message fired
|
|
439
|
+
// there it would have blamed Base by name, and the next person would have
|
|
440
|
+
// waited for a vendor outage to clear that did not exist.
|
|
441
|
+
// A timeout has no status to test — there is no response at all — so
|
|
442
|
+
// `markInternalOrigin` is called without one: an origin we run that never
|
|
443
|
+
// answered is an availability failure by definition. This is the half of
|
|
444
|
+
// fleet #1096 with neither a SQLSTATE nor a status code to key on.
|
|
445
|
+
throw new Error(
|
|
446
|
+
markInternalOrigin(
|
|
447
|
+
`upstream_down: ${name} did not respond within ${timeoutMs / 1000}s. ` +
|
|
448
|
+
`That can be ${name} being slow or down, or this environment being unable to reach it ` +
|
|
449
|
+
`(some hosts refuse datacenter/Worker egress) — retry shortly, and check reachability ` +
|
|
450
|
+
`from elsewhere before concluding ${name} is down.`,
|
|
451
|
+
url,
|
|
452
|
+
),
|
|
453
|
+
);
|
|
454
|
+
}
|
|
455
|
+
throw err;
|
|
456
|
+
}
|
|
457
|
+
}
|
|
458
|
+
|
|
459
|
+
function detailSuffix(detail: string): string {
|
|
460
|
+
return detail ? ` — ${detail}` : '';
|
|
461
|
+
}
|
|
462
|
+
|
|
463
|
+
async function readDetail(res: Response): Promise<string> {
|
|
464
|
+
let raw: string;
|
|
465
|
+
try {
|
|
466
|
+
raw = await res.text();
|
|
467
|
+
} catch {
|
|
468
|
+
// Body already consumed, or the connection died mid-read. The status alone
|
|
469
|
+
// is still worth throwing — never let the error path throw its own error.
|
|
470
|
+
return '';
|
|
471
|
+
}
|
|
472
|
+
return summarizeErrorBody(raw);
|
|
473
|
+
}
|
|
474
|
+
|
|
475
|
+
/**
|
|
476
|
+
* Turn ANY error body — JSON, HTML, XML or plain text — into one short phrase
|
|
477
|
+
* that never contains markup.
|
|
478
|
+
*
|
|
479
|
+
* This used to just drop an HTML or XML body on the floor, on the reasoning
|
|
480
|
+
* that markup crowds out the status. That was half right. Dropping it loses the
|
|
481
|
+
* one sentence a caller could have acted on: an `Access Denied` title, an SDMX
|
|
482
|
+
* `<message:Error>` text, an OPS fault string. A 2026-08-30 support sweep
|
|
483
|
+
* measured 13 of 291 caller-facing error rows carrying a raw page or document
|
|
484
|
+
* verbatim, across 11 packs, and in every one of them the useful content —
|
|
485
|
+
* "Access Denied", "Invalid country code", "SCRAPE_TIMEOUT" — was in there,
|
|
486
|
+
* buried in markup the agent had to parse out of a string (fleet #712).
|
|
487
|
+
*
|
|
488
|
+
* So: extract the meaning, discard the markup. The output is passed through
|
|
489
|
+
* `stripMarkup` unconditionally, which is what lets `check:error-body-leak`
|
|
490
|
+
* assert mechanically that no caller-facing message can contain `<?xml`,
|
|
491
|
+
* `<!DOCTYPE` or `<html`.
|
|
492
|
+
*/
|
|
493
|
+
function summarizeErrorBody(raw: string): string {
|
|
494
|
+
if (!raw || !raw.trim()) return '';
|
|
495
|
+
|
|
496
|
+
const head = raw.slice(0, 400).trimStart().toLowerCase();
|
|
497
|
+
|
|
498
|
+
// An HTML error page (Cloudflare interstitial, nginx default, a login
|
|
499
|
+
// redirect) says what it is in its <title>, and almost nowhere else.
|
|
500
|
+
if (head.startsWith('<!doctype') || head.startsWith('<html')) {
|
|
501
|
+
const title = htmlTitle(raw);
|
|
502
|
+
return title
|
|
503
|
+
? `${title} (upstream returned an HTML error page, not an API response)`
|
|
504
|
+
: 'upstream returned an HTML error page, not an API response';
|
|
505
|
+
}
|
|
506
|
+
|
|
507
|
+
// XML fault documents — EPO OPS, SDMX (`<message:Error>`), SOAP faults. The
|
|
508
|
+
// human sentence sits in a child element whose tag name says what it is.
|
|
509
|
+
if (head.startsWith('<?xml') || head.startsWith('<')) {
|
|
510
|
+
const fault = xmlFaultText(raw);
|
|
511
|
+
return fault
|
|
512
|
+
? `${stripMarkup(fault).slice(0, MAX_DETAIL)} (from the upstream's XML error document)`
|
|
513
|
+
: 'upstream returned an XML error document with no readable message';
|
|
514
|
+
}
|
|
515
|
+
|
|
516
|
+
// Most JSON error bodies bury one human sentence among ids and echoed request
|
|
517
|
+
// params. Prefer that sentence; fall back to the whole body when the shape is
|
|
518
|
+
// unfamiliar, since an unfamiliar shape is exactly when we can least afford to
|
|
519
|
+
// guess wrong and show nothing.
|
|
520
|
+
const fromJson = messageFromJson(raw);
|
|
521
|
+
return stripMarkup(fromJson ?? raw).slice(0, MAX_DETAIL);
|
|
522
|
+
}
|
|
523
|
+
|
|
524
|
+
/** The `<title>` of an HTML error page, or its first `<h1>` — the two places a
|
|
525
|
+
* bot wall, a 502 and an "Access Denied" all state what happened. */
|
|
526
|
+
function htmlTitle(raw: string): string | null {
|
|
527
|
+
const head = raw.slice(0, 4000);
|
|
528
|
+
for (const re of [/<title[^>]*>([\s\S]*?)<\/title>/i, /<h1[^>]*>([\s\S]*?)<\/h1>/i]) {
|
|
529
|
+
const m = re.exec(head);
|
|
530
|
+
const text = m ? stripMarkup(m[1]) : '';
|
|
531
|
+
if (text) return text.slice(0, 160);
|
|
532
|
+
}
|
|
533
|
+
return null;
|
|
534
|
+
}
|
|
535
|
+
|
|
536
|
+
/** Tag names that carry the explanation in an XML fault document, namespace
|
|
537
|
+
* prefix optional (`<message:Error>`, `<com:Text>`, `<faultstring>`). */
|
|
538
|
+
const XML_FAULT_TAG_RE =
|
|
539
|
+
/<(?:[A-Za-z0-9_.-]+:)?(?:text|message|description|faultstring|reason|detail|title|errormessage|error)\b[^>]*>([^<]{2,400})</i;
|
|
540
|
+
|
|
541
|
+
function xmlFaultText(raw: string): string | null {
|
|
542
|
+
const head = raw.slice(0, 8000);
|
|
543
|
+
const tagged = XML_FAULT_TAG_RE.exec(head);
|
|
544
|
+
if (tagged && tagged[1].trim()) return tagged[1];
|
|
545
|
+
|
|
546
|
+
// Nothing conventionally named — take the longest text node instead. A fault
|
|
547
|
+
// document with one sentence in an oddly named element is still readable;
|
|
548
|
+
// returning nothing at all is not.
|
|
549
|
+
let best = '';
|
|
550
|
+
for (const m of head.matchAll(/>([^<>]{8,400})</g)) {
|
|
551
|
+
const text = m[1].trim();
|
|
552
|
+
if (text.length > best.length) best = text;
|
|
553
|
+
}
|
|
554
|
+
return best || null;
|
|
555
|
+
}
|
|
556
|
+
|
|
557
|
+
/**
|
|
558
|
+
* Remove every tag and stray angle bracket, then collapse whitespace.
|
|
559
|
+
*
|
|
560
|
+
* Applied to everything on the way out, including the JSON and plain-text
|
|
561
|
+
* paths, because an upstream is free to embed markup in a JSON string field —
|
|
562
|
+
* and a leak is a leak regardless of which branch produced it.
|
|
563
|
+
*/
|
|
564
|
+
function stripMarkup(s: string): string {
|
|
565
|
+
return collapse(decodeEntities(s.replace(/<[^>]*>/g, ' ')).replace(/[<>]/g, ' '));
|
|
566
|
+
}
|
|
567
|
+
|
|
568
|
+
/** The handful of entities that show up in error-page titles. Decoded AFTER
|
|
569
|
+
* tags are stripped and BEFORE the angle-bracket sweep, so `<script>`
|
|
570
|
+
* in a title cannot decode into markup that survives — EMBL-EBI's ChEMBL 500
|
|
571
|
+
* page renders as `500 Internal Server Error < EMBL-EBI` otherwise. */
|
|
572
|
+
function decodeEntities(s: string): string {
|
|
573
|
+
return s
|
|
574
|
+
.replace(/&(?:amp|#0*38);/gi, '&')
|
|
575
|
+
.replace(/&(?:lt|#0*60);/gi, '<')
|
|
576
|
+
.replace(/&(?:gt|#0*62);/gi, '>')
|
|
577
|
+
.replace(/&(?:quot|#0*34);/gi, '"')
|
|
578
|
+
.replace(/&(?:#0*39|apos|#x0*27);/gi, "'")
|
|
579
|
+
.replace(/ /gi, ' ');
|
|
580
|
+
}
|
|
581
|
+
|
|
582
|
+
/** The conventional "what went wrong" field, under any of the names upstreams
|
|
583
|
+
* actually use. Checked in order; first non-empty string wins. */
|
|
584
|
+
const MESSAGE_KEYS = [
|
|
585
|
+
'message', 'error_message', 'errorMessage', 'detail', 'details',
|
|
586
|
+
'description', 'error_description', 'reason', 'title', 'fault',
|
|
587
|
+
];
|
|
588
|
+
|
|
589
|
+
function messageFromJson(raw: string): string | null {
|
|
590
|
+
let parsed: unknown;
|
|
591
|
+
try {
|
|
592
|
+
parsed = JSON.parse(raw);
|
|
593
|
+
} catch {
|
|
594
|
+
return null;
|
|
595
|
+
}
|
|
596
|
+
return pickMessage(parsed, 0);
|
|
597
|
+
}
|
|
598
|
+
|
|
599
|
+
function pickMessage(node: unknown, depth: number): string | null {
|
|
600
|
+
// Two levels covers `{error: {message}}` and `{errors: [{detail}]}`, the two
|
|
601
|
+
// shapes that account for nearly all of them, without walking a large payload.
|
|
602
|
+
if (depth > 2 || node == null) return null;
|
|
603
|
+
|
|
604
|
+
if (typeof node === 'string') return node.trim() || null;
|
|
605
|
+
|
|
606
|
+
if (Array.isArray(node)) {
|
|
607
|
+
for (const item of node) {
|
|
608
|
+
const found = pickMessage(item, depth + 1);
|
|
609
|
+
if (found) return found;
|
|
610
|
+
}
|
|
611
|
+
return null;
|
|
612
|
+
}
|
|
613
|
+
|
|
614
|
+
if (typeof node !== 'object') return null;
|
|
615
|
+
const obj = node as Record<string, unknown>;
|
|
616
|
+
|
|
617
|
+
for (const key of MESSAGE_KEYS) {
|
|
618
|
+
const v = obj[key];
|
|
619
|
+
if (typeof v === 'string' && v.trim()) return v.trim();
|
|
620
|
+
}
|
|
621
|
+
// `{error: …}` where error is itself an object or a string — the single most
|
|
622
|
+
// common wrapper, so it is worth descending into by name rather than scanning
|
|
623
|
+
// every key and risking picking up an echoed request parameter.
|
|
624
|
+
for (const key of ['error', 'errors', 'fault', 'Error', 'data']) {
|
|
625
|
+
if (key in obj) {
|
|
626
|
+
const found = pickMessage(obj[key], depth + 1);
|
|
627
|
+
if (found) return found;
|
|
628
|
+
}
|
|
629
|
+
}
|
|
630
|
+
return null;
|
|
631
|
+
}
|
|
632
|
+
|
|
633
|
+
/** Errors are read in a single line of log output; newlines and runs of
|
|
634
|
+
* whitespace make a multi-line body unreadable there. */
|
|
635
|
+
function collapse(s: string): string {
|
|
636
|
+
return s.replace(/\s+/g, ' ').trim();
|
|
637
|
+
}
|
|
638
|
+
/**
|
|
639
|
+
* Real-user Core Web Vitals for any website with enough traffic, from Google's Chrome UX Report — the field measurements Google Search itself uses.
|
|
640
|
+
*
|
|
641
|
+
* CrUX aggregates performance data from opted-in Chrome users and serves it
|
|
642
|
+
* through the CrUX API at chromeuxreport.googleapis.com.
|
|
643
|
+
*
|
|
644
|
+
* This is FIELD data, not a lab test: the 75th-percentile Largest Contentful
|
|
645
|
+
* Paint, Interaction to Next Paint and Cumulative Layout Shift that actual
|
|
646
|
+
* visitors experienced on a site over the trailing 28 days, plus the
|
|
647
|
+
* good/needs-improvement/poor distribution behind each number. It is the
|
|
648
|
+
* dataset Google Search uses for its Core Web Vitals assessment, so it is the
|
|
649
|
+
* authoritative answer to "is this site passing Core Web Vitals", which no lab
|
|
650
|
+
* tool (Lighthouse included) can answer.
|
|
651
|
+
*
|
|
652
|
+
* CREDENTIALS
|
|
653
|
+
* -----------
|
|
654
|
+
* There is NO keyless path. The API answers an unkeyed request with HTTP 403
|
|
655
|
+
* and "Method doesn't allow unregistered callers" — verified live 2026-09-17 —
|
|
656
|
+
* so this pack requires an API key. A caller can bring their own as `_apiKey`;
|
|
657
|
+
* the gateway supplies `PLATFORM_GOOGLE_API_KEY` when that secret is set.
|
|
658
|
+
* A key is free and self-service: create one at
|
|
659
|
+
* https://console.cloud.google.com/apis/credentials and enable the Chrome UX
|
|
660
|
+
* Report API at
|
|
661
|
+
* https://console.cloud.google.com/apis/library/chromeuxreport.googleapis.com
|
|
662
|
+
* — no billing account, no approval step, 150 queries/minute.
|
|
663
|
+
*
|
|
664
|
+
* TRAPS, VERIFIED LIVE 2026-09-17
|
|
665
|
+
* -------------------------------
|
|
666
|
+
* 1. THE TWO KEY FAILURES LOOK NOTHING ALIKE. A missing key is HTTP 403
|
|
667
|
+
* PERMISSION_DENIED "Method doesn't allow unregistered callers". A WRONG
|
|
668
|
+
* key is HTTP 400 INVALID_ARGUMENT "API key not valid". A key whose project
|
|
669
|
+
* has not enabled the CrUX API is a third shape again (SERVICE_DISABLED).
|
|
670
|
+
* Collapsing all three into "auth failed" sends a caller looking for the
|
|
671
|
+
* wrong problem, so each is reported separately below.
|
|
672
|
+
* 2. `origin` AND `url` ARE DIFFERENT QUESTIONS AND EXACTLY ONE MAY BE SENT.
|
|
673
|
+
* `origin: "https://example.com"` is every page on the site aggregated;
|
|
674
|
+
* `url: "https://example.com/pricing"` is that one page. Sending both is a
|
|
675
|
+
* 400. An origin must have no path — "https://example.com/" with the
|
|
676
|
+
* trailing slash is accepted, "https://example.com/pricing" as an origin is
|
|
677
|
+
* not.
|
|
678
|
+
* 3. NOT FOUND IS THE NORMAL ANSWER FOR MOST OF THE WEB. CrUX only publishes
|
|
679
|
+
* an entry once a page or origin has enough opted-in Chrome traffic to be
|
|
680
|
+
* both statistically sound and non-identifying. The API returns HTTP 404
|
|
681
|
+
* for everything below that bar. That is not an outage and not a bad
|
|
682
|
+
* request — it is the dataset saying "too little traffic", which is itself
|
|
683
|
+
* the answer, and this pack reports it as such rather than as an error.
|
|
684
|
+
* A URL can be absent while its origin is present.
|
|
685
|
+
* 4. THE HEADLINE NUMBER IS p75, NOT THE MEAN. Core Web Vitals is assessed at
|
|
686
|
+
* the 75th percentile, and `percentiles.p75` is what Search uses. Averaging
|
|
687
|
+
* the histogram bins gives a different, wrong number.
|
|
688
|
+
* 5. CLS IS UNITLESS; EVERY OTHER METRIC IS MILLISECONDS. CrUX returns CLS
|
|
689
|
+
* p75 as a STRING like "0.05" while the timing metrics come back as
|
|
690
|
+
* integers. Treating them uniformly silently mis-scales CLS by 1000x.
|
|
691
|
+
* 6. `crux_history` RETURNS ~40 WEEKLY COLLECTION PERIODS, and each is a
|
|
692
|
+
* 28-DAY TRAILING WINDOW, so consecutive points overlap by 27 days. A
|
|
693
|
+
* week-on-week change in the series is a change in a rolling average, not
|
|
694
|
+
* a change in that week's traffic.
|
|
695
|
+
*/
|
|
696
|
+
|
|
697
|
+
|
|
698
|
+
const API = 'https://chromeuxreport.googleapis.com/v1';
|
|
699
|
+
const UA = 'pipeworx-mcp-chrome-ux-report/1.0 (+https://pipeworx.io)';
|
|
700
|
+
const KEY_URL = 'https://console.cloud.google.com/apis/library/chromeuxreport.googleapis.com';
|
|
701
|
+
|
|
702
|
+
/** Metrics the API serves, with what each one means and its unit. */
|
|
703
|
+
const METRICS: Record<string, { label: string; unit: 'ms' | 'score'; good?: number; poor?: number }> = {
|
|
704
|
+
largest_contentful_paint: { label: 'Largest Contentful Paint', unit: 'ms', good: 2500, poor: 4000 },
|
|
705
|
+
interaction_to_next_paint: { label: 'Interaction to Next Paint', unit: 'ms', good: 200, poor: 500 },
|
|
706
|
+
cumulative_layout_shift: { label: 'Cumulative Layout Shift', unit: 'score', good: 0.1, poor: 0.25 },
|
|
707
|
+
first_contentful_paint: { label: 'First Contentful Paint', unit: 'ms', good: 1800, poor: 3000 },
|
|
708
|
+
experimental_time_to_first_byte: { label: 'Time to First Byte', unit: 'ms', good: 800, poor: 1800 },
|
|
709
|
+
round_trip_time: { label: 'Round-Trip Time', unit: 'ms' },
|
|
710
|
+
};
|
|
711
|
+
|
|
712
|
+
/** The three metrics Core Web Vitals is assessed on. Trap 4. */
|
|
713
|
+
const CORE_WEB_VITALS = ['largest_contentful_paint', 'interaction_to_next_paint', 'cumulative_layout_shift'];
|
|
714
|
+
|
|
715
|
+
const FORM_FACTORS = ['PHONE', 'DESKTOP', 'TABLET', 'ALL_FORM_FACTORS'];
|
|
716
|
+
|
|
717
|
+
async function pwFetch(url: string, init: RequestInit): Promise<Response> {
|
|
718
|
+
return fetchWithTimeout(
|
|
719
|
+
url,
|
|
720
|
+
{ ...init, headers: { 'User-Agent': UA, 'Content-Type': 'application/json', ...(init.headers ?? {}) } },
|
|
721
|
+
'Chrome UX Report API (Google)',
|
|
722
|
+
);
|
|
723
|
+
}
|
|
724
|
+
|
|
725
|
+
function requireKey(args: Record<string, unknown>): string {
|
|
726
|
+
const key = typeof args._apiKey === 'string' ? args._apiKey.trim() : '';
|
|
727
|
+
if (key) return key;
|
|
728
|
+
throw new Error(
|
|
729
|
+
`The Chrome UX Report requires an API key — Google refuses unregistered callers outright, so there is no keyless path. A key is free, instant and self-service: create one at https://console.cloud.google.com/apis/credentials, enable the Chrome UX Report API at ${KEY_URL}, and pass it as _apiKey. No billing account is needed.`,
|
|
730
|
+
);
|
|
731
|
+
}
|
|
732
|
+
|
|
733
|
+
interface CruxMetric {
|
|
734
|
+
histogram?: Array<{ start?: number | string; end?: number | string; density?: number }>;
|
|
735
|
+
percentiles?: { p75?: number | string };
|
|
736
|
+
}
|
|
737
|
+
interface CruxRecord {
|
|
738
|
+
key?: { origin?: string; url?: string; formFactor?: string };
|
|
739
|
+
metrics?: Record<string, CruxMetric>;
|
|
740
|
+
collectionPeriod?: { firstDate?: { year: number; month: number; day: number }; lastDate?: { year: number; month: number; day: number } };
|
|
741
|
+
}
|
|
742
|
+
|
|
743
|
+
function isoDate(d?: { year: number; month: number; day: number }): string | null {
|
|
744
|
+
if (!d || !d.year) return null;
|
|
745
|
+
return `${d.year}-${String(d.month).padStart(2, '0')}-${String(d.day).padStart(2, '0')}`;
|
|
746
|
+
}
|
|
747
|
+
|
|
748
|
+
/** Trap 5: CLS arrives as a decimal string, timings as integers. */
|
|
749
|
+
function asNumber(v: unknown): number | null {
|
|
750
|
+
if (v === null || v === undefined) return null;
|
|
751
|
+
const n = Number(v);
|
|
752
|
+
return Number.isFinite(n) ? n : null;
|
|
753
|
+
}
|
|
754
|
+
|
|
755
|
+
function verdict(metric: string, p75: number | null): 'good' | 'needs-improvement' | 'poor' | null {
|
|
756
|
+
const def = METRICS[metric];
|
|
757
|
+
if (!def || p75 === null || def.good === undefined || def.poor === undefined) return null;
|
|
758
|
+
if (p75 <= def.good) return 'good';
|
|
759
|
+
if (p75 <= def.poor) return 'needs-improvement';
|
|
760
|
+
return 'poor';
|
|
761
|
+
}
|
|
762
|
+
|
|
763
|
+
function shapeMetrics(metrics: Record<string, CruxMetric> | undefined) {
|
|
764
|
+
const out: Record<string, unknown> = {};
|
|
765
|
+
for (const [name, m] of Object.entries(metrics ?? {})) {
|
|
766
|
+
const def = METRICS[name];
|
|
767
|
+
const p75 = asNumber(m.percentiles?.p75);
|
|
768
|
+
const bins = (m.histogram ?? []).map((b) => ({
|
|
769
|
+
start: asNumber(b.start),
|
|
770
|
+
end: b.end === undefined ? null : asNumber(b.end),
|
|
771
|
+
density: asNumber(b.density),
|
|
772
|
+
}));
|
|
773
|
+
out[name] = {
|
|
774
|
+
label: def?.label ?? name,
|
|
775
|
+
unit: def?.unit ?? null,
|
|
776
|
+
p75,
|
|
777
|
+
assessment: verdict(name, p75),
|
|
778
|
+
good_threshold: def?.good ?? null,
|
|
779
|
+
poor_threshold: def?.poor ?? null,
|
|
780
|
+
distribution: bins,
|
|
781
|
+
};
|
|
782
|
+
}
|
|
783
|
+
return out;
|
|
784
|
+
}
|
|
785
|
+
|
|
786
|
+
/**
|
|
787
|
+
* Trap 3: a 404 is the dataset's answer ("not enough traffic"), not a failure.
|
|
788
|
+
* Trap 1: the three credential failures are distinguished by status and body.
|
|
789
|
+
*/
|
|
790
|
+
async function queryCrux(path: string, body: Record<string, unknown>, key: string) {
|
|
791
|
+
const res = await pwFetch(`${API}/${path}?key=${encodeURIComponent(key)}`, {
|
|
792
|
+
method: 'POST',
|
|
793
|
+
body: JSON.stringify(body),
|
|
794
|
+
});
|
|
795
|
+
const text = await res.text();
|
|
796
|
+
let json: { error?: { code?: number; message?: string; status?: string }; record?: CruxRecord } = {};
|
|
797
|
+
try {
|
|
798
|
+
json = JSON.parse(text);
|
|
799
|
+
} catch {
|
|
800
|
+
throw new Error(`Chrome UX Report API returned HTTP ${res.status} with a non-JSON body: ${summarizeErrorBody(text)}`);
|
|
801
|
+
}
|
|
802
|
+
|
|
803
|
+
if (res.status === 404) return { notFound: true as const, record: null };
|
|
804
|
+
if (res.ok && json.record) return { notFound: false as const, record: json.record };
|
|
805
|
+
|
|
806
|
+
const status = json.error?.status ?? '';
|
|
807
|
+
const message = json.error?.message ?? summarizeErrorBody(text);
|
|
808
|
+
if (res.status === 403 && /unregistered callers/i.test(message)) {
|
|
809
|
+
throw new Error(
|
|
810
|
+
`The Chrome UX Report requires an API key and none reached Google. Upstream said: ${message}. Create a free key at https://console.cloud.google.com/apis/credentials and pass it as _apiKey.`,
|
|
811
|
+
);
|
|
812
|
+
}
|
|
813
|
+
if (res.status === 400 && /API key not valid/i.test(message)) {
|
|
814
|
+
throw new Error(
|
|
815
|
+
`The API key was rejected as invalid by Google (this is a WRONG key, not a missing one — a missing key returns 403 instead). Upstream said: ${message}`,
|
|
816
|
+
);
|
|
817
|
+
}
|
|
818
|
+
if (status === 'PERMISSION_DENIED' || /SERVICE_DISABLED|has not been used in project|is disabled/i.test(message)) {
|
|
819
|
+
throw new Error(
|
|
820
|
+
`The API key is valid but its Google Cloud project has not enabled the Chrome UX Report API. Enable it at ${KEY_URL}, then retry — Google caches the disabled state for a few minutes. Upstream said: ${message}`,
|
|
821
|
+
);
|
|
822
|
+
}
|
|
823
|
+
throw new Error(`Chrome UX Report API returned HTTP ${res.status} (${status || 'no status'}): ${message}`);
|
|
824
|
+
}
|
|
825
|
+
|
|
826
|
+
function buildTarget(args: Record<string, unknown>, mode: 'origin' | 'url'): Record<string, unknown> {
|
|
827
|
+
// Trap 2.
|
|
828
|
+
const raw = String(args[mode] ?? '').trim();
|
|
829
|
+
if (!raw) throw new Error(`\`${mode}\` is required.`);
|
|
830
|
+
if (!/^https?:\/\//i.test(raw)) {
|
|
831
|
+
throw new Error(`\`${mode}\` must be a full URL including the scheme, e.g. https://example.com — got "${raw}".`);
|
|
832
|
+
}
|
|
833
|
+
if (mode === 'origin') {
|
|
834
|
+
let parsed: URL;
|
|
835
|
+
try {
|
|
836
|
+
parsed = new URL(raw);
|
|
837
|
+
} catch {
|
|
838
|
+
throw new Error(`\`origin\` is not a valid URL: "${raw}".`);
|
|
839
|
+
}
|
|
840
|
+
if (parsed.pathname !== '/' && parsed.pathname !== '') {
|
|
841
|
+
throw new Error(
|
|
842
|
+
`An origin has no path. "${raw}" has one — use crux_query_url for a single page, or pass "${parsed.origin}" as the origin.`,
|
|
843
|
+
);
|
|
844
|
+
}
|
|
845
|
+
}
|
|
846
|
+
|
|
847
|
+
const body: Record<string, unknown> = { [mode]: raw };
|
|
848
|
+
const ff = args.form_factor ? String(args.form_factor).trim().toUpperCase() : null;
|
|
849
|
+
if (ff) {
|
|
850
|
+
if (!FORM_FACTORS.includes(ff)) {
|
|
851
|
+
throw new Error(`\`form_factor\` must be one of ${FORM_FACTORS.join(', ')} — got "${ff}".`);
|
|
852
|
+
}
|
|
853
|
+
if (ff !== 'ALL_FORM_FACTORS') body.formFactor = ff;
|
|
854
|
+
}
|
|
855
|
+
const metrics = Array.isArray(args.metrics) ? (args.metrics as unknown[]).map((m) => String(m).trim()) : null;
|
|
856
|
+
if (metrics && metrics.length) {
|
|
857
|
+
const bad = metrics.filter((m) => !METRICS[m]);
|
|
858
|
+
if (bad.length) {
|
|
859
|
+
throw new Error(`Unknown metric(s): ${bad.join(', ')}. Valid metrics: ${Object.keys(METRICS).join(', ')}.`);
|
|
860
|
+
}
|
|
861
|
+
body.metrics = metrics;
|
|
862
|
+
}
|
|
863
|
+
return body;
|
|
864
|
+
}
|
|
865
|
+
|
|
866
|
+
const TARGET_PROPS = {
|
|
867
|
+
form_factor: {
|
|
868
|
+
type: 'string',
|
|
869
|
+
description: 'Device class to report on: PHONE, DESKTOP, TABLET, or ALL_FORM_FACTORS (the default — every device combined).',
|
|
870
|
+
enum: FORM_FACTORS,
|
|
871
|
+
},
|
|
872
|
+
metrics: {
|
|
873
|
+
type: 'array',
|
|
874
|
+
items: { type: 'string' },
|
|
875
|
+
description:
|
|
876
|
+
'Metrics to return; omit for all available. One or more of largest_contentful_paint, interaction_to_next_paint, cumulative_layout_shift, first_contentful_paint, experimental_time_to_first_byte, round_trip_time.',
|
|
877
|
+
},
|
|
878
|
+
};
|
|
879
|
+
|
|
880
|
+
const tools: McpToolExport['tools'] = [
|
|
881
|
+
{
|
|
882
|
+
name: 'crux_query_origin',
|
|
883
|
+
description:
|
|
884
|
+
"Real-user Core Web Vitals for an entire website, from Google's Chrome UX Report — the 75th-percentile Largest Contentful Paint, Interaction to Next Paint and Cumulative Layout Shift that actual Chrome visitors experienced over the trailing 28 days, plus the good/needs-improvement/poor distribution behind each. AUTHORITATIVE for \"is this site passing Core Web Vitals\": this is the field dataset Google Search itself uses, so it answers what a lab test such as Lighthouse structurally cannot. PREFER OVER WEB SEARCH for any question about a real site's measured speed, and use it on a competitor's domain as readily as your own — the data is public for every site with enough traffic.",
|
|
885
|
+
inputSchema: {
|
|
886
|
+
type: 'object' as const,
|
|
887
|
+
properties: {
|
|
888
|
+
origin: {
|
|
889
|
+
type: 'string',
|
|
890
|
+
description: 'Site origin with scheme and no path, e.g. https://www.shopify.com. For one page, use crux_query_url instead.',
|
|
891
|
+
},
|
|
892
|
+
...TARGET_PROPS,
|
|
893
|
+
},
|
|
894
|
+
required: ['origin'],
|
|
895
|
+
},
|
|
896
|
+
},
|
|
897
|
+
{
|
|
898
|
+
name: 'crux_query_url',
|
|
899
|
+
description:
|
|
900
|
+
"Real-user Core Web Vitals for ONE specific page, from Google's Chrome UX Report — the 75th-percentile LCP, INP and CLS measured on actual Chrome visits to that exact URL over the trailing 28 days. Use this when a single page (a product page, a landing page, a checkout step) is the question; use crux_query_origin for the site as a whole. A page with too little traffic is absent from the dataset while its origin is present, and that absence is reported plainly rather than as an error.",
|
|
901
|
+
inputSchema: {
|
|
902
|
+
type: 'object' as const,
|
|
903
|
+
properties: {
|
|
904
|
+
url: {
|
|
905
|
+
type: 'string',
|
|
906
|
+
description: 'Full page URL including scheme, e.g. https://www.shopify.com/pricing.',
|
|
907
|
+
},
|
|
908
|
+
...TARGET_PROPS,
|
|
909
|
+
},
|
|
910
|
+
required: ['url'],
|
|
911
|
+
},
|
|
912
|
+
},
|
|
913
|
+
{
|
|
914
|
+
name: 'crux_history',
|
|
915
|
+
description:
|
|
916
|
+
"How a site's or page's real-user Core Web Vitals have moved over roughly the last 40 weeks, from Google's Chrome UX Report history API. Returns a weekly series of 75th-percentile LCP, INP and CLS with each collection period's dates. AUTHORITATIVE for \"did the performance work actually help\" and for spotting the week a regression landed — each point is a 28-day trailing window, so consecutive points overlap and a step change in the series marks a real shift in visitor experience.",
|
|
917
|
+
inputSchema: {
|
|
918
|
+
type: 'object' as const,
|
|
919
|
+
properties: {
|
|
920
|
+
origin: { type: 'string', description: 'Site origin with scheme and no path, e.g. https://www.shopify.com. Give this OR url.' },
|
|
921
|
+
url: { type: 'string', description: 'Full page URL. Give this OR origin.' },
|
|
922
|
+
...TARGET_PROPS,
|
|
923
|
+
},
|
|
924
|
+
required: [],
|
|
925
|
+
},
|
|
926
|
+
},
|
|
927
|
+
];
|
|
928
|
+
|
|
929
|
+
function notFoundAnswer(kind: 'origin' | 'url', target: string, formFactor: string | null) {
|
|
930
|
+
return {
|
|
931
|
+
found: false,
|
|
932
|
+
[kind]: target,
|
|
933
|
+
form_factor: formFactor ?? 'ALL_FORM_FACTORS',
|
|
934
|
+
reason: 'insufficient_traffic',
|
|
935
|
+
note:
|
|
936
|
+
kind === 'url'
|
|
937
|
+
? `The Chrome UX Report has no entry for this exact page. That is the dataset's normal answer for most URLs: a page is only published once it has enough opted-in Chrome traffic to be statistically sound and non-identifying. The page's ORIGIN may still be covered — try crux_query_origin on ${(() => { try { return new URL(target).origin; } catch { return 'the site origin'; } })()}.`
|
|
938
|
+
: `The Chrome UX Report has no entry for this origin, which means it is below the traffic threshold at which Google publishes data. This is not an outage; it is the answer. Narrower form factors (PHONE, DESKTOP) have separate, higher thresholds — omitting form_factor gives the best chance of a result.`,
|
|
939
|
+
source: 'Chrome UX Report (CrUX), Google',
|
|
940
|
+
source_url: 'https://developer.chrome.com/docs/crux',
|
|
941
|
+
};
|
|
942
|
+
}
|
|
943
|
+
|
|
944
|
+
async function queryRecord(args: Record<string, unknown>, mode: 'origin' | 'url') {
|
|
945
|
+
const key = requireKey(args);
|
|
946
|
+
const body = buildTarget(args, mode);
|
|
947
|
+
const { notFound, record } = await queryCrux('records:queryRecord', body, key);
|
|
948
|
+
const formFactor = (body.formFactor as string | undefined) ?? null;
|
|
949
|
+
if (notFound || !record) return notFoundAnswer(mode, String(args[mode]), formFactor);
|
|
950
|
+
|
|
951
|
+
const metrics = shapeMetrics(record.metrics);
|
|
952
|
+
const cwv = CORE_WEB_VITALS.filter((m) => metrics[m]);
|
|
953
|
+
const assessments = cwv.map((m) => (metrics[m] as { assessment: string | null }).assessment);
|
|
954
|
+
const allMeasured = cwv.length === CORE_WEB_VITALS.length && assessments.every((a) => a !== null);
|
|
955
|
+
|
|
956
|
+
return {
|
|
957
|
+
found: true,
|
|
958
|
+
[mode]: record.key?.[mode] ?? String(args[mode]),
|
|
959
|
+
form_factor: record.key?.formFactor ?? 'ALL_FORM_FACTORS',
|
|
960
|
+
collection_period: {
|
|
961
|
+
first_date: isoDate(record.collectionPeriod?.firstDate),
|
|
962
|
+
last_date: isoDate(record.collectionPeriod?.lastDate),
|
|
963
|
+
},
|
|
964
|
+
// Trap 4: the assessment is on p75, and Search's pass/fail needs all three.
|
|
965
|
+
core_web_vitals_assessment: allMeasured ? (assessments.every((a) => a === 'good') ? 'pass' : 'fail') : 'incomplete',
|
|
966
|
+
core_web_vitals_note:
|
|
967
|
+
'Google Search assesses Core Web Vitals at the 75th percentile of real visits, and requires LCP, INP and CLS all "good" to pass. CLS is a unitless score; every other metric here is milliseconds.',
|
|
968
|
+
metrics,
|
|
969
|
+
source: 'Chrome UX Report (CrUX), Google',
|
|
970
|
+
source_url: 'https://developer.chrome.com/docs/crux',
|
|
971
|
+
};
|
|
972
|
+
}
|
|
973
|
+
|
|
974
|
+
async function history(args: Record<string, unknown>) {
|
|
975
|
+
const key = requireKey(args);
|
|
976
|
+
const hasOrigin = !!String(args.origin ?? '').trim();
|
|
977
|
+
const hasUrl = !!String(args.url ?? '').trim();
|
|
978
|
+
if (hasOrigin === hasUrl) {
|
|
979
|
+
throw new Error('Give exactly one of `origin` (the whole site) or `url` (one page) — the CrUX API rejects both together and needs one.');
|
|
980
|
+
}
|
|
981
|
+
const mode: 'origin' | 'url' = hasOrigin ? 'origin' : 'url';
|
|
982
|
+
const body = buildTarget(args, mode);
|
|
983
|
+
const { notFound, record } = await queryCrux('records:queryHistoryRecord', body, key);
|
|
984
|
+
const formFactor = (body.formFactor as string | undefined) ?? null;
|
|
985
|
+
if (notFound || !record) return notFoundAnswer(mode, String(args[mode]), formFactor);
|
|
986
|
+
|
|
987
|
+
// The history shape differs from the point shape: collectionPeriods is an
|
|
988
|
+
// array, and every metric carries parallel arrays of the same length.
|
|
989
|
+
const raw = record as CruxRecord & {
|
|
990
|
+
collectionPeriods?: Array<{ firstDate?: { year: number; month: number; day: number }; lastDate?: { year: number; month: number; day: number } }>;
|
|
991
|
+
metrics?: Record<string, { percentilesTimeseries?: { p75s?: Array<number | string | null> } }>;
|
|
992
|
+
};
|
|
993
|
+
const periods = raw.collectionPeriods ?? [];
|
|
994
|
+
const series: Record<string, unknown> = {};
|
|
995
|
+
for (const [name, m] of Object.entries(raw.metrics ?? {})) {
|
|
996
|
+
const def = METRICS[name];
|
|
997
|
+
const p75s = m.percentilesTimeseries?.p75s ?? [];
|
|
998
|
+
const points = periods.map((p, i) => {
|
|
999
|
+
const v = asNumber(p75s[i]);
|
|
1000
|
+
return {
|
|
1001
|
+
period_start: isoDate(p.firstDate),
|
|
1002
|
+
period_end: isoDate(p.lastDate),
|
|
1003
|
+
p75: v,
|
|
1004
|
+
assessment: verdict(name, v),
|
|
1005
|
+
};
|
|
1006
|
+
});
|
|
1007
|
+
const measured = points.filter((p) => p.p75 !== null);
|
|
1008
|
+
series[name] = {
|
|
1009
|
+
label: def?.label ?? name,
|
|
1010
|
+
unit: def?.unit ?? null,
|
|
1011
|
+
points,
|
|
1012
|
+
first_measured: measured.length ? measured[0].p75 : null,
|
|
1013
|
+
latest_measured: measured.length ? measured[measured.length - 1].p75 : null,
|
|
1014
|
+
change: measured.length > 1 ? (measured[measured.length - 1].p75 as number) - (measured[0].p75 as number) : null,
|
|
1015
|
+
};
|
|
1016
|
+
}
|
|
1017
|
+
|
|
1018
|
+
return {
|
|
1019
|
+
found: true,
|
|
1020
|
+
[mode]: record.key?.[mode] ?? String(args[mode]),
|
|
1021
|
+
form_factor: record.key?.formFactor ?? 'ALL_FORM_FACTORS',
|
|
1022
|
+
period_count: periods.length,
|
|
1023
|
+
first_period_start: isoDate(periods[0]?.firstDate),
|
|
1024
|
+
last_period_end: isoDate(periods[periods.length - 1]?.lastDate),
|
|
1025
|
+
series,
|
|
1026
|
+
// Trap 6.
|
|
1027
|
+
window_note:
|
|
1028
|
+
'Each point is a 28-day TRAILING window ending on period_end, so consecutive weekly points overlap by 27 days. A move in this series is a move in a rolling average — a one-week regression shows up damped and spread across four points.',
|
|
1029
|
+
source: 'Chrome UX Report (CrUX) history API, Google',
|
|
1030
|
+
source_url: 'https://developer.chrome.com/docs/crux/history-api',
|
|
1031
|
+
};
|
|
1032
|
+
}
|
|
1033
|
+
|
|
1034
|
+
async function callTool(name: string, args: Record<string, unknown>): Promise<unknown> {
|
|
1035
|
+
switch (name) {
|
|
1036
|
+
case 'crux_query_origin':
|
|
1037
|
+
return queryRecord(args, 'origin');
|
|
1038
|
+
case 'crux_query_url':
|
|
1039
|
+
return queryRecord(args, 'url');
|
|
1040
|
+
case 'crux_history':
|
|
1041
|
+
return history(args);
|
|
1042
|
+
default:
|
|
1043
|
+
throw new Error(`Unknown tool: ${name}`);
|
|
1044
|
+
}
|
|
1045
|
+
}
|
|
1046
|
+
|
|
1047
|
+
export default { tools, callTool, meter: { credits: 1 } } satisfies McpToolExport;
|