@pipeworx/mcp-fred 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +1 -1
- package/README.md +160 -9
- package/bin/cli.js +17 -0
- package/package.json +15 -3
- package/server.json +2 -2
- package/src/index.ts +883 -31
- package/src/server.ts +45 -0
- package/tsconfig.json +5 -1
package/src/index.ts
CHANGED
|
@@ -1,18 +1,640 @@
|
|
|
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
|
+
throw err;
|
|
456
|
+
}
|
|
457
|
+
}
|
|
458
|
+
|
|
459
|
+
function detailSuffix(detail: string): string {
|
|
460
|
+
return detail ? ` — ${detail}` : '';
|
|
461
|
+
}
|
|
462
|
+
|
|
463
|
+
async function readDetail(res: Response): Promise<string> {
|
|
464
|
+
let raw: string;
|
|
465
|
+
try {
|
|
466
|
+
raw = await res.text();
|
|
467
|
+
} catch {
|
|
468
|
+
// Body already consumed, or the connection died mid-read. The status alone
|
|
469
|
+
// is still worth throwing — never let the error path throw its own error.
|
|
470
|
+
return '';
|
|
471
|
+
}
|
|
472
|
+
return summarizeErrorBody(raw);
|
|
473
|
+
}
|
|
474
|
+
|
|
475
|
+
/**
|
|
476
|
+
* Turn ANY error body — JSON, HTML, XML or plain text — into one short phrase
|
|
477
|
+
* that never contains markup.
|
|
478
|
+
*
|
|
479
|
+
* This used to just drop an HTML or XML body on the floor, on the reasoning
|
|
480
|
+
* that markup crowds out the status. That was half right. Dropping it loses the
|
|
481
|
+
* one sentence a caller could have acted on: an `Access Denied` title, an SDMX
|
|
482
|
+
* `<message:Error>` text, an OPS fault string. A 2026-08-30 support sweep
|
|
483
|
+
* measured 13 of 291 caller-facing error rows carrying a raw page or document
|
|
484
|
+
* verbatim, across 11 packs, and in every one of them the useful content —
|
|
485
|
+
* "Access Denied", "Invalid country code", "SCRAPE_TIMEOUT" — was in there,
|
|
486
|
+
* buried in markup the agent had to parse out of a string (fleet #712).
|
|
487
|
+
*
|
|
488
|
+
* So: extract the meaning, discard the markup. The output is passed through
|
|
489
|
+
* `stripMarkup` unconditionally, which is what lets `check:error-body-leak`
|
|
490
|
+
* assert mechanically that no caller-facing message can contain `<?xml`,
|
|
491
|
+
* `<!DOCTYPE` or `<html`.
|
|
492
|
+
*/
|
|
493
|
+
function summarizeErrorBody(raw: string): string {
|
|
494
|
+
if (!raw || !raw.trim()) return '';
|
|
495
|
+
|
|
496
|
+
const head = raw.slice(0, 400).trimStart().toLowerCase();
|
|
497
|
+
|
|
498
|
+
// An HTML error page (Cloudflare interstitial, nginx default, a login
|
|
499
|
+
// redirect) says what it is in its <title>, and almost nowhere else.
|
|
500
|
+
if (head.startsWith('<!doctype') || head.startsWith('<html')) {
|
|
501
|
+
const title = htmlTitle(raw);
|
|
502
|
+
return title
|
|
503
|
+
? `${title} (upstream returned an HTML error page, not an API response)`
|
|
504
|
+
: 'upstream returned an HTML error page, not an API response';
|
|
505
|
+
}
|
|
506
|
+
|
|
507
|
+
// XML fault documents — EPO OPS, SDMX (`<message:Error>`), SOAP faults. The
|
|
508
|
+
// human sentence sits in a child element whose tag name says what it is.
|
|
509
|
+
if (head.startsWith('<?xml') || head.startsWith('<')) {
|
|
510
|
+
const fault = xmlFaultText(raw);
|
|
511
|
+
return fault
|
|
512
|
+
? `${stripMarkup(fault).slice(0, MAX_DETAIL)} (from the upstream's XML error document)`
|
|
513
|
+
: 'upstream returned an XML error document with no readable message';
|
|
514
|
+
}
|
|
515
|
+
|
|
516
|
+
// Most JSON error bodies bury one human sentence among ids and echoed request
|
|
517
|
+
// params. Prefer that sentence; fall back to the whole body when the shape is
|
|
518
|
+
// unfamiliar, since an unfamiliar shape is exactly when we can least afford to
|
|
519
|
+
// guess wrong and show nothing.
|
|
520
|
+
const fromJson = messageFromJson(raw);
|
|
521
|
+
return stripMarkup(fromJson ?? raw).slice(0, MAX_DETAIL);
|
|
522
|
+
}
|
|
523
|
+
|
|
524
|
+
/** The `<title>` of an HTML error page, or its first `<h1>` — the two places a
|
|
525
|
+
* bot wall, a 502 and an "Access Denied" all state what happened. */
|
|
526
|
+
function htmlTitle(raw: string): string | null {
|
|
527
|
+
const head = raw.slice(0, 4000);
|
|
528
|
+
for (const re of [/<title[^>]*>([\s\S]*?)<\/title>/i, /<h1[^>]*>([\s\S]*?)<\/h1>/i]) {
|
|
529
|
+
const m = re.exec(head);
|
|
530
|
+
const text = m ? stripMarkup(m[1]) : '';
|
|
531
|
+
if (text) return text.slice(0, 160);
|
|
532
|
+
}
|
|
533
|
+
return null;
|
|
534
|
+
}
|
|
535
|
+
|
|
536
|
+
/** Tag names that carry the explanation in an XML fault document, namespace
|
|
537
|
+
* prefix optional (`<message:Error>`, `<com:Text>`, `<faultstring>`). */
|
|
538
|
+
const XML_FAULT_TAG_RE =
|
|
539
|
+
/<(?:[A-Za-z0-9_.-]+:)?(?:text|message|description|faultstring|reason|detail|title|errormessage|error)\b[^>]*>([^<]{2,400})</i;
|
|
540
|
+
|
|
541
|
+
function xmlFaultText(raw: string): string | null {
|
|
542
|
+
const head = raw.slice(0, 8000);
|
|
543
|
+
const tagged = XML_FAULT_TAG_RE.exec(head);
|
|
544
|
+
if (tagged && tagged[1].trim()) return tagged[1];
|
|
545
|
+
|
|
546
|
+
// Nothing conventionally named — take the longest text node instead. A fault
|
|
547
|
+
// document with one sentence in an oddly named element is still readable;
|
|
548
|
+
// returning nothing at all is not.
|
|
549
|
+
let best = '';
|
|
550
|
+
for (const m of head.matchAll(/>([^<>]{8,400})</g)) {
|
|
551
|
+
const text = m[1].trim();
|
|
552
|
+
if (text.length > best.length) best = text;
|
|
553
|
+
}
|
|
554
|
+
return best || null;
|
|
555
|
+
}
|
|
556
|
+
|
|
557
|
+
/**
|
|
558
|
+
* Remove every tag and stray angle bracket, then collapse whitespace.
|
|
559
|
+
*
|
|
560
|
+
* Applied to everything on the way out, including the JSON and plain-text
|
|
561
|
+
* paths, because an upstream is free to embed markup in a JSON string field —
|
|
562
|
+
* and a leak is a leak regardless of which branch produced it.
|
|
563
|
+
*/
|
|
564
|
+
function stripMarkup(s: string): string {
|
|
565
|
+
return collapse(decodeEntities(s.replace(/<[^>]*>/g, ' ')).replace(/[<>]/g, ' '));
|
|
566
|
+
}
|
|
567
|
+
|
|
568
|
+
/** The handful of entities that show up in error-page titles. Decoded AFTER
|
|
569
|
+
* tags are stripped and BEFORE the angle-bracket sweep, so `<script>`
|
|
570
|
+
* in a title cannot decode into markup that survives — EMBL-EBI's ChEMBL 500
|
|
571
|
+
* page renders as `500 Internal Server Error < EMBL-EBI` otherwise. */
|
|
572
|
+
function decodeEntities(s: string): string {
|
|
573
|
+
return s
|
|
574
|
+
.replace(/&(?:amp|#0*38);/gi, '&')
|
|
575
|
+
.replace(/&(?:lt|#0*60);/gi, '<')
|
|
576
|
+
.replace(/&(?:gt|#0*62);/gi, '>')
|
|
577
|
+
.replace(/&(?:quot|#0*34);/gi, '"')
|
|
578
|
+
.replace(/&(?:#0*39|apos|#x0*27);/gi, "'")
|
|
579
|
+
.replace(/ /gi, ' ');
|
|
580
|
+
}
|
|
581
|
+
|
|
582
|
+
/** The conventional "what went wrong" field, under any of the names upstreams
|
|
583
|
+
* actually use. Checked in order; first non-empty string wins. */
|
|
584
|
+
const MESSAGE_KEYS = [
|
|
585
|
+
'message', 'error_message', 'errorMessage', 'detail', 'details',
|
|
586
|
+
'description', 'error_description', 'reason', 'title', 'fault',
|
|
587
|
+
];
|
|
588
|
+
|
|
589
|
+
function messageFromJson(raw: string): string | null {
|
|
590
|
+
let parsed: unknown;
|
|
591
|
+
try {
|
|
592
|
+
parsed = JSON.parse(raw);
|
|
593
|
+
} catch {
|
|
594
|
+
return null;
|
|
595
|
+
}
|
|
596
|
+
return pickMessage(parsed, 0);
|
|
597
|
+
}
|
|
598
|
+
|
|
599
|
+
function pickMessage(node: unknown, depth: number): string | null {
|
|
600
|
+
// Two levels covers `{error: {message}}` and `{errors: [{detail}]}`, the two
|
|
601
|
+
// shapes that account for nearly all of them, without walking a large payload.
|
|
602
|
+
if (depth > 2 || node == null) return null;
|
|
603
|
+
|
|
604
|
+
if (typeof node === 'string') return node.trim() || null;
|
|
605
|
+
|
|
606
|
+
if (Array.isArray(node)) {
|
|
607
|
+
for (const item of node) {
|
|
608
|
+
const found = pickMessage(item, depth + 1);
|
|
609
|
+
if (found) return found;
|
|
610
|
+
}
|
|
611
|
+
return null;
|
|
612
|
+
}
|
|
613
|
+
|
|
614
|
+
if (typeof node !== 'object') return null;
|
|
615
|
+
const obj = node as Record<string, unknown>;
|
|
616
|
+
|
|
617
|
+
for (const key of MESSAGE_KEYS) {
|
|
618
|
+
const v = obj[key];
|
|
619
|
+
if (typeof v === 'string' && v.trim()) return v.trim();
|
|
620
|
+
}
|
|
621
|
+
// `{error: …}` where error is itself an object or a string — the single most
|
|
622
|
+
// common wrapper, so it is worth descending into by name rather than scanning
|
|
623
|
+
// every key and risking picking up an echoed request parameter.
|
|
624
|
+
for (const key of ['error', 'errors', 'fault', 'Error', 'data']) {
|
|
625
|
+
if (key in obj) {
|
|
626
|
+
const found = pickMessage(obj[key], depth + 1);
|
|
627
|
+
if (found) return found;
|
|
628
|
+
}
|
|
629
|
+
}
|
|
630
|
+
return null;
|
|
631
|
+
}
|
|
632
|
+
|
|
633
|
+
/** Errors are read in a single line of log output; newlines and runs of
|
|
634
|
+
* whitespace make a multi-line body unreadable there. */
|
|
635
|
+
function collapse(s: string): string {
|
|
636
|
+
return s.replace(/\s+/g, ' ').trim();
|
|
637
|
+
}
|
|
16
638
|
/**
|
|
17
639
|
* FRED MCP — Federal Reserve Economic Data (St. Louis Fed)
|
|
18
640
|
*
|
|
@@ -37,13 +659,52 @@ function extractKey(args: Record<string, unknown>): string {
|
|
|
37
659
|
return key;
|
|
38
660
|
}
|
|
39
661
|
|
|
40
|
-
|
|
41
|
-
|
|
662
|
+
// FRED's upstream (api.stlouisfed.org) periodically slows/stalls. Without a
|
|
663
|
+
// timeout the fetch hangs until Cloudflare kills the worker and returns a raw
|
|
664
|
+
// 504 to the agent — the failure isn't catchable, so the gateway circuit
|
|
665
|
+
// breaker can't trip. Abort at 8s instead: a clean error returns fast, and the
|
|
666
|
+
// breaker can short-circuit the pack after repeated failures.
|
|
667
|
+
//
|
|
668
|
+
// In-pack retry on 5xx + timeout (revised 2026-06-08). Initial single-retry
|
|
669
|
+
// landed 2026-06-07; production analytics next day showed FRED at 27 calls /
|
|
670
|
+
// 9 errors (33% — only a modest improvement from the pre-retry 37.5%). Per-
|
|
671
|
+
// attempt error rate is ~55%, suggesting FRED's CF origin has sustained
|
|
672
|
+
// flakiness, not isolated flakes. Bumped to 3 attempts total with
|
|
673
|
+
// exponential backoff (250ms, 1000ms). At p=0.55 per attempt, P(all 3 fail)
|
|
674
|
+
// drops to ~17%, vs ~30% with 2 attempts and 55% with 1. Attempt count is
|
|
675
|
+
// included in the final error message so we can see whether the cap should
|
|
676
|
+
// be raised further.
|
|
677
|
+
const FRED_RETRY_DELAYS_MS = [250, 1000]; // delay before attempts 2 and 3
|
|
678
|
+
async function fredFetch(url: string, attempt = 1): Promise<unknown> {
|
|
679
|
+
const controller = new AbortController();
|
|
680
|
+
const t = setTimeout(() => controller.abort(), 8000);
|
|
681
|
+
let res: Response;
|
|
682
|
+
try {
|
|
683
|
+
res = await fetch(url, { signal: controller.signal });
|
|
684
|
+
} catch (e) {
|
|
685
|
+
if ((e as Error)?.name === 'AbortError') {
|
|
686
|
+
if (attempt <= FRED_RETRY_DELAYS_MS.length) {
|
|
687
|
+
await new Promise((r) => setTimeout(r, FRED_RETRY_DELAYS_MS[attempt - 1]));
|
|
688
|
+
return fredFetch(url, attempt + 1);
|
|
689
|
+
}
|
|
690
|
+
throw new Error(`upstream_down: FRED API timeout — api.stlouisfed.org did not respond within 8s on any of ${attempt} attempts.`);
|
|
691
|
+
}
|
|
692
|
+
throw e;
|
|
693
|
+
} finally {
|
|
694
|
+
clearTimeout(t);
|
|
695
|
+
}
|
|
696
|
+
if (res.status >= 500 && res.status < 600 && attempt <= FRED_RETRY_DELAYS_MS.length) {
|
|
697
|
+
await new Promise((r) => setTimeout(r, FRED_RETRY_DELAYS_MS[attempt - 1]));
|
|
698
|
+
return fredFetch(url, attempt + 1);
|
|
699
|
+
}
|
|
42
700
|
if (!res.ok) {
|
|
43
|
-
|
|
44
|
-
|
|
701
|
+
// FRED answers a throttle with an Akamai HTML page, so pasting the body
|
|
702
|
+
// handed the caller `<HTML><HEAD><TITLE>Access Denied</TITLE>…` verbatim.
|
|
703
|
+
// httpErrorMessage keeps the title and drops the markup (fleet #712).
|
|
704
|
+
const attemptNote = attempt > 1 ? ` (after ${attempt} attempts)` : '';
|
|
705
|
+
throw new Error(`${await httpErrorMessage(res, 'FRED API')}${attemptNote}`);
|
|
45
706
|
}
|
|
46
|
-
return res
|
|
707
|
+
return parseJson(res, 'FRED');
|
|
47
708
|
}
|
|
48
709
|
|
|
49
710
|
// ── Tool definitions ────────────────────────────────────────────────────
|
|
@@ -52,15 +713,23 @@ const tools: McpToolExport['tools'] = [
|
|
|
52
713
|
{
|
|
53
714
|
name: 'fred_get_series',
|
|
54
715
|
description:
|
|
55
|
-
'
|
|
716
|
+
'AUTHORITATIVE historical time-series for US economic indicators from FRED (Federal Reserve Bank of St. Louis — the official US macroeconomic data repository, 800k+ series). Every series is an AGGREGATE for a whole country, state, or METROPOLITAN AREA (e.g. the Phoenix or Oklahoma City metro), reported monthly or quarterly. Pass a series ID like "MORTGAGE30US" (30y mortgage rate), "UNRATE" (unemployment), "CPIAUCSL" (CPI), "GDP", "FEDFUNDS" (Fed funds rate), "HOUST" (housing starts), "RHORUSQ156N" (US homeownership rate — the percent of households that OWN their home, distinct from the mortgage interest rate). Returns dates + values + the indicator\'s units. Use for macro, Fed, and metro-level US indicator questions. DO NOT GUESS a non-US series ID by pattern-matching a US one — "DEUUNRATE", "JPNUNRATE", "CANUNRATE" and similar <ISO3><METRIC> codes do NOT exist on FRED and 400 with "the series does not exist". For a NON-US country\'s unemployment/GDP/inflation/population, use worldbank_get_indicator (ISO country code + indicator, e.g. SL.UEM.TOTL.ZS for unemployment) instead — it is the reliable source for foreign macro data. If you don\'t know a FRED series ID, call fred_search first rather than inventing one.',
|
|
717
|
+
summary: 'A US economic indicator\'s full history, from the St. Louis Fed\'s FRED database.',
|
|
56
718
|
inputSchema: {
|
|
57
719
|
type: 'object' as const,
|
|
58
720
|
properties: {
|
|
59
721
|
series_id: { type: 'string', description: 'FRED series ID (e.g., "MORTGAGE30US", "HOUST", "CSUSHPISA")' },
|
|
60
722
|
observation_start: { type: 'string', description: 'Start date in YYYY-MM-DD format (optional)' },
|
|
61
723
|
observation_end: { type: 'string', description: 'End date in YYYY-MM-DD format (optional)' },
|
|
62
|
-
frequency: { type: 'string', description: 'Frequency aggregation: d, w, bw, m, q, sa, a (
|
|
724
|
+
frequency: { type: 'string', description: 'Frequency aggregation (optional). Codes: d, w, bw, m, q, sa, a — English words also accepted (daily/weekly/biweekly/monthly/quarterly/semiannual/annual).' },
|
|
63
725
|
units: { type: 'string', description: 'Data transformation: lin (levels), chg (change), ch1 (change from year ago), pch (% change), pc1 (% change from year ago), pca (compounded annual rate of change), cch (continuously compounded rate of change), cca (continuously compounded annual rate of change), log (natural log). Default: lin' },
|
|
726
|
+
// Read at runtime since the newest-first fix, but never declared — so it
|
|
727
|
+
// was invisible to callers and to every schema-based check.
|
|
728
|
+
limit: { type: 'number', description: 'Max observations, newest first (1-100000, default 20)' },
|
|
729
|
+
// Same gap `limit` had: read at runtime, never declared. Declared now so
|
|
730
|
+
// a caller who wants a series in chronological order can ask for it
|
|
731
|
+
// instead of reversing a truncated tail (fleet #718).
|
|
732
|
+
sort_order: { type: 'string', description: 'Observation order: desc = newest first (default), asc = oldest first.', enum: ['asc', 'desc'] },
|
|
64
733
|
_apiKey: { type: 'string', description: 'FRED API key' },
|
|
65
734
|
},
|
|
66
735
|
required: ['series_id', '_apiKey'],
|
|
@@ -69,7 +738,8 @@ const tools: McpToolExport['tools'] = [
|
|
|
69
738
|
{
|
|
70
739
|
name: 'fred_search',
|
|
71
740
|
description:
|
|
72
|
-
'Search for
|
|
741
|
+
'Search for economic data series by keyword. Returns series IDs, titles, and descriptions to identify the right indicator.',
|
|
742
|
+
summary: 'US economic data series matching a keyword search, from the St. Louis Fed\'s FRED database.',
|
|
73
743
|
inputSchema: {
|
|
74
744
|
type: 'object' as const,
|
|
75
745
|
properties: {
|
|
@@ -85,7 +755,8 @@ const tools: McpToolExport['tools'] = [
|
|
|
85
755
|
{
|
|
86
756
|
name: 'fred_series_info',
|
|
87
757
|
description:
|
|
88
|
-
'Get metadata
|
|
758
|
+
'Get metadata for a series: title, units, frequency, seasonal adjustment, notes, and date range. Check this before fetching historical data.',
|
|
759
|
+
summary: 'The metadata for one FRED economic data series — units, frequency, last updated — from the St. Louis Fed.',
|
|
89
760
|
inputSchema: {
|
|
90
761
|
type: 'object' as const,
|
|
91
762
|
properties: {
|
|
@@ -98,7 +769,8 @@ const tools: McpToolExport['tools'] = [
|
|
|
98
769
|
{
|
|
99
770
|
name: 'fred_category',
|
|
100
771
|
description:
|
|
101
|
-
'Browse
|
|
772
|
+
'Browse economic data by category (housing, employment, money/banking, etc.). Returns subcategories and related series IDs.',
|
|
773
|
+
summary: 'The economic data series filed under one FRED category, from the St. Louis Fed.',
|
|
102
774
|
inputSchema: {
|
|
103
775
|
type: 'object' as const,
|
|
104
776
|
properties: {
|
|
@@ -111,7 +783,8 @@ const tools: McpToolExport['tools'] = [
|
|
|
111
783
|
{
|
|
112
784
|
name: 'fred_releases',
|
|
113
785
|
description:
|
|
114
|
-
'
|
|
786
|
+
'Check upcoming and recent economic data releases. Returns release dates, names, and which series they update.',
|
|
787
|
+
summary: 'The economic data releases (e.g. Employment Situation) tracked by FRED, from the St. Louis Fed.',
|
|
115
788
|
inputSchema: {
|
|
116
789
|
type: 'object' as const,
|
|
117
790
|
properties: {
|
|
@@ -122,6 +795,22 @@ const tools: McpToolExport['tools'] = [
|
|
|
122
795
|
required: ['_apiKey'],
|
|
123
796
|
},
|
|
124
797
|
},
|
|
798
|
+
{
|
|
799
|
+
name: 'fred_release_dates',
|
|
800
|
+
description:
|
|
801
|
+
'Economic data RELEASE CALENDAR from FRED — the dates indicators are/were published, including FUTURE scheduled dates. PREFER OVER WEB SEARCH for "when is the next CPI / jobs report / GDP release", "economic calendar", "Fed data release schedule". Omit release_id for the cross-release calendar; pass a release_id (from fred_releases — e.g. 10 = CPI, 50 = Employment Situation, 53 = GDP) for one release schedule. Returns release name + date, newest/upcoming first by default.',
|
|
802
|
+
summary: 'The past and scheduled publication dates for one FRED data release, from the St. Louis Fed.',
|
|
803
|
+
inputSchema: {
|
|
804
|
+
type: 'object' as const,
|
|
805
|
+
properties: {
|
|
806
|
+
release_id: { type: 'number', description: 'Optional FRED release id (from fred_releases). Omit for the all-releases calendar.' },
|
|
807
|
+
limit: { type: 'number', description: 'Max dates to return (1-1000, default 25)' },
|
|
808
|
+
sort_order: { type: 'string', description: 'asc or desc (default desc — newest/upcoming first)', enum: ['asc', 'desc'] },
|
|
809
|
+
_apiKey: { type: 'string', description: 'FRED API key' },
|
|
810
|
+
},
|
|
811
|
+
required: ['_apiKey'],
|
|
812
|
+
},
|
|
813
|
+
},
|
|
125
814
|
];
|
|
126
815
|
|
|
127
816
|
// ── callTool dispatcher ─────────────────────────────────────────────────
|
|
@@ -140,42 +829,156 @@ async function callTool(name: string, args: Record<string, unknown>): Promise<un
|
|
|
140
829
|
return getCategory(key, args.category_id as number | undefined);
|
|
141
830
|
case 'fred_releases':
|
|
142
831
|
return getReleases(key, args);
|
|
832
|
+
case 'fred_release_dates':
|
|
833
|
+
return getReleaseDates(key, args);
|
|
143
834
|
default:
|
|
144
835
|
throw new Error(`Unknown tool: ${name}`);
|
|
145
836
|
}
|
|
146
837
|
}
|
|
147
838
|
|
|
839
|
+
// FRED's `frequency` accepts only its short codes (d/w/bw/m/q/sa/a + week-
|
|
840
|
+
// ending variants). LLMs routinely pass the English word ("monthly", "Quarterly")
|
|
841
|
+
// → FRED 400s "Value of frequency is invalid" (the #1 fred error: 78/day). Map
|
|
842
|
+
// the common synonyms; pass valid codes through; DROP anything unrecognized
|
|
843
|
+
// (frequency is optional → return native-frequency data, never fail the fetch).
|
|
844
|
+
const FRED_FREQ = new Set(['d', 'w', 'bw', 'm', 'q', 'sa', 'a', 'wef', 'weth', 'wew', 'wetu', 'wem', 'wesm', 'wesa', 'bwew', 'bwem']);
|
|
845
|
+
const FRED_FREQ_SYNONYMS: Record<string, string> = {
|
|
846
|
+
daily: 'd', day: 'd',
|
|
847
|
+
weekly: 'w', week: 'w', wk: 'w',
|
|
848
|
+
biweekly: 'bw', 'bi-weekly': 'bw', fortnightly: 'bw',
|
|
849
|
+
monthly: 'm', month: 'm', mo: 'm', mon: 'm',
|
|
850
|
+
quarterly: 'q', quarter: 'q', qtr: 'q', qtrly: 'q',
|
|
851
|
+
semiannual: 'sa', 'semi-annual': 'sa', semiannually: 'sa', biannual: 'sa', 'half-yearly': 'sa',
|
|
852
|
+
annual: 'a', annually: 'a', yearly: 'a', year: 'a', yr: 'a', y: 'a',
|
|
853
|
+
};
|
|
854
|
+
function normalizeFredFrequency(v: unknown): string | null {
|
|
855
|
+
const s = String(v).trim().toLowerCase();
|
|
856
|
+
if (FRED_FREQ.has(s)) return s;
|
|
857
|
+
return FRED_FREQ_SYNONYMS[s] ?? null;
|
|
858
|
+
}
|
|
859
|
+
|
|
148
860
|
// ── Tool implementations ────────────────────────────────────────────────
|
|
149
861
|
|
|
150
862
|
async function getSeries(key: string, args: Record<string, unknown>) {
|
|
863
|
+
const seriesId = args.series_id as string;
|
|
151
864
|
const params = new URLSearchParams({
|
|
152
|
-
series_id:
|
|
865
|
+
series_id: seriesId,
|
|
153
866
|
api_key: key,
|
|
154
867
|
file_type: 'json',
|
|
155
868
|
});
|
|
156
869
|
if (args.observation_start) params.set('observation_start', args.observation_start as string);
|
|
157
870
|
if (args.observation_end) params.set('observation_end', args.observation_end as string);
|
|
158
|
-
if (args.frequency)
|
|
871
|
+
if (args.frequency) {
|
|
872
|
+
const f = normalizeFredFrequency(args.frequency);
|
|
873
|
+
if (f) params.set('frequency', f); // unknown → drop, return native frequency (don't 400)
|
|
874
|
+
}
|
|
159
875
|
if (args.units) params.set('units', args.units as string);
|
|
876
|
+
// FRED's observations API defaults to sort_order=asc + ALL observations, so a
|
|
877
|
+
// bare fred_get_series(UNRATE) returned the full series from 1948 OLDEST-first
|
|
878
|
+
// and ignored the documented `limit: 20` — agents read a decades-old value,
|
|
879
|
+
// surfacing as "stale unemployment data" (user feedback 2026-06-24). Default to
|
|
880
|
+
// NEWEST-first + honor the limit so the latest observation leads.
|
|
881
|
+
params.set('sort_order', (args.sort_order as string) || 'desc');
|
|
882
|
+
params.set('limit', String(Math.min(100000, Math.max(1, (args.limit as number) ?? 20))));
|
|
160
883
|
|
|
161
|
-
const
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
884
|
+
const infoParams = new URLSearchParams({ series_id: seriesId, api_key: key, file_type: 'json' });
|
|
885
|
+
const [data, infoRaw] = await Promise.all([
|
|
886
|
+
fredFetch(`${BASE}/series/observations?${params}`) as Promise<{
|
|
887
|
+
realtime_start: string;
|
|
888
|
+
realtime_end: string;
|
|
889
|
+
observation_start: string;
|
|
890
|
+
observation_end: string;
|
|
891
|
+
count: number;
|
|
892
|
+
observations: { date: string; value: string }[];
|
|
893
|
+
}>,
|
|
894
|
+
fredFetch(`${BASE}/series?${infoParams}`)
|
|
895
|
+
.then((d) => ((d as { seriess?: { title: string; units: string; frequency: string; observation_start?: string; observation_end?: string }[] }).seriess?.[0] ?? null))
|
|
896
|
+
.catch(() => null),
|
|
897
|
+
]);
|
|
898
|
+
|
|
899
|
+
// Empty-window rescue. A "what is the current rate" question routed here
|
|
900
|
+
// often arrives with a days-wide observation window, but weekly/monthly
|
|
901
|
+
// series have no observation inside it — FRED answers 200 with an empty
|
|
902
|
+
// array and the caller concludes "no data" (live case: MORTGAGE15US asked
|
|
903
|
+
// with a 4-day window that started after the last weekly print). Refetch
|
|
904
|
+
// without the window and lead with the latest observations, saying so.
|
|
905
|
+
let obs = data;
|
|
906
|
+
let windowNote: string | undefined;
|
|
907
|
+
let usedWindowRescue = false;
|
|
908
|
+
if (data.observations.length === 0 && (args.observation_start || args.observation_end)) {
|
|
909
|
+
const p2 = new URLSearchParams({
|
|
910
|
+
series_id: seriesId,
|
|
911
|
+
api_key: key,
|
|
912
|
+
file_type: 'json',
|
|
913
|
+
sort_order: 'desc',
|
|
914
|
+
limit: String(Math.min(20, Math.max(1, (args.limit as number) ?? 4))),
|
|
915
|
+
});
|
|
916
|
+
if (args.frequency) {
|
|
917
|
+
const f = normalizeFredFrequency(args.frequency);
|
|
918
|
+
if (f) p2.set('frequency', f);
|
|
919
|
+
}
|
|
920
|
+
if (args.units) p2.set('units', args.units as string);
|
|
921
|
+
const retry = (await fredFetch(`${BASE}/series/observations?${p2}`)) as typeof data;
|
|
922
|
+
if (retry.observations.length > 0) {
|
|
923
|
+
obs = retry;
|
|
924
|
+
usedWindowRescue = true;
|
|
925
|
+
windowNote = `No observations between ${args.observation_start ?? 'series start'} and ${args.observation_end ?? 'today'} — this series publishes ${infoRaw?.frequency ? `${infoRaw.frequency.toLowerCase()}, ` : ''}so narrow recent windows can be empty. Returning the latest observations instead.`;
|
|
926
|
+
}
|
|
927
|
+
}
|
|
928
|
+
|
|
929
|
+
// The observations endpoint ECHOES observation_start/observation_end back as
|
|
930
|
+
// it received them, and when the caller sets neither, FRED substitutes its own
|
|
931
|
+
// open bounds: 1600-01-01 and 9999-12-31. Emitting those under names that read
|
|
932
|
+
// as coverage told every caller that US GDP runs from 1600 through 9999
|
|
933
|
+
// (fleet #718). The real range is in the series metadata we already fetch
|
|
934
|
+
// alongside, so publish THAT under these names — matching what
|
|
935
|
+
// fred_series_info and fred_search already mean by them — and surface what the
|
|
936
|
+
// caller asked for separately, only when they actually asked. If the metadata
|
|
937
|
+
// call failed, omit the range rather than fall back to the sentinels.
|
|
938
|
+
const rows = obs.observations.map((o) => ({
|
|
939
|
+
date: o.date,
|
|
940
|
+
value: o.value === '.' ? null : o.value,
|
|
941
|
+
}));
|
|
942
|
+
const returned = rows.length;
|
|
943
|
+
const sortOrder = usedWindowRescue ? 'desc' : ((args.sort_order as string) || 'desc');
|
|
944
|
+
const order = sortOrder === 'asc' ? 'oldest_first' : 'newest_first';
|
|
945
|
+
// `count` is FRED's total for the requested window; `limit` (default 20) caps
|
|
946
|
+
// what comes back. Reporting the total beside a short list with nothing
|
|
947
|
+
// marking the cut is how a caller reads 20 rows as the whole series.
|
|
948
|
+
const truncated = typeof obs.count === 'number' && returned < obs.count;
|
|
949
|
+
const truncationNote = truncated
|
|
950
|
+
? `Showing ${returned} of ${obs.count} observations (${order.replace('_', ' ')}); raise \`limit\` for more.`
|
|
951
|
+
: undefined;
|
|
952
|
+
const notes = [windowNote, truncationNote].filter(Boolean);
|
|
953
|
+
|
|
954
|
+
// Say what the series IS, in words (fleet #2238): a bare id plus numbers
|
|
955
|
+
// reads as nothing to the gateway's entity check, so 62/72 fred_get_series
|
|
956
|
+
// answers scored `unverifiable` even when the caller asked by exact id.
|
|
957
|
+
const newest = order === 'newest_first' ? rows[0] : rows[rows.length - 1];
|
|
958
|
+
const oldest = order === 'newest_first' ? rows[rows.length - 1] : rows[0];
|
|
959
|
+
const statement =
|
|
960
|
+
`FRED ${seriesId}${infoRaw?.title ? ` (${infoRaw.title})` : ''}: ${infoRaw?.units ?? 'units not reported'}, ${infoRaw?.frequency ?? 'native frequency'}, ` +
|
|
961
|
+
`from the Federal Reserve Bank of St. Louis (FRED). ${returned} of ${obs.count} observation(s) returned ${order.replace('_', ' ')}` +
|
|
962
|
+
(oldest && newest ? `, ${oldest.date} to ${newest.date}; latest ${newest.value ?? 'missing'} on ${newest.date}` : '') +
|
|
963
|
+
'.';
|
|
169
964
|
|
|
170
965
|
return {
|
|
171
|
-
series_id:
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
966
|
+
series_id: seriesId,
|
|
967
|
+
...(infoRaw?.title ? { series_title: infoRaw.title, series_name: infoRaw.title } : {}),
|
|
968
|
+
source: 'Federal Reserve Bank of St. Louis (FRED)',
|
|
969
|
+
statement,
|
|
970
|
+
...(infoRaw?.units ? { units: infoRaw.units } : {}),
|
|
971
|
+
...(infoRaw?.frequency ? { frequency: infoRaw.frequency } : {}),
|
|
972
|
+
...(notes.length ? { note: notes.join(' ') } : {}),
|
|
973
|
+
count: obs.count,
|
|
974
|
+
returned,
|
|
975
|
+
truncated,
|
|
976
|
+
observation_order: order,
|
|
977
|
+
...(infoRaw?.observation_start ? { observation_start: infoRaw.observation_start } : {}),
|
|
978
|
+
...(infoRaw?.observation_end ? { observation_end: infoRaw.observation_end } : {}),
|
|
979
|
+
...(args.observation_start ? { requested_start: args.observation_start as string } : {}),
|
|
980
|
+
...(args.observation_end ? { requested_end: args.observation_end as string } : {}),
|
|
981
|
+
observations: rows,
|
|
179
982
|
};
|
|
180
983
|
}
|
|
181
984
|
|
|
@@ -205,9 +1008,15 @@ async function searchSeries(key: string, args: Record<string, unknown>) {
|
|
|
205
1008
|
}[];
|
|
206
1009
|
};
|
|
207
1010
|
|
|
1011
|
+
const hits = data.seriess ?? [];
|
|
208
1012
|
return {
|
|
209
1013
|
total_matches: data.count,
|
|
210
|
-
|
|
1014
|
+
returned: hits.length,
|
|
1015
|
+
truncated: typeof data.count === 'number' && hits.length < data.count,
|
|
1016
|
+
...(typeof data.count === 'number' && hits.length < data.count
|
|
1017
|
+
? { note: `Showing ${hits.length} of ${data.count} matching series; raise \`limit\` (max 1000) or narrow search_text.` }
|
|
1018
|
+
: {}),
|
|
1019
|
+
series: hits.map((s) => ({
|
|
211
1020
|
series_id: s.id,
|
|
212
1021
|
title: s.title,
|
|
213
1022
|
units: s.units,
|
|
@@ -308,9 +1117,15 @@ async function getReleases(key: string, args: Record<string, unknown>) {
|
|
|
308
1117
|
}[];
|
|
309
1118
|
};
|
|
310
1119
|
|
|
1120
|
+
const rels = data.releases ?? [];
|
|
311
1121
|
return {
|
|
312
1122
|
total_releases: data.count,
|
|
313
|
-
|
|
1123
|
+
returned: rels.length,
|
|
1124
|
+
truncated: typeof data.count === 'number' && rels.length < data.count,
|
|
1125
|
+
...(typeof data.count === 'number' && rels.length < data.count
|
|
1126
|
+
? { note: `Showing ${rels.length} of ${data.count} releases; raise \`limit\` (max 1000) or page with \`offset\`.` }
|
|
1127
|
+
: {}),
|
|
1128
|
+
releases: rels.map((r) => ({
|
|
314
1129
|
id: r.id,
|
|
315
1130
|
name: r.name,
|
|
316
1131
|
press_release: r.press_release,
|
|
@@ -320,4 +1135,41 @@ async function getReleases(key: string, args: Record<string, unknown>) {
|
|
|
320
1135
|
};
|
|
321
1136
|
}
|
|
322
1137
|
|
|
1138
|
+
async function getReleaseDates(key: string, args: Record<string, unknown>) {
|
|
1139
|
+
const cap = Math.min(1000, Math.max(1, (args.limit as number) ?? 25));
|
|
1140
|
+
// Fetch the full schedule (desc + future scheduled dates), then partition by
|
|
1141
|
+
// today so the NEXT release is the headline — FRED has no date>=today filter,
|
|
1142
|
+
// and a raw asc/desc sort buries the imminent release. 1000 rows comfortably
|
|
1143
|
+
// spans the ~1y of future scheduled dates back through recent actuals.
|
|
1144
|
+
const params = new URLSearchParams({
|
|
1145
|
+
api_key: key,
|
|
1146
|
+
file_type: 'json',
|
|
1147
|
+
limit: '1000',
|
|
1148
|
+
sort_order: 'desc',
|
|
1149
|
+
});
|
|
1150
|
+
const rid = args.release_id;
|
|
1151
|
+
const single = rid != null && Number.isFinite(Number(rid));
|
|
1152
|
+
// Future scheduled dates only for a SINGLE release — across ALL releases the
|
|
1153
|
+
// far-future flood (300+ releases x ~12 months) overflows any fetch window
|
|
1154
|
+
// and makes a cross-release "next" unreliable, so cross-release returns recent actuals.
|
|
1155
|
+
if (single) { params.set('release_id', String(Math.floor(Number(rid)))); params.set('include_release_dates_with_no_data', 'true'); }
|
|
1156
|
+
const path = single ? 'release/dates' : 'releases/dates';
|
|
1157
|
+
const data = (await fredFetch(`${BASE}/${path}?${params}`)) as {
|
|
1158
|
+
release_dates?: { release_id?: number; release_name?: string; date?: string }[];
|
|
1159
|
+
};
|
|
1160
|
+
const all = (data.release_dates ?? []).filter((d) => d.date);
|
|
1161
|
+
const today = new Date().toISOString().slice(0, 10);
|
|
1162
|
+
const shape = (d: { release_id?: number; release_name?: string; date?: string }) => ({ release_id: d.release_id ?? null, release_name: d.release_name ?? null, date: d.date ?? null });
|
|
1163
|
+
const upcoming = all.filter((d) => (d.date as string) >= today).sort((a, b) => (a.date as string).localeCompare(b.date as string));
|
|
1164
|
+
const recent = all.filter((d) => (d.date as string) < today).sort((a, b) => (b.date as string).localeCompare(a.date as string));
|
|
1165
|
+
return {
|
|
1166
|
+
release_id: single ? Math.floor(Number(rid)) : null,
|
|
1167
|
+
as_of: today,
|
|
1168
|
+
next_release: upcoming[0] ? shape(upcoming[0]) : null,
|
|
1169
|
+
note: single ? undefined : 'Cross-release calendar returns RECENT releases. For an upcoming schedule / next release date, pass a release_id (from fred_releases).',
|
|
1170
|
+
upcoming: upcoming.slice(0, cap).map(shape),
|
|
1171
|
+
recent: recent.slice(0, cap).map(shape),
|
|
1172
|
+
};
|
|
1173
|
+
}
|
|
1174
|
+
|
|
323
1175
|
export default { tools, callTool, meter: { credits: 5 } } satisfies McpToolExport;
|