@pipeworx/mcp-macau-stats 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/src/index.ts ADDED
@@ -0,0 +1,1112 @@
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 `&lt;script&gt;`
570
+ * in a title cannot decode into markup that survives — EMBL-EBI's ChEMBL 500
571
+ * page renders as `500 Internal Server Error &lt; 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(/&nbsp;/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
+ * Macau Statistics MCP — DSEC (Direcção dos Serviços de Estatística e Censos
640
+ * 澳門統計暨普查局 / Serviços de Estatística e Censos de Macau) key indicators.
641
+ *
642
+ * Why this exists: Pipeworx had zero Macau coverage. DSEC publishes a public
643
+ * SOAP web service, `TimeSeriesDatabase.asmx` (WSDL:
644
+ * https://www.dsec.gov.mo/TimeSeriesDatabase.asmx?WSDL), that is old-school
645
+ * ASP.NET ASMX — every SOAP operation also answers a plain HTTP GET
646
+ * (the framework's HttpGet binding), so no SOAP envelope, no registration and
647
+ * no key are needed despite the `/zh-MO/Service/WebService` page framing this
648
+ * as a "contact us" widget product (that copy describes the styled embed
649
+ * widget, not the raw data call used here). Confirmed live with a browser
650
+ * network tab (fleet #1311) and re-verified directly (fleet #1338).
651
+ *
652
+ * `getKeyIndicatorList` returns 143 named headline indicators (population,
653
+ * visitor arrivals, CPI, unemployment, gaming tax, gross revenue of games of
654
+ * chance, etc.) each with a `KeyIndicatorID`. `getKeyIndicatorValue` returns
655
+ * the latest published value for one of those 143 — this is the SAME monthly
656
+ * gross-gaming-revenue figure DICJ (the gaming regulator) publishes as an
657
+ * HTML table, sourced here as clean XML with no scrape needed. This
658
+ * supersedes any DICJ HTML-table pack — none is built.
659
+ *
660
+ * IMPORTANT ID-SPACE TRAP: the 143 curated `KeyIndicatorID`s are a SEPARATE,
661
+ * disjoint numbering from the general `IndicatorID` space used by
662
+ * `getIndicatorLatestNValues`/`getIndicatorValue` (DSEC's full statistics
663
+ * database, tens of thousands of series). `getIndicatorByID(15)` returns an
664
+ * EMPTY result — KeyIndicatorID 15 is not IndicatorID 15. There is no
665
+ * documented mapping between the two spaces. `getIndicatorID` does an
666
+ * upstream keyword/substring search over general-catalog descriptions; when
667
+ * a key indicator's own description matches EXACTLY ONE general-catalog
668
+ * series (e.g. "Live births" -> IndicatorID 9014, confirmed live), this pack
669
+ * uses that unique match to also pull a real historical series via
670
+ * `getIndicatorLatestNValues`. When the search is ambiguous (multiple hits)
671
+ * or empty (no hits — true for "Gross revenue of games of chance", which
672
+ * turns out to exist ONLY in the curated key-indicator set, not the general
673
+ * catalog), the tool still returns the correct current value from
674
+ * `getKeyIndicatorValue`, with `history: null` and a `history_note`
675
+ * explaining why — never a silently wrong series from a mismatched id.
676
+ *
677
+ * Source: Macao Statistics and Census Service (DSEC), dsec.gov.mo.
678
+ */
679
+
680
+
681
+ const UA = 'pipeworx-mcp-macau-stats/1.0 (+https://pipeworx.io)';
682
+ const BASE = 'https://www.dsec.gov.mo/TimeSeriesDatabase.asmx';
683
+ const UPSTREAM = 'DSEC TimeSeriesDatabase';
684
+
685
+ async function pwFetch(url: string): Promise<Response> {
686
+ return fetchWithTimeout(url, { headers: { 'User-Agent': UA } }, UPSTREAM);
687
+ }
688
+
689
+ // ── Tiny hand-rolled XML reader ─────────────────────────────────────────
690
+ // The upstream is old ASP.NET ASMX SOAP/GET and answers XML, not JSON — no
691
+ // namespaces or attributes worth parsing, just flat/nested tags with plain
692
+ // text or numeric content, so a couple of regexes cover it without pulling
693
+ // in an XML dependency (this pack must stay a single self-contained file —
694
+ // publish-pack.sh cannot inline sibling modules).
695
+
696
+ /** First occurrence of <tag>...</tag> content, or null. Handles self-closing
697
+ * empty tags (<tag />) by returning null too. */
698
+ function xmlTag(xml: string, tag: string): string | null {
699
+ const m = new RegExp(`<${tag}>([\\s\\S]*?)</${tag}>`).exec(xml);
700
+ return m ? decodeXmlEntities(m[1].trim()) : null;
701
+ }
702
+
703
+ /** Every top-level occurrence of a repeated <wrapperTag><itemTag>...</itemTag>
704
+ * ...</wrapperTag> block's inner content, as raw (un-decoded) XML fragments
705
+ * ready for a further xmlTag() call each. */
706
+ function xmlBlocks(xml: string, itemTag: string): string[] {
707
+ const re = new RegExp(`<${itemTag}>([\\s\\S]*?)</${itemTag}>`, 'g');
708
+ const out: string[] = [];
709
+ let m: RegExpExecArray | null;
710
+ while ((m = re.exec(xml))) out.push(m[1]);
711
+ return out;
712
+ }
713
+
714
+ function decodeXmlEntities(s: string): string {
715
+ return s
716
+ .replace(/&lt;/g, '<')
717
+ .replace(/&gt;/g, '>')
718
+ .replace(/&quot;/g, '"')
719
+ .replace(/&apos;/g, "'")
720
+ .replace(/&#(\d+);/g, (_, n) => String.fromCharCode(Number(n)))
721
+ .replace(/&amp;/g, '&');
722
+ }
723
+
724
+ function xmlStatusCode(xml: string): number | null {
725
+ const s = xmlTag(xml, 'StatusCode');
726
+ return s === null ? null : Number(s);
727
+ }
728
+
729
+ // ── Upstream shapes ──────────────────────────────────────────────────────
730
+
731
+ type Language = 'English' | 'TraditionalChinese' | 'SimplifiedChinese' | 'Portuguese';
732
+
733
+ interface KeyIndicator {
734
+ id: number;
735
+ description: string;
736
+ frequency: string;
737
+ }
738
+
739
+ interface IndicatorValue {
740
+ reference_period: string;
741
+ unit: string | null;
742
+ year: number;
743
+ period_id: number;
744
+ value: number | null;
745
+ remark: string | null;
746
+ }
747
+
748
+ const FREQUENCY_LABEL: Record<string, string> = {
749
+ Yearly: 'yearly',
750
+ Monthly: 'monthly',
751
+ Quarterly: 'quarterly',
752
+ ThreeConsecutiveMonths: 'rolling 3-month',
753
+ SchoolTerm: 'school term',
754
+ TwoConsecutiveYears: 'rolling 2-year',
755
+ ThreeConsecutiveYears: 'rolling 3-year',
756
+ FourConsecutiveYears: 'rolling 4-year',
757
+ };
758
+
759
+ function freqLabel(dataPeriod: string): string {
760
+ return FREQUENCY_LABEL[dataPeriod] ?? dataPeriod;
761
+ }
762
+
763
+ async function fetchKeyIndicatorList(lang: Language): Promise<KeyIndicator[]> {
764
+ const url = `${BASE}/getKeyIndicatorList?vLanguageType=${lang}`;
765
+ const res = await pwFetch(url);
766
+ if (!res.ok) throw await httpError(res, UPSTREAM);
767
+ const xml = await res.text();
768
+ const status = xmlStatusCode(xml);
769
+ if (status !== 0) {
770
+ throw new Error(`${UPSTREAM}: getKeyIndicatorList returned StatusCode ${status ?? 'unknown'} for ${lang}`);
771
+ }
772
+ return xmlBlocks(xml, 'DSECKeyIndicator')
773
+ .filter((b) => b.includes('<KeyIndicatorID>'))
774
+ .map((b) => ({
775
+ id: Number(xmlTag(b, 'KeyIndicatorID')),
776
+ description: xmlTag(b, 'Description') ?? '',
777
+ frequency: xmlTag(b, 'DataPeriod') ?? '',
778
+ }));
779
+ }
780
+
781
+ // In-isolate cache — the 143-row catalogue changes rarely and is fetched in
782
+ // up to 3 languages per call; no reason to refetch per request.
783
+ const CATALOG_TTL_MS = 60 * 60 * 1000; // 1h
784
+ let catalogCache: { rows: TriIndicator[]; expiresAt: number } | null = null;
785
+
786
+ interface TriIndicator {
787
+ id: number;
788
+ frequency: string;
789
+ en: string;
790
+ zh: string | null;
791
+ pt: string | null;
792
+ }
793
+
794
+ async function keyIndicatorCatalog(): Promise<TriIndicator[]> {
795
+ if (catalogCache && catalogCache.expiresAt > Date.now()) return catalogCache.rows;
796
+ const [en, zh, pt] = await Promise.all([
797
+ fetchKeyIndicatorList('English'),
798
+ fetchKeyIndicatorList('TraditionalChinese'),
799
+ fetchKeyIndicatorList('Portuguese'),
800
+ ]);
801
+ const zhById = new Map(zh.map((r) => [r.id, r.description]));
802
+ const ptById = new Map(pt.map((r) => [r.id, r.description]));
803
+ const rows: TriIndicator[] = en.map((r) => ({
804
+ id: r.id,
805
+ frequency: freqLabel(r.frequency),
806
+ en: r.description,
807
+ zh: zhById.get(r.id) ?? null,
808
+ pt: ptById.get(r.id) ?? null,
809
+ }));
810
+ catalogCache = { rows, expiresAt: Date.now() + CATALOG_TTL_MS };
811
+ return rows;
812
+ }
813
+
814
+ async function fetchKeyIndicatorValue(id: number, lang: Language = 'English'): Promise<IndicatorValue | null> {
815
+ const url = `${BASE}/getKeyIndicatorValue?iKeyIndicatorID=${id}&vLanguageType=${lang}`;
816
+ const res = await pwFetch(url);
817
+ if (!res.ok) throw await httpError(res, UPSTREAM);
818
+ const xml = await res.text();
819
+ const status = xmlStatusCode(xml);
820
+ if (status !== 0) {
821
+ throw new Error(`${UPSTREAM}: getKeyIndicatorValue returned StatusCode ${status ?? 'unknown'} for id ${id}`);
822
+ }
823
+ const block = xmlBlocks(xml, 'DSECIndicatorWSData')[0];
824
+ if (!block) return null;
825
+ const valueRaw = xmlTag(block, 'IndicatorValue');
826
+ return {
827
+ reference_period: xmlTag(block, 'ReferencePeriod') ?? '',
828
+ unit: xmlTag(block, 'UnitLabel'),
829
+ year: Number(xmlTag(block, 'Year') ?? 0),
830
+ period_id: Number(xmlTag(block, 'PeriodID') ?? 0),
831
+ value: valueRaw === null || valueRaw === '' ? null : Number(valueRaw),
832
+ remark: xmlTag(block, 'RemarkDescription') || null,
833
+ };
834
+ }
835
+
836
+ interface GeneralIndicatorMatch {
837
+ indicator_id: number;
838
+ description: string;
839
+ available_periods: string[];
840
+ }
841
+
842
+ /** Search DSEC's general (non-curated) indicator catalog by description
843
+ * substring. Returns a match ONLY when the search resolves to exactly one
844
+ * series — an ambiguous or empty search is deliberately treated as "no
845
+ * reliable mapping" rather than guessing, since KeyIndicatorID and
846
+ * IndicatorID are disjoint id spaces and a wrong guess would silently
847
+ * attach the wrong history to the wrong headline number. */
848
+ async function findUniqueGeneralIndicator(description: string): Promise<GeneralIndicatorMatch | null> {
849
+ const url = `${BASE}/getIndicatorID?strIndicatorDescription=${encodeURIComponent(description)}&vLanguageType=English`;
850
+ const res = await pwFetch(url);
851
+ if (!res.ok) throw await httpError(res, UPSTREAM);
852
+ const xml = await res.text();
853
+ if (xmlStatusCode(xml) !== 0) return null;
854
+ const blocks = xmlBlocks(xml, 'DSECIndicator').filter((b) => b.includes('<IndicatorID>'));
855
+ const exact = blocks.filter((b) => (xmlTag(b, 'Description') ?? '').trim().toLowerCase() === description.trim().toLowerCase());
856
+ const candidates = exact.length === 1 ? exact : blocks.length === 1 ? blocks : [];
857
+ if (candidates.length !== 1) return null;
858
+ const b = candidates[0];
859
+ const periods = xmlBlocks(b, 'DataPeriod');
860
+ return {
861
+ indicator_id: Number(xmlTag(b, 'IndicatorID')),
862
+ description: xmlTag(b, 'Description') ?? description,
863
+ available_periods: periods.length ? periods.map((p) => p.trim()) : [],
864
+ };
865
+ }
866
+
867
+ async function fetchIndicatorHistory(
868
+ indicatorId: number,
869
+ dataPeriod: string,
870
+ n: number,
871
+ ): Promise<IndicatorValue[]> {
872
+ const url =
873
+ `${BASE}/getIndicatorLatestNValues?iIndicatorID=${indicatorId}&vLanguageType=English` +
874
+ `&vFunctionType=VAL&vDataPeriodType=${dataPeriod}&iLatestNRecords=${n}`;
875
+ const res = await pwFetch(url);
876
+ if (!res.ok) throw await httpError(res, UPSTREAM);
877
+ const xml = await res.text();
878
+ if (xmlStatusCode(xml) !== 0) return [];
879
+ return xmlBlocks(xml, 'DSECIndicatorWSData').map((b) => {
880
+ const valueRaw = xmlTag(b, 'IndicatorValue');
881
+ return {
882
+ reference_period: xmlTag(b, 'ReferencePeriod') ?? '',
883
+ unit: xmlTag(b, 'UnitLabel'),
884
+ year: Number(xmlTag(b, 'Year') ?? 0),
885
+ period_id: Number(xmlTag(b, 'PeriodID') ?? 0),
886
+ value: valueRaw === null || valueRaw === '' ? null : Number(valueRaw),
887
+ remark: xmlTag(b, 'RemarkDescription') || null,
888
+ };
889
+ });
890
+ }
891
+
892
+ /** Resolve a caller-supplied id-or-name against the 143-row catalogue. */
893
+ async function resolveIndicator(idOrName: string | number | undefined, catalog: TriIndicator[]): Promise<TriIndicator | null> {
894
+ if (idOrName === undefined || idOrName === '') return null;
895
+ if (typeof idOrName === 'number' || /^\d+$/.test(String(idOrName))) {
896
+ const id = Number(idOrName);
897
+ return catalog.find((r) => r.id === id) ?? null;
898
+ }
899
+ const q = String(idOrName).trim().toLowerCase();
900
+ const exact = catalog.find((r) => r.en.toLowerCase() === q || r.zh === idOrName || r.pt?.toLowerCase() === q);
901
+ if (exact) return exact;
902
+ const contains = catalog.filter(
903
+ (r) => r.en.toLowerCase().includes(q) || (r.zh && String(idOrName).includes(r.zh)) || r.pt?.toLowerCase().includes(q),
904
+ );
905
+ return contains[0] ?? null;
906
+ }
907
+
908
+ async function buildIndicatorResult(row: TriIndicator, periods: number) {
909
+ const latest = await fetchKeyIndicatorValue(row.id);
910
+ const result: Record<string, unknown> = {
911
+ key_indicator_id: row.id,
912
+ description: { en: row.en, zh: row.zh, pt: row.pt },
913
+ frequency: row.frequency,
914
+ latest,
915
+ history: null,
916
+ history_note:
917
+ 'DSEC\'s curated key-indicator service (getKeyIndicatorValue) returns only the latest published value per indicator, ' +
918
+ 'not a series. This tool separately searches DSEC\'s general statistics catalog for a description match to pull real ' +
919
+ 'history via getIndicatorLatestNValues; that search found no single unambiguous match for this indicator, so only the ' +
920
+ 'latest value is returned.',
921
+ };
922
+ if (periods > 1) {
923
+ const match = await findUniqueGeneralIndicator(row.en);
924
+ if (match) {
925
+ const dataPeriod = match.available_periods.includes('Monthly')
926
+ ? 'Monthly'
927
+ : match.available_periods.includes('Quarterly')
928
+ ? 'Quarterly'
929
+ : match.available_periods.includes('Yearly')
930
+ ? 'Yearly'
931
+ : match.available_periods[0];
932
+ if (dataPeriod) {
933
+ const history = await fetchIndicatorHistory(match.indicator_id, dataPeriod, periods);
934
+ if (history.length) {
935
+ result.history = history;
936
+ result.history_note = `Historical series (${history.length} periods, ${freqLabel(dataPeriod)}) from DSEC's general statistics catalog, matched by description to "${match.description}" (IndicatorID ${match.indicator_id}).`;
937
+ }
938
+ }
939
+ }
940
+ }
941
+ return result;
942
+ }
943
+
944
+ // ── Tools ────────────────────────────────────────────────────────────────
945
+
946
+ const tools: McpToolExport['tools'] = [
947
+ {
948
+ name: 'macau_indicators',
949
+ description:
950
+ 'Catalogue of Macau\'s 143 official key statistical indicators (population, visitor arrivals, gaming revenue, CPI, unemployment, crime, births/deaths, and more) from DSEC (Macao Statistics and Census Service / 澳門統計暨普查局). Returns each indicator\'s id, name in English, 中文 (Traditional Chinese) and Portuguese, and reporting frequency. Pass `query` to filter by keyword (matches any language); omit it to list all 143. Use this to find the right id/name for `macau_indicator`. Answers "what economic indicators does Macau publish", "find Macau\'s tourism statistics".',
951
+ inputSchema: {
952
+ type: 'object' as const,
953
+ properties: {
954
+ query: {
955
+ type: 'string',
956
+ description: 'Optional keyword to filter indicators by name, in English, 中文 or Portuguese, e.g. "gaming", "population", "turismo".',
957
+ },
958
+ },
959
+ },
960
+ },
961
+ {
962
+ name: 'macau_indicator',
963
+ description:
964
+ 'Latest published value (and, when a reliable match exists, recent history) for one of Macau\'s 143 DSEC key indicators. Pass either the numeric `id` from `macau_indicators`, or a `name` keyword (English, 中文 or Portuguese, e.g. "gross revenue of games of chance", "population", "turismo"). Always returns the current value with its reference period and unit; `periods` (default 24) additionally attempts a historical series by matching the indicator against DSEC\'s general statistics database — this succeeds for many series but not all (some key indicators, notably gaming revenue, exist only as a curated latest-value widget with no general-catalog counterpart), in which case `history` is null and `history_note` explains why. Sourced from DSEC\'s public TimeSeriesDatabase.asmx web service.',
965
+ inputSchema: {
966
+ type: 'object' as const,
967
+ properties: {
968
+ id: { type: 'number', description: 'Numeric KeyIndicatorID from macau_indicators, e.g. 15 for "Gross revenue of games of chance".' },
969
+ name: { type: 'string', description: 'Indicator name or keyword, English/中文/Portuguese, e.g. "gaming revenue", "population".' },
970
+ periods: { type: 'number', description: 'How many historical periods to attempt to fetch when a general-catalog match is found (default 24).' },
971
+ },
972
+ },
973
+ },
974
+ {
975
+ name: 'macau_gaming_revenue',
976
+ description:
977
+ 'Macau\'s monthly gross revenue of games of chance (澳門博彩毛收入 / receita bruta dos jogos de fortuna ou azar) — the headline casino-gaming-revenue figure, in million MOP, from DSEC. This is the SAME monthly number the gaming regulator DICJ publishes as an HTML table, sourced here as clean structured data. Answers "what was Macau\'s gaming revenue in August 2026", "Macau casino revenue this month".',
978
+ inputSchema: { type: 'object' as const, properties: {} },
979
+ },
980
+ {
981
+ name: 'macau_population',
982
+ description:
983
+ "Macau's total resident population (澳門總人口 / população total de Macau), quarterly, from DSEC. Answers \"what is Macau's population\".",
984
+ inputSchema: { type: 'object' as const, properties: {} },
985
+ },
986
+ {
987
+ name: 'macau_tourism',
988
+ description:
989
+ 'Macau visitor arrivals (訪澳旅客人數 / chegadas de visitantes a Macau), monthly, from DSEC — the headline tourism-volume figure. Answers "how many tourists visited Macau", "Macau visitor arrivals this month".',
990
+ inputSchema: { type: 'object' as const, properties: {} },
991
+ },
992
+ {
993
+ name: 'macau_employment',
994
+ description:
995
+ "Macau's labour-market snapshot from DSEC: overall unemployment rate, total employment and overall median monthly employment earnings (each on its own DSEC reporting cycle — unemployment/employment are rolling 3-month, earnings quarterly). Answers \"what is Macau's unemployment rate\", \"Macau employment statistics\".",
996
+ inputSchema: { type: 'object' as const, properties: {} },
997
+ },
998
+ ];
999
+
1000
+ // ── Convenience-tool ids, resolved against the live catalogue (not
1001
+ // hardcoded blind) so a description change upstream can't silently point
1002
+ // at the wrong series — each is verified by exact-description match below. ──
1003
+ const GAMING_REVENUE_DESC = 'Gross revenue of games of chance';
1004
+ const POPULATION_DESC = 'Total Population';
1005
+ const VISITOR_ARRIVALS_DESC = 'Visitor arrivals';
1006
+ const UNEMPLOYMENT_DESC = 'Overall unemployment rate';
1007
+ const EMPLOYMENT_DESC = 'Total employment';
1008
+ const EARNINGS_DESC = 'Overall median monthly employment earnings';
1009
+
1010
+ async function findByExactEn(catalog: TriIndicator[], desc: string): Promise<TriIndicator | null> {
1011
+ return catalog.find((r) => r.en === desc) ?? null;
1012
+ }
1013
+
1014
+ // ── Implementations ────────────────────────────────────────────────────
1015
+
1016
+ async function toolIndicators(args: Record<string, unknown>) {
1017
+ const catalog = await keyIndicatorCatalog();
1018
+ const query = typeof args.query === 'string' ? args.query.trim().toLowerCase() : '';
1019
+ const rows = query
1020
+ ? catalog.filter(
1021
+ (r) => r.en.toLowerCase().includes(query) || (r.zh && r.zh.includes(args.query as string)) || r.pt?.toLowerCase().includes(query),
1022
+ )
1023
+ : catalog;
1024
+ return {
1025
+ total: catalog.length,
1026
+ matched: rows.length,
1027
+ query: query || null,
1028
+ indicators: rows.map((r) => ({
1029
+ id: r.id,
1030
+ frequency: r.frequency,
1031
+ name: { en: r.en, zh: r.zh, pt: r.pt },
1032
+ })),
1033
+ source: 'DSEC (Macao Statistics and Census Service) TimeSeriesDatabase.asmx getKeyIndicatorList',
1034
+ };
1035
+ }
1036
+
1037
+ async function toolIndicator(args: Record<string, unknown>) {
1038
+ const catalog = await keyIndicatorCatalog();
1039
+ const idArg = typeof args.id === 'number' ? args.id : typeof args.id === 'string' ? args.id : undefined;
1040
+ const nameArg = typeof args.name === 'string' ? args.name : undefined;
1041
+ const row = await resolveIndicator(idArg ?? nameArg, catalog);
1042
+ if (!row) {
1043
+ return {
1044
+ found: false,
1045
+ reason: 'indicator_not_recognized',
1046
+ queried: idArg ?? nameArg ?? null,
1047
+ hint: 'Call macau_indicators (optionally with a `query` keyword) to find a valid id or name from DSEC\'s 143 published key indicators.',
1048
+ };
1049
+ }
1050
+ const periods = typeof args.periods === 'number' && args.periods > 0 ? Math.floor(args.periods) : 24;
1051
+ return { found: true, ...(await buildIndicatorResult(row, periods)) };
1052
+ }
1053
+
1054
+ async function toolGamingRevenue() {
1055
+ const catalog = await keyIndicatorCatalog();
1056
+ const row = await findByExactEn(catalog, GAMING_REVENUE_DESC);
1057
+ if (!row) throw new Error(`${UPSTREAM}: expected key indicator "${GAMING_REVENUE_DESC}" was not found in the current catalogue`);
1058
+ return buildIndicatorResult(row, 1);
1059
+ }
1060
+
1061
+ async function toolPopulation() {
1062
+ const catalog = await keyIndicatorCatalog();
1063
+ const row = await findByExactEn(catalog, POPULATION_DESC);
1064
+ if (!row) throw new Error(`${UPSTREAM}: expected key indicator "${POPULATION_DESC}" was not found in the current catalogue`);
1065
+ return buildIndicatorResult(row, 8);
1066
+ }
1067
+
1068
+ async function toolTourism() {
1069
+ const catalog = await keyIndicatorCatalog();
1070
+ const row = await findByExactEn(catalog, VISITOR_ARRIVALS_DESC);
1071
+ if (!row) throw new Error(`${UPSTREAM}: expected key indicator "${VISITOR_ARRIVALS_DESC}" was not found in the current catalogue`);
1072
+ return buildIndicatorResult(row, 24);
1073
+ }
1074
+
1075
+ async function toolEmployment() {
1076
+ const catalog = await keyIndicatorCatalog();
1077
+ const [unemployment, employment, earnings] = await Promise.all(
1078
+ [UNEMPLOYMENT_DESC, EMPLOYMENT_DESC, EARNINGS_DESC].map(async (desc) => {
1079
+ const row = await findByExactEn(catalog, desc);
1080
+ if (!row) return { description: desc, found: false };
1081
+ const latest = await fetchKeyIndicatorValue(row.id);
1082
+ return { key_indicator_id: row.id, description: { en: row.en, zh: row.zh, pt: row.pt }, frequency: row.frequency, latest, found: true };
1083
+ }),
1084
+ );
1085
+ return {
1086
+ unemployment_rate: unemployment,
1087
+ total_employment: employment,
1088
+ median_monthly_earnings: earnings,
1089
+ source: 'DSEC (Macao Statistics and Census Service) TimeSeriesDatabase.asmx',
1090
+ };
1091
+ }
1092
+
1093
+ async function callTool(name: string, args: Record<string, unknown>): Promise<unknown> {
1094
+ switch (name) {
1095
+ case 'macau_indicators':
1096
+ return toolIndicators(args);
1097
+ case 'macau_indicator':
1098
+ return toolIndicator(args);
1099
+ case 'macau_gaming_revenue':
1100
+ return toolGamingRevenue();
1101
+ case 'macau_population':
1102
+ return toolPopulation();
1103
+ case 'macau_tourism':
1104
+ return toolTourism();
1105
+ case 'macau_employment':
1106
+ return toolEmployment();
1107
+ default:
1108
+ throw new Error(`Unknown tool: ${name}`);
1109
+ }
1110
+ }
1111
+
1112
+ export default { tools, callTool, meter: { credits: 1 } } satisfies McpToolExport;