@pipeworx/mcp-pulse-verity 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 +246 -0
- package/bin/cli.js +17 -0
- package/package.json +32 -0
- package/server.json +18 -0
- package/src/index.ts +1161 -0
- package/src/server.ts +45 -0
- package/tsconfig.json +18 -0
package/src/index.ts
ADDED
|
@@ -0,0 +1,1161 @@
|
|
|
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
|
+
* Pulse Verity — crypto index prices that come with a PROOF.
|
|
640
|
+
*
|
|
641
|
+
* Every other price source in this catalogue hands back a number you have to
|
|
642
|
+
* take on trust. Pulse signs each observation with ECDSA P-256 over a canonical
|
|
643
|
+
* string, so an agent that acted on a price can later demonstrate WHICH price it
|
|
644
|
+
* acted on, and that demonstration holds with the agent, this gateway and Pulse
|
|
645
|
+
* all offline. That is the reason this pack exists; the price is the vehicle.
|
|
646
|
+
*
|
|
647
|
+
* ── DO NOT STRIP THE SIGNATURE TO TIDY THE PAYLOAD ──────────────────────
|
|
648
|
+
*
|
|
649
|
+
* `signature`, `kid` and `sig` travel on every print we return. They look like
|
|
650
|
+
* noise next to a price and they are the product. A caller that receives the
|
|
651
|
+
* number without them has the same thing every other pack gives it.
|
|
652
|
+
*
|
|
653
|
+
* ── THE priceText TRAP, MEASURED ────────────────────────────────────────
|
|
654
|
+
*
|
|
655
|
+
* The canonical string is built from `priceText` — the price EXACTLY as it
|
|
656
|
+
* appeared on the wire — never from a reparsed float. On the sample used while
|
|
657
|
+
* building this, `String(price)` happened to equal `priceText`, so a
|
|
658
|
+
* float-reparsing verifier VERIFIED CORRECTLY and looked right. It breaks the
|
|
659
|
+
* first time JS number formatting diverges from the wire text: a trailing zero
|
|
660
|
+
* ("76051.10" vs 76051.1), exponent form (1e-7), or more than 17 significant
|
|
661
|
+
* digits. A verifier that is correct only until the price has a trailing zero is
|
|
662
|
+
* worse than none, because it will be trusted.
|
|
663
|
+
*
|
|
664
|
+
* So: `canonicalString()` below prefers priceText and falls back to
|
|
665
|
+
* String(price) ONLY when priceText is absent, which is the fallback Pulse's own
|
|
666
|
+
* verifier documents. When we fall back, the response says so.
|
|
667
|
+
*
|
|
668
|
+
* ── GRADES ARE LOAD-BEARING, NOT METADATA ───────────────────────────────
|
|
669
|
+
*
|
|
670
|
+
* consensus — 3+ independent venues
|
|
671
|
+
* blended — 2 venues
|
|
672
|
+
* indicative — ONE exact-mapped venue. NEVER valid for settlement.
|
|
673
|
+
*
|
|
674
|
+
* A thin asset comes back marked `indicative` rather than confidently wrong,
|
|
675
|
+
* which is the honest behaviour we want from an upstream — and it is only
|
|
676
|
+
* honest downstream if we carry the grade through and say what it means. Every
|
|
677
|
+
* print we return therefore also carries `settleable` (a boolean we derive) and
|
|
678
|
+
* `grade_note`, because an agent reading a bare price field will not infer that
|
|
679
|
+
* `indicative` disqualifies it.
|
|
680
|
+
*
|
|
681
|
+
* ── WHAT IS SIGNED AND WHAT IS NOT ──────────────────────────────────────
|
|
682
|
+
*
|
|
683
|
+
* Prints (`/price`, `/batch`, `/print`) are signed. The asset CATALOGUE is NOT:
|
|
684
|
+
* its rows carry prices and coverage metadata with no signature, and Pulse says
|
|
685
|
+
* to re-read the number through a print tool if you need a verifiable one. So
|
|
686
|
+
* `pulse_asset_catalog` marks itself `signed: false` and says that in the tool
|
|
687
|
+
* description. Serving an unsigned price from a pack whose whole pitch is
|
|
688
|
+
* signatures is exactly the confusion worth pre-empting.
|
|
689
|
+
*/
|
|
690
|
+
|
|
691
|
+
|
|
692
|
+
const API_BASE = 'https://mcp.thepulse.markets/api/index/v1';
|
|
693
|
+
const UA = 'pipeworx-mcp-pulse-verity/1.0 (+https://pipeworx.io)';
|
|
694
|
+
const SOURCE = 'Pulse Verity Index (thepulse.markets)';
|
|
695
|
+
const MAX_BATCH = 100;
|
|
696
|
+
|
|
697
|
+
const GRADE_NOTES: Record<string, string> = {
|
|
698
|
+
consensus: 'consensus: 3 or more independent venues agreed. Valid for settlement.',
|
|
699
|
+
blended: 'blended: 2 independent venues. Valid for settlement, with a wider interval than consensus.',
|
|
700
|
+
indicative:
|
|
701
|
+
'indicative: ONE exact-mapped venue. NOT valid for settlement — Pulse publishes it so a thin asset reads as thin instead of confidently wrong. Use it as a sighting, never as a price to settle against.',
|
|
702
|
+
};
|
|
703
|
+
|
|
704
|
+
/** Grades Pulse states are settleable. Unknown grades are treated as NOT settleable. */
|
|
705
|
+
const SETTLEABLE = new Set(['consensus', 'blended']);
|
|
706
|
+
|
|
707
|
+
function gradeFields(grade: unknown) {
|
|
708
|
+
const g = typeof grade === 'string' ? grade : '';
|
|
709
|
+
return {
|
|
710
|
+
settleable: SETTLEABLE.has(g),
|
|
711
|
+
grade_note:
|
|
712
|
+
GRADE_NOTES[g] ??
|
|
713
|
+
`unrecognised grade ${JSON.stringify(grade)} — treated as NOT settleable, because a grade this pack has never seen cannot be asserted to be safe. Check /pubkey's notes and this pack's README.`,
|
|
714
|
+
};
|
|
715
|
+
}
|
|
716
|
+
|
|
717
|
+
// ── canonical string ────────────────────────────────────────────────────
|
|
718
|
+
|
|
719
|
+
export interface SignedPrint {
|
|
720
|
+
symbol: string;
|
|
721
|
+
price?: number;
|
|
722
|
+
priceText?: string;
|
|
723
|
+
at: string;
|
|
724
|
+
grade: string;
|
|
725
|
+
signature: string;
|
|
726
|
+
kid?: string;
|
|
727
|
+
sig?: string;
|
|
728
|
+
}
|
|
729
|
+
|
|
730
|
+
/**
|
|
731
|
+
* Rebuild the exact bytes Pulse signed: `pulse-index-v1\n{symbol}\n{price}\n{at}\n{grade}`.
|
|
732
|
+
* Returns the string plus whether the priceText fallback was used, so the
|
|
733
|
+
* caller can be told rather than silently trusting a reparsed float.
|
|
734
|
+
*/
|
|
735
|
+
export function canonicalString(p: SignedPrint): { canonical: string; usedFallback: boolean } {
|
|
736
|
+
const hasText = typeof p.priceText === 'string' && p.priceText.length > 0;
|
|
737
|
+
const priceField = hasText ? (p.priceText as string) : String(p.price);
|
|
738
|
+
return {
|
|
739
|
+
canonical: `pulse-index-v1\n${p.symbol}\n${priceField}\n${p.at}\n${p.grade}`,
|
|
740
|
+
usedFallback: !hasText,
|
|
741
|
+
};
|
|
742
|
+
}
|
|
743
|
+
|
|
744
|
+
// ── key ring ────────────────────────────────────────────────────────────
|
|
745
|
+
|
|
746
|
+
interface RingKey { kid: string; jwk: JsonWebKey; active?: boolean }
|
|
747
|
+
interface KeyRing { algorithm?: string; canonical?: string; activeKid?: string; verificationKeys: RingKey[] }
|
|
748
|
+
|
|
749
|
+
/**
|
|
750
|
+
* Module-scope ring cache, keyed by kid.
|
|
751
|
+
*
|
|
752
|
+
* WHY A CACHE AND NOT AN EMBEDDED CONSTANT. Hard-coding today's public key
|
|
753
|
+
* would make verification need no network at all, and would silently start
|
|
754
|
+
* REJECTING VALID PRINTS the day Pulse rotates its key — a signature failure
|
|
755
|
+
* that reads as "Pulse is lying to you" when the truth is that the key it was
|
|
756
|
+
* checked against had simply expired. That is the worst possible direction for
|
|
757
|
+
* this pack's error to point.
|
|
758
|
+
*
|
|
759
|
+
* WHY THE CACHE IS STILL HONEST ABOUT "LOCAL". The ECDSA verification is local:
|
|
760
|
+
* we never ask Pulse whether a print is valid, so Pulse cannot answer "yes"
|
|
761
|
+
* about a print it never signed, and a compromised or offline Pulse cannot turn
|
|
762
|
+
* an invalid print into a valid one. What is not local is KEY DISTRIBUTION — a
|
|
763
|
+
* kid we have never seen costs one fetch of the public ring. Every response
|
|
764
|
+
* says which of the two happened in `key_source`, because "verified locally" is
|
|
765
|
+
* a security claim and a pack should not make it vaguely.
|
|
766
|
+
*/
|
|
767
|
+
const ringCache = new Map<string, CryptoKey>();
|
|
768
|
+
let ringMeta: { algorithm?: string; activeKid?: string; fetchedAt?: string } = {};
|
|
769
|
+
|
|
770
|
+
async function fetchRing(): Promise<KeyRing> {
|
|
771
|
+
const res = await fetchWithTimeout(
|
|
772
|
+
`${API_BASE}/pubkey`,
|
|
773
|
+
{ headers: { Accept: 'application/json', 'User-Agent': UA } },
|
|
774
|
+
'Pulse Verity key ring',
|
|
775
|
+
);
|
|
776
|
+
const text = await res.text();
|
|
777
|
+
if (!res.ok) throw pulseError(res.status, text, 'pulse_key_ring');
|
|
778
|
+
let body: KeyRing;
|
|
779
|
+
try {
|
|
780
|
+
body = JSON.parse(text) as KeyRing;
|
|
781
|
+
} catch {
|
|
782
|
+
throw new Error(
|
|
783
|
+
`pulse_key_ring: Pulse's key ring was not JSON (HTTP ${res.status}). Without the ring no signature can be checked, so this fails rather than returning an unverified print. Upstream said: ${summarizeErrorBody(text)}`,
|
|
784
|
+
);
|
|
785
|
+
}
|
|
786
|
+
if (!Array.isArray(body.verificationKeys) || body.verificationKeys.length === 0) {
|
|
787
|
+
throw new Error('pulse_key_ring: the ring came back with no verification keys, so nothing can be verified against it.');
|
|
788
|
+
}
|
|
789
|
+
ringMeta = { algorithm: body.algorithm, activeKid: body.activeKid, fetchedAt: new Date().toISOString() };
|
|
790
|
+
return body;
|
|
791
|
+
}
|
|
792
|
+
|
|
793
|
+
async function keyFor(kid: string | undefined): Promise<{ key: CryptoKey; source: 'cache' | 'fetched'; kid: string }> {
|
|
794
|
+
const wanted = kid && kid.length > 0 ? kid : undefined;
|
|
795
|
+
if (wanted) {
|
|
796
|
+
const hit = ringCache.get(wanted);
|
|
797
|
+
if (hit) return { key: hit, source: 'cache', kid: wanted };
|
|
798
|
+
}
|
|
799
|
+
const ring = await fetchRing();
|
|
800
|
+
for (const entry of ring.verificationKeys) {
|
|
801
|
+
if (!entry?.kid || !entry?.jwk) continue;
|
|
802
|
+
try {
|
|
803
|
+
const k = await crypto.subtle.importKey(
|
|
804
|
+
'jwk',
|
|
805
|
+
{ ...(entry.jwk as JsonWebKey), ext: true },
|
|
806
|
+
{ name: 'ECDSA', namedCurve: 'P-256' },
|
|
807
|
+
false,
|
|
808
|
+
['verify'],
|
|
809
|
+
);
|
|
810
|
+
ringCache.set(entry.kid, k);
|
|
811
|
+
} catch {
|
|
812
|
+
/* a ring entry we cannot import is skipped, not fatal: the kid we need may still be there */
|
|
813
|
+
}
|
|
814
|
+
}
|
|
815
|
+
const chosenKid = wanted ?? ring.activeKid ?? ring.verificationKeys[0]?.kid;
|
|
816
|
+
const key = chosenKid ? ringCache.get(chosenKid) : undefined;
|
|
817
|
+
if (!key || !chosenKid) {
|
|
818
|
+
throw new Error(
|
|
819
|
+
`pulse_verify_print: no public key in Pulse's ring matches kid ${JSON.stringify(kid)}. The ring currently holds ${[...ringCache.keys()].join(', ') || '(nothing importable)'}. A print whose kid is absent from the ring cannot be verified — treat it as UNVERIFIED, not as invalid.`,
|
|
820
|
+
);
|
|
821
|
+
}
|
|
822
|
+
return { key, source: 'fetched', kid: chosenKid };
|
|
823
|
+
}
|
|
824
|
+
|
|
825
|
+
// ── verification ────────────────────────────────────────────────────────
|
|
826
|
+
|
|
827
|
+
function b64ToBytes(b64: string): Uint8Array {
|
|
828
|
+
const bin = atob(b64);
|
|
829
|
+
const out = new Uint8Array(bin.length);
|
|
830
|
+
for (let i = 0; i < bin.length; i++) out[i] = bin.charCodeAt(i);
|
|
831
|
+
return out;
|
|
832
|
+
}
|
|
833
|
+
|
|
834
|
+
async function verifyPrint(args: Record<string, unknown>) {
|
|
835
|
+
const p = args as unknown as SignedPrint;
|
|
836
|
+
for (const f of ['symbol', 'at', 'grade', 'signature'] as const) {
|
|
837
|
+
if (typeof p[f] !== 'string' || !(p[f] as string).length) {
|
|
838
|
+
throw new Error(
|
|
839
|
+
`pulse_verify_print requires ${f}. Pass the print back EXACTLY as a Pulse tool returned it — symbol, price, priceText, at, grade, signature and kid. Re-typing or rounding any field will make a genuine print fail to verify.`,
|
|
840
|
+
);
|
|
841
|
+
}
|
|
842
|
+
}
|
|
843
|
+
if (typeof p.priceText !== 'string' && typeof p.price !== 'number') {
|
|
844
|
+
throw new Error(
|
|
845
|
+
'pulse_verify_print requires priceText (preferred) or price. priceText is the price exactly as Pulse served it and is what was signed.',
|
|
846
|
+
);
|
|
847
|
+
}
|
|
848
|
+
|
|
849
|
+
const { canonical, usedFallback } = canonicalString(p);
|
|
850
|
+
let sigBytes: Uint8Array;
|
|
851
|
+
try {
|
|
852
|
+
sigBytes = b64ToBytes(p.signature);
|
|
853
|
+
} catch {
|
|
854
|
+
throw new Error('pulse_verify_print: signature is not valid base64, so it cannot be a Pulse signature. Pass it exactly as returned.');
|
|
855
|
+
}
|
|
856
|
+
|
|
857
|
+
const { key, source, kid } = await keyFor(p.kid);
|
|
858
|
+
const valid = await crypto.subtle.verify({ name: 'ECDSA', hash: 'SHA-256' }, key, sigBytes, new TextEncoder().encode(canonical));
|
|
859
|
+
|
|
860
|
+
return {
|
|
861
|
+
valid,
|
|
862
|
+
symbol: p.symbol,
|
|
863
|
+
at: p.at,
|
|
864
|
+
grade: p.grade,
|
|
865
|
+
...gradeFields(p.grade),
|
|
866
|
+
kid_used: kid,
|
|
867
|
+
key_source: source === 'cache'
|
|
868
|
+
? 'cached public key — this verification made NO network call of any kind'
|
|
869
|
+
: "fetched Pulse's public key ring once for this kid, then verified locally; the ring is cached for subsequent calls",
|
|
870
|
+
signature_bytes: sigBytes.length,
|
|
871
|
+
canonical_string: canonical,
|
|
872
|
+
price_field_used: usedFallback ? 'String(price) — priceText was absent' : 'priceText, verbatim',
|
|
873
|
+
...(usedFallback
|
|
874
|
+
? {
|
|
875
|
+
fallback_warning:
|
|
876
|
+
'priceText was not supplied, so the canonical string was rebuilt from String(price). That matches Pulse\'s documented fallback and is usually right, but JS float formatting can differ from the wire text (trailing zeros, exponent form, >17 significant digits) and would make a GENUINE print fail here. Pass priceText when you have it.',
|
|
877
|
+
}
|
|
878
|
+
: {}),
|
|
879
|
+
verification:
|
|
880
|
+
'ECDSA P-256 / SHA-256 over `pulse-index-v1\\n{symbol}\\n{priceText}\\n{at}\\n{grade}`, signature as IEEE-P1363 r||s, base64. Computed in this worker: Pulse is never asked whether the print is valid, so it cannot vouch for a print it did not sign.',
|
|
881
|
+
...(valid
|
|
882
|
+
? {}
|
|
883
|
+
: {
|
|
884
|
+
invalid_note:
|
|
885
|
+
'The signature does NOT match this print. Either a field was altered after signing (a single changed digit, or a 1ms shift in `at`, is enough) or the print did not come from Pulse. Do not settle against it. If you re-typed any field by hand, re-fetch the print and try again before concluding it was tampered with.',
|
|
886
|
+
}),
|
|
887
|
+
source: SOURCE,
|
|
888
|
+
};
|
|
889
|
+
}
|
|
890
|
+
|
|
891
|
+
// ── HTTP ────────────────────────────────────────────────────────────────
|
|
892
|
+
|
|
893
|
+
function requireKey(apiKey: string | undefined, tool: string): string {
|
|
894
|
+
if (!apiKey) {
|
|
895
|
+
throw new Error(
|
|
896
|
+
`${tool} requires an API key: the Pulse Verity Index refuses unkeyed reads for anything beyond the BTC/ETH/SOL sample. Pass it as _apiKey. A free key is self-serve at https://thepulse.markets/developers (60 requests/minute, 25,000/month, no card).`,
|
|
897
|
+
);
|
|
898
|
+
}
|
|
899
|
+
return apiKey;
|
|
900
|
+
}
|
|
901
|
+
|
|
902
|
+
function pulseError(status: number, bodyText: string, tool: string): Error {
|
|
903
|
+
const upstream = summarizeErrorBody(bodyText);
|
|
904
|
+
const detail = upstream ? ` Upstream said: ${upstream}` : '';
|
|
905
|
+
if (status === 401 || status === 403) {
|
|
906
|
+
return new Error(
|
|
907
|
+
`${tool} requires an API key that Pulse accepts (HTTP ${status}). Get a free one at https://thepulse.markets/developers and pass it as _apiKey.${detail}`,
|
|
908
|
+
);
|
|
909
|
+
}
|
|
910
|
+
if (status === 404) {
|
|
911
|
+
return new Error(
|
|
912
|
+
`${tool}: Pulse does not serve that symbol (HTTP 404). The index covers thousands of assets but not every ticker — call pulse_asset_catalog to see what is covered and at what grade.${detail}`,
|
|
913
|
+
);
|
|
914
|
+
}
|
|
915
|
+
if (status === 429) {
|
|
916
|
+
return new Error(
|
|
917
|
+
`${tool}: rate limited by Pulse (HTTP 429). The free tier is 60 requests/minute and 25,000/month; pause rather than retrying in a loop.${detail}`,
|
|
918
|
+
);
|
|
919
|
+
}
|
|
920
|
+
return new Error(`${tool}: HTTP ${status} from the Pulse Verity Index.${detail}`);
|
|
921
|
+
}
|
|
922
|
+
|
|
923
|
+
async function pulseGet(path: string, apiKey: string | undefined, tool: string, keyed = true): Promise<unknown> {
|
|
924
|
+
const headers: Record<string, string> = { Accept: 'application/json', 'User-Agent': UA };
|
|
925
|
+
if (keyed) headers.Authorization = `Bearer ${requireKey(apiKey, tool)}`;
|
|
926
|
+
const res = await fetchWithTimeout(`${API_BASE}${path}`, { headers }, SOURCE);
|
|
927
|
+
const text = await res.text();
|
|
928
|
+
if (!res.ok) throw pulseError(res.status, text, tool);
|
|
929
|
+
let body: unknown;
|
|
930
|
+
try {
|
|
931
|
+
body = JSON.parse(text);
|
|
932
|
+
} catch {
|
|
933
|
+
// A 200 is not a promise of JSON. Never forward the raw body: an upstream
|
|
934
|
+
// HTML error page inside a JSON field makes the caller's whole explanation
|
|
935
|
+
// a parser complaint about the letter '<'.
|
|
936
|
+
throw new Error(`${tool}: Pulse answered HTTP ${res.status} with a body that is not JSON. Upstream said: ${summarizeErrorBody(text)}`);
|
|
937
|
+
}
|
|
938
|
+
// Pulse signals refusals in-band with success:false and a code.
|
|
939
|
+
const b = body as Record<string, unknown>;
|
|
940
|
+
if (b && b.success === false) {
|
|
941
|
+
const code = typeof b.code === 'string' ? ` (${b.code})` : '';
|
|
942
|
+
throw new Error(`${tool}: Pulse refused the request${code}: ${String(b.message ?? 'no message')}`);
|
|
943
|
+
}
|
|
944
|
+
return body;
|
|
945
|
+
}
|
|
946
|
+
|
|
947
|
+
function decorate(print: Record<string, unknown>): Record<string, unknown> {
|
|
948
|
+
return { ...print, ...gradeFields(print.grade) };
|
|
949
|
+
}
|
|
950
|
+
|
|
951
|
+
// ── tools ───────────────────────────────────────────────────────────────
|
|
952
|
+
|
|
953
|
+
async function signedPrice(args: Record<string, unknown>, apiKey?: string) {
|
|
954
|
+
const symbol = String(args.symbol ?? '').trim();
|
|
955
|
+
if (!symbol) throw new Error('pulse_signed_price requires a symbol, e.g. {"symbol":"BTC"}. pulse_asset_catalog lists what is covered.');
|
|
956
|
+
const body = (await pulseGet(`/price?symbol=${encodeURIComponent(symbol)}`, apiKey, 'pulse_signed_price')) as Record<string, unknown>;
|
|
957
|
+
return {
|
|
958
|
+
print: decorate(body),
|
|
959
|
+
verify_with: 'pulse_verify_print — pass this print back unchanged, including priceText, signature and kid.',
|
|
960
|
+
source: SOURCE,
|
|
961
|
+
};
|
|
962
|
+
}
|
|
963
|
+
|
|
964
|
+
async function signedBatch(args: Record<string, unknown>, apiKey?: string) {
|
|
965
|
+
const raw = args.symbols;
|
|
966
|
+
const list = Array.isArray(raw)
|
|
967
|
+
? raw.map((s) => String(s).trim()).filter(Boolean)
|
|
968
|
+
: String(raw ?? '').split(',').map((s) => s.trim()).filter(Boolean);
|
|
969
|
+
if (!list.length) throw new Error('pulse_signed_batch requires symbols, e.g. {"symbols":["BTC","ETH"]}.');
|
|
970
|
+
if (list.length > MAX_BATCH) {
|
|
971
|
+
throw new Error(`pulse_signed_batch takes at most ${MAX_BATCH} symbols per call (${list.length} given); your API tier may allow fewer. Split the list rather than dropping symbols silently.`);
|
|
972
|
+
}
|
|
973
|
+
const body = (await pulseGet(`/batch?symbols=${encodeURIComponent(list.join(','))}`, apiKey, 'pulse_signed_batch')) as Record<string, unknown>;
|
|
974
|
+
const obs = Array.isArray(body.observations) ? (body.observations as Record<string, unknown>[]) : [];
|
|
975
|
+
const returned = obs.filter((o) => o?.success !== false).map(decorate);
|
|
976
|
+
const returnedSymbols = new Set(returned.map((o) => String(o.symbol)));
|
|
977
|
+
// Pulse returns FEWER rows than requested for symbols it does not serve, and
|
|
978
|
+
// the missing ones are simply absent. Reporting a short list as the answer is
|
|
979
|
+
// a silent partial: name what did not come back.
|
|
980
|
+
const missing = list.filter((s) => !returnedSymbols.has(s));
|
|
981
|
+
return {
|
|
982
|
+
requested: list.length,
|
|
983
|
+
returned: returned.length,
|
|
984
|
+
observations: returned,
|
|
985
|
+
...(missing.length
|
|
986
|
+
? {
|
|
987
|
+
not_served: missing,
|
|
988
|
+
not_served_note: `Pulse returned no print for ${missing.length} of the ${list.length} symbols requested. They are absent from the response rather than reported as errors, so they are listed here explicitly — an unlisted symbol is NOT a price of zero. Check pulse_asset_catalog for coverage.`,
|
|
989
|
+
}
|
|
990
|
+
: {}),
|
|
991
|
+
each_row_signed: 'Every observation is individually signed and can be checked on its own with pulse_verify_print.',
|
|
992
|
+
source: SOURCE,
|
|
993
|
+
};
|
|
994
|
+
}
|
|
995
|
+
|
|
996
|
+
async function settlementPrint(args: Record<string, unknown>, apiKey?: string) {
|
|
997
|
+
const symbol = String(args.symbol ?? '').trim();
|
|
998
|
+
const at = String(args.at ?? '').trim();
|
|
999
|
+
if (!symbol || !at) {
|
|
1000
|
+
throw new Error('pulse_settlement_print requires symbol and at, e.g. {"symbol":"BTC","at":"2026-09-16T21:41:46.000Z"}. `at` accepts ISO-8601 or epoch milliseconds.');
|
|
1001
|
+
}
|
|
1002
|
+
const body = (await pulseGet(
|
|
1003
|
+
`/print?symbol=${encodeURIComponent(symbol)}&at=${encodeURIComponent(at)}`,
|
|
1004
|
+
apiKey,
|
|
1005
|
+
'pulse_settlement_print',
|
|
1006
|
+
)) as Record<string, unknown>;
|
|
1007
|
+
const deltaMs = typeof body.deltaMs === 'number' ? body.deltaMs : null;
|
|
1008
|
+
return {
|
|
1009
|
+
print: decorate(body),
|
|
1010
|
+
requested_at: at,
|
|
1011
|
+
delta_ms: deltaMs,
|
|
1012
|
+
delta_note:
|
|
1013
|
+
deltaMs === null
|
|
1014
|
+
? 'Pulse did not report deltaMs for this print, so how far it sits from the time you asked for is unknown — do not assume it is exact.'
|
|
1015
|
+
: `The print returned is the recorded observation NEAREST your requested time, ${deltaMs} ms away — it is not a print AT that instant. For a settlement, state the tolerance you accept and check this number against it.`,
|
|
1016
|
+
source: SOURCE,
|
|
1017
|
+
};
|
|
1018
|
+
}
|
|
1019
|
+
|
|
1020
|
+
async function assetCatalog(args: Record<string, unknown>, apiKey?: string) {
|
|
1021
|
+
const q = new URLSearchParams();
|
|
1022
|
+
const limit = Number(args.limit ?? 50);
|
|
1023
|
+
q.set('limit', String(Number.isFinite(limit) && limit > 0 ? Math.min(limit, 500) : 50));
|
|
1024
|
+
if (args.offset !== undefined) q.set('offset', String(args.offset));
|
|
1025
|
+
if (args.band) q.set('band', String(args.band));
|
|
1026
|
+
if (args.status) q.set('status', String(args.status));
|
|
1027
|
+
const body = (await pulseGet(`/verity/catalog?${q.toString()}`, apiKey, 'pulse_asset_catalog')) as Record<string, unknown>;
|
|
1028
|
+
return {
|
|
1029
|
+
...body,
|
|
1030
|
+
signed: false,
|
|
1031
|
+
signed_note:
|
|
1032
|
+
'CATALOGUE ROWS ARE NOT SIGNED. The prices and coverage metadata here carry no signature and must not be settled against. If you need a verifiable number for one of these symbols, read it through pulse_signed_price and check it with pulse_verify_print.',
|
|
1033
|
+
source: SOURCE,
|
|
1034
|
+
};
|
|
1035
|
+
}
|
|
1036
|
+
|
|
1037
|
+
async function keyRing(_args: Record<string, unknown>) {
|
|
1038
|
+
const ring = (await pulseGet('/pubkey', undefined, 'pulse_key_ring', false)) as Record<string, unknown>;
|
|
1039
|
+
return {
|
|
1040
|
+
...ring,
|
|
1041
|
+
usage:
|
|
1042
|
+
'Select the key whose kid matches the print, rebuild `pulse-index-v1\\n{symbol}\\n{priceText}\\n{at}\\n{grade}` using priceText VERBATIM, then ECDSA P-256 / SHA-256 verify the base64 IEEE-P1363 signature. pulse_verify_print does all of this for you.',
|
|
1043
|
+
keyless: true,
|
|
1044
|
+
source: SOURCE,
|
|
1045
|
+
};
|
|
1046
|
+
}
|
|
1047
|
+
|
|
1048
|
+
// ── definitions ─────────────────────────────────────────────────────────
|
|
1049
|
+
|
|
1050
|
+
const KEY_ARG = {
|
|
1051
|
+
type: 'string',
|
|
1052
|
+
description: 'Pulse Verity API key. Free and self-serve at https://thepulse.markets/developers (60 req/min, 25,000/month, no card).',
|
|
1053
|
+
} as const;
|
|
1054
|
+
|
|
1055
|
+
const PRINT_NOTE =
|
|
1056
|
+
'Each print carries signature, kid, grade, the number of independent venues (sources), dispersion in basis points and a confidence interval. Grades: consensus (3+ venues) and blended (2) are settleable; indicative (1 venue) is NOT.';
|
|
1057
|
+
|
|
1058
|
+
const tools: McpToolExport['tools'] = [
|
|
1059
|
+
{
|
|
1060
|
+
name: 'pulse_signed_price',
|
|
1061
|
+
description:
|
|
1062
|
+
`The current CRYPTOGRAPHICALLY SIGNED index price for one crypto asset, from the Pulse Verity Index across thousands of assets and dozens of venues — this result carries a signature you can verify: pass it unchanged to pulse_verify_print to check it OFFLINE, with no network call, against Pulse's public key. ${PRINT_NOTE} Use it when a price has to be defensible — settlement, an audit trail, a dispute — not merely current. Requires a Pulse API key via _apiKey. Example: pulse_signed_price({ symbol: "BTC" }).`,
|
|
1063
|
+
inputSchema: {
|
|
1064
|
+
type: 'object' as const,
|
|
1065
|
+
properties: {
|
|
1066
|
+
symbol: { type: 'string', description: 'Asset ticker as Pulse spells it, e.g. BTC, ETH, SOL. pulse_asset_catalog lists coverage.' },
|
|
1067
|
+
_apiKey: KEY_ARG,
|
|
1068
|
+
},
|
|
1069
|
+
required: ['symbol'],
|
|
1070
|
+
},
|
|
1071
|
+
},
|
|
1072
|
+
{
|
|
1073
|
+
name: 'pulse_signed_batch',
|
|
1074
|
+
description:
|
|
1075
|
+
`Signed index prices for up to 100 crypto assets in ONE call — each row carries its own signature you can verify individually with pulse_verify_print, offline, with no network call, not just the batch as a whole. Use this instead of looping pulse_signed_price: it is one request against the rate limit and every observation still carries its own signature, grade, venue count and interval. Symbols Pulse does not serve come back named in not_served rather than silently missing. Requires a Pulse API key via _apiKey. Example: pulse_signed_batch({ symbols: ["BTC", "ETH", "SOL"] }).`,
|
|
1076
|
+
inputSchema: {
|
|
1077
|
+
type: 'object' as const,
|
|
1078
|
+
properties: {
|
|
1079
|
+
symbols: {
|
|
1080
|
+
type: 'array',
|
|
1081
|
+
items: { type: 'string' },
|
|
1082
|
+
description: 'Up to 100 tickers. A comma-separated string is also accepted.',
|
|
1083
|
+
},
|
|
1084
|
+
_apiKey: KEY_ARG,
|
|
1085
|
+
},
|
|
1086
|
+
required: ['symbols'],
|
|
1087
|
+
},
|
|
1088
|
+
},
|
|
1089
|
+
{
|
|
1090
|
+
name: 'pulse_settlement_print',
|
|
1091
|
+
description:
|
|
1092
|
+
`The signed index print Pulse RECORDED nearest a past moment — the tool for settling a contract, pricing an option at expiry, or reconstructing what an asset was worth at a specific timestamp. Returns the observation with its original signature intact — verify it offline with pulse_verify_print, no network call — plus delta_ms, the distance between the time you asked for and the print actually returned; it is the nearest recorded print, never a price synthesised at your exact instant. Accepts ISO-8601 or epoch milliseconds. Requires a Pulse API key via _apiKey. Example: pulse_settlement_print({ symbol: "BTC", at: "2026-09-16T21:41:46.000Z" }).`,
|
|
1093
|
+
inputSchema: {
|
|
1094
|
+
type: 'object' as const,
|
|
1095
|
+
properties: {
|
|
1096
|
+
symbol: { type: 'string', description: 'Asset ticker, e.g. BTC.' },
|
|
1097
|
+
at: { type: 'string', description: 'The moment to price, as ISO-8601 (2026-09-16T21:41:46.000Z) or epoch milliseconds.' },
|
|
1098
|
+
_apiKey: KEY_ARG,
|
|
1099
|
+
},
|
|
1100
|
+
required: ['symbol', 'at'],
|
|
1101
|
+
},
|
|
1102
|
+
},
|
|
1103
|
+
{
|
|
1104
|
+
name: 'pulse_verify_print',
|
|
1105
|
+
description:
|
|
1106
|
+
'Check whether a Pulse signed price print is authentic and unaltered — pass a print back exactly as a Pulse tool returned it and this recomputes the ECDSA P-256 / SHA-256 signature over the canonical string, entirely OFFLINE with no network call to Pulse. WHAT A valid:true RESULT PROVES: that Pulse asserted this exact price, for this symbol, at this timestamp, at this grade, and that nobody altered any of those fields in transit — it detects a single changed digit of price or a one-millisecond shift in the timestamp. WHAT IT DOES NOT PROVE: that the price is CORRECT or reflects the true market — this checks Pulse\'s signature, not the world, so a print can verify perfectly and still be a price Pulse itself got wrong. The verification is computed here, not asked of Pulse, so Pulse cannot vouch for a print it never signed and an offline or compromised source cannot turn an invalid print into a valid one. Needs NO API key. Example: pulse_verify_print({ symbol: "BTC", priceText: "76051.0676303142", price: 76051.0676303142, at: "2026-09-16T23:39:30.524Z", grade: "consensus", signature: "wiD005d9...", kid: "pvi-Sl40p5Gj2t_-JyKUhxyg" }).',
|
|
1107
|
+
inputSchema: {
|
|
1108
|
+
type: 'object' as const,
|
|
1109
|
+
properties: {
|
|
1110
|
+
symbol: { type: 'string', description: 'From the print, unchanged.' },
|
|
1111
|
+
price: { type: 'number', description: 'From the print. Used only if priceText is absent.' },
|
|
1112
|
+
priceText: { type: 'string', description: 'The price EXACTLY as Pulse served it. This is what was signed — prefer it always.' },
|
|
1113
|
+
at: { type: 'string', description: 'From the print, unchanged. A 1ms difference invalidates the signature.' },
|
|
1114
|
+
grade: { type: 'string', description: 'From the print: consensus, blended or indicative.' },
|
|
1115
|
+
signature: { type: 'string', description: 'Base64 signature from the print.' },
|
|
1116
|
+
kid: { type: 'string', description: 'Key id from the print; selects which public key to check against.' },
|
|
1117
|
+
sig: { type: 'string', description: 'Scheme tag from the print (pulse-index-v1).' },
|
|
1118
|
+
},
|
|
1119
|
+
required: ['symbol', 'at', 'grade', 'signature'],
|
|
1120
|
+
},
|
|
1121
|
+
},
|
|
1122
|
+
{
|
|
1123
|
+
name: 'pulse_asset_catalog',
|
|
1124
|
+
description:
|
|
1125
|
+
'Which crypto assets the Pulse Verity Index covers, at what grade, across how many venues, and how fast each one actually updates — cadence measured per asset from its own update intervals rather than from a poll schedule. Filter by coverage band (real-time, five-second, ten-second, slow, unavailable) or status (consensus, blended, indicative). Call this to find out whether a symbol is covered, and how thin it is, before quoting it. NOTE: these rows are UNSIGNED, including their prices — read a verifiable number through pulse_signed_price. Requires a Pulse API key via _apiKey. Example: pulse_asset_catalog({ limit: 5 }).',
|
|
1126
|
+
inputSchema: {
|
|
1127
|
+
type: 'object' as const,
|
|
1128
|
+
properties: {
|
|
1129
|
+
limit: { type: 'number', description: 'Rows to return, max 500 (default 50).' },
|
|
1130
|
+
offset: { type: 'number', description: 'Row offset for paging.' },
|
|
1131
|
+
band: { type: 'string', description: 'Cadence band: real-time, five-second, ten-second, slow, unavailable.' },
|
|
1132
|
+
status: { type: 'string', description: 'Coverage grade: consensus, blended, indicative.' },
|
|
1133
|
+
_apiKey: KEY_ARG,
|
|
1134
|
+
},
|
|
1135
|
+
required: [],
|
|
1136
|
+
},
|
|
1137
|
+
},
|
|
1138
|
+
{
|
|
1139
|
+
name: 'pulse_key_ring',
|
|
1140
|
+
description:
|
|
1141
|
+
"The public keys Pulse signs its price prints with, as PEM and JWK, plus the signing algorithm and the exact canonical string format — everything needed to verify a signed print yourself, OFFLINE, with no network call to Pulse. Use it to write your own verifier, or to audit what pulse_verify_print (this pack's ready-made offline checker) is checking against. Needs NO API key. Example: pulse_key_ring({}).",
|
|
1142
|
+
inputSchema: { type: 'object' as const, properties: {}, required: [] },
|
|
1143
|
+
},
|
|
1144
|
+
];
|
|
1145
|
+
|
|
1146
|
+
async function callTool(name: string, args: Record<string, unknown> = {}) {
|
|
1147
|
+
const apiKey = (args._apiKey as string | undefined) || undefined;
|
|
1148
|
+
delete args._apiKey;
|
|
1149
|
+
switch (name) {
|
|
1150
|
+
case 'pulse_signed_price': return signedPrice(args, apiKey);
|
|
1151
|
+
case 'pulse_signed_batch': return signedBatch(args, apiKey);
|
|
1152
|
+
case 'pulse_settlement_print': return settlementPrint(args, apiKey);
|
|
1153
|
+
case 'pulse_verify_print': return verifyPrint(args);
|
|
1154
|
+
case 'pulse_asset_catalog': return assetCatalog(args, apiKey);
|
|
1155
|
+
case 'pulse_key_ring': return keyRing(args);
|
|
1156
|
+
default: throw new Error(`Unknown tool: ${name}`);
|
|
1157
|
+
}
|
|
1158
|
+
}
|
|
1159
|
+
|
|
1160
|
+
export { tools, callTool, ringMeta };
|
|
1161
|
+
export default { tools, callTool } satisfies McpToolExport;
|