@pipeworx/mcp-alphavantage 0.1.0 → 0.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/src/index.ts CHANGED
@@ -1,23 +1,694 @@
1
1
  interface McpToolDefinition {
2
2
  name: string;
3
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;
4
8
  inputSchema: {
5
9
  type: 'object';
6
10
  properties: Record<string, unknown>;
7
11
  required?: string[];
12
+ anyOf?: Array<{ required: string[] }>;
13
+ oneOf?: Array<{ required: string[] }>;
14
+ allOf?: Array<{ required: string[] }>;
8
15
  };
16
+ outputSchema?: Record<string, unknown>;
9
17
  }
10
18
 
11
19
  interface McpToolExport {
12
20
  tools: McpToolDefinition[];
13
21
  callTool: (name: string, args: Record<string, unknown>) => Promise<unknown>;
22
+ meter?: { credits: number };
23
+ cost?: Record<string, unknown>;
24
+ provider?: string;
14
25
  }
15
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
+ // Fleet #2382. Everything that isn't a timeout/abort here is a genuine
456
+ // NETWORK-LEVEL failure — DNS resolution, connection refused, TLS handshake,
457
+ // Cloudflare's own "Network connection lost." — meaning `fetch()` itself
458
+ // threw and no HTTP response of any kind was ever received. Until this fix
459
+ // that raw exception was rethrown VERBATIM: a bare `TypeError: fetch failed`
460
+ // (or the Workers-runtime equivalent) names no upstream, carries no class
461
+ // token, and reads exactly like a defect in OUR code — because it says
462
+ // nothing about the call at all. It landed in `error`, the tier that means
463
+ // "Pipeworx has a defect", for every one of the (at the time of writing)
464
+ // ~470 packs that call this helper directly with no wrapper of their own.
465
+ //
466
+ // `dexscreener` hit this independently (fleet #1579) and fixed it with a
467
+ // bespoke per-pack try/catch around `fetchWithTimeout`. That fix is correct
468
+ // but only covers one pack; every other caller of this shared helper still
469
+ // leaked the raw exception. Moving the same fix HERE — the one place that
470
+ // already carries the timeout case — covers every pack that uses
471
+ // `fetchWithTimeout` without a wrapper, for free, and without widening
472
+ // `classifyToolError`'s regex list: the fix is giving the message a proper
473
+ // `upstream_down:` token at the point the two facts (no response was ever
474
+ // received, and which host we were trying to reach) are actually in hand,
475
+ // not teaching the classifier to guess from prose after the fact.
476
+ //
477
+ // Safe on the same grounds as the timeout branch above: no argument a
478
+ // caller passes can make `fetch()` itself throw a connection-level error,
479
+ // so this is always an availability failure, never a caller mistake. Same
480
+ // `markInternalOrigin` treatment — an origin we run that never answered is
481
+ // still ours, not a third party's outage.
482
+ const raw = err instanceof Error ? err.message : String(err);
483
+ throw new Error(
484
+ markInternalOrigin(
485
+ `upstream_down: could not reach ${name} at all (${raw.slice(0, 160)}). ` +
486
+ `No request reached ${name}, so this says NOTHING about whether the arguments you passed ` +
487
+ 'are valid — do not re-check them on the strength of this error. Retry shortly.',
488
+ url,
489
+ ),
490
+ );
491
+ }
492
+ }
493
+
494
+ function detailSuffix(detail: string): string {
495
+ return detail ? ` — ${detail}` : '';
496
+ }
497
+
498
+ async function readDetail(res: Response): Promise<string> {
499
+ let raw: string;
500
+ try {
501
+ raw = await res.text();
502
+ } catch {
503
+ // Body already consumed, or the connection died mid-read. The status alone
504
+ // is still worth throwing — never let the error path throw its own error.
505
+ return '';
506
+ }
507
+ return summarizeErrorBody(raw);
508
+ }
509
+
510
+ /**
511
+ * Turn ANY error body — JSON, HTML, XML or plain text — into one short phrase
512
+ * that never contains markup.
513
+ *
514
+ * This used to just drop an HTML or XML body on the floor, on the reasoning
515
+ * that markup crowds out the status. That was half right. Dropping it loses the
516
+ * one sentence a caller could have acted on: an `Access Denied` title, an SDMX
517
+ * `<message:Error>` text, an OPS fault string. A 2026-08-30 support sweep
518
+ * measured 13 of 291 caller-facing error rows carrying a raw page or document
519
+ * verbatim, across 11 packs, and in every one of them the useful content —
520
+ * "Access Denied", "Invalid country code", "SCRAPE_TIMEOUT" — was in there,
521
+ * buried in markup the agent had to parse out of a string (fleet #712).
522
+ *
523
+ * So: extract the meaning, discard the markup. The output is passed through
524
+ * `stripMarkup` unconditionally, which is what lets `check:error-body-leak`
525
+ * assert mechanically that no caller-facing message can contain `<?xml`,
526
+ * `<!DOCTYPE` or `<html`.
527
+ */
528
+ function summarizeErrorBody(raw: string): string {
529
+ if (!raw || !raw.trim()) return '';
530
+
531
+ const head = raw.slice(0, 400).trimStart().toLowerCase();
532
+
533
+ // An HTML error page (Cloudflare interstitial, nginx default, a login
534
+ // redirect) says what it is in its <title>, and almost nowhere else.
535
+ if (head.startsWith('<!doctype') || head.startsWith('<html')) {
536
+ const title = htmlTitle(raw);
537
+ return title
538
+ ? `${title} (upstream returned an HTML error page, not an API response)`
539
+ : 'upstream returned an HTML error page, not an API response';
540
+ }
541
+
542
+ // XML fault documents — EPO OPS, SDMX (`<message:Error>`), SOAP faults. The
543
+ // human sentence sits in a child element whose tag name says what it is.
544
+ if (head.startsWith('<?xml') || head.startsWith('<')) {
545
+ const fault = xmlFaultText(raw);
546
+ return fault
547
+ ? `${stripMarkup(fault).slice(0, MAX_DETAIL)} (from the upstream's XML error document)`
548
+ : 'upstream returned an XML error document with no readable message';
549
+ }
550
+
551
+ // Most JSON error bodies bury one human sentence among ids and echoed request
552
+ // params. Prefer that sentence; fall back to the whole body when the shape is
553
+ // unfamiliar, since an unfamiliar shape is exactly when we can least afford to
554
+ // guess wrong and show nothing.
555
+ const fromJson = messageFromJson(raw);
556
+ return stripMarkup(fromJson ?? raw).slice(0, MAX_DETAIL);
557
+ }
558
+
559
+ /** The `<title>` of an HTML error page, or its first `<h1>` — the two places a
560
+ * bot wall, a 502 and an "Access Denied" all state what happened. */
561
+ function htmlTitle(raw: string): string | null {
562
+ const head = raw.slice(0, 4000);
563
+ for (const re of [/<title[^>]*>([\s\S]*?)<\/title>/i, /<h1[^>]*>([\s\S]*?)<\/h1>/i]) {
564
+ const m = re.exec(head);
565
+ const text = m ? stripMarkup(m[1]) : '';
566
+ if (text) return text.slice(0, 160);
567
+ }
568
+ return null;
569
+ }
570
+
571
+ /** Tag names that carry the explanation in an XML fault document, namespace
572
+ * prefix optional (`<message:Error>`, `<com:Text>`, `<faultstring>`). */
573
+ const XML_FAULT_TAG_RE =
574
+ /<(?:[A-Za-z0-9_.-]+:)?(?:text|message|description|faultstring|reason|detail|title|errormessage|error)\b[^>]*>([^<]{2,400})</i;
575
+
576
+ function xmlFaultText(raw: string): string | null {
577
+ const head = raw.slice(0, 8000);
578
+ const tagged = XML_FAULT_TAG_RE.exec(head);
579
+ if (tagged && tagged[1].trim()) return tagged[1];
580
+
581
+ // Nothing conventionally named — take the longest text node instead. A fault
582
+ // document with one sentence in an oddly named element is still readable;
583
+ // returning nothing at all is not.
584
+ let best = '';
585
+ for (const m of head.matchAll(/>([^<>]{8,400})</g)) {
586
+ const text = m[1].trim();
587
+ if (text.length > best.length) best = text;
588
+ }
589
+ return best || null;
590
+ }
591
+
592
+ /**
593
+ * Remove every tag and stray angle bracket, then collapse whitespace.
594
+ *
595
+ * Applied to everything on the way out, including the JSON and plain-text
596
+ * paths, because an upstream is free to embed markup in a JSON string field —
597
+ * and a leak is a leak regardless of which branch produced it.
598
+ */
599
+ function stripMarkup(s: string): string {
600
+ return collapse(decodeEntities(s.replace(/<[^>]*>/g, ' ')).replace(/[<>]/g, ' '));
601
+ }
602
+
603
+ /** The handful of entities that show up in error-page titles. Decoded AFTER
604
+ * tags are stripped and BEFORE the angle-bracket sweep, so `&lt;script&gt;`
605
+ * in a title cannot decode into markup that survives — EMBL-EBI's ChEMBL 500
606
+ * page renders as `500 Internal Server Error &lt; EMBL-EBI` otherwise. */
607
+ function decodeEntities(s: string): string {
608
+ return s
609
+ .replace(/&(?:amp|#0*38);/gi, '&')
610
+ .replace(/&(?:lt|#0*60);/gi, '<')
611
+ .replace(/&(?:gt|#0*62);/gi, '>')
612
+ .replace(/&(?:quot|#0*34);/gi, '"')
613
+ .replace(/&(?:#0*39|apos|#x0*27);/gi, "'")
614
+ .replace(/&nbsp;/gi, ' ');
615
+ }
616
+
617
+ /** The conventional "what went wrong" field, under any of the names upstreams
618
+ * actually use. Checked in order; first non-empty string wins. */
619
+ const MESSAGE_KEYS = [
620
+ 'message', 'error_message', 'errorMessage', 'detail', 'details',
621
+ 'description', 'error_description', 'reason', 'title', 'fault',
622
+ ];
623
+
624
+ function messageFromJson(raw: string): string | null {
625
+ let parsed: unknown;
626
+ try {
627
+ parsed = JSON.parse(raw);
628
+ } catch {
629
+ return null;
630
+ }
631
+ return pickMessage(parsed, 0);
632
+ }
633
+
634
+ function pickMessage(node: unknown, depth: number): string | null {
635
+ // Two levels covers `{error: {message}}` and `{errors: [{detail}]}`, the two
636
+ // shapes that account for nearly all of them, without walking a large payload.
637
+ if (depth > 2 || node == null) return null;
638
+
639
+ if (typeof node === 'string') return node.trim() || null;
640
+
641
+ if (Array.isArray(node)) {
642
+ for (const item of node) {
643
+ const found = pickMessage(item, depth + 1);
644
+ if (found) return found;
645
+ }
646
+ return null;
647
+ }
648
+
649
+ if (typeof node !== 'object') return null;
650
+ const obj = node as Record<string, unknown>;
651
+
652
+ for (const key of MESSAGE_KEYS) {
653
+ const v = obj[key];
654
+ if (typeof v === 'string' && v.trim()) return v.trim();
655
+ }
656
+ // `{error: …}` where error is itself an object or a string — the single most
657
+ // common wrapper, so it is worth descending into by name rather than scanning
658
+ // every key and risking picking up an echoed request parameter.
659
+ for (const key of ['error', 'errors', 'fault', 'Error', 'data']) {
660
+ if (key in obj) {
661
+ const found = pickMessage(obj[key], depth + 1);
662
+ if (found) return found;
663
+ }
664
+ }
665
+ return null;
666
+ }
667
+
668
+ /** Errors are read in a single line of log output; newlines and runs of
669
+ * whitespace make a multi-line body unreadable there. */
670
+ function collapse(s: string): string {
671
+ return s.replace(/\s+/g, ' ').trim();
672
+ }
16
673
  /**
17
674
  * Alpha Vantage MCP — Stock market data, fundamentals, and earnings
18
675
  *
19
- * BYO key: requires a free Alpha Vantage API key from https://www.alphavantage.co/support/#api-key
20
- * Passed via _apiKey parameter. Free tier: 25 requests/day.
676
+ * PAID-TIER PLATFORM KEY SINCE 2026-09-10 (Bruce). This reverses the 2026-09-02
677
+ * `byok` ruling (fleet #1117): that ruling and #1129 were about the FREE tier,
678
+ * which Alpha Vantage meters by server IP so no free key works from the
679
+ * gateway. The key Bruce supplied on 09-10 is a PAID plan (verified: it answers
680
+ * the premium intraday endpoint a free key refuses), metered by key, and the
681
+ * gateway entry names PLATFORM_ALPHAVANTAGE_KEY with `paidKeyOnly: true` —
682
+ * OUR key backs calls from PAID accounts only; everyone else passes `_apiKey`.
683
+ * Callers with neither get the refusal in extractKey below, which says the
684
+ * pack requires an API key and names two keyless substitutes.
685
+ *
686
+ * The key that has to be brought is a PAID one. A FREE key does not work from
687
+ * our infrastructure at all — Alpha Vantage meters the free tier by source IP
688
+ * and never validates the key, so a caller's free key is refused from our
689
+ * egress for exactly the reason ours was, and both our egress paths are already
690
+ * spent. See the measurement below (fleet #1070) before assuming a key of any
691
+ * kind is the fix.
21
692
  *
22
693
  * Tools:
23
694
  * - av_quote: get real-time stock quote
@@ -29,43 +700,249 @@ interface McpToolExport {
29
700
  */
30
701
 
31
702
 
703
+ // Bound every fetch() in this pack to a fixed timeout — an upstream that
704
+ // degrades without erroring would otherwise hold the Worker in `await fetch()`
705
+ // until its own execution budget kills the request (minutes, not seconds).
706
+ // Mirrors the epoFetch / usaspending retryFetch pattern (fleet #685).
707
+ async function pwFetch(url: string | URL, init?: RequestInit): Promise<Response> {
708
+ return fetchWithTimeout(url, init ?? {}, 'Alpha Vantage');
709
+ }
710
+
32
711
  const BASE = 'https://www.alphavantage.co/query';
33
712
 
713
+ /**
714
+ * ALPHA VANTAGE'S FREE TIER IS METERED PER SOURCE IP, NOT PER KEY — AND NEITHER
715
+ * OF OUR EGRESS PATHS HAS ANY OF THAT BUDGET LEFT.
716
+ *
717
+ * Measured 2026-09-02 (fleet #1070), the first three within one minute:
718
+ * gateway, a key Bruce had just issued -> "25 requests per day" refusal
719
+ * gateway, the string "ZZZZINVALIDKEY99" -> the SAME refusal
720
+ * laptop, the string "ZZZZINVALIDKEY99" -> HTTP 200, real IBM quote data
721
+ * supabase edge fn, that same string -> the same 25-per-day refusal
722
+ *
723
+ * A key Alpha Vantage never validates cannot be the thing it is counting; what
724
+ * is spent is the address we leave from. That rules out every fix that sounds
725
+ * plausible here: rotating our platform key (Bruce supplied a fresh one and it
726
+ * changed nothing), BYOK (a caller's free key is refused from our egress just
727
+ * like ours), and the non-CF egress relay (its own IP is spent too — this is
728
+ * the GLOBOCAN case, not the stackexchange case, so the host is deliberately
729
+ * NOT allow-listed in supabase/functions/egress-proxy/index.ts).
730
+ *
731
+ * RE-CONFIRMED 2026-09-02 on a THIRD key, because the obvious response to all of
732
+ * the above is to try one more. Bruce issued a new key and answered fleet #1070
733
+ * with it. Measured the same hour:
734
+ * laptop, that new key -> HTTP 200, real MSFT quote
735
+ * laptop, "ZZZZINVALIDKEY99" -> HTTP 200, real IBM quote <-- the point
736
+ * gateway, that new key as _apiKey -> the same daily-cap refusal
737
+ * The second line is why a laptop check proves nothing here: Alpha Vantage does
738
+ * not validate the key on this path at all, so ANY string "works" from an IP
739
+ * with budget left. Validating a key from your workstation and concluding the
740
+ * key is good is the trap; the only meaningful probe is from the gateway.
741
+ *
742
+ * What is left is a PAID key: premium is the one thing Alpha Vantage actually
743
+ * authenticates, its premium endpoints refuse a free key by name. Not verified
744
+ * from here — we do not hold one — so it is an inference, not a measurement.
745
+ * Note BYOK does not rescue this either unless the CALLER's key is itself paid:
746
+ * a caller's free key is metered by our egress IP exactly like ours.
747
+ *
748
+ * That is the whole content of Bruce's `byok` ruling on fleet #1117, and it is
749
+ * worth stating plainly rather than leaving implied: BYOK here is NOT "any
750
+ * caller key makes this work again". It restores the pack for the narrow set of
751
+ * callers who already hold a PAID Alpha Vantage plan, and for everyone else it
752
+ * makes the refusal honest and free — honest because a keyless caller now meets
753
+ * our own "requires an API key" wall instead of Alpha Vantage's daily-cap prose
754
+ * about a key they never supplied, and free because that wall is reached
755
+ * without spending an upstream call. Every refusal names finnhub (quotes) and
756
+ * keyless sec-xbrl (US company financials), which do work today.
757
+ */
758
+
34
759
  // ── Helpers ───────────────────────────────────────────────────────────
35
760
 
761
+ const FINNHUB_HINT = 'For real-time quotes without rate-limit headaches, the "finnhub" pack is a better default — get a free key at https://finnhub.io/register (60 calls/min, no daily cap).';
762
+
763
+ // For fundamentals (income statement / balance sheet / overview / earnings) the
764
+ // best fallback is keyless: SEC XBRL needs NO API key at all and is never
765
+ // quota-limited. Point US-company financial-statement queries there first.
766
+ const SEC_XBRL_HINT = 'For US-company financial statements without any API key, call get_company_financials (the "sec-xbrl" pack) — keyless SEC XBRL data, no daily cap. Pass it as `company` — a ticker (e.g. "NVDA") or a CIK. Then finnhub (needs a free key) covers non-US / real-time.';
767
+
36
768
  function extractKey(args: Record<string, unknown>): string {
37
769
  const key = args._apiKey as string;
38
770
  delete args._apiKey;
39
- if (!key) throw new Error('Alpha Vantage API key required. Get one free at https://www.alphavantage.co/support/#api-key and pass via _apiKey.');
771
+ if (!key || typeof key !== 'string' || !key.trim()) {
772
+ // THE BYO WALL, and the one refusal most callers of this pack will ever see
773
+ // (Bruce, fleet #1117: `byok`). Three things it has to do, none optional:
774
+ //
775
+ // 1. Say "requires an API key", in those words. That clause is what marks a
776
+ // gated refusal as an expected access wall rather than a pack defect;
777
+ // without it the call books as an ERROR and the pack shows up on the
778
+ // problem-tool list for working exactly as designed.
779
+ // 2. Carry the `auth_required:` prefix, which classifyToolError trusts
780
+ // unconditionally (workers/gateway/src/error-class.ts) instead of
781
+ // inferring the class from incidental wording.
782
+ // 3. NOT send the caller to fetch a free key. The previous version of this
783
+ // message did ("Get one free at ... and pass via _apiKey") and it was
784
+ // measured wrong: Alpha Vantage meters its free tier by SOURCE IP and
785
+ // never validates the key, so a caller's free key is refused from our
786
+ // egress exactly like ours was. Telling someone to go and get a
787
+ // credential that cannot change the outcome is worse than refusing, and
788
+ // it is the same mistake this pack spent a month making about OUR key.
789
+ // Only a PAID key changes anything, because premium is the one thing
790
+ // Alpha Vantage actually authenticates.
791
+ //
792
+ // Both substitutes are named because they cover the pack's two halves and
793
+ // both work right now: sec-xbrl keylessly for US financial statements,
794
+ // finnhub for quotes.
795
+ throw new Error(
796
+ 'auth_required: alphavantage requires an API key — Pipeworx fronts one for paid accounts only; otherwise pass your own via _apiKey. '
797
+ + 'It must be a PAID Alpha Vantage key: their free tier is metered by source IP rather than by key, so a free key is refused through the gateway no matter whose it is (https://www.alphavantage.co/premium/). '
798
+ + `Two substitutes that need no paid key at all: ${SEC_XBRL_HINT} ${FINNHUB_HINT}`,
799
+ );
800
+ }
801
+ if (key.trim().toLowerCase() === 'demo') {
802
+ throw new Error(`auth_required: The "demo" Alpha Vantage key is heavily rate-limited and only works for one specific symbol, and a free key of your own will not work either — Alpha Vantage meters the free tier by source IP, so it is refused through the gateway. A PAID key works (https://www.alphavantage.co/premium/). ${SEC_XBRL_HINT} ${FINNHUB_HINT}`);
803
+ }
40
804
  return key;
41
805
  }
42
806
 
43
- async function avGet(apiKey: string, params: Record<string, string>): Promise<unknown> {
807
+ async function avGet(apiKey: string, params: Record<string, string>, fallbackHint: string = FINNHUB_HINT): Promise<unknown> {
44
808
  const url = new URL(BASE);
45
809
  for (const [k, v] of Object.entries(params)) {
46
810
  url.searchParams.set(k, v);
47
811
  }
48
812
  url.searchParams.set('apikey', apiKey);
49
813
 
50
- const res = await fetch(url.toString(), {
814
+ // Declared BEFORE the first thing that can echo the upstream, not after it.
815
+ // #1091 added this scrub for the 200-with-a-notice branches, where Alpha
816
+ // Vantage quotes the key back in prose ("We have detected your API key as
817
+ // <key>..."). The non-200 branch below forwards res.text() verbatim and sat
818
+ // ABOVE the declaration, so it was the one path that could still put the key
819
+ // into a thrown message — and a thrown message reaches Analytics Engine
820
+ // (blob5) unscrubbed. That is how the previous key went out in live
821
+ // rate-limit responses; rotating without closing this would refill the same
822
+ // pipe with the new one.
823
+ const scrub = (text: string): string => (apiKey ? text.split(apiKey).join('[redacted]') : text);
824
+
825
+ const res = await pwFetch(url.toString(), {
51
826
  headers: { Accept: 'application/json' },
52
827
  });
53
828
  if (!res.ok) {
54
829
  const text = await res.text();
55
- throw new Error(`Alpha Vantage API error (${res.status}): ${text}`);
830
+ throw new Error(`Alpha Vantage API error (${res.status}): ${scrub(text)}`);
56
831
  }
57
832
 
58
833
  const data = (await res.json()) as Record<string, unknown>;
59
834
 
60
- // Alpha Vantage returns error messages in the response body
835
+ // Alpha Vantage quotes the key straight back inside its own refusal prose
836
+ // ("We have detected your API key as <key> and our standard API rate limit is
837
+ // 25 requests per day"), so every branch below that repeats the upstream's
838
+ // words redacts ours out of it first. The gateway scrubs injected credentials
839
+ // from a RETURNED envelope, but the daily-cap branch now THROWS, and a thrown
840
+ // message reaches Analytics Engine (blob5) unscrubbed — so leaving this to the
841
+ // gateway would park our own platform key in the metrics store for the
842
+ // retention window. Doing it here also keeps the standalone npm build honest,
843
+ // where there is no gateway to scrub anything. (fleet #1091)
844
+ // scrub is declared above, before the first branch that can echo upstream text.
845
+
846
+ // Alpha Vantage returns error messages in the response body. Treat genuine
847
+ // input errors (bad symbol, malformed request) as hard errors — the agent
848
+ // should know to fix its call.
61
849
  if (data['Error Message']) {
62
- throw new Error(`Alpha Vantage error: ${data['Error Message']}`);
850
+ throw new Error(`Alpha Vantage error: ${scrub(String(data['Error Message']))}`);
63
851
  }
64
- if (data['Note']) {
65
- throw new Error(`Alpha Vantage rate limit: ${data['Note']}`);
66
- }
67
- if (data['Information']) {
68
- throw new Error(`Alpha Vantage: ${data['Information']}`);
852
+
853
+ // THE REFUSAL NOTICE ARRIVES UNDER EITHER KEY, and which one is not stable.
854
+ // This used to be two separate branches: `Note` was hardcoded to
855
+ // reason:'rate_limit' and only `Information` was classified. Measured live
856
+ // 2026-09-02, minutes apart, on the same spent key:
857
+ // Information: "Thank you for using Alpha Vantage! Please contact
858
+ // premium@alphavantage.co ..." -> quota_exceeded
859
+ // Note: "We have detected your API key as <k> and our standard API
860
+ // rate limit is 25 requests per day ..." -> rate_limit
861
+ // The SECOND is the more explicit daily-cap message and it was the one landing
862
+ // in the branch that could not say so. Fleet #1091 was filed on exactly that
863
+ // observation ("the reason string is rate_limit, NOT quota_exceeded") and read
864
+ // it as a transcription error; it was the envelope key. Classify one notice,
865
+ // whichever key carries it.
866
+ const notice = data['Note'] ?? data['Information'];
867
+ if (notice !== undefined && notice !== null && String(notice).trim()) {
868
+ const info = scrub(String(notice));
869
+ // A notice naming ONLY a per-minute frequency is a short throttle: wait a
870
+ // minute and the same call works. Anything else, on a key whose entire free
871
+ // allowance is 25 calls a DAY, is that allowance being spent — including the
872
+ // bare "contact premium@alphavantage.co if you are targeting a higher API
873
+ // call volume", which is what Alpha Vantage says once the day is gone.
874
+ //
875
+ // Narrow by construction rather than by wording: all six tools in this pack
876
+ // call free-tier functions (GLOBAL_QUOTE, TIME_SERIES_DAILY, OVERVIEW,
877
+ // INCOME_STATEMENT, BALANCE_SHEET, EARNINGS), so the third thing Alpha
878
+ // Vantage uses these keys for — "this is a premium endpoint" — cannot be
879
+ // reached from here. If a premium-only function is ever added to this pack,
880
+ // it needs its own branch and a plan_required clause; do not let it fall in
881
+ // here and get reported as a purchase that would not fix it.
882
+ // The burst notice names a PER-SECOND frequency, not a per-minute one:
883
+ // "Please consider spreading out your free API requests more sparingly
884
+ // (1 request per second)" — measured live 2026-09-02. Matching only
885
+ // /per minute/ meant that notice fell through to the daily-cap branch and
886
+ // told the caller their allowance was gone when the next second would have
887
+ // worked, which is the same defect in the other direction.
888
+ const shortThrottle = /per (minute|second)/i.test(info) && !/per day/i.test(info);
889
+ if (!shortThrottle) {
890
+ // A SPENT DAILY ALLOWANCE IS A CREDENTIAL STATE, NOT DATA (fleet #1091).
891
+ //
892
+ // This used to return `{found:false, reason:'quota_exceeded'}`, and that
893
+ // shape is invisible to everything that asks "is our key alive": the
894
+ // monitor's platform-key probe classifies on `structuredContent.credential`
895
+ // or `.error`, this payload carried neither, so it fell off the end of the
896
+ // ladder into `pass` — at the HIGHER confidence band, so not even on the
897
+ // list a human re-checks. The key had been spent daily for weeks while a
898
+ // Needs Bruce item (#1070) said so and the board said healthy.
899
+ //
900
+ // Throwing hands it to the channel built for this. `auth_required:` is the
901
+ // token classifyToolError trusts unconditionally (shared/src/error-prefix.ts),
902
+ // and "the daily request allowance behind this key is spent" is the clause
903
+ // PLATFORM_QUOTA_PATTERNS matches — together they produce a `credential`
904
+ // block of {holder, state:'quota_exhausted'} on the response, which the
905
+ // probe reads as `account_limited`: a purchase, not a key to rotate.
906
+ //
907
+ // The gateway decides the HOLDER, which is the half a pack cannot know:
908
+ // our key and the caller's arrive in the same `_apiKey` slot, so a pack
909
+ // that asserted "Pipeworx's key is spent" would say it to BYO callers too.
910
+ //
911
+ // Keyed on OUR wording rather than Alpha Vantage's, for the reason
912
+ // jina-reader is: the vendor's prose has already changed under us once, and
913
+ // a pattern chasing it fails silently. The coupling is pinned by a test in
914
+ // workers/gateway/src/provisioned-platform-key.test.ts — reword this clause
915
+ // and the build goes red instead of the class going quiet.
916
+ //
917
+ // ask_pipeworx still fails over: `auth_required` is retriable
918
+ // (workers/gateway/src/index.ts ~14459) and the retry skips siblings that
919
+ // would hit the same key wall, so keyless sec-xbrl is still reached.
920
+ throw new Error(
921
+ `auth_required: Alpha Vantage refused this call because the daily request allowance behind this key is spent (${info.slice(0, 200)}). `
922
+ + 'The key itself is valid, so there is nothing to rotate and nothing a short retry will fix — it stays refused until the daily cap resets or the plan is raised at https://www.alphavantage.co/premium/. '
923
+ // NOT "pass your own key and it works". Alpha Vantage meters the free
924
+ // tier by source IP and never validates the key at all (see the header
925
+ // note above: an invented key gets the same refusal, and the same
926
+ // invented key returns real data from a laptop). Telling a caller to
927
+ // supply their own key sends them to fetch a credential that cannot
928
+ // change the outcome — the exact failure this pack was already making
929
+ // about OUR key, aimed at theirs. Only a PAID key changes it, because
930
+ // premium is the one thing Alpha Vantage authenticates.
931
+ + 'Supplying your own FREE key via _apiKey will not help: Alpha Vantage meters the free tier by source IP, so a caller key is refused from here for the same reason ours is. A PAID Alpha Vantage key should work, since premium is what it actually authenticates — untested, we do not hold one. '
932
+ + `${fallbackHint}`,
933
+ );
934
+ }
935
+ // Soft-failed, same pattern as dictionary/europepmc/zippopotam: a structured
936
+ // no-data with a hint pointing at finnhub, so the routing layer can recover
937
+ // instead of crashing the conversation. Kept ONLY for the short throttle,
938
+ // which really does clear on its own.
939
+ return {
940
+ found: false,
941
+ reason: 'rate_limit',
942
+ provider: 'alphavantage',
943
+ message: info,
944
+ hint: `Alpha Vantage is throttling calls on this key for the next minute or so. ${fallbackHint}`,
945
+ };
69
946
  }
70
947
 
71
948
  return data;
@@ -77,11 +954,18 @@ const tools: McpToolExport['tools'] = [
77
954
  {
78
955
  name: 'av_quote',
79
956
  description:
80
- 'Get a real-time stock quote including price, change, change percent, volume, and latest trading day.',
957
+ 'Get real-time stock price for a symbol (e.g., "AAPL"). Returns current price, change, percent change, and trading volume. Needs your own PAID Alpha Vantage key via _apiKey — Pipeworx fronts no key for this pack and a free-tier key is refused when the call goes through the gateway (Alpha Vantage meters its free tier by source IP, not by key). Keyless alternative for US company financials: sec-xbrl.',
81
958
  inputSchema: {
82
959
  type: 'object' as const,
83
960
  properties: {
84
- _apiKey: { type: 'string', description: 'Alpha Vantage API key' },
961
+ _apiKey: {
962
+ type: 'string',
963
+ description:
964
+ 'REQUIRED — your own PAID Alpha Vantage key. Pipeworx does not front a key for this pack. '
965
+ + 'A free Alpha Vantage key will not work here: they meter the free tier by source IP rather than by key, '
966
+ + 'so it is refused when the call goes through the gateway, whoever it belongs to. Paid plans: https://www.alphavantage.co/premium/. '
967
+ + 'If you have no paid key, use sec-xbrl (keyless US financial statements) or finnhub (quotes) instead.',
968
+ },
85
969
  symbol: {
86
970
  type: 'string',
87
971
  description: 'Stock ticker symbol (e.g., "SOFI", "AFRM", "SQ", "PYPL")',
@@ -93,11 +977,18 @@ const tools: McpToolExport['tools'] = [
93
977
  {
94
978
  name: 'av_daily',
95
979
  description:
96
- 'Get daily time series (open, high, low, close, volume) for a stock. Returns up to 100 recent trading days by default, or 20+ years of full history.',
980
+ 'Get daily stock price history for a symbol (e.g., "AAPL"). Returns open, high, low, close, volume for recent days or full 20+ year history. Needs your own PAID Alpha Vantage key via _apiKey — Pipeworx fronts no key for this pack and a free-tier key is refused when the call goes through the gateway (Alpha Vantage meters its free tier by source IP, not by key). Keyless alternative for US company financials: sec-xbrl.',
97
981
  inputSchema: {
98
982
  type: 'object' as const,
99
983
  properties: {
100
- _apiKey: { type: 'string', description: 'Alpha Vantage API key' },
984
+ _apiKey: {
985
+ type: 'string',
986
+ description:
987
+ 'REQUIRED — your own PAID Alpha Vantage key. Pipeworx does not front a key for this pack. '
988
+ + 'A free Alpha Vantage key will not work here: they meter the free tier by source IP rather than by key, '
989
+ + 'so it is refused when the call goes through the gateway, whoever it belongs to. Paid plans: https://www.alphavantage.co/premium/. '
990
+ + 'If you have no paid key, use sec-xbrl (keyless US financial statements) or finnhub (quotes) instead.',
991
+ },
101
992
  symbol: {
102
993
  type: 'string',
103
994
  description: 'Stock ticker symbol (e.g., "AAPL", "MSFT")',
@@ -113,11 +1004,18 @@ const tools: McpToolExport['tools'] = [
113
1004
  {
114
1005
  name: 'av_overview',
115
1006
  description:
116
- 'Get company overview and fundamentals including description, sector, market cap, P/E ratio, EPS, dividend yield, 52-week range, and more.',
1007
+ 'Get company fundamentals for a symbol (e.g., "AAPL"). Returns sector, market cap, P/E ratio, EPS, dividend yield, 52-week range, and analyst ratings. Needs your own PAID Alpha Vantage key via _apiKey — Pipeworx fronts no key for this pack and a free-tier key is refused when the call goes through the gateway (Alpha Vantage meters its free tier by source IP, not by key). Keyless alternative for US company financials: sec-xbrl.',
117
1008
  inputSchema: {
118
1009
  type: 'object' as const,
119
1010
  properties: {
120
- _apiKey: { type: 'string', description: 'Alpha Vantage API key' },
1011
+ _apiKey: {
1012
+ type: 'string',
1013
+ description:
1014
+ 'REQUIRED — your own PAID Alpha Vantage key. Pipeworx does not front a key for this pack. '
1015
+ + 'A free Alpha Vantage key will not work here: they meter the free tier by source IP rather than by key, '
1016
+ + 'so it is refused when the call goes through the gateway, whoever it belongs to. Paid plans: https://www.alphavantage.co/premium/. '
1017
+ + 'If you have no paid key, use sec-xbrl (keyless US financial statements) or finnhub (quotes) instead.',
1018
+ },
121
1019
  symbol: {
122
1020
  type: 'string',
123
1021
  description: 'Stock ticker symbol (e.g., "AAPL", "GOOGL")',
@@ -129,11 +1027,18 @@ const tools: McpToolExport['tools'] = [
129
1027
  {
130
1028
  name: 'av_income_statement',
131
1029
  description:
132
- 'Get income statement data for a company, including both annual and quarterly reports. Shows revenue, gross profit, operating income, net income, EBITDA, and more.',
1030
+ 'Get annual and quarterly income statements for a symbol (e.g., "AAPL"). Returns revenue, gross profit, operating income, net income, and EBITDA. Needs your own PAID Alpha Vantage key via _apiKey — Pipeworx fronts no key for this pack and a free-tier key is refused when the call goes through the gateway (Alpha Vantage meters its free tier by source IP, not by key). Keyless alternative for US company financials: sec-xbrl.',
133
1031
  inputSchema: {
134
1032
  type: 'object' as const,
135
1033
  properties: {
136
- _apiKey: { type: 'string', description: 'Alpha Vantage API key' },
1034
+ _apiKey: {
1035
+ type: 'string',
1036
+ description:
1037
+ 'REQUIRED — your own PAID Alpha Vantage key. Pipeworx does not front a key for this pack. '
1038
+ + 'A free Alpha Vantage key will not work here: they meter the free tier by source IP rather than by key, '
1039
+ + 'so it is refused when the call goes through the gateway, whoever it belongs to. Paid plans: https://www.alphavantage.co/premium/. '
1040
+ + 'If you have no paid key, use sec-xbrl (keyless US financial statements) or finnhub (quotes) instead.',
1041
+ },
137
1042
  symbol: {
138
1043
  type: 'string',
139
1044
  description: 'Stock ticker symbol (e.g., "AAPL", "MSFT")',
@@ -145,11 +1050,18 @@ const tools: McpToolExport['tools'] = [
145
1050
  {
146
1051
  name: 'av_balance_sheet',
147
1052
  description:
148
- 'Get balance sheet data for a company, including both annual and quarterly reports. Shows total assets, liabilities, equity, cash, debt, and more.',
1053
+ 'Get annual and quarterly balance sheets for a symbol (e.g., "AAPL"). Returns total assets, liabilities, equity, cash, and debt. Needs your own PAID Alpha Vantage key via _apiKey — Pipeworx fronts no key for this pack and a free-tier key is refused when the call goes through the gateway (Alpha Vantage meters its free tier by source IP, not by key). Keyless alternative for US company financials: sec-xbrl.',
149
1054
  inputSchema: {
150
1055
  type: 'object' as const,
151
1056
  properties: {
152
- _apiKey: { type: 'string', description: 'Alpha Vantage API key' },
1057
+ _apiKey: {
1058
+ type: 'string',
1059
+ description:
1060
+ 'REQUIRED — your own PAID Alpha Vantage key. Pipeworx does not front a key for this pack. '
1061
+ + 'A free Alpha Vantage key will not work here: they meter the free tier by source IP rather than by key, '
1062
+ + 'so it is refused when the call goes through the gateway, whoever it belongs to. Paid plans: https://www.alphavantage.co/premium/. '
1063
+ + 'If you have no paid key, use sec-xbrl (keyless US financial statements) or finnhub (quotes) instead.',
1064
+ },
153
1065
  symbol: {
154
1066
  type: 'string',
155
1067
  description: 'Stock ticker symbol (e.g., "AAPL", "TSLA")',
@@ -161,11 +1073,18 @@ const tools: McpToolExport['tools'] = [
161
1073
  {
162
1074
  name: 'av_earnings',
163
1075
  description:
164
- 'Get earnings data for a company, including annual and quarterly EPS (reported and estimated), surprise amount, and surprise percentage.',
1076
+ 'Get quarterly earnings data for a symbol (e.g., "AAPL"). Returns reported and estimated EPS, surprise amount, and surprise percentage. Needs your own PAID Alpha Vantage key via _apiKey — Pipeworx fronts no key for this pack and a free-tier key is refused when the call goes through the gateway (Alpha Vantage meters its free tier by source IP, not by key). Keyless alternative for US company financials: sec-xbrl.',
165
1077
  inputSchema: {
166
1078
  type: 'object' as const,
167
1079
  properties: {
168
- _apiKey: { type: 'string', description: 'Alpha Vantage API key' },
1080
+ _apiKey: {
1081
+ type: 'string',
1082
+ description:
1083
+ 'REQUIRED — your own PAID Alpha Vantage key. Pipeworx does not front a key for this pack. '
1084
+ + 'A free Alpha Vantage key will not work here: they meter the free tier by source IP rather than by key, '
1085
+ + 'so it is refused when the call goes through the gateway, whoever it belongs to. Paid plans: https://www.alphavantage.co/premium/. '
1086
+ + 'If you have no paid key, use sec-xbrl (keyless US financial statements) or finnhub (quotes) instead.',
1087
+ },
169
1088
  symbol: {
170
1089
  type: 'string',
171
1090
  description: 'Stock ticker symbol (e.g., "AAPL", "NVDA")',
@@ -202,10 +1121,12 @@ async function callTool(name: string, args: Record<string, unknown>): Promise<un
202
1121
  // ── Tool implementations ─────────────────────────────────────────────
203
1122
 
204
1123
  async function getQuote(apiKey: string, symbol: string) {
205
- const data = (await avGet(apiKey, {
1124
+ const raw = await avGet(apiKey, {
206
1125
  function: 'GLOBAL_QUOTE',
207
1126
  symbol,
208
- })) as { 'Global Quote': Record<string, string> };
1127
+ });
1128
+ if ((raw as { found?: boolean }).found === false) return raw;
1129
+ const data = raw as { 'Global Quote': Record<string, string> };
209
1130
 
210
1131
  const q = data['Global Quote'];
211
1132
  if (!q || Object.keys(q).length === 0) {
@@ -227,11 +1148,13 @@ async function getQuote(apiKey: string, symbol: string) {
227
1148
  }
228
1149
 
229
1150
  async function getDaily(apiKey: string, symbol: string, outputsize: string) {
230
- const data = (await avGet(apiKey, {
1151
+ const raw = await avGet(apiKey, {
231
1152
  function: 'TIME_SERIES_DAILY',
232
1153
  symbol,
233
1154
  outputsize,
234
- })) as {
1155
+ });
1156
+ if ((raw as { found?: boolean }).found === false) return raw;
1157
+ const data = raw as {
235
1158
  'Meta Data': Record<string, string>;
236
1159
  'Time Series (Daily)': Record<string, Record<string, string>>;
237
1160
  };
@@ -261,10 +1184,12 @@ async function getDaily(apiKey: string, symbol: string, outputsize: string) {
261
1184
  }
262
1185
 
263
1186
  async function getOverview(apiKey: string, symbol: string) {
264
- const data = (await avGet(apiKey, {
1187
+ const raw = await avGet(apiKey, {
265
1188
  function: 'OVERVIEW',
266
1189
  symbol,
267
- })) as Record<string, string>;
1190
+ }, SEC_XBRL_HINT);
1191
+ if ((raw as { found?: boolean }).found === false) return raw;
1192
+ const data = raw as Record<string, string>;
268
1193
 
269
1194
  if (!data.Symbol && !data.Name) {
270
1195
  throw new Error(`No overview data found for symbol: ${symbol}`);
@@ -306,10 +1231,12 @@ async function getOverview(apiKey: string, symbol: string) {
306
1231
  }
307
1232
 
308
1233
  async function getIncomeStatement(apiKey: string, symbol: string) {
309
- const data = (await avGet(apiKey, {
1234
+ const raw = await avGet(apiKey, {
310
1235
  function: 'INCOME_STATEMENT',
311
1236
  symbol,
312
- })) as {
1237
+ }, SEC_XBRL_HINT);
1238
+ if ((raw as { found?: boolean }).found === false) return raw;
1239
+ const data = raw as {
313
1240
  symbol: string;
314
1241
  annualReports: Record<string, string>[];
315
1242
  quarterlyReports: Record<string, string>[];
@@ -340,10 +1267,12 @@ function formatIncomeReport(r: Record<string, string>) {
340
1267
  }
341
1268
 
342
1269
  async function getBalanceSheet(apiKey: string, symbol: string) {
343
- const data = (await avGet(apiKey, {
1270
+ const raw = await avGet(apiKey, {
344
1271
  function: 'BALANCE_SHEET',
345
1272
  symbol,
346
- })) as {
1273
+ }, SEC_XBRL_HINT);
1274
+ if ((raw as { found?: boolean }).found === false) return raw;
1275
+ const data = raw as {
347
1276
  symbol: string;
348
1277
  annualReports: Record<string, string>[];
349
1278
  quarterlyReports: Record<string, string>[];
@@ -373,10 +1302,12 @@ function formatBalanceReport(r: Record<string, string>) {
373
1302
  }
374
1303
 
375
1304
  async function getEarnings(apiKey: string, symbol: string) {
376
- const data = (await avGet(apiKey, {
1305
+ const raw = await avGet(apiKey, {
377
1306
  function: 'EARNINGS',
378
1307
  symbol,
379
- })) as {
1308
+ }, SEC_XBRL_HINT);
1309
+ if ((raw as { found?: boolean }).found === false) return raw;
1310
+ const data = raw as {
380
1311
  symbol: string;
381
1312
  annualEarnings: Record<string, string>[];
382
1313
  quarterlyEarnings: Record<string, string>[];