@pipeworx/mcp-nyfed-markets 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +139 -0
- package/bin/cli.js +17 -0
- package/package.json +32 -0
- package/server.json +18 -0
- package/src/index.ts +1270 -0
- package/src/server.ts +45 -0
- package/tsconfig.json +18 -0
package/src/index.ts
ADDED
|
@@ -0,0 +1,1270 @@
|
|
|
1
|
+
interface McpToolDefinition {
|
|
2
|
+
name: string;
|
|
3
|
+
description: string;
|
|
4
|
+
/** Human-facing one-liner (fleet #1967). Optional; consumers fall back to
|
|
5
|
+
* description. Kept in step with shared/src/types.ts — scripts/lib/
|
|
6
|
+
* check-inlined-types.mjs reports drift at publish time. */
|
|
7
|
+
summary?: string;
|
|
8
|
+
inputSchema: {
|
|
9
|
+
type: 'object';
|
|
10
|
+
properties: Record<string, unknown>;
|
|
11
|
+
required?: string[];
|
|
12
|
+
anyOf?: Array<{ required: string[] }>;
|
|
13
|
+
oneOf?: Array<{ required: string[] }>;
|
|
14
|
+
allOf?: Array<{ required: string[] }>;
|
|
15
|
+
};
|
|
16
|
+
outputSchema?: Record<string, unknown>;
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
interface McpToolExport {
|
|
20
|
+
tools: McpToolDefinition[];
|
|
21
|
+
callTool: (name: string, args: Record<string, unknown>) => Promise<unknown>;
|
|
22
|
+
meter?: { credits: number };
|
|
23
|
+
cost?: Record<string, unknown>;
|
|
24
|
+
provider?: string;
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
/**
|
|
28
|
+
* Was this failure OUR OWN web service? — the other half of `internal-db-class.ts`.
|
|
29
|
+
*
|
|
30
|
+
* fleet #1089 pulled failures from our own Postgres out of `upstream_down` by
|
|
31
|
+
* keying on the SQLSTATE inside PostgREST's four-key error envelope. That
|
|
32
|
+
* covered the majority and structurally could not cover the rest: the rest
|
|
33
|
+
* never reach Postgres, so they carry no SQLSTATE. What was left, measured over
|
|
34
|
+
* the 24h to 2026-09-02T15:00Z (fleet #1096):
|
|
35
|
+
*
|
|
36
|
+
* 5 pipeworx-catalog get_pack_tools Pipeworx catalog error: 522 — error code: 522
|
|
37
|
+
* 3 fleet fleet_list_open … upstream_down: Fleet task queue did not respond within 25s
|
|
38
|
+
*
|
|
39
|
+
* 521/522/523/526 are Cloudflare saying its edge could not reach an ORIGIN, and
|
|
40
|
+
* in both of those rows the origin is ours — `gateway.pipeworx.io` for the
|
|
41
|
+
* catalog pack (it self-fetches when the gateway hasn't injected a manifest),
|
|
42
|
+
* our own Supabase for fleet. There is no third party anywhere in either call.
|
|
43
|
+
* Same defect as #1089: our own outage filed under `upstream_down`, the one
|
|
44
|
+
* class that means "the source is unreachable and there is nothing for us to
|
|
45
|
+
* fix", which is why the problem-tools triage skips it.
|
|
46
|
+
*
|
|
47
|
+
* WHY NOT A WORDING RULE. The obvious fix is to match `fleet db error:` and
|
|
48
|
+
* `Pipeworx catalog error:` in classifyToolError. Each is emitted from exactly
|
|
49
|
+
* one site today, so it would work today. It would also rot the first time
|
|
50
|
+
* somebody rewords a label — silently, and in the direction of hiding our own
|
|
51
|
+
* outage, which is worse than the bug being fixed. Every prose rule in
|
|
52
|
+
* error-class.ts has needed widening as packs invented new wording (#409/#450/
|
|
53
|
+
* #584); that history is most of that file's comment budget.
|
|
54
|
+
*
|
|
55
|
+
* WHAT THIS KEYS ON INSTEAD: **the host the call actually reached.** A URL's
|
|
56
|
+
* hostname is a fact about the call, not a guess about its prose. Two
|
|
57
|
+
* consequences that a pack-level flag could not give us, and the reason the
|
|
58
|
+
* flag was rejected:
|
|
59
|
+
*
|
|
60
|
+
* - It describes the CALL, not the pack. `govcon-intel` fans out to our own
|
|
61
|
+
* Supabase AND to genuine third parties; `court-listener` holds our cache
|
|
62
|
+
* in Supabase and fetches courtlistener.com. An `internallyHosted: true` on
|
|
63
|
+
* either pack would relabel a real third-party outage as ours — inventing
|
|
64
|
+
* work, which is the same class of error in the opposite direction.
|
|
65
|
+
* - It covers every future internal pack for free, instead of one declared
|
|
66
|
+
* slug at a time.
|
|
67
|
+
*
|
|
68
|
+
* WHY IT SURVIVES A REWORD. The marker below is not matched as a literal by two
|
|
69
|
+
* separate files. `markInternalOrigin()` writes it and `internalHostMetricsClass()`
|
|
70
|
+
* reads it, both from the single exported `INTERNAL_ORIGIN_MARKER` constant in
|
|
71
|
+
* this module — so changing the wording changes both sides in the same edit and
|
|
72
|
+
* cannot desynchronise them. The pack's own label (`fleet db error:`,
|
|
73
|
+
* `Pipeworx catalog error:`) is not read at all: reword it freely, the class is
|
|
74
|
+
* unaffected. That is the property `stripClassPrefix` lacked when it drifted
|
|
75
|
+
* from its own classifier three times and needed a CI gate to hold them
|
|
76
|
+
* together.
|
|
77
|
+
*
|
|
78
|
+
* WHERE THE 5xx TEST LIVES. `markInternalOrigin` is called from the places that
|
|
79
|
+
* hold the real `Response` — `httpError`/`httpErrorMessage` and the timeout
|
|
80
|
+
* branch of `fetchWithTimeout` in `shared/src/http.ts` — so "is this an
|
|
81
|
+
* availability failure" is decided from the actual status code, never re-derived
|
|
82
|
+
* by scraping a number out of a sentence. A 404 from our own registry for a slug
|
|
83
|
+
* that does not exist is a caller's bad argument and is deliberately NOT marked.
|
|
84
|
+
*/
|
|
85
|
+
|
|
86
|
+
/**
|
|
87
|
+
* OUR OWN web service was unreachable — not an upstream, and never `upstream_down`.
|
|
88
|
+
*
|
|
89
|
+
* ONE value, not three, unlike `internal_db_*`. That split existed because a
|
|
90
|
+
* slow query, an exhausted pool and an unknown SQLSTATE have different owners
|
|
91
|
+
* and different fixes. Here there is only one story to tell — an origin we run
|
|
92
|
+
* did not answer the edge — and one owner. A bucket with no distinct owner per
|
|
93
|
+
* value is decoration; #724 is what happens when a class holds several
|
|
94
|
+
* situations, and inventing sub-values ahead of a reason to act on them
|
|
95
|
+
* differently is the same mistake with the sign flipped.
|
|
96
|
+
*
|
|
97
|
+
* METRICS ONLY, exactly like PLATFORM_KEY_ERROR_CLASS and the internal_db
|
|
98
|
+
* values. `classifyToolError` still answers `upstream_down` for the retry and
|
|
99
|
+
* hint paths, which only care whether retrying or a sibling tool might work —
|
|
100
|
+
* and it might. Nothing a caller sees or is charged changes here.
|
|
101
|
+
*
|
|
102
|
+
* READ SIDE: this value is in BROKEN_TOOL_CLASSES, FAULT_CLASSES and
|
|
103
|
+
* ALL_ERROR_CLASSES in `workers/registry-api/src/index.ts`. All three, or it
|
|
104
|
+
* lands on no dashboard — fleet #721 is the warning, where the #719 split
|
|
105
|
+
* worked on the write side and was invisible for weeks.
|
|
106
|
+
*/
|
|
107
|
+
const INTERNAL_SERVICE_UNREACHABLE_CLASS = 'internal_service_unreachable';
|
|
108
|
+
|
|
109
|
+
/**
|
|
110
|
+
* The token that carries "this origin is ours" from the call site to the
|
|
111
|
+
* classifier.
|
|
112
|
+
*
|
|
113
|
+
* Appended to the error message rather than attached to the Error object,
|
|
114
|
+
* because the object does not survive the trip: 275 packs return `{ error:
|
|
115
|
+
* string }` instead of throwing, the gateway reads `observedError` as a string,
|
|
116
|
+
* and the fleet pack rebuilds its error from a captured status + body across a
|
|
117
|
+
* retry loop. A property on an Error would be dropped by every one of those
|
|
118
|
+
* paths and the class would work in tests and vanish in production.
|
|
119
|
+
*
|
|
120
|
+
* WORDING IS LOAD-BEARING, same rule as labelAge's note in authority.ts. This
|
|
121
|
+
* string is appended to a pack's thrown Error message (shared/src/http.ts),
|
|
122
|
+
* and a thrown Error's message is exactly what the gateway hands back to the
|
|
123
|
+
* caller as `content[0].text` when nothing rewrites it (workers/gateway/src
|
|
124
|
+
* catches the throw and sets `rawResult.message = stripClassPrefix(error)`,
|
|
125
|
+
* which does not touch this suffix) — so the original wording,
|
|
126
|
+
* " [pipeworx-hosted origin — our own service, not a third party]", was not a
|
|
127
|
+
* theoretical leak: it shipped live on pipeworx-catalog's 522s, 7 times in 6
|
|
128
|
+
* hours on 2026-09-02 (see tests/golden-internal-service.test.ts), verbatim
|
|
129
|
+
* naming Pipeworx as the host. check:hosting-claims never caught it because it
|
|
130
|
+
* did not scan shared/ at all (task #2009). Reworded to describe the
|
|
131
|
+
* OBSERVATION (the origin did not answer) without a claim about who runs it —
|
|
132
|
+
* the identical fix labelAge got: drop the possessive, keep the fact.
|
|
133
|
+
*/
|
|
134
|
+
const INTERNAL_ORIGIN_MARKER = ' [origin did not respond — retry before concluding the named source is down]';
|
|
135
|
+
|
|
136
|
+
/**
|
|
137
|
+
* Supabase's data plane for a project is `<ref>.supabase.co`, where the ref is
|
|
138
|
+
* exactly twenty lowercase letters (ours is `pqauisounztsgdgfkhke`).
|
|
139
|
+
*
|
|
140
|
+
* Matching the shape rather than listing the ref keeps this correct when we add
|
|
141
|
+
* a project — `supabaseEnv` on a pack entry already points some packs at a
|
|
142
|
+
* second one — while still excluding `status.supabase.co`, which is Supabase's
|
|
143
|
+
* own status page and emphatically not our database. Verified 2026-09-02 by
|
|
144
|
+
* `grep -rhoE '[a-z0-9-]+\.supabase\.(co|in)' mcps shared workers scripts`: the
|
|
145
|
+
* only real project ref anywhere in the tree is ours, the rest are doc
|
|
146
|
+
* placeholders (`abc`, `xyz`, `example`) which this pattern also excludes. Same
|
|
147
|
+
* finding internal-db-class.ts relies on for the PostgREST envelope being ours
|
|
148
|
+
* by construction.
|
|
149
|
+
*/
|
|
150
|
+
const SUPABASE_PROJECT_HOST = /^[a-z]{20}\.supabase\.(co|in)$/;
|
|
151
|
+
|
|
152
|
+
/**
|
|
153
|
+
* Is this a host WE run?
|
|
154
|
+
*
|
|
155
|
+
* Deliberately NOT including `*.workers.dev`: plenty of third-party APIs are
|
|
156
|
+
* hosted on workers.dev, so the suffix says where something runs and not who
|
|
157
|
+
* owns it. Every internal call we actually make goes to a `pipeworx.io`
|
|
158
|
+
* hostname or to our Supabase project, both of which are ownership facts.
|
|
159
|
+
*
|
|
160
|
+
* `workers/gateway/src/provenance.ts`'s `OUR_HOSTS` answers the same
|
|
161
|
+
* question and DOES include `workers.dev` — a documented divergence
|
|
162
|
+
* (task #2051), not a bug to converge. That list decides what a response may
|
|
163
|
+
* cite as a data SOURCE, where a false negative (citing our own worker as an
|
|
164
|
+
* external source) is the hosting-disclosure leak this whole file exists to
|
|
165
|
+
* prevent, so it errs broad. This one decides who gets BLAMED for a 5xx in
|
|
166
|
+
* outage metrics read by on-call, where a false positive (crediting our own
|
|
167
|
+
* infra with a third party's outage) hides the real failure, so it errs
|
|
168
|
+
* narrow. Same suffix, opposite direction, because they are never called for
|
|
169
|
+
* the same reason.
|
|
170
|
+
*
|
|
171
|
+
* Returns false on anything unparseable rather than throwing — this runs inside
|
|
172
|
+
* an error path, and an error path that can itself throw turns a diagnosable
|
|
173
|
+
* failure into a mystery.
|
|
174
|
+
*/
|
|
175
|
+
function isPipeworxOrigin(url: string | URL | undefined | null): boolean {
|
|
176
|
+
if (!url) return false;
|
|
177
|
+
let host: string;
|
|
178
|
+
try {
|
|
179
|
+
host = new URL(url instanceof URL ? url.href : url).hostname.toLowerCase();
|
|
180
|
+
} catch {
|
|
181
|
+
return false;
|
|
182
|
+
}
|
|
183
|
+
if (host === 'pipeworx.io' || host.endsWith('.pipeworx.io')) return true;
|
|
184
|
+
return SUPABASE_PROJECT_HOST.test(host);
|
|
185
|
+
}
|
|
186
|
+
|
|
187
|
+
/**
|
|
188
|
+
* Append the marker when this failure was OUR origin failing to answer.
|
|
189
|
+
*
|
|
190
|
+
* `status` is the HTTP status when there is one, and omitted for a timeout —
|
|
191
|
+
* where there is no response at all, and "the origin did not answer" is the
|
|
192
|
+
* whole observation. Statuses below 500 are left alone: a 404 from our own
|
|
193
|
+
* registry for a slug that does not exist is the caller's argument, not our
|
|
194
|
+
* outage, and marking it would put ordinary 404s on the incident dashboard.
|
|
195
|
+
*
|
|
196
|
+
* Idempotent, so a message that is wrapped and re-marked on the way up (the
|
|
197
|
+
* fleet pack's retry loop re-throws through two layers) carries the marker once.
|
|
198
|
+
*/
|
|
199
|
+
function markInternalOrigin(
|
|
200
|
+
message: string,
|
|
201
|
+
url: string | URL | undefined | null,
|
|
202
|
+
status?: number,
|
|
203
|
+
): string {
|
|
204
|
+
if (status !== undefined && status < 500) return message;
|
|
205
|
+
if (!isPipeworxOrigin(url)) return message;
|
|
206
|
+
if (message.includes(INTERNAL_ORIGIN_MARKER)) return message;
|
|
207
|
+
return message + INTERNAL_ORIGIN_MARKER;
|
|
208
|
+
}
|
|
209
|
+
|
|
210
|
+
/**
|
|
211
|
+
* Which blob4 value a failure from our own web services books as, or undefined
|
|
212
|
+
* if this is not one.
|
|
213
|
+
*
|
|
214
|
+
* Ordered AFTER `internalDbMetricsClass` at the call site: a PostgREST envelope
|
|
215
|
+
* from our own Supabase is a strictly more specific statement about the same
|
|
216
|
+
* row (which of our services, and why), and the two cannot disagree about
|
|
217
|
+
* whether the failure is ours.
|
|
218
|
+
*/
|
|
219
|
+
function internalHostMetricsClass(error: string): string | undefined {
|
|
220
|
+
return error.includes(INTERNAL_ORIGIN_MARKER) ? INTERNAL_SERVICE_UNREACHABLE_CLASS : undefined;
|
|
221
|
+
}
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
/**
|
|
225
|
+
* One place to turn a failed `fetch` into an error a caller can act on.
|
|
226
|
+
*
|
|
227
|
+
* Nearly every pack was written the same way:
|
|
228
|
+
*
|
|
229
|
+
* if (!res.ok) throw new Error(`Unsplash: ${res.status}`);
|
|
230
|
+
*
|
|
231
|
+
* which discards the response body — and the body is usually where the upstream
|
|
232
|
+
* says what was actually wrong ("**symbol** not found: GBP", "parameter `year`
|
|
233
|
+
* out of range", "unknown taxonomy id"). The caller gets a number, cannot
|
|
234
|
+
* self-correct, and retries the same broken call. A 2026-07-31 sweep found this
|
|
235
|
+
* shape in 481 of 1,400 packs, 47 of them PLATFORM-keyed.
|
|
236
|
+
*
|
|
237
|
+
* It also hides bugs one level down. Two of the first three packs audited had a
|
|
238
|
+
* second defect that only existed because of this line: unsplash's rate-limit
|
|
239
|
+
* branch sat BELOW a catch-all and was unreachable, and bea-gov parsed
|
|
240
|
+
* `BEAAPI.Error.APIErrorDescription` below a `!res.ok` throw that made the
|
|
241
|
+
* parsing dead code for every non-200.
|
|
242
|
+
*
|
|
243
|
+
* DELIBERATELY NOT A CLASSIFIER. It does not add `user_error:` /
|
|
244
|
+
* `upstream_down:` prefixes. Those decide which tier a failure lands in, and the
|
|
245
|
+
* `error` tier is what the daily problem-tools list is built from — it means
|
|
246
|
+
* "Pipeworx has a defect". A 400 is genuinely ambiguous: often a caller's bad
|
|
247
|
+
* argument, but sometimes a query WE built wrong (ted-eu comma-joined its CPV
|
|
248
|
+
* values into something TED rejected, and that bug was found only because it sat
|
|
249
|
+
* in `error`). Blanket-classifying 400s as caller mistakes would have hidden it.
|
|
250
|
+
* A pack that KNOWS which it is should keep saying so explicitly; this helper is
|
|
251
|
+
* for the 481 that say nothing at all.
|
|
252
|
+
*/
|
|
253
|
+
|
|
254
|
+
/** Longest upstream explanation we'll pass through. Enough for a real message,
|
|
255
|
+
* short enough that an HTML page or a stack trace can't swamp the error. */
|
|
256
|
+
|
|
257
|
+
const MAX_DETAIL = 300;
|
|
258
|
+
|
|
259
|
+
/**
|
|
260
|
+
* Default bound for `fetchWithTimeout` when a pack doesn't state its own.
|
|
261
|
+
*
|
|
262
|
+
* 25s mirrors the number `epo-ops` landed on after measuring the real failure:
|
|
263
|
+
* a degraded upstream that doesn't error, it just never answers, and a Worker
|
|
264
|
+
* sits in `await fetch()` until ITS OWN execution budget kills the request —
|
|
265
|
+
* which can take minutes, not seconds (epo_ops_search_patents measured 4-8
|
|
266
|
+
* MINUTE hangs before this existed). 25s is short enough that a caller gets a
|
|
267
|
+
* fast, actionable error instead of holding the connection, and long enough
|
|
268
|
+
* that it doesn't false-trip on a merely-slow-but-alive upstream.
|
|
269
|
+
*/
|
|
270
|
+
const DEFAULT_FETCH_TIMEOUT_MS = 25_000;
|
|
271
|
+
|
|
272
|
+
/**
|
|
273
|
+
* Read the body of a failed response and fold it into a throwable Error.
|
|
274
|
+
*
|
|
275
|
+
* Usage — note the `await`, which is the one thing that makes this a mechanical
|
|
276
|
+
* change rather than a drop-in:
|
|
277
|
+
*
|
|
278
|
+
* if (!res.ok) throw await httpError(res, 'Unsplash');
|
|
279
|
+
*
|
|
280
|
+
* Safe to call on any non-ok response: a body that is missing, empty, unreadable
|
|
281
|
+
* or HTML degrades to exactly the old `Name: 404` string rather than throwing
|
|
282
|
+
* something new from inside the error path.
|
|
283
|
+
*/
|
|
284
|
+
async function httpError(res: Response, name: string): Promise<Error> {
|
|
285
|
+
return new Error(await httpErrorMessage(res, name));
|
|
286
|
+
}
|
|
287
|
+
|
|
288
|
+
/** The message text without constructing an Error — for packs that need to wrap
|
|
289
|
+
* it in their own envelope or add an explicit classification prefix. */
|
|
290
|
+
async function httpErrorMessage(res: Response, name: string): Promise<string> {
|
|
291
|
+
// The one place a 5xx from a host WE run gets stamped as ours. `res.url` is
|
|
292
|
+
// the URL the fetch actually resolved to (after redirects), so this is a fact
|
|
293
|
+
// about the call rather than a guess from the `name` the pack passed in —
|
|
294
|
+
// reword that label freely, the class does not move. See
|
|
295
|
+
// internal-host-class.ts; no-op for every third-party upstream, which is why
|
|
296
|
+
// this touches 481 packs' error text and changes none of it.
|
|
297
|
+
return markInternalOrigin(
|
|
298
|
+
`${name}: ${res.status}${detailSuffix(await readDetail(res))}`,
|
|
299
|
+
res.url,
|
|
300
|
+
res.status,
|
|
301
|
+
);
|
|
302
|
+
}
|
|
303
|
+
|
|
304
|
+
/**
|
|
305
|
+
* Just the upstream's own explanation — no name, no status.
|
|
306
|
+
*
|
|
307
|
+
* For a pack that has already said both in its own sentence. epo-ops reads
|
|
308
|
+
* `EPO rejected this search as too large (HTTP 413) — ${httpErrorMessage(…)}`,
|
|
309
|
+
* which rendered as `… (HTTP 413) — EPO: 413.` once the XML detail was being
|
|
310
|
+
* dropped: the upstream named twice, the status twice, and the one thing EPO
|
|
311
|
+
* actually said ("Not enough characters before truncation character") nowhere
|
|
312
|
+
* (fleet #712). Returns '' when the body carries nothing readable, so a caller
|
|
313
|
+
* can fall back to its own wording.
|
|
314
|
+
*/
|
|
315
|
+
async function upstreamDetail(res: Response): Promise<string> {
|
|
316
|
+
return readDetail(res);
|
|
317
|
+
}
|
|
318
|
+
|
|
319
|
+
/**
|
|
320
|
+
* Read a SUCCESSFUL response as JSON, failing loudly when it isn't JSON.
|
|
321
|
+
*
|
|
322
|
+
* `httpError` above only ever runs on `!res.ok`, which leaves the nastier half
|
|
323
|
+
* of the problem unhandled: an upstream that answers **HTTP 200 with an HTML
|
|
324
|
+
* page**. A bot wall, a login redirect, a maintenance interstitial and a CDN
|
|
325
|
+
* error page are all 200s, so `res.ok` is true, and `res.json()` then throws
|
|
326
|
+
* `Unexpected token '<', "<!DOCTYPE "... is not valid JSON`.
|
|
327
|
+
*
|
|
328
|
+
* That string is the problem. It names no upstream, carries no status, and
|
|
329
|
+
* reads like a parser bug in Pipeworx — so it lands in the `error` tier, which
|
|
330
|
+
* means "we have a defect", and the caller is told nothing they can act on.
|
|
331
|
+
* data.govt.nz sat dead behind an Imperva challenge this way and every
|
|
332
|
+
* status-code health check we own reported it green (7889a845). A zero-length
|
|
333
|
+
* body has the same shape: `Unexpected end of JSON input`, seen this week on
|
|
334
|
+
* uk-gazette (83% of external calls) and census.
|
|
335
|
+
*
|
|
336
|
+
* UNLIKE `httpError`, this one DOES classify, and the asymmetry is deliberate.
|
|
337
|
+
* A 400 is genuinely ambiguous — often the caller's bad argument, sometimes a
|
|
338
|
+
* query we built wrong — so blanket-classifying it would hide our own bugs.
|
|
339
|
+
* There is no such ambiguity here: **no argument a caller can pass makes a JSON
|
|
340
|
+
* API return an HTML page.** It is always the upstream, so `upstream_down:` is
|
|
341
|
+
* a statement of fact rather than a guess, and it keeps these out of the
|
|
342
|
+
* problem-tools list where they crowd out real defects.
|
|
343
|
+
*
|
|
344
|
+
* const data = await parseJson<Feed>(res, 'UK Gazette');
|
|
345
|
+
*
|
|
346
|
+
* Call it only after the `!res.ok` check — on a failed response you want
|
|
347
|
+
* `httpError`, which mines the body for the upstream's own explanation.
|
|
348
|
+
*/
|
|
349
|
+
async function parseJson<T>(res: Response, name: string): Promise<T> {
|
|
350
|
+
let raw: string;
|
|
351
|
+
try {
|
|
352
|
+
raw = await res.text();
|
|
353
|
+
} catch {
|
|
354
|
+
throw new Error(
|
|
355
|
+
`upstream_down: ${name} returned a body that could not be read (HTTP ${res.status}). ` +
|
|
356
|
+
'The connection most likely dropped mid-response; retrying is reasonable.',
|
|
357
|
+
);
|
|
358
|
+
}
|
|
359
|
+
|
|
360
|
+
const type = res.headers.get('content-type') ?? 'no content-type';
|
|
361
|
+
|
|
362
|
+
if (!raw.trim()) {
|
|
363
|
+
throw new Error(
|
|
364
|
+
`upstream_down: ${name} answered HTTP ${res.status} with an EMPTY body where JSON was expected (${type}). ` +
|
|
365
|
+
'Nothing about the request can cause this — it is an upstream fault, and the same call may well work on retry.',
|
|
366
|
+
);
|
|
367
|
+
}
|
|
368
|
+
|
|
369
|
+
// Checked before parsing rather than in the catch, because knowing it is
|
|
370
|
+
// markup is what turns "we failed to parse something" into "they served a
|
|
371
|
+
// web page" — the second is diagnosable, the first is not.
|
|
372
|
+
const head = raw.slice(0, 200).trimStart().toLowerCase();
|
|
373
|
+
if (head.startsWith('<!doctype') || head.startsWith('<html') || head.startsWith('<?xml')) {
|
|
374
|
+
const kind = head.startsWith('<?xml') ? 'an XML document' : 'an HTML page';
|
|
375
|
+
// The summary, not the source. Pasting the first 120 characters of a web
|
|
376
|
+
// page handed the agent `<!DOCTYPE html><html lang="en"…` — the same leak
|
|
377
|
+
// this branch exists to describe (fleet #712).
|
|
378
|
+
throw new Error(
|
|
379
|
+
`upstream_down: ${name} answered HTTP ${res.status} with ${kind} instead of JSON (${type}). ` +
|
|
380
|
+
'That is typically a bot wall, a login redirect or a maintenance page — it is returned as a SUCCESS, ' +
|
|
381
|
+
`so status-code health checks read it as fine. No argument change will get past it. ` +
|
|
382
|
+
`The page says: ${summarizeErrorBody(raw) || 'nothing readable'}`,
|
|
383
|
+
);
|
|
384
|
+
}
|
|
385
|
+
|
|
386
|
+
try {
|
|
387
|
+
return JSON.parse(raw) as T;
|
|
388
|
+
} catch {
|
|
389
|
+
throw new Error(
|
|
390
|
+
`upstream_down: ${name} answered HTTP ${res.status} with a body that is not valid JSON (${type}). ` +
|
|
391
|
+
`It begins: ${stripMarkup(raw).slice(0, 120) || '(unreadable)'}`,
|
|
392
|
+
);
|
|
393
|
+
}
|
|
394
|
+
}
|
|
395
|
+
|
|
396
|
+
/**
|
|
397
|
+
* `fetch`, but bounded — the fix for a systemic gap found 2026-08-30: a grep
|
|
398
|
+
* audit of every pack's `mcps/*\/src/index.ts` found 1,339 of ~1,500 call
|
|
399
|
+
* `fetch()` with NO timeout guard anywhere in the file. Two of those
|
|
400
|
+
* (epo-ops, statcan) were confirmed live-hanging for 4-8 minutes before this
|
|
401
|
+
* existed — every unguarded call carries the same risk, just unconfirmed.
|
|
402
|
+
*
|
|
403
|
+
* Mirrors the `epoFetch` wrapper `mcps/epo-ops/src/index.ts` shipped first:
|
|
404
|
+
* bound the request with `AbortSignal.timeout`, and on a timeout/abort throw
|
|
405
|
+
* an `upstream_down:` error that names the upstream and the bound rather than
|
|
406
|
+
* letting the raw `TimeoutError`/`AbortError` (which names neither) propagate.
|
|
407
|
+
* `upstream_down:` is deliberate, same reasoning as `parseJson` above — no
|
|
408
|
+
* argument a caller passes can make an upstream hang, so it is always the
|
|
409
|
+
* upstream's fault, and marking it that way keeps a slow API off the
|
|
410
|
+
* problem-tools list where it would crowd out our own defects.
|
|
411
|
+
*
|
|
412
|
+
* Usage — a mechanical swap for a bare `fetch(url, init)`:
|
|
413
|
+
*
|
|
414
|
+
* const res = await fetchWithTimeout(url, init, 'Some API');
|
|
415
|
+
*
|
|
416
|
+
* Pass `timeoutMs` as a fourth argument to override the default for a pack
|
|
417
|
+
* with a known-slower upstream; the label should be the same short name you'd
|
|
418
|
+
* pass to `httpError`/`httpErrorMessage` for that call.
|
|
419
|
+
*/
|
|
420
|
+
async function fetchWithTimeout(
|
|
421
|
+
url: string | URL,
|
|
422
|
+
init: RequestInit = {},
|
|
423
|
+
name: string,
|
|
424
|
+
timeoutMs: number = DEFAULT_FETCH_TIMEOUT_MS,
|
|
425
|
+
): Promise<Response> {
|
|
426
|
+
try {
|
|
427
|
+
return await fetch(url, { ...init, signal: AbortSignal.timeout(timeoutMs) });
|
|
428
|
+
} catch (err) {
|
|
429
|
+
if (err instanceof Error && (err.name === 'TimeoutError' || err.name === 'AbortError')) {
|
|
430
|
+
// States the OBSERVATION (no response in N seconds), not a diagnosis.
|
|
431
|
+
// "appears to be degraded" is an inference about the vendor that we have
|
|
432
|
+
// not checked, and it is wrong in a way that misdirects whoever reads it:
|
|
433
|
+
// a timeout from a Worker can equally mean OUR egress is blocked.
|
|
434
|
+
//
|
|
435
|
+
// Measured today (2026-09-01, fleet #1047): every call to
|
|
436
|
+
// mainnet.base.org failed from the x402 facilitator while the identical
|
|
437
|
+
// request from a laptop returned 200. Base was entirely healthy; the
|
|
438
|
+
// public RPC refuses Cloudflare Worker egress. Had this message fired
|
|
439
|
+
// there it would have blamed Base by name, and the next person would have
|
|
440
|
+
// waited for a vendor outage to clear that did not exist.
|
|
441
|
+
// A timeout has no status to test — there is no response at all — so
|
|
442
|
+
// `markInternalOrigin` is called without one: an origin we run that never
|
|
443
|
+
// answered is an availability failure by definition. This is the half of
|
|
444
|
+
// fleet #1096 with neither a SQLSTATE nor a status code to key on.
|
|
445
|
+
throw new Error(
|
|
446
|
+
markInternalOrigin(
|
|
447
|
+
`upstream_down: ${name} did not respond within ${timeoutMs / 1000}s. ` +
|
|
448
|
+
`That can be ${name} being slow or down, or this environment being unable to reach it ` +
|
|
449
|
+
`(some hosts refuse datacenter/Worker egress) — retry shortly, and check reachability ` +
|
|
450
|
+
`from elsewhere before concluding ${name} is down.`,
|
|
451
|
+
url,
|
|
452
|
+
),
|
|
453
|
+
);
|
|
454
|
+
}
|
|
455
|
+
throw err;
|
|
456
|
+
}
|
|
457
|
+
}
|
|
458
|
+
|
|
459
|
+
function detailSuffix(detail: string): string {
|
|
460
|
+
return detail ? ` — ${detail}` : '';
|
|
461
|
+
}
|
|
462
|
+
|
|
463
|
+
async function readDetail(res: Response): Promise<string> {
|
|
464
|
+
let raw: string;
|
|
465
|
+
try {
|
|
466
|
+
raw = await res.text();
|
|
467
|
+
} catch {
|
|
468
|
+
// Body already consumed, or the connection died mid-read. The status alone
|
|
469
|
+
// is still worth throwing — never let the error path throw its own error.
|
|
470
|
+
return '';
|
|
471
|
+
}
|
|
472
|
+
return summarizeErrorBody(raw);
|
|
473
|
+
}
|
|
474
|
+
|
|
475
|
+
/**
|
|
476
|
+
* Turn ANY error body — JSON, HTML, XML or plain text — into one short phrase
|
|
477
|
+
* that never contains markup.
|
|
478
|
+
*
|
|
479
|
+
* This used to just drop an HTML or XML body on the floor, on the reasoning
|
|
480
|
+
* that markup crowds out the status. That was half right. Dropping it loses the
|
|
481
|
+
* one sentence a caller could have acted on: an `Access Denied` title, an SDMX
|
|
482
|
+
* `<message:Error>` text, an OPS fault string. A 2026-08-30 support sweep
|
|
483
|
+
* measured 13 of 291 caller-facing error rows carrying a raw page or document
|
|
484
|
+
* verbatim, across 11 packs, and in every one of them the useful content —
|
|
485
|
+
* "Access Denied", "Invalid country code", "SCRAPE_TIMEOUT" — was in there,
|
|
486
|
+
* buried in markup the agent had to parse out of a string (fleet #712).
|
|
487
|
+
*
|
|
488
|
+
* So: extract the meaning, discard the markup. The output is passed through
|
|
489
|
+
* `stripMarkup` unconditionally, which is what lets `check:error-body-leak`
|
|
490
|
+
* assert mechanically that no caller-facing message can contain `<?xml`,
|
|
491
|
+
* `<!DOCTYPE` or `<html`.
|
|
492
|
+
*/
|
|
493
|
+
function summarizeErrorBody(raw: string): string {
|
|
494
|
+
if (!raw || !raw.trim()) return '';
|
|
495
|
+
|
|
496
|
+
const head = raw.slice(0, 400).trimStart().toLowerCase();
|
|
497
|
+
|
|
498
|
+
// An HTML error page (Cloudflare interstitial, nginx default, a login
|
|
499
|
+
// redirect) says what it is in its <title>, and almost nowhere else.
|
|
500
|
+
if (head.startsWith('<!doctype') || head.startsWith('<html')) {
|
|
501
|
+
const title = htmlTitle(raw);
|
|
502
|
+
return title
|
|
503
|
+
? `${title} (upstream returned an HTML error page, not an API response)`
|
|
504
|
+
: 'upstream returned an HTML error page, not an API response';
|
|
505
|
+
}
|
|
506
|
+
|
|
507
|
+
// XML fault documents — EPO OPS, SDMX (`<message:Error>`), SOAP faults. The
|
|
508
|
+
// human sentence sits in a child element whose tag name says what it is.
|
|
509
|
+
if (head.startsWith('<?xml') || head.startsWith('<')) {
|
|
510
|
+
const fault = xmlFaultText(raw);
|
|
511
|
+
return fault
|
|
512
|
+
? `${stripMarkup(fault).slice(0, MAX_DETAIL)} (from the upstream's XML error document)`
|
|
513
|
+
: 'upstream returned an XML error document with no readable message';
|
|
514
|
+
}
|
|
515
|
+
|
|
516
|
+
// Most JSON error bodies bury one human sentence among ids and echoed request
|
|
517
|
+
// params. Prefer that sentence; fall back to the whole body when the shape is
|
|
518
|
+
// unfamiliar, since an unfamiliar shape is exactly when we can least afford to
|
|
519
|
+
// guess wrong and show nothing.
|
|
520
|
+
const fromJson = messageFromJson(raw);
|
|
521
|
+
return stripMarkup(fromJson ?? raw).slice(0, MAX_DETAIL);
|
|
522
|
+
}
|
|
523
|
+
|
|
524
|
+
/** The `<title>` of an HTML error page, or its first `<h1>` — the two places a
|
|
525
|
+
* bot wall, a 502 and an "Access Denied" all state what happened. */
|
|
526
|
+
function htmlTitle(raw: string): string | null {
|
|
527
|
+
const head = raw.slice(0, 4000);
|
|
528
|
+
for (const re of [/<title[^>]*>([\s\S]*?)<\/title>/i, /<h1[^>]*>([\s\S]*?)<\/h1>/i]) {
|
|
529
|
+
const m = re.exec(head);
|
|
530
|
+
const text = m ? stripMarkup(m[1]) : '';
|
|
531
|
+
if (text) return text.slice(0, 160);
|
|
532
|
+
}
|
|
533
|
+
return null;
|
|
534
|
+
}
|
|
535
|
+
|
|
536
|
+
/** Tag names that carry the explanation in an XML fault document, namespace
|
|
537
|
+
* prefix optional (`<message:Error>`, `<com:Text>`, `<faultstring>`). */
|
|
538
|
+
const XML_FAULT_TAG_RE =
|
|
539
|
+
/<(?:[A-Za-z0-9_.-]+:)?(?:text|message|description|faultstring|reason|detail|title|errormessage|error)\b[^>]*>([^<]{2,400})</i;
|
|
540
|
+
|
|
541
|
+
function xmlFaultText(raw: string): string | null {
|
|
542
|
+
const head = raw.slice(0, 8000);
|
|
543
|
+
const tagged = XML_FAULT_TAG_RE.exec(head);
|
|
544
|
+
if (tagged && tagged[1].trim()) return tagged[1];
|
|
545
|
+
|
|
546
|
+
// Nothing conventionally named — take the longest text node instead. A fault
|
|
547
|
+
// document with one sentence in an oddly named element is still readable;
|
|
548
|
+
// returning nothing at all is not.
|
|
549
|
+
let best = '';
|
|
550
|
+
for (const m of head.matchAll(/>([^<>]{8,400})</g)) {
|
|
551
|
+
const text = m[1].trim();
|
|
552
|
+
if (text.length > best.length) best = text;
|
|
553
|
+
}
|
|
554
|
+
return best || null;
|
|
555
|
+
}
|
|
556
|
+
|
|
557
|
+
/**
|
|
558
|
+
* Remove every tag and stray angle bracket, then collapse whitespace.
|
|
559
|
+
*
|
|
560
|
+
* Applied to everything on the way out, including the JSON and plain-text
|
|
561
|
+
* paths, because an upstream is free to embed markup in a JSON string field —
|
|
562
|
+
* and a leak is a leak regardless of which branch produced it.
|
|
563
|
+
*/
|
|
564
|
+
function stripMarkup(s: string): string {
|
|
565
|
+
return collapse(decodeEntities(s.replace(/<[^>]*>/g, ' ')).replace(/[<>]/g, ' '));
|
|
566
|
+
}
|
|
567
|
+
|
|
568
|
+
/** The handful of entities that show up in error-page titles. Decoded AFTER
|
|
569
|
+
* tags are stripped and BEFORE the angle-bracket sweep, so `<script>`
|
|
570
|
+
* in a title cannot decode into markup that survives — EMBL-EBI's ChEMBL 500
|
|
571
|
+
* page renders as `500 Internal Server Error < EMBL-EBI` otherwise. */
|
|
572
|
+
function decodeEntities(s: string): string {
|
|
573
|
+
return s
|
|
574
|
+
.replace(/&(?:amp|#0*38);/gi, '&')
|
|
575
|
+
.replace(/&(?:lt|#0*60);/gi, '<')
|
|
576
|
+
.replace(/&(?:gt|#0*62);/gi, '>')
|
|
577
|
+
.replace(/&(?:quot|#0*34);/gi, '"')
|
|
578
|
+
.replace(/&(?:#0*39|apos|#x0*27);/gi, "'")
|
|
579
|
+
.replace(/ /gi, ' ');
|
|
580
|
+
}
|
|
581
|
+
|
|
582
|
+
/** The conventional "what went wrong" field, under any of the names upstreams
|
|
583
|
+
* actually use. Checked in order; first non-empty string wins. */
|
|
584
|
+
const MESSAGE_KEYS = [
|
|
585
|
+
'message', 'error_message', 'errorMessage', 'detail', 'details',
|
|
586
|
+
'description', 'error_description', 'reason', 'title', 'fault',
|
|
587
|
+
];
|
|
588
|
+
|
|
589
|
+
function messageFromJson(raw: string): string | null {
|
|
590
|
+
let parsed: unknown;
|
|
591
|
+
try {
|
|
592
|
+
parsed = JSON.parse(raw);
|
|
593
|
+
} catch {
|
|
594
|
+
return null;
|
|
595
|
+
}
|
|
596
|
+
return pickMessage(parsed, 0);
|
|
597
|
+
}
|
|
598
|
+
|
|
599
|
+
function pickMessage(node: unknown, depth: number): string | null {
|
|
600
|
+
// Two levels covers `{error: {message}}` and `{errors: [{detail}]}`, the two
|
|
601
|
+
// shapes that account for nearly all of them, without walking a large payload.
|
|
602
|
+
if (depth > 2 || node == null) return null;
|
|
603
|
+
|
|
604
|
+
if (typeof node === 'string') return node.trim() || null;
|
|
605
|
+
|
|
606
|
+
if (Array.isArray(node)) {
|
|
607
|
+
for (const item of node) {
|
|
608
|
+
const found = pickMessage(item, depth + 1);
|
|
609
|
+
if (found) return found;
|
|
610
|
+
}
|
|
611
|
+
return null;
|
|
612
|
+
}
|
|
613
|
+
|
|
614
|
+
if (typeof node !== 'object') return null;
|
|
615
|
+
const obj = node as Record<string, unknown>;
|
|
616
|
+
|
|
617
|
+
for (const key of MESSAGE_KEYS) {
|
|
618
|
+
const v = obj[key];
|
|
619
|
+
if (typeof v === 'string' && v.trim()) return v.trim();
|
|
620
|
+
}
|
|
621
|
+
// `{error: …}` where error is itself an object or a string — the single most
|
|
622
|
+
// common wrapper, so it is worth descending into by name rather than scanning
|
|
623
|
+
// every key and risking picking up an echoed request parameter.
|
|
624
|
+
for (const key of ['error', 'errors', 'fault', 'Error', 'data']) {
|
|
625
|
+
if (key in obj) {
|
|
626
|
+
const found = pickMessage(obj[key], depth + 1);
|
|
627
|
+
if (found) return found;
|
|
628
|
+
}
|
|
629
|
+
}
|
|
630
|
+
return null;
|
|
631
|
+
}
|
|
632
|
+
|
|
633
|
+
/** Errors are read in a single line of log output; newlines and runs of
|
|
634
|
+
* whitespace make a multi-line body unreadable there. */
|
|
635
|
+
function collapse(s: string): string {
|
|
636
|
+
return s.replace(/\s+/g, ' ').trim();
|
|
637
|
+
}
|
|
638
|
+
/**
|
|
639
|
+
* New York Fed Markets Data APIs — markets.newyorkfed.org, keyless JSON, no
|
|
640
|
+
* auth wall. Operation-level and holdings-level Desk data: repo/reverse repo
|
|
641
|
+
* (ON RRP) auction results, securities lending operations, System Open Market
|
|
642
|
+
* Account (SOMA) portfolio holdings, the Desk's reference rates (SOFR, EFFR,
|
|
643
|
+
* OBFR, TGCR, BGCR), and primary dealer survey statistics.
|
|
644
|
+
*
|
|
645
|
+
* DIFFERENT FROM `fred`: FRED (see mcps/fred) carries the daily reference-rate
|
|
646
|
+
* AGGREGATES (e.g. series "SOFR") as a single number per day, sourced from this
|
|
647
|
+
* same Desk release, but nothing else here — no individual repo/RRP operation
|
|
648
|
+
* results, no counterparty participation counts, no SOMA CUSIP-level holdings,
|
|
649
|
+
* no primary dealer survey. This pack is the operation- and security-level
|
|
650
|
+
* data underneath those FRED aggregates: "how much did the Desk accept at
|
|
651
|
+
* today's ON RRP operation and how many counterparties took it", "what CUSIPs
|
|
652
|
+
* does SOMA hold and how much matured this week", not "what was SOFR on date
|
|
653
|
+
* X" (use `fred_get_series` with SOFR/DFF/etc. for that).
|
|
654
|
+
*
|
|
655
|
+
* PROVENANCE / TRAPS, captured live 2026-09-23:
|
|
656
|
+
*
|
|
657
|
+
* - Swagger spec at /static/docs/markets-api.yml (the .html page is a JS SPA
|
|
658
|
+
* that renders it, so it is useless to fetch directly — fetch the .yml).
|
|
659
|
+
*
|
|
660
|
+
* - THE ONE REAL TRAP: `/api/rp/results/search.json`'s `operationTypes` query
|
|
661
|
+
* param is a SILENT NO-OP. Querying with `operationTypes=Reverse Repo` still
|
|
662
|
+
* returns Repo rows mixed in — confirmed live, 21 rows returned for a 9-day
|
|
663
|
+
* window that should have been ~7 RRP-only rows. `method` and `term` are
|
|
664
|
+
* UNVERIFIED and are not trusted either. This pack always filters
|
|
665
|
+
* `operationType`/`term` CLIENT-SIDE after the fetch, never relies on the
|
|
666
|
+
* query string to do it. The equivalent PATH-based filter on the `latest`
|
|
667
|
+
* endpoint (`/api/rp/{reverserepo|repo|all}/all/results/latest.json`) DOES
|
|
668
|
+
* work correctly — verified — so latest-day queries use that instead.
|
|
669
|
+
*
|
|
670
|
+
* - SOMA holdings lag: `/api/soma/asofdates/latest.json` returned 2026-09-16
|
|
671
|
+
* on 2026-09-23 — a ~1 week publication lag is normal, not a bug.
|
|
672
|
+
*
|
|
673
|
+
* - Agency holding-type path segment `agency debts` contains a literal SPACE
|
|
674
|
+
* (`/api/soma/agency/get/agency debts/asof/{date}.json`) — this pack accepts
|
|
675
|
+
* the friendly `agency_debts` and encodes the space for you.
|
|
676
|
+
*
|
|
677
|
+
* - `soma/*/get/{holdingtype}/asof/{date}` with holdingtype=all returns
|
|
678
|
+
* EVERY CUSIP at that date (hundreds of rows) — this pack truncates to
|
|
679
|
+
* `limit` (default 20) and reports `total_count` so a caller isn't silently
|
|
680
|
+
* handed a clipped-looking small array with no signal that more exists.
|
|
681
|
+
*
|
|
682
|
+
* - Primary dealer stats: keyids are opaque codes (PDPOSMBS-TOT etc.) grouped
|
|
683
|
+
* into "series break" windows (definitions change over time, so the same
|
|
684
|
+
* keyid's meaning can shift across windows — /api/pd/list/seriesbreaks.json
|
|
685
|
+
* is the authoritative window list). This pack resolves "current" as the
|
|
686
|
+
* window whose `enddate` is "9999-12-31" rather than hardcoding a window id,
|
|
687
|
+
* so it keeps working across the next series break.
|
|
688
|
+
*/
|
|
689
|
+
|
|
690
|
+
|
|
691
|
+
const UA = 'pipeworx-mcp/1.0 (+https://pipeworx.io)';
|
|
692
|
+
const BASE = 'https://markets.newyorkfed.org/api';
|
|
693
|
+
|
|
694
|
+
async function nyfedFetch(path: string): Promise<Response> {
|
|
695
|
+
return fetchWithTimeout(`${BASE}${path}`, { headers: { 'User-Agent': UA } }, 'NY Fed Markets Data');
|
|
696
|
+
}
|
|
697
|
+
|
|
698
|
+
async function nyfedGet<T>(path: string): Promise<T> {
|
|
699
|
+
const res = await nyfedFetch(path);
|
|
700
|
+
if (!res.ok) throw await httpError(res, 'NY Fed Markets Data');
|
|
701
|
+
return parseJson<T>(res, 'NY Fed Markets Data');
|
|
702
|
+
}
|
|
703
|
+
|
|
704
|
+
function clamp(v: unknown, def: number, min: number, max: number): number {
|
|
705
|
+
const n = Number(v);
|
|
706
|
+
if (!Number.isFinite(n)) return def;
|
|
707
|
+
return Math.min(Math.max(Math.trunc(n), min), max);
|
|
708
|
+
}
|
|
709
|
+
|
|
710
|
+
const DATE_RE = /^\d{4}-\d{2}-\d{2}$/;
|
|
711
|
+
function checkDate(v: unknown, field: string): string | undefined {
|
|
712
|
+
if (v === undefined || v === null || v === '') return undefined;
|
|
713
|
+
const s = String(v);
|
|
714
|
+
if (!DATE_RE.test(s)) throw new Error(`${field} must be YYYY-MM-DD, got "${s}".`);
|
|
715
|
+
return s;
|
|
716
|
+
}
|
|
717
|
+
|
|
718
|
+
// ---------------------------------------------------------------------------
|
|
719
|
+
// 1. Repo / Reverse Repo operations
|
|
720
|
+
// ---------------------------------------------------------------------------
|
|
721
|
+
|
|
722
|
+
interface RepoOperation {
|
|
723
|
+
operationId?: string;
|
|
724
|
+
auctionStatus?: string;
|
|
725
|
+
operationDate?: string;
|
|
726
|
+
settlementDate?: string;
|
|
727
|
+
maturityDate?: string;
|
|
728
|
+
operationType?: string; // "Repo" | "Reverse Repo"
|
|
729
|
+
operationMethod?: string;
|
|
730
|
+
settlementType?: string;
|
|
731
|
+
termCalenderDays?: number;
|
|
732
|
+
term?: string; // "Overnight" | "Term"
|
|
733
|
+
releaseTime?: string;
|
|
734
|
+
closeTime?: string;
|
|
735
|
+
note?: string;
|
|
736
|
+
lastUpdated?: string;
|
|
737
|
+
participatingCpty?: number;
|
|
738
|
+
acceptedCpty?: number;
|
|
739
|
+
totalAmtSubmitted?: number;
|
|
740
|
+
totalAmtAccepted?: number;
|
|
741
|
+
details?: Array<{ securityType?: string; amtSubmitted?: number; amtAccepted?: number; percentOfferingRate?: number; percentAwardRate?: number }>;
|
|
742
|
+
}
|
|
743
|
+
|
|
744
|
+
function shapeRepoOp(o: RepoOperation) {
|
|
745
|
+
return {
|
|
746
|
+
operation_id: o.operationId,
|
|
747
|
+
type: o.operationType,
|
|
748
|
+
method: o.operationMethod,
|
|
749
|
+
term: o.term,
|
|
750
|
+
operation_date: o.operationDate,
|
|
751
|
+
settlement_date: o.settlementDate,
|
|
752
|
+
maturity_date: o.maturityDate,
|
|
753
|
+
total_submitted_usd: o.totalAmtSubmitted,
|
|
754
|
+
total_accepted_usd: o.totalAmtAccepted,
|
|
755
|
+
participating_counterparties: o.participatingCpty,
|
|
756
|
+
accepted_counterparties: o.acceptedCpty,
|
|
757
|
+
by_security_type: o.details,
|
|
758
|
+
release_time: o.releaseTime,
|
|
759
|
+
close_time: o.closeTime,
|
|
760
|
+
last_updated: o.lastUpdated,
|
|
761
|
+
};
|
|
762
|
+
}
|
|
763
|
+
|
|
764
|
+
async function nyfedRepoOperations(args: Record<string, unknown>) {
|
|
765
|
+
const operationType = String(args.operation_type ?? 'all').toLowerCase();
|
|
766
|
+
if (!['all', 'repo', 'reverserepo'].includes(operationType)) {
|
|
767
|
+
throw new Error('operation_type must be one of: all, repo, reverserepo.');
|
|
768
|
+
}
|
|
769
|
+
const term = args.term ? String(args.term).toLowerCase() : undefined;
|
|
770
|
+
if (term && !['overnight', 'term'].includes(term)) {
|
|
771
|
+
throw new Error('term must be one of: overnight, term.');
|
|
772
|
+
}
|
|
773
|
+
const startDate = checkDate(args.start_date, 'start_date');
|
|
774
|
+
const endDate = checkDate(args.end_date, 'end_date');
|
|
775
|
+
const limit = clamp(args.limit, 20, 1, 100);
|
|
776
|
+
|
|
777
|
+
let ops: RepoOperation[];
|
|
778
|
+
let mode: string;
|
|
779
|
+
if (startDate || endDate) {
|
|
780
|
+
const qs = new URLSearchParams();
|
|
781
|
+
if (startDate) qs.set('startDate', startDate);
|
|
782
|
+
if (endDate) qs.set('endDate', endDate);
|
|
783
|
+
const data = await nyfedGet<{ repo?: { operations?: RepoOperation[] } }>(
|
|
784
|
+
`/rp/results/search.json?${qs.toString()}`,
|
|
785
|
+
);
|
|
786
|
+
ops = data.repo?.operations ?? [];
|
|
787
|
+
// operationTypes/term query params are a confirmed silent no-op upstream —
|
|
788
|
+
// always filter client-side.
|
|
789
|
+
const wantType = operationType === 'repo' ? 'Repo' : operationType === 'reverserepo' ? 'Reverse Repo' : null;
|
|
790
|
+
if (wantType) ops = ops.filter((o) => o.operationType === wantType);
|
|
791
|
+
if (term === 'overnight') ops = ops.filter((o) => o.term === 'Overnight');
|
|
792
|
+
if (term === 'term') ops = ops.filter((o) => o.term && o.term !== 'Overnight');
|
|
793
|
+
mode = 'date_range_search';
|
|
794
|
+
} else {
|
|
795
|
+
const data = await nyfedGet<{ repo?: { operations?: RepoOperation[] } }>(
|
|
796
|
+
`/rp/${operationType}/all/results/latest.json`,
|
|
797
|
+
);
|
|
798
|
+
ops = data.repo?.operations ?? [];
|
|
799
|
+
if (term === 'overnight') ops = ops.filter((o) => o.term === 'Overnight');
|
|
800
|
+
if (term === 'term') ops = ops.filter((o) => o.term && o.term !== 'Overnight');
|
|
801
|
+
mode = 'latest';
|
|
802
|
+
}
|
|
803
|
+
|
|
804
|
+
if (ops.length === 0) {
|
|
805
|
+
return {
|
|
806
|
+
found: false,
|
|
807
|
+
reason: mode === 'latest' ? 'no_operation_today' : 'no_operations_in_window',
|
|
808
|
+
hint:
|
|
809
|
+
mode === 'latest'
|
|
810
|
+
? 'No matching repo/reverse repo operation was conducted today (weekends/holidays and days the Desk skips a leg both look like this). Pass start_date/end_date to search a window instead.'
|
|
811
|
+
: `No operations of type "${operationType}" between ${startDate ?? 'the start of the record'} and ${endDate ?? 'today'}.`,
|
|
812
|
+
operation_type: operationType,
|
|
813
|
+
window: mode === 'date_range_search' ? { start_date: startDate, end_date: endDate } : undefined,
|
|
814
|
+
};
|
|
815
|
+
}
|
|
816
|
+
|
|
817
|
+
const total = ops.length;
|
|
818
|
+
const page = ops.slice(0, limit);
|
|
819
|
+
return {
|
|
820
|
+
found: true,
|
|
821
|
+
mode,
|
|
822
|
+
operation_type: operationType,
|
|
823
|
+
window: mode === 'date_range_search' ? { start_date: startDate, end_date: endDate } : undefined,
|
|
824
|
+
total_operations: total,
|
|
825
|
+
returned: page.length,
|
|
826
|
+
operations: page.map(shapeRepoOp),
|
|
827
|
+
source: 'New York Fed Markets Data — Repo and Reverse Repo Operations (markets.newyorkfed.org/api/rp).',
|
|
828
|
+
};
|
|
829
|
+
}
|
|
830
|
+
|
|
831
|
+
// ---------------------------------------------------------------------------
|
|
832
|
+
// 2. Securities lending operations
|
|
833
|
+
// ---------------------------------------------------------------------------
|
|
834
|
+
|
|
835
|
+
interface SecLendingOp {
|
|
836
|
+
operationId?: string;
|
|
837
|
+
auctionStatus?: string;
|
|
838
|
+
operationType?: string;
|
|
839
|
+
operationDate?: string;
|
|
840
|
+
settlementDate?: string;
|
|
841
|
+
maturityDate?: string;
|
|
842
|
+
releaseTime?: string;
|
|
843
|
+
closeTime?: string;
|
|
844
|
+
note?: string;
|
|
845
|
+
lastUpdated?: string;
|
|
846
|
+
totalParAmtSubmitted?: number;
|
|
847
|
+
totalParAmtAccepted?: number;
|
|
848
|
+
securities?: unknown[];
|
|
849
|
+
}
|
|
850
|
+
|
|
851
|
+
async function nyfedSeclendingOperations(args: Record<string, unknown>) {
|
|
852
|
+
const operation = String(args.operation ?? 'seclending').toLowerCase();
|
|
853
|
+
if (!['seclending', 'extensions', 'all'].includes(operation)) {
|
|
854
|
+
throw new Error('operation must be one of: seclending, extensions, all.');
|
|
855
|
+
}
|
|
856
|
+
const startDate = checkDate(args.start_date, 'start_date');
|
|
857
|
+
const endDate = checkDate(args.end_date, 'end_date');
|
|
858
|
+
const cusips = args.cusips ? String(args.cusips).trim() : undefined;
|
|
859
|
+
const limit = clamp(args.limit, 20, 1, 100);
|
|
860
|
+
const filtered = Boolean(startDate || endDate || cusips);
|
|
861
|
+
const include = cusips ? 'details' : 'summary';
|
|
862
|
+
|
|
863
|
+
let ops: SecLendingOp[];
|
|
864
|
+
let mode: string;
|
|
865
|
+
if (filtered) {
|
|
866
|
+
const qs = new URLSearchParams();
|
|
867
|
+
if (startDate) qs.set('startDate', startDate);
|
|
868
|
+
if (endDate) qs.set('endDate', endDate);
|
|
869
|
+
if (cusips) qs.set('cusips', cusips);
|
|
870
|
+
const data = await nyfedGet<{ seclending?: { operations?: SecLendingOp[] } }>(
|
|
871
|
+
`/seclending/${operation}/results/${include}/search.json?${qs.toString()}`,
|
|
872
|
+
);
|
|
873
|
+
ops = data.seclending?.operations ?? [];
|
|
874
|
+
mode = 'search';
|
|
875
|
+
} else {
|
|
876
|
+
const data = await nyfedGet<{ seclending?: { operations?: SecLendingOp[] } }>(
|
|
877
|
+
`/seclending/${operation}/results/${include}/latest.json`,
|
|
878
|
+
);
|
|
879
|
+
ops = data.seclending?.operations ?? [];
|
|
880
|
+
mode = 'latest';
|
|
881
|
+
}
|
|
882
|
+
|
|
883
|
+
if (ops.length === 0) {
|
|
884
|
+
return {
|
|
885
|
+
found: false,
|
|
886
|
+
reason: mode === 'latest' ? 'no_operation_today' : 'no_operations_in_window',
|
|
887
|
+
hint:
|
|
888
|
+
mode === 'latest'
|
|
889
|
+
? 'No securities lending operation today. Pass start_date/end_date to search a window instead.'
|
|
890
|
+
: 'No securities lending operations matched the given window/cusips filter.',
|
|
891
|
+
operation,
|
|
892
|
+
};
|
|
893
|
+
}
|
|
894
|
+
|
|
895
|
+
const total = ops.length;
|
|
896
|
+
const page = ops.slice(0, limit);
|
|
897
|
+
return {
|
|
898
|
+
found: true,
|
|
899
|
+
mode,
|
|
900
|
+
operation,
|
|
901
|
+
include,
|
|
902
|
+
total_operations: total,
|
|
903
|
+
returned: page.length,
|
|
904
|
+
operations: page,
|
|
905
|
+
source: 'New York Fed Markets Data — Securities Lending Operations (markets.newyorkfed.org/api/seclending).',
|
|
906
|
+
};
|
|
907
|
+
}
|
|
908
|
+
|
|
909
|
+
// ---------------------------------------------------------------------------
|
|
910
|
+
// 3. SOMA holdings
|
|
911
|
+
// ---------------------------------------------------------------------------
|
|
912
|
+
|
|
913
|
+
let latestSomaDateCache: { date: string; fetchedAt: number } | null = null;
|
|
914
|
+
async function getLatestSomaDate(): Promise<string> {
|
|
915
|
+
if (latestSomaDateCache && Date.now() - latestSomaDateCache.fetchedAt < 5 * 60_000) {
|
|
916
|
+
return latestSomaDateCache.date;
|
|
917
|
+
}
|
|
918
|
+
const data = await nyfedGet<{ soma?: { asOfDates?: string[] } }>('/soma/asofdates/latest.json');
|
|
919
|
+
const date = data.soma?.asOfDates?.[0];
|
|
920
|
+
if (!date) throw new Error('upstream_down: NY Fed SOMA asofdates/latest returned no date.');
|
|
921
|
+
latestSomaDateCache = { date, fetchedAt: Date.now() };
|
|
922
|
+
return date;
|
|
923
|
+
}
|
|
924
|
+
|
|
925
|
+
const TREASURY_HOLDING_TYPES = ['all', 'bills', 'notesbonds', 'frn', 'tips'];
|
|
926
|
+
const AGENCY_HOLDING_TYPES: Record<string, string> = {
|
|
927
|
+
all: 'all',
|
|
928
|
+
agency_debts: 'agency debts',
|
|
929
|
+
mbs: 'mbs',
|
|
930
|
+
cmbs: 'cmbs',
|
|
931
|
+
};
|
|
932
|
+
|
|
933
|
+
async function nyfedSomaHoldings(args: Record<string, unknown>) {
|
|
934
|
+
const cusip = args.cusip ? String(args.cusip).trim() : undefined;
|
|
935
|
+
const limit = clamp(args.limit, 20, 1, 200);
|
|
936
|
+
|
|
937
|
+
if (cusip) {
|
|
938
|
+
const tsy = await nyfedGet<{ soma?: { holdings?: unknown[] } }>(`/soma/tsy/get/cusip/${encodeURIComponent(cusip)}.json`).catch(() => null);
|
|
939
|
+
if (tsy?.soma?.holdings?.length) {
|
|
940
|
+
return {
|
|
941
|
+
found: true,
|
|
942
|
+
holding_class: 'treasury',
|
|
943
|
+
cusip,
|
|
944
|
+
total_observations: tsy.soma.holdings.length,
|
|
945
|
+
returned: Math.min(limit, tsy.soma.holdings.length),
|
|
946
|
+
holdings: tsy.soma.holdings.slice(-limit),
|
|
947
|
+
source: 'New York Fed Markets Data — SOMA Treasury Holdings by CUSIP (markets.newyorkfed.org/api/soma/tsy).',
|
|
948
|
+
};
|
|
949
|
+
}
|
|
950
|
+
const agency = await nyfedGet<{ soma?: { holdings?: unknown[] } }>(`/soma/agency/get/cusip/${encodeURIComponent(cusip)}.json`).catch(() => null);
|
|
951
|
+
if (agency?.soma?.holdings?.length) {
|
|
952
|
+
return {
|
|
953
|
+
found: true,
|
|
954
|
+
holding_class: 'agency',
|
|
955
|
+
cusip,
|
|
956
|
+
total_observations: agency.soma.holdings.length,
|
|
957
|
+
returned: Math.min(limit, agency.soma.holdings.length),
|
|
958
|
+
holdings: agency.soma.holdings.slice(-limit),
|
|
959
|
+
source: 'New York Fed Markets Data — SOMA Agency Holdings by CUSIP (markets.newyorkfed.org/api/soma/agency).',
|
|
960
|
+
};
|
|
961
|
+
}
|
|
962
|
+
return {
|
|
963
|
+
found: false,
|
|
964
|
+
reason: 'cusip_not_held',
|
|
965
|
+
hint: `CUSIP "${cusip}" was not found in either SOMA Treasury or Agency holdings (checked both).`,
|
|
966
|
+
cusip,
|
|
967
|
+
};
|
|
968
|
+
}
|
|
969
|
+
|
|
970
|
+
const view = String(args.view ?? 'summary').toLowerCase();
|
|
971
|
+
|
|
972
|
+
if (view === 'summary') {
|
|
973
|
+
const data = await nyfedGet<{ soma?: { summary?: Array<Record<string, unknown>> } }>('/soma/summary.json');
|
|
974
|
+
const rows = data.soma?.summary ?? [];
|
|
975
|
+
const asOfDate = checkDate(args.as_of_date, 'as_of_date');
|
|
976
|
+
if (asOfDate) {
|
|
977
|
+
const row = rows.find((r) => r.asOfDate === asOfDate);
|
|
978
|
+
if (!row) {
|
|
979
|
+
return {
|
|
980
|
+
found: false,
|
|
981
|
+
reason: 'no_summary_for_date',
|
|
982
|
+
hint: `No SOMA summary row for ${asOfDate}. Summaries are published weekly — try a nearby Wednesday, or omit as_of_date for the most recent rows.`,
|
|
983
|
+
as_of_date: asOfDate,
|
|
984
|
+
};
|
|
985
|
+
}
|
|
986
|
+
return { found: true, view: 'summary', as_of_date: asOfDate, row, source: 'New York Fed Markets Data — SOMA Holdings Summary (markets.newyorkfed.org/api/soma/summary).' };
|
|
987
|
+
}
|
|
988
|
+
const page = rows.slice(-limit);
|
|
989
|
+
return {
|
|
990
|
+
found: true,
|
|
991
|
+
view: 'summary',
|
|
992
|
+
total_observations: rows.length,
|
|
993
|
+
returned: page.length,
|
|
994
|
+
note: 'Total SOMA holdings by security-type bucket (mbs, notesbonds, bills, agencies, tips, ...), one row per publication date. Weekly cadence.',
|
|
995
|
+
rows: page,
|
|
996
|
+
source: 'New York Fed Markets Data — SOMA Holdings Summary (markets.newyorkfed.org/api/soma/summary).',
|
|
997
|
+
};
|
|
998
|
+
}
|
|
999
|
+
|
|
1000
|
+
const asOfDate = checkDate(args.as_of_date, 'as_of_date') ?? (await getLatestSomaDate());
|
|
1001
|
+
|
|
1002
|
+
if (view === 'treasury') {
|
|
1003
|
+
const holdingType = String(args.holding_type ?? 'all').toLowerCase();
|
|
1004
|
+
if (!TREASURY_HOLDING_TYPES.includes(holdingType)) {
|
|
1005
|
+
throw new Error(`holding_type for view=treasury must be one of: ${TREASURY_HOLDING_TYPES.join(', ')}.`);
|
|
1006
|
+
}
|
|
1007
|
+
const data = await nyfedGet<{ soma?: { holdings?: unknown[] } }>(
|
|
1008
|
+
`/soma/tsy/get/${holdingType}/asof/${asOfDate}.json`,
|
|
1009
|
+
);
|
|
1010
|
+
const holdings = data.soma?.holdings ?? [];
|
|
1011
|
+
return {
|
|
1012
|
+
found: holdings.length > 0,
|
|
1013
|
+
view: 'treasury',
|
|
1014
|
+
holding_type: holdingType,
|
|
1015
|
+
as_of_date: asOfDate,
|
|
1016
|
+
total_holdings: holdings.length,
|
|
1017
|
+
returned: Math.min(limit, holdings.length),
|
|
1018
|
+
holdings: holdings.slice(0, limit),
|
|
1019
|
+
source: 'New York Fed Markets Data — SOMA Treasury Holdings (markets.newyorkfed.org/api/soma/tsy).',
|
|
1020
|
+
};
|
|
1021
|
+
}
|
|
1022
|
+
|
|
1023
|
+
if (view === 'agency') {
|
|
1024
|
+
const rawType = String(args.holding_type ?? 'all').toLowerCase();
|
|
1025
|
+
const holdingType = AGENCY_HOLDING_TYPES[rawType];
|
|
1026
|
+
if (!holdingType) {
|
|
1027
|
+
throw new Error(`holding_type for view=agency must be one of: ${Object.keys(AGENCY_HOLDING_TYPES).join(', ')}.`);
|
|
1028
|
+
}
|
|
1029
|
+
const data = await nyfedGet<{ soma?: { holdings?: unknown[] } }>(
|
|
1030
|
+
`/soma/agency/get/${encodeURIComponent(holdingType)}/asof/${asOfDate}.json`,
|
|
1031
|
+
);
|
|
1032
|
+
const holdings = data.soma?.holdings ?? [];
|
|
1033
|
+
return {
|
|
1034
|
+
found: holdings.length > 0,
|
|
1035
|
+
view: 'agency',
|
|
1036
|
+
holding_type: rawType,
|
|
1037
|
+
as_of_date: asOfDate,
|
|
1038
|
+
total_holdings: holdings.length,
|
|
1039
|
+
returned: Math.min(limit, holdings.length),
|
|
1040
|
+
holdings: holdings.slice(0, limit),
|
|
1041
|
+
source: 'New York Fed Markets Data — SOMA Agency Holdings (markets.newyorkfed.org/api/soma/agency).',
|
|
1042
|
+
};
|
|
1043
|
+
}
|
|
1044
|
+
|
|
1045
|
+
throw new Error('view must be one of: summary, treasury, agency.');
|
|
1046
|
+
}
|
|
1047
|
+
|
|
1048
|
+
// ---------------------------------------------------------------------------
|
|
1049
|
+
// 4. Reference rates
|
|
1050
|
+
// ---------------------------------------------------------------------------
|
|
1051
|
+
|
|
1052
|
+
const SECURED = new Set(['tgcr', 'bgcr', 'sofr', 'sofrai']);
|
|
1053
|
+
const UNSECURED = new Set(['effr', 'obfr']);
|
|
1054
|
+
|
|
1055
|
+
async function nyfedReferenceRates(args: Record<string, unknown>) {
|
|
1056
|
+
const rateType = String(args.rate_type ?? 'all').toLowerCase();
|
|
1057
|
+
const number = clamp(args.number, 1, 1, 100);
|
|
1058
|
+
|
|
1059
|
+
if (rateType === 'all') {
|
|
1060
|
+
const data = await nyfedGet<{ refRates?: unknown[] }>('/rates/all/latest.json');
|
|
1061
|
+
const rows = data.refRates ?? [];
|
|
1062
|
+
return {
|
|
1063
|
+
found: rows.length > 0,
|
|
1064
|
+
rate_type: 'all',
|
|
1065
|
+
rows,
|
|
1066
|
+
note: 'Latest observation for each of SOFR, SOFRAI (30/90/180-day averages + index), EFFR, OBFR, TGCR, BGCR. Rates are published the business day AFTER the effective date (an EFFR/OBFR/TGCR/BGCR dated "today" was not yet observed — that is normal, not a lag).',
|
|
1067
|
+
source: 'New York Fed Markets Data — Reference Rates (markets.newyorkfed.org/api/rates).',
|
|
1068
|
+
};
|
|
1069
|
+
}
|
|
1070
|
+
|
|
1071
|
+
if (!SECURED.has(rateType) && !UNSECURED.has(rateType)) {
|
|
1072
|
+
throw new Error(
|
|
1073
|
+
`rate_type must be one of: all, sofr, sofrai, tgcr, bgcr (secured), effr, obfr (unsecured). Got "${rateType}".`,
|
|
1074
|
+
);
|
|
1075
|
+
}
|
|
1076
|
+
const bucket = SECURED.has(rateType) ? 'secured' : 'unsecured';
|
|
1077
|
+
const data = await nyfedGet<{ refRates?: unknown[] }>(`/rates/${bucket}/${rateType}/last/${number}.json`);
|
|
1078
|
+
const rows = data.refRates ?? [];
|
|
1079
|
+
return {
|
|
1080
|
+
found: rows.length > 0,
|
|
1081
|
+
rate_type: rateType,
|
|
1082
|
+
bucket,
|
|
1083
|
+
requested: number,
|
|
1084
|
+
returned: rows.length,
|
|
1085
|
+
rows,
|
|
1086
|
+
source: `New York Fed Markets Data — Reference Rates, ${bucket} (markets.newyorkfed.org/api/rates/${bucket}).`,
|
|
1087
|
+
};
|
|
1088
|
+
}
|
|
1089
|
+
|
|
1090
|
+
// ---------------------------------------------------------------------------
|
|
1091
|
+
// 5. Primary dealer statistics
|
|
1092
|
+
// ---------------------------------------------------------------------------
|
|
1093
|
+
|
|
1094
|
+
interface SeriesBreak {
|
|
1095
|
+
label?: string;
|
|
1096
|
+
seriesbreak?: string;
|
|
1097
|
+
startdate?: string;
|
|
1098
|
+
enddate?: string;
|
|
1099
|
+
}
|
|
1100
|
+
|
|
1101
|
+
let currentSeriesBreakCache: { seriesbreak: string; fetchedAt: number } | null = null;
|
|
1102
|
+
async function getCurrentSeriesBreak(): Promise<string> {
|
|
1103
|
+
if (currentSeriesBreakCache && Date.now() - currentSeriesBreakCache.fetchedAt < 60 * 60_000) {
|
|
1104
|
+
return currentSeriesBreakCache.seriesbreak;
|
|
1105
|
+
}
|
|
1106
|
+
const data = await nyfedGet<{ pd?: { seriesbreaks?: SeriesBreak[] } }>('/pd/list/seriesbreaks.json');
|
|
1107
|
+
const breaks = data.pd?.seriesbreaks ?? [];
|
|
1108
|
+
const current = breaks.find((b) => b.enddate === '9999-12-31') ?? breaks[breaks.length - 1];
|
|
1109
|
+
if (!current?.seriesbreak) throw new Error('upstream_down: could not resolve the current Primary Dealer series-break window.');
|
|
1110
|
+
currentSeriesBreakCache = { seriesbreak: current.seriesbreak, fetchedAt: Date.now() };
|
|
1111
|
+
return current.seriesbreak;
|
|
1112
|
+
}
|
|
1113
|
+
|
|
1114
|
+
async function nyfedPrimaryDealerStats(args: Record<string, unknown>) {
|
|
1115
|
+
const mode = String(args.mode ?? 'list_series').toLowerCase();
|
|
1116
|
+
const keidFilter = args.keyid_filter ? String(args.keyid_filter).trim().toLowerCase() : undefined;
|
|
1117
|
+
const limit = clamp(args.limit, 50, 1, 200);
|
|
1118
|
+
|
|
1119
|
+
if (mode === 'list_series') {
|
|
1120
|
+
const data = await nyfedGet<{ pd?: { timeseries?: Array<{ seriesbreak?: string; keyid?: string; description?: string }> } }>(
|
|
1121
|
+
'/pd/list/timeseries.json',
|
|
1122
|
+
);
|
|
1123
|
+
let rows = data.pd?.timeseries ?? [];
|
|
1124
|
+
if (keidFilter) {
|
|
1125
|
+
rows = rows.filter(
|
|
1126
|
+
(r) => r.keyid?.toLowerCase().includes(keidFilter) || r.description?.toLowerCase().includes(keidFilter),
|
|
1127
|
+
);
|
|
1128
|
+
}
|
|
1129
|
+
const total = rows.length;
|
|
1130
|
+
return {
|
|
1131
|
+
found: total > 0,
|
|
1132
|
+
mode: 'list_series',
|
|
1133
|
+
keyid_filter: keidFilter,
|
|
1134
|
+
total_matching: total,
|
|
1135
|
+
returned: Math.min(limit, total),
|
|
1136
|
+
series: rows.slice(0, limit),
|
|
1137
|
+
note: 'Definitions of the opaque keyid codes used by mode=latest. Pass a substring in keyid_filter (e.g. "treasury", "mbs", "agency") to narrow.',
|
|
1138
|
+
source: 'New York Fed Markets Data — Primary Dealer Statistics, series definitions (markets.newyorkfed.org/api/pd).',
|
|
1139
|
+
};
|
|
1140
|
+
}
|
|
1141
|
+
|
|
1142
|
+
if (mode === 'latest') {
|
|
1143
|
+
const seriesbreak = args.seriesbreak ? String(args.seriesbreak).trim() : await getCurrentSeriesBreak();
|
|
1144
|
+
const data = await nyfedGet<{ pd?: { timeseries?: Array<{ asofdate?: string; keyid?: string; value?: string }> } }>(
|
|
1145
|
+
`/pd/latest/${encodeURIComponent(seriesbreak)}.json`,
|
|
1146
|
+
);
|
|
1147
|
+
let rows = data.pd?.timeseries ?? [];
|
|
1148
|
+
if (keidFilter) rows = rows.filter((r) => r.keyid?.toLowerCase().includes(keidFilter));
|
|
1149
|
+
const total = rows.length;
|
|
1150
|
+
if (total === 0) {
|
|
1151
|
+
return {
|
|
1152
|
+
found: false,
|
|
1153
|
+
reason: 'no_matching_keyids',
|
|
1154
|
+
hint: keidFilter
|
|
1155
|
+
? `No keyid in series-break window "${seriesbreak}" matched "${keidFilter}". Call mode=list_series to browse the full keyid catalog.`
|
|
1156
|
+
: `Series-break window "${seriesbreak}" returned no rows — check it against /pd/list/seriesbreaks.json.`,
|
|
1157
|
+
seriesbreak,
|
|
1158
|
+
};
|
|
1159
|
+
}
|
|
1160
|
+
return {
|
|
1161
|
+
found: true,
|
|
1162
|
+
mode: 'latest',
|
|
1163
|
+
seriesbreak,
|
|
1164
|
+
as_of_date: rows[0]?.asofdate,
|
|
1165
|
+
keyid_filter: keidFilter,
|
|
1166
|
+
total_matching: total,
|
|
1167
|
+
returned: Math.min(limit, total),
|
|
1168
|
+
values: rows.slice(0, limit),
|
|
1169
|
+
note: 'Latest weekly FR 2004 primary dealer survey values for the matching keyids ("*" means the observation is suppressed/not reported that week). Use mode=list_series to look up what a keyid means.',
|
|
1170
|
+
source: 'New York Fed Markets Data — Primary Dealer Statistics (markets.newyorkfed.org/api/pd).',
|
|
1171
|
+
};
|
|
1172
|
+
}
|
|
1173
|
+
|
|
1174
|
+
throw new Error('mode must be one of: list_series, latest.');
|
|
1175
|
+
}
|
|
1176
|
+
|
|
1177
|
+
// ---------------------------------------------------------------------------
|
|
1178
|
+
|
|
1179
|
+
const tools: McpToolExport['tools'] = [
|
|
1180
|
+
{
|
|
1181
|
+
name: 'nyfed_repo_operations',
|
|
1182
|
+
description:
|
|
1183
|
+
"NY Fed Desk repo and reverse repo (ON RRP) operation RESULTS — the actual auctions the Desk ran, not a daily rate aggregate. Each operation: total submitted/accepted USD, counterparty counts, award rate(s), breakdown by security type (Treasury/Agency/MBS/SRF). No start_date/end_date -> today's operation(s) only (empty on weekends/holidays). With start_date/end_date -> a date-range search. Use for \"today's ON RRP usage\", \"reverse repo take-up this week vs last\", \"who's using the SRF\". Different from fred_get_series('RRPONTSYD') which only has the daily accepted total, no per-operation detail.",
|
|
1184
|
+
inputSchema: {
|
|
1185
|
+
type: 'object' as const,
|
|
1186
|
+
properties: {
|
|
1187
|
+
operation_type: { type: 'string', enum: ['all', 'repo', 'reverserepo'], description: 'repo = Desk lends cash (RP); reverserepo = Desk borrows cash (ON RRP). Default all.' },
|
|
1188
|
+
start_date: { type: 'string', description: 'YYYY-MM-DD, inclusive. Triggers a date-range search instead of "latest".' },
|
|
1189
|
+
end_date: { type: 'string', description: 'YYYY-MM-DD, inclusive.' },
|
|
1190
|
+
term: { type: 'string', enum: ['overnight', 'term'], description: 'Filter to overnight-only or term operations.' },
|
|
1191
|
+
limit: { type: 'number', description: 'Max operations to return, newest first. Default 20, max 100.' },
|
|
1192
|
+
},
|
|
1193
|
+
},
|
|
1194
|
+
},
|
|
1195
|
+
{
|
|
1196
|
+
name: 'nyfed_seclending_operations',
|
|
1197
|
+
description:
|
|
1198
|
+
'NY Fed Desk securities lending operation results — how much of the SOMA portfolio was lent out today (or in a date range), by operation (seclending = the daily program, extensions = extended-term lending). Returns total par amount submitted/accepted and, when cusips is given, per-security detail. Use for "how active is securities lending today", "was CUSIP X lent out this week".',
|
|
1199
|
+
inputSchema: {
|
|
1200
|
+
type: 'object' as const,
|
|
1201
|
+
properties: {
|
|
1202
|
+
operation: { type: 'string', enum: ['seclending', 'extensions', 'all'], description: 'Default seclending.' },
|
|
1203
|
+
start_date: { type: 'string', description: 'YYYY-MM-DD, inclusive.' },
|
|
1204
|
+
end_date: { type: 'string', description: 'YYYY-MM-DD, inclusive.' },
|
|
1205
|
+
cusips: { type: 'string', description: 'Comma-separated CUSIP(s) to filter to (partial match).' },
|
|
1206
|
+
limit: { type: 'number', description: 'Default 20, max 100.' },
|
|
1207
|
+
},
|
|
1208
|
+
},
|
|
1209
|
+
},
|
|
1210
|
+
{
|
|
1211
|
+
name: 'nyfed_soma_holdings',
|
|
1212
|
+
description:
|
|
1213
|
+
"System Open Market Account (SOMA) portfolio — the Fed's own securities holdings from QE/reinvestment. view=summary (default) gives total by asset bucket (bills, notesbonds, mbs, agencies, tips) over time — the series to read for \"SOMA runoff this month\". view=treasury/agency with as_of_date gives the full CUSIP-level holdings snapshot for that date (holding_type narrows to bills/notesbonds/frn/tips for treasury, or agency_debts/mbs/cmbs for agency). Pass cusip alone to look up one security's full holdings history regardless of view. Publishes on a ~1-week lag (as_of_date defaults to the latest available, not today).",
|
|
1214
|
+
inputSchema: {
|
|
1215
|
+
type: 'object' as const,
|
|
1216
|
+
properties: {
|
|
1217
|
+
view: { type: 'string', enum: ['summary', 'treasury', 'agency'], description: 'Default summary.' },
|
|
1218
|
+
holding_type: { type: 'string', description: 'For view=treasury: all|bills|notesbonds|frn|tips. For view=agency: all|agency_debts|mbs|cmbs.' },
|
|
1219
|
+
as_of_date: { type: 'string', description: 'YYYY-MM-DD. Defaults to the latest published SOMA as-of date.' },
|
|
1220
|
+
cusip: { type: 'string', description: "A single security's CUSIP — overrides view and searches both Treasury and Agency holdings." },
|
|
1221
|
+
limit: { type: 'number', description: 'Max rows to return. Default 20, max 200.' },
|
|
1222
|
+
},
|
|
1223
|
+
},
|
|
1224
|
+
},
|
|
1225
|
+
{
|
|
1226
|
+
name: 'nyfed_reference_rates',
|
|
1227
|
+
description:
|
|
1228
|
+
"The Desk's own reference-rate publications: SOFR, SOFRAI (30/90/180-day compounded averages + index), EFFR (effective fed funds), OBFR (overnight bank funding), TGCR/BGCR (tri-party general collateral rates). rate_type=all (default) returns the latest value of every rate in one call; a specific rate_type with number>1 returns that rate's recent history including percentile bands and traded volume — detail fred_get_series('SOFR') etc. does not carry (FRED has only the single daily value, no percentiles/volume).",
|
|
1229
|
+
inputSchema: {
|
|
1230
|
+
type: 'object' as const,
|
|
1231
|
+
properties: {
|
|
1232
|
+
rate_type: { type: 'string', enum: ['all', 'sofr', 'sofrai', 'tgcr', 'bgcr', 'effr', 'obfr'], description: 'Default all.' },
|
|
1233
|
+
number: { type: 'number', description: 'History length when rate_type is not "all". Default 1 (latest only), max 100.' },
|
|
1234
|
+
},
|
|
1235
|
+
},
|
|
1236
|
+
},
|
|
1237
|
+
{
|
|
1238
|
+
name: 'nyfed_primary_dealer_stats',
|
|
1239
|
+
description:
|
|
1240
|
+
'FR 2004 weekly primary dealer positioning/transaction survey (aggregate across all primary dealers). mode=list_series (default) browses the keyid catalog — pass keyid_filter (e.g. "treasury", "mbs", "agency") to find the codes you want. mode=latest returns the most recent weekly values for matching keyids. Data is reported for the current "series break" window automatically (definitions can change across windows; pass seriesbreak explicitly to pin one — see mode=list_series output for window ids).',
|
|
1241
|
+
inputSchema: {
|
|
1242
|
+
type: 'object' as const,
|
|
1243
|
+
properties: {
|
|
1244
|
+
mode: { type: 'string', enum: ['list_series', 'latest'], description: 'Default list_series.' },
|
|
1245
|
+
keyid_filter: { type: 'string', description: 'Substring to match against keyid or its description.' },
|
|
1246
|
+
seriesbreak: { type: 'string', description: 'Pin a specific series-break window id (e.g. "SBN2024"). Defaults to the current window.' },
|
|
1247
|
+
limit: { type: 'number', description: 'Default 50, max 200.' },
|
|
1248
|
+
},
|
|
1249
|
+
},
|
|
1250
|
+
},
|
|
1251
|
+
];
|
|
1252
|
+
|
|
1253
|
+
async function callTool(name: string, args: Record<string, unknown>): Promise<unknown> {
|
|
1254
|
+
switch (name) {
|
|
1255
|
+
case 'nyfed_repo_operations':
|
|
1256
|
+
return nyfedRepoOperations(args);
|
|
1257
|
+
case 'nyfed_seclending_operations':
|
|
1258
|
+
return nyfedSeclendingOperations(args);
|
|
1259
|
+
case 'nyfed_soma_holdings':
|
|
1260
|
+
return nyfedSomaHoldings(args);
|
|
1261
|
+
case 'nyfed_reference_rates':
|
|
1262
|
+
return nyfedReferenceRates(args);
|
|
1263
|
+
case 'nyfed_primary_dealer_stats':
|
|
1264
|
+
return nyfedPrimaryDealerStats(args);
|
|
1265
|
+
default:
|
|
1266
|
+
throw new Error(`Unknown tool: ${name}`);
|
|
1267
|
+
}
|
|
1268
|
+
}
|
|
1269
|
+
|
|
1270
|
+
export default { tools, callTool } satisfies McpToolExport;
|