@pipeworx/mcp-dpla 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 +178 -0
- package/bin/cli.js +17 -0
- package/package.json +32 -0
- package/server.json +18 -0
- package/src/index.ts +1032 -0
- package/src/server.ts +45 -0
- package/tsconfig.json +18 -0
package/src/index.ts
ADDED
|
@@ -0,0 +1,1032 @@
|
|
|
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
|
+
* DPLA — the Digital Public Library of America.
|
|
640
|
+
*
|
|
641
|
+
* DPLA is the national aggregator for American digitised cultural heritage:
|
|
642
|
+
* ~50 million records contributed by the Library of Congress, the National
|
|
643
|
+
* Archives, the Smithsonian, HathiTrust, Internet Archive, and hundreds of
|
|
644
|
+
* state libraries, universities, museums and historical societies. One record
|
|
645
|
+
* is one digitised thing — a photograph, a letter, a map, a newspaper page, an
|
|
646
|
+
* oral history, a book — with its title, creator, date, subjects, rights
|
|
647
|
+
* statement, the institution that holds the original, and a link to the item
|
|
648
|
+
* on that institution's own site.
|
|
649
|
+
*
|
|
650
|
+
* Why it is worth a pack of its own next to the individual museum APIs: DPLA
|
|
651
|
+
* is the only place where "find me primary sources about X across American
|
|
652
|
+
* libraries and archives" is ONE query. The alternative is knowing in advance
|
|
653
|
+
* which of several hundred institutions happens to hold the thing.
|
|
654
|
+
*
|
|
655
|
+
* REQUIRES AN API KEY, AND THE KEY IS FREE AND SELF-SERVICE. DPLA issues one
|
|
656
|
+
* by email to anyone who asks:
|
|
657
|
+
*
|
|
658
|
+
* curl -v -XPOST https://api.dp.la/v2/api_key/<your-email>
|
|
659
|
+
*
|
|
660
|
+
* The key arrives by email within a minute or two; there is no approval step,
|
|
661
|
+
* no plan and no payment. Pass it as `_apiKey` to use your own.
|
|
662
|
+
*
|
|
663
|
+
* PLATFORM-BACKED since 2026-09-18: `PLATFORM_DPLA_KEY` is in the encrypted
|
|
664
|
+
* platform_keys table and `platformKeyEnv` is declared in pack-manifest.json,
|
|
665
|
+
* so the gateway fronts the key and callers need nothing. Both landed in the
|
|
666
|
+
* same change on purpose: declaring the env var without the secret un-sinks
|
|
667
|
+
* routing and sends American-archives questions to a tool that can only
|
|
668
|
+
* refuse (the fda-inspections precedent, fleet #617). Verify the key is
|
|
669
|
+
* really set with `curl -s https://gateway.pipeworx.io/manifest.json` →
|
|
670
|
+
* dpla.platform_key_set, never from a file on a laptop.
|
|
671
|
+
*
|
|
672
|
+
* WHAT A KEYLESS CALL LOOKS LIKE UPSTREAM, so nobody mistakes it for an
|
|
673
|
+
* outage: DPLA answers HTTP 403 with
|
|
674
|
+
* `{"error":"invalid_api_key","message":"Invalid or inactive API key."}` — the
|
|
675
|
+
* SAME status and the SAME body for a missing key and for a wrong one, and it
|
|
676
|
+
* checks the key BEFORE it validates any other parameter. So a 403 here tells
|
|
677
|
+
* you nothing about whether the rest of the query was well formed. Verified
|
|
678
|
+
* 2026-09-17.
|
|
679
|
+
*
|
|
680
|
+
* FIELD NAMES ARE DOTTED PATHS INTO THE RECORD, not flat parameters:
|
|
681
|
+
* `sourceResource.title`, `sourceResource.creator`, `provider.name`. A
|
|
682
|
+
* parameter DPLA does not know is rejected by name, so a misspelt filter fails
|
|
683
|
+
* loudly rather than silently returning everything.
|
|
684
|
+
*
|
|
685
|
+
* /v2/collections IS GONE (fleet #2249, 2026-09-18). DPLA's API serves exactly
|
|
686
|
+
* three routes — GET /v2/items, GET /v2/items/{id}, POST /v2/api_key/{email}
|
|
687
|
+
* (their source: github.com/dpla/dpla-api src/index.ts) — and
|
|
688
|
+
* api.dp.la/v2/collections answers `404 The requested resource could not be
|
|
689
|
+
* found` to a VALID key, the same body it gives no key at all. An earlier
|
|
690
|
+
* version of this pack read that 404 as "bad key" because it had only ever been
|
|
691
|
+
* run without a working one. Named collections now surface ONLY as the
|
|
692
|
+
* `sourceResource.collection.title` facet on /v2/items, which is what
|
|
693
|
+
* dpla_collections is built on. A 404 from DPLA is never a key problem: a
|
|
694
|
+
* missing or wrong key is a 403 invalid_api_key, checked before anything else.
|
|
695
|
+
*/
|
|
696
|
+
|
|
697
|
+
|
|
698
|
+
const UA = 'pipeworx-mcp-dpla/1.0 (+https://pipeworx.io)';
|
|
699
|
+
const BASE = 'https://api.dp.la/v2';
|
|
700
|
+
const SOURCE = 'Digital Public Library of America API v2 (api.dp.la)';
|
|
701
|
+
const SIGNUP = 'https://pro.dp.la/developers/policies — request one with: curl -XPOST https://api.dp.la/v2/api_key/<your-email>';
|
|
702
|
+
|
|
703
|
+
const KEY_DESC = `Your DPLA API key. Free and self-service: POST https://api.dp.la/v2/api_key/<your-email> and DPLA emails it to you.`;
|
|
704
|
+
|
|
705
|
+
async function pwFetch(url: string | URL, init?: RequestInit): Promise<Response> {
|
|
706
|
+
const headers = { 'User-Agent': UA, Accept: 'application/json', ...(init?.headers ?? {}) };
|
|
707
|
+
return fetchWithTimeout(url, { ...init, headers }, 'DPLA');
|
|
708
|
+
}
|
|
709
|
+
|
|
710
|
+
/** The refusal a keyless caller meets. It must say "requires an API key" —
|
|
711
|
+
* quality books a refusal that does not as an outage rather than a gate. */
|
|
712
|
+
function requireKey(raw: string | undefined, tool: string): string {
|
|
713
|
+
const key = String(raw ?? '').trim();
|
|
714
|
+
if (!key) {
|
|
715
|
+
throw new Error(
|
|
716
|
+
`${tool} requires an API key: every api.dp.la endpoint answers 403 invalid_api_key without one. Pass it as _apiKey. DPLA issues keys free and instantly — ${SIGNUP}`,
|
|
717
|
+
);
|
|
718
|
+
}
|
|
719
|
+
return key;
|
|
720
|
+
}
|
|
721
|
+
|
|
722
|
+
async function dplaGet(
|
|
723
|
+
path: string,
|
|
724
|
+
params: URLSearchParams,
|
|
725
|
+
key: string,
|
|
726
|
+
tool: string,
|
|
727
|
+
opts: { notFoundIsMissing?: boolean } = {},
|
|
728
|
+
): Promise<any> {
|
|
729
|
+
params.set('api_key', key);
|
|
730
|
+
const res = await pwFetch(`${BASE}${path}?${params.toString()}`);
|
|
731
|
+
const text = await res.text();
|
|
732
|
+
if (res.status === 401 || res.status === 403) {
|
|
733
|
+
throw new Error(`${tool} requires an API key DPLA accepts (HTTP ${res.status}: ${summarizeErrorBody(text)}). Keys are free — ${SIGNUP}`);
|
|
734
|
+
}
|
|
735
|
+
if (res.status === 404) {
|
|
736
|
+
// `/items/{id}` legitimately 404s for "no such id" — that path opts in via
|
|
737
|
+
// notFoundIsMissing and this returns null so item() reports found:false.
|
|
738
|
+
// Any other 404 means the PATH does not exist on api.dp.la (the way
|
|
739
|
+
// /v2/collections stopped existing — #2249). It is never a credential
|
|
740
|
+
// signal: DPLA checks the key first and answers 403 invalid_api_key for a
|
|
741
|
+
// missing or wrong one, so saying "requires an API key" here would send a
|
|
742
|
+
// caller off to mint a key that cannot help.
|
|
743
|
+
if (opts.notFoundIsMissing) return null;
|
|
744
|
+
throw new Error(
|
|
745
|
+
`${tool}: DPLA answered HTTP 404 for ${path} — that endpoint does not exist on api.dp.la (${summarizeErrorBody(text)}). This is not a key problem; a missing or bad key answers 403 invalid_api_key. If DPLA has moved the endpoint, the pack needs updating — file pipeworx_feedback.`,
|
|
746
|
+
);
|
|
747
|
+
}
|
|
748
|
+
if (!res.ok) {
|
|
749
|
+
throw new Error(`${tool}: DPLA returned HTTP ${res.status}. ${summarizeErrorBody(text)}`);
|
|
750
|
+
}
|
|
751
|
+
try {
|
|
752
|
+
return JSON.parse(text);
|
|
753
|
+
} catch {
|
|
754
|
+
throw new Error(`${tool}: DPLA returned a non-JSON body (${summarizeErrorBody(text)}).`);
|
|
755
|
+
}
|
|
756
|
+
}
|
|
757
|
+
|
|
758
|
+
/** DPLA fields are singular strings OR arrays of strings, per record, with no
|
|
759
|
+
* rule about which — the same field is a string in one contributor's records
|
|
760
|
+
* and an array in another's. Normalise both directions. */
|
|
761
|
+
function list(v: unknown): string[] {
|
|
762
|
+
if (v == null) return [];
|
|
763
|
+
const arr = Array.isArray(v) ? v : [v];
|
|
764
|
+
return arr
|
|
765
|
+
.map((x) => (typeof x === 'string' ? x : x && typeof x === 'object' ? String((x as any).name ?? (x as any).displayDate ?? '') : ''))
|
|
766
|
+
.map((s) => s.trim())
|
|
767
|
+
.filter(Boolean);
|
|
768
|
+
}
|
|
769
|
+
|
|
770
|
+
function one(v: unknown): string | null {
|
|
771
|
+
return list(v)[0] ?? null;
|
|
772
|
+
}
|
|
773
|
+
|
|
774
|
+
/** `sourceResource.collection` is an object (or array of objects) carrying
|
|
775
|
+
* `title`, not `name`, so the generic list() — which reads `.name` — used to
|
|
776
|
+
* drop every one of them and item.collections was always []. */
|
|
777
|
+
function collectionTitles(v: unknown): string[] {
|
|
778
|
+
if (v == null) return [];
|
|
779
|
+
const arr = Array.isArray(v) ? v : [v];
|
|
780
|
+
return arr
|
|
781
|
+
.map((c) => (typeof c === 'string' ? c : c && typeof c === 'object' ? String((c as any).title ?? (c as any).name ?? '') : ''))
|
|
782
|
+
.map((s) => s.trim())
|
|
783
|
+
.filter(Boolean);
|
|
784
|
+
}
|
|
785
|
+
|
|
786
|
+
function shapeItem(d: any) {
|
|
787
|
+
const sr = (d?.sourceResource ?? {}) as Record<string, any>;
|
|
788
|
+
const date = sr.date;
|
|
789
|
+
const dates = Array.isArray(date) ? date : date ? [date] : [];
|
|
790
|
+
return {
|
|
791
|
+
id: d?.id ?? null,
|
|
792
|
+
title: one(sr.title),
|
|
793
|
+
creators: list(sr.creator),
|
|
794
|
+
date: dates.length ? (dates[0]?.displayDate ?? dates[0]?.begin ?? (typeof dates[0] === 'string' ? dates[0] : null)) : null,
|
|
795
|
+
description: one(sr.description),
|
|
796
|
+
types: list(sr.type),
|
|
797
|
+
formats: list(sr.format),
|
|
798
|
+
subjects: list(sr.subject).slice(0, 25),
|
|
799
|
+
languages: list(sr.language).slice(0, 5),
|
|
800
|
+
places: list(sr.spatial).slice(0, 10),
|
|
801
|
+
publisher: one(sr.publisher),
|
|
802
|
+
collections: collectionTitles(sr.collection).slice(0, 10),
|
|
803
|
+
rights: one(sr.rights) ?? d?.rights ?? null,
|
|
804
|
+
contributing_institution: d?.dataProvider ? one(d.dataProvider) : null,
|
|
805
|
+
hub: d?.provider?.name ?? null,
|
|
806
|
+
item_url: d?.isShownAt ?? null,
|
|
807
|
+
thumbnail_url: d?.object ?? null,
|
|
808
|
+
ingested_at: d?.ingestDate ?? null,
|
|
809
|
+
};
|
|
810
|
+
}
|
|
811
|
+
|
|
812
|
+
// ── Tool implementations ────────────────────────────────────────────────
|
|
813
|
+
|
|
814
|
+
async function searchItems(args: Record<string, unknown>, key: string) {
|
|
815
|
+
const params = new URLSearchParams();
|
|
816
|
+
const q = String(args.q ?? '').trim();
|
|
817
|
+
const title = String(args.title ?? '').trim();
|
|
818
|
+
const creator = String(args.creator ?? '').trim();
|
|
819
|
+
const provider = String(args.provider ?? '').trim();
|
|
820
|
+
const subject = String(args.subject ?? '').trim();
|
|
821
|
+
const type = String(args.type ?? '').trim();
|
|
822
|
+
const collection = String(args.collection ?? '').trim();
|
|
823
|
+
const after = String(args.date_after ?? '').trim();
|
|
824
|
+
const before = String(args.date_before ?? '').trim();
|
|
825
|
+
|
|
826
|
+
if (q) params.set('q', q);
|
|
827
|
+
if (collection) params.set('sourceResource.collection.title', collection);
|
|
828
|
+
if (title) params.set('sourceResource.title', title);
|
|
829
|
+
if (creator) params.set('sourceResource.creator', creator);
|
|
830
|
+
if (provider) params.set('provider.name', provider);
|
|
831
|
+
if (subject) params.set('sourceResource.subject.name', subject);
|
|
832
|
+
if (type) params.set('sourceResource.type', type);
|
|
833
|
+
if (after) params.set('sourceResource.date.after', after);
|
|
834
|
+
if (before) params.set('sourceResource.date.before', before);
|
|
835
|
+
if ([...params.keys()].length === 0) {
|
|
836
|
+
throw new Error('dpla_search_items needs at least one of: q (free text across the whole record), title, creator, provider, subject, type, collection, date_after, date_before. A bare call would ask DPLA for all ~50 million records.');
|
|
837
|
+
}
|
|
838
|
+
|
|
839
|
+
const pageSize = Math.min(Math.max(Number(args.limit ?? 20) || 20, 1), 100);
|
|
840
|
+
const page = Math.max(Number(args.page ?? 1) || 1, 1);
|
|
841
|
+
params.set('page_size', String(pageSize));
|
|
842
|
+
params.set('page', String(page));
|
|
843
|
+
|
|
844
|
+
const data = await dplaGet('/items', params, key, 'dpla_search_items');
|
|
845
|
+
const docs: any[] = Array.isArray(data?.docs) ? data.docs : [];
|
|
846
|
+
const total = Number(data?.count ?? 0);
|
|
847
|
+
|
|
848
|
+
return {
|
|
849
|
+
query: Object.fromEntries([...params].filter(([k]) => k !== 'api_key')),
|
|
850
|
+
total_matches: total,
|
|
851
|
+
page,
|
|
852
|
+
page_size: pageSize,
|
|
853
|
+
returned: docs.length,
|
|
854
|
+
items: docs.map(shapeItem),
|
|
855
|
+
note: docs.length === 0
|
|
856
|
+
? 'No DPLA records matched. DPLA aggregates descriptive metadata written by hundreds of separate institutions, so vocabulary varies — try a broader `q` before concluding nothing was digitised.'
|
|
857
|
+
: 'item_url points at the contributing institution\'s own page for the object; DPLA holds the description, the institution holds the object.',
|
|
858
|
+
source: SOURCE,
|
|
859
|
+
};
|
|
860
|
+
}
|
|
861
|
+
|
|
862
|
+
async function item(args: Record<string, unknown>, key: string) {
|
|
863
|
+
const id = String(args.id ?? '').trim();
|
|
864
|
+
if (!/^[0-9a-f]{8,64}$/i.test(id)) {
|
|
865
|
+
throw new Error(`dpla_item requires \`id\` — a DPLA record id, a 32-character hex string as returned by dpla_search_items. Got "${id}".`);
|
|
866
|
+
}
|
|
867
|
+
const data = await dplaGet(`/items/${encodeURIComponent(id)}`, new URLSearchParams(), key, 'dpla_item', { notFoundIsMissing: true });
|
|
868
|
+
const docs: any[] = Array.isArray(data?.docs) ? data.docs : [];
|
|
869
|
+
if (docs.length === 0) {
|
|
870
|
+
return { id, found: false, note: 'No DPLA record with that id.', source: SOURCE };
|
|
871
|
+
}
|
|
872
|
+
const d = docs[0];
|
|
873
|
+
return {
|
|
874
|
+
found: true,
|
|
875
|
+
item: {
|
|
876
|
+
...shapeItem(d),
|
|
877
|
+
original_record_url: d?.isShownAt ?? null,
|
|
878
|
+
hub_url: d?.provider?.['@id'] ?? null,
|
|
879
|
+
source_resource_raw: d?.sourceResource ?? null,
|
|
880
|
+
},
|
|
881
|
+
source: SOURCE,
|
|
882
|
+
};
|
|
883
|
+
}
|
|
884
|
+
|
|
885
|
+
/** DPLA's facet block has worn two shapes: the documented legacy one,
|
|
886
|
+
* `{ "<field>": { _type: "terms", terms: [{ term, count }] } }`, and the raw
|
|
887
|
+
* Elasticsearch aggregation, `{ "<field>": { buckets: [{ key, doc_count }] } }`
|
|
888
|
+
* (their in-progress rewrite also types it as a list of `{ field, buckets }`).
|
|
889
|
+
* Read all three; return null when the field is simply absent so the caller
|
|
890
|
+
* can tell "no facet block" from "facet present, zero collections". */
|
|
891
|
+
function readFacetTerms(facets: unknown, field: string): Array<{ term: string; count: number }> | null {
|
|
892
|
+
let block: any = null;
|
|
893
|
+
if (Array.isArray(facets)) {
|
|
894
|
+
block = facets.find((f: any) => f?.field === field) ?? null;
|
|
895
|
+
} else if (facets && typeof facets === 'object') {
|
|
896
|
+
const f = facets as Record<string, any>;
|
|
897
|
+
block = f[field] ?? (Array.isArray(f.facets) ? f.facets.find((x: any) => x?.field === field) : null) ?? null;
|
|
898
|
+
}
|
|
899
|
+
if (!block || typeof block !== 'object') return null;
|
|
900
|
+
const rows: any[] = Array.isArray(block.terms) ? block.terms : Array.isArray(block.buckets) ? block.buckets : [];
|
|
901
|
+
if (!Array.isArray(block.terms) && !Array.isArray(block.buckets)) return null;
|
|
902
|
+
return rows
|
|
903
|
+
.map((r: any) => ({
|
|
904
|
+
term: String(r?.term ?? r?.key ?? r?.keyAsString ?? '').trim(),
|
|
905
|
+
count: Number(r?.count ?? r?.doc_count ?? r?.docCount ?? 0),
|
|
906
|
+
}))
|
|
907
|
+
.filter((r) => r.term);
|
|
908
|
+
}
|
|
909
|
+
|
|
910
|
+
async function collections(args: Record<string, unknown>, key: string) {
|
|
911
|
+
const params = new URLSearchParams();
|
|
912
|
+
const q = String(args.q ?? '').trim();
|
|
913
|
+
const title = String(args.title ?? '').trim();
|
|
914
|
+
if (q) params.set('q', q);
|
|
915
|
+
if (title) params.set('sourceResource.collection.title', title);
|
|
916
|
+
if ([...params.keys()].length === 0) {
|
|
917
|
+
throw new Error('dpla_collections needs `q` (free text — collections whose items match it) or `title` (words in the collection name), e.g. { q: "Civil War" }.');
|
|
918
|
+
}
|
|
919
|
+
// DPLA retired /v2/collections (#2249). Named collections are the
|
|
920
|
+
// `sourceResource.collection.title` facet on the items search: one call gives
|
|
921
|
+
// every collection title among the matching items, with how many items each
|
|
922
|
+
// holds. facet_size is capped at 2,000 upstream; page_size=0 silently falls
|
|
923
|
+
// back to the default page, so ask for one doc and ignore it.
|
|
924
|
+
const size = Math.min(Math.max(Number(args.limit ?? 20) || 20, 1), 200);
|
|
925
|
+
params.set('facets', 'sourceResource.collection.title');
|
|
926
|
+
params.set('facet_size', String(size));
|
|
927
|
+
params.set('page_size', '1');
|
|
928
|
+
|
|
929
|
+
const data = await dplaGet('/items', params, key, 'dpla_collections');
|
|
930
|
+
const total = Number(data?.count ?? 0);
|
|
931
|
+
const terms = readFacetTerms(data?.facets, 'sourceResource.collection.title');
|
|
932
|
+
if (terms === null && total > 0) {
|
|
933
|
+
// A 200 with matches but no facet block is a shape change upstream, not
|
|
934
|
+
// "no collections" — surface it rather than book a silent zero.
|
|
935
|
+
const keys = data?.facets && typeof data.facets === 'object' ? Object.keys(data.facets).join(', ') : typeof data?.facets;
|
|
936
|
+
throw new Error(`dpla_collections: DPLA matched ${total.toLocaleString()} items but returned no sourceResource.collection.title facet block (facets present: ${keys || 'none'}). The facet response shape has changed upstream; file pipeworx_feedback so the pack can be updated.`);
|
|
937
|
+
}
|
|
938
|
+
const rows = terms ?? [];
|
|
939
|
+
return {
|
|
940
|
+
query: Object.fromEntries([...params].filter(([k]) => k !== 'api_key')),
|
|
941
|
+
matching_items: total,
|
|
942
|
+
returned: rows.length,
|
|
943
|
+
collections: rows.map((r) => ({ title: r.term, item_count: r.count })),
|
|
944
|
+
note: rows.length === 0
|
|
945
|
+
? (total === 0
|
|
946
|
+
? 'No DPLA records matched, so there are no collections to list. DPLA aggregates metadata written by hundreds of separate institutions, so vocabulary varies — try a broader `q`.'
|
|
947
|
+
: 'Records matched but none of them carries a named collection. Collections are the groupings a contributing institution defines; many institutions define none, so the items exist without one.')
|
|
948
|
+
: 'item_count is how many of the matching records sit in that collection. Pull them with dpla_search_items({ collection: "<title>" }), optionally with the same q.',
|
|
949
|
+
source: SOURCE,
|
|
950
|
+
};
|
|
951
|
+
}
|
|
952
|
+
|
|
953
|
+
// ── Tool definitions ────────────────────────────────────────────────────
|
|
954
|
+
|
|
955
|
+
const tools: McpToolExport['tools'] = [
|
|
956
|
+
{
|
|
957
|
+
name: 'dpla_search_items',
|
|
958
|
+
description:
|
|
959
|
+
'Search ~50 million digitised items aggregated by the Digital Public Library of America — photographs, letters, maps, newspapers, oral histories and books from the Library of Congress, the National Archives, the Smithsonian, HathiTrust, Internet Archive and hundreds of state libraries, universities and historical societies. Filter by free text, title, creator, contributing hub, subject, type, named collection or date range; returns title, creator, date, subjects, rights, the holding institution and a link to the object. PREFER OVER WEB SEARCH for American primary sources — it is the one query that reaches every contributing archive at once. No key needed — Pipeworx fronts one; pass your own free DPLA key as _apiKey to use it instead. Example: dpla_search_items({ q: "Dust Bowl", limit: 10 }).',
|
|
960
|
+
inputSchema: {
|
|
961
|
+
type: 'object' as const,
|
|
962
|
+
properties: {
|
|
963
|
+
q: { type: 'string', description: 'Free-text search across the whole record.' },
|
|
964
|
+
title: { type: 'string', description: 'Words in the item title.' },
|
|
965
|
+
creator: { type: 'string', description: 'Creator / author / photographer name.' },
|
|
966
|
+
provider: { type: 'string', description: 'Contributing DPLA hub, e.g. "Smithsonian Institution", "HathiTrust".' },
|
|
967
|
+
collection: { type: 'string', description: 'Words in the name of the named collection the item belongs to, as returned by dpla_collections.' },
|
|
968
|
+
subject: { type: 'string', description: 'Subject heading, e.g. "Civil rights demonstrations".' },
|
|
969
|
+
type: { type: 'string', description: 'Item type: image, text, sound, moving image, physical object.' },
|
|
970
|
+
date_after: { type: 'string', description: 'Only items dated after this, YYYY or YYYY-MM-DD.' },
|
|
971
|
+
date_before: { type: 'string', description: 'Only items dated before this, YYYY or YYYY-MM-DD.' },
|
|
972
|
+
limit: { type: 'number', description: 'Items per page, 1-100. Default 20.' },
|
|
973
|
+
page: { type: 'number', description: '1-based page number. Default 1.' },
|
|
974
|
+
_apiKey: { type: 'string', description: KEY_DESC },
|
|
975
|
+
},
|
|
976
|
+
required: [],
|
|
977
|
+
},
|
|
978
|
+
},
|
|
979
|
+
{
|
|
980
|
+
name: 'dpla_item',
|
|
981
|
+
description:
|
|
982
|
+
'One DPLA record in full by its id: title, creator, date, description, subjects, language, place, format, rights statement, the institution holding the original, the DPLA hub that contributed it, a thumbnail, a link to the object on the holder\'s own site, and the raw source metadata as the institution wrote it. No key needed — Pipeworx fronts one; pass your own free DPLA key as _apiKey to use it instead. Example: dpla_item({ id: "<32-hex id from dpla_search_items>" }).',
|
|
983
|
+
inputSchema: {
|
|
984
|
+
type: 'object' as const,
|
|
985
|
+
properties: {
|
|
986
|
+
id: { type: 'string', description: 'DPLA record id — a 32-character hex string from dpla_search_items.' },
|
|
987
|
+
_apiKey: { type: 'string', description: KEY_DESC },
|
|
988
|
+
},
|
|
989
|
+
required: ['id'],
|
|
990
|
+
},
|
|
991
|
+
},
|
|
992
|
+
{
|
|
993
|
+
name: 'dpla_collections',
|
|
994
|
+
description:
|
|
995
|
+
'Which named collections inside DPLA\'s contributing institutions hold material on a topic — the curated groupings an archive defines around a subject, a donor or a project — each with how many matching items it holds. Backed by the collection-title facet of DPLA\'s item search (DPLA retired its separate collections endpoint), so `q` scopes the list to collections whose items match the text and `title` matches words in the collection name. Use it to see how American libraries have organised a subject before pulling records with dpla_search_items({ collection }). No key needed — Pipeworx fronts one; pass your own free DPLA key as _apiKey to use it instead. Example: dpla_collections({ q: "Civil War" }).',
|
|
996
|
+
inputSchema: {
|
|
997
|
+
type: 'object' as const,
|
|
998
|
+
properties: {
|
|
999
|
+
q: { type: 'string', description: 'Free text; lists the collections whose items match it.' },
|
|
1000
|
+
title: { type: 'string', description: 'Words in the collection name.' },
|
|
1001
|
+
limit: { type: 'number', description: 'Maximum collections to return, 1-200. Default 20. Ordered by item count, most first.' },
|
|
1002
|
+
_apiKey: { type: 'string', description: KEY_DESC },
|
|
1003
|
+
},
|
|
1004
|
+
required: [],
|
|
1005
|
+
},
|
|
1006
|
+
},
|
|
1007
|
+
];
|
|
1008
|
+
|
|
1009
|
+
async function callTool(name: string, args: Record<string, unknown>): Promise<unknown> {
|
|
1010
|
+
const raw = args._apiKey as string | undefined;
|
|
1011
|
+
delete args._apiKey;
|
|
1012
|
+
const key = requireKey(raw, name);
|
|
1013
|
+
|
|
1014
|
+
switch (name) {
|
|
1015
|
+
case 'dpla_search_items':
|
|
1016
|
+
return searchItems(args, key);
|
|
1017
|
+
case 'dpla_item':
|
|
1018
|
+
return item(args, key);
|
|
1019
|
+
case 'dpla_collections':
|
|
1020
|
+
return collections(args, key);
|
|
1021
|
+
default:
|
|
1022
|
+
throw new Error(`Unknown tool: ${name}`);
|
|
1023
|
+
}
|
|
1024
|
+
}
|
|
1025
|
+
|
|
1026
|
+
export { tools, callTool };
|
|
1027
|
+
export default {
|
|
1028
|
+
tools,
|
|
1029
|
+
callTool,
|
|
1030
|
+
meter: { credits: 1 },
|
|
1031
|
+
provider: 'Digital Public Library of America (DPLA)',
|
|
1032
|
+
} satisfies McpToolExport;
|