@pipeworx/mcp-census 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +1 -1
- package/README.md +121 -9
- package/bin/cli.js +17 -0
- package/package.json +15 -3
- package/server.json +2 -2
- package/src/index.ts +1090 -54
- package/src/server.ts +45 -0
- package/tsconfig.json +5 -1
package/src/index.ts
CHANGED
|
@@ -1,22 +1,645 @@
|
|
|
1
1
|
interface McpToolDefinition {
|
|
2
2
|
name: string;
|
|
3
3
|
description: string;
|
|
4
|
+
/** Human-facing one-liner (fleet #1967). Optional; consumers fall back to
|
|
5
|
+
* description. Kept in step with shared/src/types.ts — scripts/lib/
|
|
6
|
+
* check-inlined-types.mjs reports drift at publish time. */
|
|
7
|
+
summary?: string;
|
|
4
8
|
inputSchema: {
|
|
5
9
|
type: 'object';
|
|
6
10
|
properties: Record<string, unknown>;
|
|
7
11
|
required?: string[];
|
|
12
|
+
anyOf?: Array<{ required: string[] }>;
|
|
13
|
+
oneOf?: Array<{ required: string[] }>;
|
|
14
|
+
allOf?: Array<{ required: string[] }>;
|
|
8
15
|
};
|
|
16
|
+
outputSchema?: Record<string, unknown>;
|
|
9
17
|
}
|
|
10
18
|
|
|
11
19
|
interface McpToolExport {
|
|
12
20
|
tools: McpToolDefinition[];
|
|
13
21
|
callTool: (name: string, args: Record<string, unknown>) => Promise<unknown>;
|
|
22
|
+
meter?: { credits: number };
|
|
23
|
+
cost?: Record<string, unknown>;
|
|
24
|
+
provider?: string;
|
|
14
25
|
}
|
|
15
26
|
|
|
27
|
+
/**
|
|
28
|
+
* Was this failure OUR OWN web service? — the other half of `internal-db-class.ts`.
|
|
29
|
+
*
|
|
30
|
+
* fleet #1089 pulled failures from our own Postgres out of `upstream_down` by
|
|
31
|
+
* keying on the SQLSTATE inside PostgREST's four-key error envelope. That
|
|
32
|
+
* covered the majority and structurally could not cover the rest: the rest
|
|
33
|
+
* never reach Postgres, so they carry no SQLSTATE. What was left, measured over
|
|
34
|
+
* the 24h to 2026-09-02T15:00Z (fleet #1096):
|
|
35
|
+
*
|
|
36
|
+
* 5 pipeworx-catalog get_pack_tools Pipeworx catalog error: 522 — error code: 522
|
|
37
|
+
* 3 fleet fleet_list_open … upstream_down: Fleet task queue did not respond within 25s
|
|
38
|
+
*
|
|
39
|
+
* 521/522/523/526 are Cloudflare saying its edge could not reach an ORIGIN, and
|
|
40
|
+
* in both of those rows the origin is ours — `gateway.pipeworx.io` for the
|
|
41
|
+
* catalog pack (it self-fetches when the gateway hasn't injected a manifest),
|
|
42
|
+
* our own Supabase for fleet. There is no third party anywhere in either call.
|
|
43
|
+
* Same defect as #1089: our own outage filed under `upstream_down`, the one
|
|
44
|
+
* class that means "the source is unreachable and there is nothing for us to
|
|
45
|
+
* fix", which is why the problem-tools triage skips it.
|
|
46
|
+
*
|
|
47
|
+
* WHY NOT A WORDING RULE. The obvious fix is to match `fleet db error:` and
|
|
48
|
+
* `Pipeworx catalog error:` in classifyToolError. Each is emitted from exactly
|
|
49
|
+
* one site today, so it would work today. It would also rot the first time
|
|
50
|
+
* somebody rewords a label — silently, and in the direction of hiding our own
|
|
51
|
+
* outage, which is worse than the bug being fixed. Every prose rule in
|
|
52
|
+
* error-class.ts has needed widening as packs invented new wording (#409/#450/
|
|
53
|
+
* #584); that history is most of that file's comment budget.
|
|
54
|
+
*
|
|
55
|
+
* WHAT THIS KEYS ON INSTEAD: **the host the call actually reached.** A URL's
|
|
56
|
+
* hostname is a fact about the call, not a guess about its prose. Two
|
|
57
|
+
* consequences that a pack-level flag could not give us, and the reason the
|
|
58
|
+
* flag was rejected:
|
|
59
|
+
*
|
|
60
|
+
* - It describes the CALL, not the pack. `govcon-intel` fans out to our own
|
|
61
|
+
* Supabase AND to genuine third parties; `court-listener` holds our cache
|
|
62
|
+
* in Supabase and fetches courtlistener.com. An `internallyHosted: true` on
|
|
63
|
+
* either pack would relabel a real third-party outage as ours — inventing
|
|
64
|
+
* work, which is the same class of error in the opposite direction.
|
|
65
|
+
* - It covers every future internal pack for free, instead of one declared
|
|
66
|
+
* slug at a time.
|
|
67
|
+
*
|
|
68
|
+
* WHY IT SURVIVES A REWORD. The marker below is not matched as a literal by two
|
|
69
|
+
* separate files. `markInternalOrigin()` writes it and `internalHostMetricsClass()`
|
|
70
|
+
* reads it, both from the single exported `INTERNAL_ORIGIN_MARKER` constant in
|
|
71
|
+
* this module — so changing the wording changes both sides in the same edit and
|
|
72
|
+
* cannot desynchronise them. The pack's own label (`fleet db error:`,
|
|
73
|
+
* `Pipeworx catalog error:`) is not read at all: reword it freely, the class is
|
|
74
|
+
* unaffected. That is the property `stripClassPrefix` lacked when it drifted
|
|
75
|
+
* from its own classifier three times and needed a CI gate to hold them
|
|
76
|
+
* together.
|
|
77
|
+
*
|
|
78
|
+
* WHERE THE 5xx TEST LIVES. `markInternalOrigin` is called from the places that
|
|
79
|
+
* hold the real `Response` — `httpError`/`httpErrorMessage` and the timeout
|
|
80
|
+
* branch of `fetchWithTimeout` in `shared/src/http.ts` — so "is this an
|
|
81
|
+
* availability failure" is decided from the actual status code, never re-derived
|
|
82
|
+
* by scraping a number out of a sentence. A 404 from our own registry for a slug
|
|
83
|
+
* that does not exist is a caller's bad argument and is deliberately NOT marked.
|
|
84
|
+
*/
|
|
85
|
+
|
|
86
|
+
/**
|
|
87
|
+
* OUR OWN web service was unreachable — not an upstream, and never `upstream_down`.
|
|
88
|
+
*
|
|
89
|
+
* ONE value, not three, unlike `internal_db_*`. That split existed because a
|
|
90
|
+
* slow query, an exhausted pool and an unknown SQLSTATE have different owners
|
|
91
|
+
* and different fixes. Here there is only one story to tell — an origin we run
|
|
92
|
+
* did not answer the edge — and one owner. A bucket with no distinct owner per
|
|
93
|
+
* value is decoration; #724 is what happens when a class holds several
|
|
94
|
+
* situations, and inventing sub-values ahead of a reason to act on them
|
|
95
|
+
* differently is the same mistake with the sign flipped.
|
|
96
|
+
*
|
|
97
|
+
* METRICS ONLY, exactly like PLATFORM_KEY_ERROR_CLASS and the internal_db
|
|
98
|
+
* values. `classifyToolError` still answers `upstream_down` for the retry and
|
|
99
|
+
* hint paths, which only care whether retrying or a sibling tool might work —
|
|
100
|
+
* and it might. Nothing a caller sees or is charged changes here.
|
|
101
|
+
*
|
|
102
|
+
* READ SIDE: this value is in BROKEN_TOOL_CLASSES, FAULT_CLASSES and
|
|
103
|
+
* ALL_ERROR_CLASSES in `workers/registry-api/src/index.ts`. All three, or it
|
|
104
|
+
* lands on no dashboard — fleet #721 is the warning, where the #719 split
|
|
105
|
+
* worked on the write side and was invisible for weeks.
|
|
106
|
+
*/
|
|
107
|
+
const INTERNAL_SERVICE_UNREACHABLE_CLASS = 'internal_service_unreachable';
|
|
108
|
+
|
|
109
|
+
/**
|
|
110
|
+
* The token that carries "this origin is ours" from the call site to the
|
|
111
|
+
* classifier.
|
|
112
|
+
*
|
|
113
|
+
* Appended to the error message rather than attached to the Error object,
|
|
114
|
+
* because the object does not survive the trip: 275 packs return `{ error:
|
|
115
|
+
* string }` instead of throwing, the gateway reads `observedError` as a string,
|
|
116
|
+
* and the fleet pack rebuilds its error from a captured status + body across a
|
|
117
|
+
* retry loop. A property on an Error would be dropped by every one of those
|
|
118
|
+
* paths and the class would work in tests and vanish in production.
|
|
119
|
+
*
|
|
120
|
+
* WORDING IS LOAD-BEARING, same rule as labelAge's note in authority.ts. This
|
|
121
|
+
* string is appended to a pack's thrown Error message (shared/src/http.ts),
|
|
122
|
+
* and a thrown Error's message is exactly what the gateway hands back to the
|
|
123
|
+
* caller as `content[0].text` when nothing rewrites it (workers/gateway/src
|
|
124
|
+
* catches the throw and sets `rawResult.message = stripClassPrefix(error)`,
|
|
125
|
+
* which does not touch this suffix) — so the original wording,
|
|
126
|
+
* " [pipeworx-hosted origin — our own service, not a third party]", was not a
|
|
127
|
+
* theoretical leak: it shipped live on pipeworx-catalog's 522s, 7 times in 6
|
|
128
|
+
* hours on 2026-09-02 (see tests/golden-internal-service.test.ts), verbatim
|
|
129
|
+
* naming Pipeworx as the host. check:hosting-claims never caught it because it
|
|
130
|
+
* did not scan shared/ at all (task #2009). Reworded to describe the
|
|
131
|
+
* OBSERVATION (the origin did not answer) without a claim about who runs it —
|
|
132
|
+
* the identical fix labelAge got: drop the possessive, keep the fact.
|
|
133
|
+
*/
|
|
134
|
+
const INTERNAL_ORIGIN_MARKER = ' [origin did not respond — retry before concluding the named source is down]';
|
|
135
|
+
|
|
136
|
+
/**
|
|
137
|
+
* Supabase's data plane for a project is `<ref>.supabase.co`, where the ref is
|
|
138
|
+
* exactly twenty lowercase letters (ours is `pqauisounztsgdgfkhke`).
|
|
139
|
+
*
|
|
140
|
+
* Matching the shape rather than listing the ref keeps this correct when we add
|
|
141
|
+
* a project — `supabaseEnv` on a pack entry already points some packs at a
|
|
142
|
+
* second one — while still excluding `status.supabase.co`, which is Supabase's
|
|
143
|
+
* own status page and emphatically not our database. Verified 2026-09-02 by
|
|
144
|
+
* `grep -rhoE '[a-z0-9-]+\.supabase\.(co|in)' mcps shared workers scripts`: the
|
|
145
|
+
* only real project ref anywhere in the tree is ours, the rest are doc
|
|
146
|
+
* placeholders (`abc`, `xyz`, `example`) which this pattern also excludes. Same
|
|
147
|
+
* finding internal-db-class.ts relies on for the PostgREST envelope being ours
|
|
148
|
+
* by construction.
|
|
149
|
+
*/
|
|
150
|
+
const SUPABASE_PROJECT_HOST = /^[a-z]{20}\.supabase\.(co|in)$/;
|
|
151
|
+
|
|
152
|
+
/**
|
|
153
|
+
* Is this a host WE run?
|
|
154
|
+
*
|
|
155
|
+
* Deliberately NOT including `*.workers.dev`: plenty of third-party APIs are
|
|
156
|
+
* hosted on workers.dev, so the suffix says where something runs and not who
|
|
157
|
+
* owns it. Every internal call we actually make goes to a `pipeworx.io`
|
|
158
|
+
* hostname or to our Supabase project, both of which are ownership facts.
|
|
159
|
+
*
|
|
160
|
+
* `workers/gateway/src/provenance.ts`'s `OUR_HOSTS` answers the same
|
|
161
|
+
* question and DOES include `workers.dev` — a documented divergence
|
|
162
|
+
* (task #2051), not a bug to converge. That list decides what a response may
|
|
163
|
+
* cite as a data SOURCE, where a false negative (citing our own worker as an
|
|
164
|
+
* external source) is the hosting-disclosure leak this whole file exists to
|
|
165
|
+
* prevent, so it errs broad. This one decides who gets BLAMED for a 5xx in
|
|
166
|
+
* outage metrics read by on-call, where a false positive (crediting our own
|
|
167
|
+
* infra with a third party's outage) hides the real failure, so it errs
|
|
168
|
+
* narrow. Same suffix, opposite direction, because they are never called for
|
|
169
|
+
* the same reason.
|
|
170
|
+
*
|
|
171
|
+
* Returns false on anything unparseable rather than throwing — this runs inside
|
|
172
|
+
* an error path, and an error path that can itself throw turns a diagnosable
|
|
173
|
+
* failure into a mystery.
|
|
174
|
+
*/
|
|
175
|
+
function isPipeworxOrigin(url: string | URL | undefined | null): boolean {
|
|
176
|
+
if (!url) return false;
|
|
177
|
+
let host: string;
|
|
178
|
+
try {
|
|
179
|
+
host = new URL(url instanceof URL ? url.href : url).hostname.toLowerCase();
|
|
180
|
+
} catch {
|
|
181
|
+
return false;
|
|
182
|
+
}
|
|
183
|
+
if (host === 'pipeworx.io' || host.endsWith('.pipeworx.io')) return true;
|
|
184
|
+
return SUPABASE_PROJECT_HOST.test(host);
|
|
185
|
+
}
|
|
186
|
+
|
|
187
|
+
/**
|
|
188
|
+
* Append the marker when this failure was OUR origin failing to answer.
|
|
189
|
+
*
|
|
190
|
+
* `status` is the HTTP status when there is one, and omitted for a timeout —
|
|
191
|
+
* where there is no response at all, and "the origin did not answer" is the
|
|
192
|
+
* whole observation. Statuses below 500 are left alone: a 404 from our own
|
|
193
|
+
* registry for a slug that does not exist is the caller's argument, not our
|
|
194
|
+
* outage, and marking it would put ordinary 404s on the incident dashboard.
|
|
195
|
+
*
|
|
196
|
+
* Idempotent, so a message that is wrapped and re-marked on the way up (the
|
|
197
|
+
* fleet pack's retry loop re-throws through two layers) carries the marker once.
|
|
198
|
+
*/
|
|
199
|
+
function markInternalOrigin(
|
|
200
|
+
message: string,
|
|
201
|
+
url: string | URL | undefined | null,
|
|
202
|
+
status?: number,
|
|
203
|
+
): string {
|
|
204
|
+
if (status !== undefined && status < 500) return message;
|
|
205
|
+
if (!isPipeworxOrigin(url)) return message;
|
|
206
|
+
if (message.includes(INTERNAL_ORIGIN_MARKER)) return message;
|
|
207
|
+
return message + INTERNAL_ORIGIN_MARKER;
|
|
208
|
+
}
|
|
209
|
+
|
|
210
|
+
/**
|
|
211
|
+
* Which blob4 value a failure from our own web services books as, or undefined
|
|
212
|
+
* if this is not one.
|
|
213
|
+
*
|
|
214
|
+
* Ordered AFTER `internalDbMetricsClass` at the call site: a PostgREST envelope
|
|
215
|
+
* from our own Supabase is a strictly more specific statement about the same
|
|
216
|
+
* row (which of our services, and why), and the two cannot disagree about
|
|
217
|
+
* whether the failure is ours.
|
|
218
|
+
*/
|
|
219
|
+
function internalHostMetricsClass(error: string): string | undefined {
|
|
220
|
+
return error.includes(INTERNAL_ORIGIN_MARKER) ? INTERNAL_SERVICE_UNREACHABLE_CLASS : undefined;
|
|
221
|
+
}
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
/**
|
|
225
|
+
* One place to turn a failed `fetch` into an error a caller can act on.
|
|
226
|
+
*
|
|
227
|
+
* Nearly every pack was written the same way:
|
|
228
|
+
*
|
|
229
|
+
* if (!res.ok) throw new Error(`Unsplash: ${res.status}`);
|
|
230
|
+
*
|
|
231
|
+
* which discards the response body — and the body is usually where the upstream
|
|
232
|
+
* says what was actually wrong ("**symbol** not found: GBP", "parameter `year`
|
|
233
|
+
* out of range", "unknown taxonomy id"). The caller gets a number, cannot
|
|
234
|
+
* self-correct, and retries the same broken call. A 2026-07-31 sweep found this
|
|
235
|
+
* shape in 481 of 1,400 packs, 47 of them PLATFORM-keyed.
|
|
236
|
+
*
|
|
237
|
+
* It also hides bugs one level down. Two of the first three packs audited had a
|
|
238
|
+
* second defect that only existed because of this line: unsplash's rate-limit
|
|
239
|
+
* branch sat BELOW a catch-all and was unreachable, and bea-gov parsed
|
|
240
|
+
* `BEAAPI.Error.APIErrorDescription` below a `!res.ok` throw that made the
|
|
241
|
+
* parsing dead code for every non-200.
|
|
242
|
+
*
|
|
243
|
+
* DELIBERATELY NOT A CLASSIFIER. It does not add `user_error:` /
|
|
244
|
+
* `upstream_down:` prefixes. Those decide which tier a failure lands in, and the
|
|
245
|
+
* `error` tier is what the daily problem-tools list is built from — it means
|
|
246
|
+
* "Pipeworx has a defect". A 400 is genuinely ambiguous: often a caller's bad
|
|
247
|
+
* argument, but sometimes a query WE built wrong (ted-eu comma-joined its CPV
|
|
248
|
+
* values into something TED rejected, and that bug was found only because it sat
|
|
249
|
+
* in `error`). Blanket-classifying 400s as caller mistakes would have hidden it.
|
|
250
|
+
* A pack that KNOWS which it is should keep saying so explicitly; this helper is
|
|
251
|
+
* for the 481 that say nothing at all.
|
|
252
|
+
*/
|
|
253
|
+
|
|
254
|
+
/** Longest upstream explanation we'll pass through. Enough for a real message,
|
|
255
|
+
* short enough that an HTML page or a stack trace can't swamp the error. */
|
|
256
|
+
|
|
257
|
+
const MAX_DETAIL = 300;
|
|
258
|
+
|
|
259
|
+
/**
|
|
260
|
+
* Default bound for `fetchWithTimeout` when a pack doesn't state its own.
|
|
261
|
+
*
|
|
262
|
+
* 25s mirrors the number `epo-ops` landed on after measuring the real failure:
|
|
263
|
+
* a degraded upstream that doesn't error, it just never answers, and a Worker
|
|
264
|
+
* sits in `await fetch()` until ITS OWN execution budget kills the request —
|
|
265
|
+
* which can take minutes, not seconds (epo_ops_search_patents measured 4-8
|
|
266
|
+
* MINUTE hangs before this existed). 25s is short enough that a caller gets a
|
|
267
|
+
* fast, actionable error instead of holding the connection, and long enough
|
|
268
|
+
* that it doesn't false-trip on a merely-slow-but-alive upstream.
|
|
269
|
+
*/
|
|
270
|
+
const DEFAULT_FETCH_TIMEOUT_MS = 25_000;
|
|
271
|
+
|
|
272
|
+
/**
|
|
273
|
+
* Read the body of a failed response and fold it into a throwable Error.
|
|
274
|
+
*
|
|
275
|
+
* Usage — note the `await`, which is the one thing that makes this a mechanical
|
|
276
|
+
* change rather than a drop-in:
|
|
277
|
+
*
|
|
278
|
+
* if (!res.ok) throw await httpError(res, 'Unsplash');
|
|
279
|
+
*
|
|
280
|
+
* Safe to call on any non-ok response: a body that is missing, empty, unreadable
|
|
281
|
+
* or HTML degrades to exactly the old `Name: 404` string rather than throwing
|
|
282
|
+
* something new from inside the error path.
|
|
283
|
+
*/
|
|
284
|
+
async function httpError(res: Response, name: string): Promise<Error> {
|
|
285
|
+
return new Error(await httpErrorMessage(res, name));
|
|
286
|
+
}
|
|
287
|
+
|
|
288
|
+
/** The message text without constructing an Error — for packs that need to wrap
|
|
289
|
+
* it in their own envelope or add an explicit classification prefix. */
|
|
290
|
+
async function httpErrorMessage(res: Response, name: string): Promise<string> {
|
|
291
|
+
// The one place a 5xx from a host WE run gets stamped as ours. `res.url` is
|
|
292
|
+
// the URL the fetch actually resolved to (after redirects), so this is a fact
|
|
293
|
+
// about the call rather than a guess from the `name` the pack passed in —
|
|
294
|
+
// reword that label freely, the class does not move. See
|
|
295
|
+
// internal-host-class.ts; no-op for every third-party upstream, which is why
|
|
296
|
+
// this touches 481 packs' error text and changes none of it.
|
|
297
|
+
return markInternalOrigin(
|
|
298
|
+
`${name}: ${res.status}${detailSuffix(await readDetail(res))}`,
|
|
299
|
+
res.url,
|
|
300
|
+
res.status,
|
|
301
|
+
);
|
|
302
|
+
}
|
|
303
|
+
|
|
304
|
+
/**
|
|
305
|
+
* Just the upstream's own explanation — no name, no status.
|
|
306
|
+
*
|
|
307
|
+
* For a pack that has already said both in its own sentence. epo-ops reads
|
|
308
|
+
* `EPO rejected this search as too large (HTTP 413) — ${httpErrorMessage(…)}`,
|
|
309
|
+
* which rendered as `… (HTTP 413) — EPO: 413.` once the XML detail was being
|
|
310
|
+
* dropped: the upstream named twice, the status twice, and the one thing EPO
|
|
311
|
+
* actually said ("Not enough characters before truncation character") nowhere
|
|
312
|
+
* (fleet #712). Returns '' when the body carries nothing readable, so a caller
|
|
313
|
+
* can fall back to its own wording.
|
|
314
|
+
*/
|
|
315
|
+
async function upstreamDetail(res: Response): Promise<string> {
|
|
316
|
+
return readDetail(res);
|
|
317
|
+
}
|
|
318
|
+
|
|
319
|
+
/**
|
|
320
|
+
* Read a SUCCESSFUL response as JSON, failing loudly when it isn't JSON.
|
|
321
|
+
*
|
|
322
|
+
* `httpError` above only ever runs on `!res.ok`, which leaves the nastier half
|
|
323
|
+
* of the problem unhandled: an upstream that answers **HTTP 200 with an HTML
|
|
324
|
+
* page**. A bot wall, a login redirect, a maintenance interstitial and a CDN
|
|
325
|
+
* error page are all 200s, so `res.ok` is true, and `res.json()` then throws
|
|
326
|
+
* `Unexpected token '<', "<!DOCTYPE "... is not valid JSON`.
|
|
327
|
+
*
|
|
328
|
+
* That string is the problem. It names no upstream, carries no status, and
|
|
329
|
+
* reads like a parser bug in Pipeworx — so it lands in the `error` tier, which
|
|
330
|
+
* means "we have a defect", and the caller is told nothing they can act on.
|
|
331
|
+
* data.govt.nz sat dead behind an Imperva challenge this way and every
|
|
332
|
+
* status-code health check we own reported it green (7889a845). A zero-length
|
|
333
|
+
* body has the same shape: `Unexpected end of JSON input`, seen this week on
|
|
334
|
+
* uk-gazette (83% of external calls) and census.
|
|
335
|
+
*
|
|
336
|
+
* UNLIKE `httpError`, this one DOES classify, and the asymmetry is deliberate.
|
|
337
|
+
* A 400 is genuinely ambiguous — often the caller's bad argument, sometimes a
|
|
338
|
+
* query we built wrong — so blanket-classifying it would hide our own bugs.
|
|
339
|
+
* There is no such ambiguity here: **no argument a caller can pass makes a JSON
|
|
340
|
+
* API return an HTML page.** It is always the upstream, so `upstream_down:` is
|
|
341
|
+
* a statement of fact rather than a guess, and it keeps these out of the
|
|
342
|
+
* problem-tools list where they crowd out real defects.
|
|
343
|
+
*
|
|
344
|
+
* const data = await parseJson<Feed>(res, 'UK Gazette');
|
|
345
|
+
*
|
|
346
|
+
* Call it only after the `!res.ok` check — on a failed response you want
|
|
347
|
+
* `httpError`, which mines the body for the upstream's own explanation.
|
|
348
|
+
*/
|
|
349
|
+
async function parseJson<T>(res: Response, name: string): Promise<T> {
|
|
350
|
+
let raw: string;
|
|
351
|
+
try {
|
|
352
|
+
raw = await res.text();
|
|
353
|
+
} catch {
|
|
354
|
+
throw new Error(
|
|
355
|
+
`upstream_down: ${name} returned a body that could not be read (HTTP ${res.status}). ` +
|
|
356
|
+
'The connection most likely dropped mid-response; retrying is reasonable.',
|
|
357
|
+
);
|
|
358
|
+
}
|
|
359
|
+
|
|
360
|
+
const type = res.headers.get('content-type') ?? 'no content-type';
|
|
361
|
+
|
|
362
|
+
if (!raw.trim()) {
|
|
363
|
+
throw new Error(
|
|
364
|
+
`upstream_down: ${name} answered HTTP ${res.status} with an EMPTY body where JSON was expected (${type}). ` +
|
|
365
|
+
'Nothing about the request can cause this — it is an upstream fault, and the same call may well work on retry.',
|
|
366
|
+
);
|
|
367
|
+
}
|
|
368
|
+
|
|
369
|
+
// Checked before parsing rather than in the catch, because knowing it is
|
|
370
|
+
// markup is what turns "we failed to parse something" into "they served a
|
|
371
|
+
// web page" — the second is diagnosable, the first is not.
|
|
372
|
+
const head = raw.slice(0, 200).trimStart().toLowerCase();
|
|
373
|
+
if (head.startsWith('<!doctype') || head.startsWith('<html') || head.startsWith('<?xml')) {
|
|
374
|
+
const kind = head.startsWith('<?xml') ? 'an XML document' : 'an HTML page';
|
|
375
|
+
// The summary, not the source. Pasting the first 120 characters of a web
|
|
376
|
+
// page handed the agent `<!DOCTYPE html><html lang="en"…` — the same leak
|
|
377
|
+
// this branch exists to describe (fleet #712).
|
|
378
|
+
throw new Error(
|
|
379
|
+
`upstream_down: ${name} answered HTTP ${res.status} with ${kind} instead of JSON (${type}). ` +
|
|
380
|
+
'That is typically a bot wall, a login redirect or a maintenance page — it is returned as a SUCCESS, ' +
|
|
381
|
+
`so status-code health checks read it as fine. No argument change will get past it. ` +
|
|
382
|
+
`The page says: ${summarizeErrorBody(raw) || 'nothing readable'}`,
|
|
383
|
+
);
|
|
384
|
+
}
|
|
385
|
+
|
|
386
|
+
try {
|
|
387
|
+
return JSON.parse(raw) as T;
|
|
388
|
+
} catch {
|
|
389
|
+
throw new Error(
|
|
390
|
+
`upstream_down: ${name} answered HTTP ${res.status} with a body that is not valid JSON (${type}). ` +
|
|
391
|
+
`It begins: ${stripMarkup(raw).slice(0, 120) || '(unreadable)'}`,
|
|
392
|
+
);
|
|
393
|
+
}
|
|
394
|
+
}
|
|
395
|
+
|
|
396
|
+
/**
|
|
397
|
+
* `fetch`, but bounded — the fix for a systemic gap found 2026-08-30: a grep
|
|
398
|
+
* audit of every pack's `mcps/*\/src/index.ts` found 1,339 of ~1,500 call
|
|
399
|
+
* `fetch()` with NO timeout guard anywhere in the file. Two of those
|
|
400
|
+
* (epo-ops, statcan) were confirmed live-hanging for 4-8 minutes before this
|
|
401
|
+
* existed — every unguarded call carries the same risk, just unconfirmed.
|
|
402
|
+
*
|
|
403
|
+
* Mirrors the `epoFetch` wrapper `mcps/epo-ops/src/index.ts` shipped first:
|
|
404
|
+
* bound the request with `AbortSignal.timeout`, and on a timeout/abort throw
|
|
405
|
+
* an `upstream_down:` error that names the upstream and the bound rather than
|
|
406
|
+
* letting the raw `TimeoutError`/`AbortError` (which names neither) propagate.
|
|
407
|
+
* `upstream_down:` is deliberate, same reasoning as `parseJson` above — no
|
|
408
|
+
* argument a caller passes can make an upstream hang, so it is always the
|
|
409
|
+
* upstream's fault, and marking it that way keeps a slow API off the
|
|
410
|
+
* problem-tools list where it would crowd out our own defects.
|
|
411
|
+
*
|
|
412
|
+
* Usage — a mechanical swap for a bare `fetch(url, init)`:
|
|
413
|
+
*
|
|
414
|
+
* const res = await fetchWithTimeout(url, init, 'Some API');
|
|
415
|
+
*
|
|
416
|
+
* Pass `timeoutMs` as a fourth argument to override the default for a pack
|
|
417
|
+
* with a known-slower upstream; the label should be the same short name you'd
|
|
418
|
+
* pass to `httpError`/`httpErrorMessage` for that call.
|
|
419
|
+
*/
|
|
420
|
+
async function fetchWithTimeout(
|
|
421
|
+
url: string | URL,
|
|
422
|
+
init: RequestInit = {},
|
|
423
|
+
name: string,
|
|
424
|
+
timeoutMs: number = DEFAULT_FETCH_TIMEOUT_MS,
|
|
425
|
+
): Promise<Response> {
|
|
426
|
+
try {
|
|
427
|
+
return await fetch(url, { ...init, signal: AbortSignal.timeout(timeoutMs) });
|
|
428
|
+
} catch (err) {
|
|
429
|
+
if (err instanceof Error && (err.name === 'TimeoutError' || err.name === 'AbortError')) {
|
|
430
|
+
// States the OBSERVATION (no response in N seconds), not a diagnosis.
|
|
431
|
+
// "appears to be degraded" is an inference about the vendor that we have
|
|
432
|
+
// not checked, and it is wrong in a way that misdirects whoever reads it:
|
|
433
|
+
// a timeout from a Worker can equally mean OUR egress is blocked.
|
|
434
|
+
//
|
|
435
|
+
// Measured today (2026-09-01, fleet #1047): every call to
|
|
436
|
+
// mainnet.base.org failed from the x402 facilitator while the identical
|
|
437
|
+
// request from a laptop returned 200. Base was entirely healthy; the
|
|
438
|
+
// public RPC refuses Cloudflare Worker egress. Had this message fired
|
|
439
|
+
// there it would have blamed Base by name, and the next person would have
|
|
440
|
+
// waited for a vendor outage to clear that did not exist.
|
|
441
|
+
// A timeout has no status to test — there is no response at all — so
|
|
442
|
+
// `markInternalOrigin` is called without one: an origin we run that never
|
|
443
|
+
// answered is an availability failure by definition. This is the half of
|
|
444
|
+
// fleet #1096 with neither a SQLSTATE nor a status code to key on.
|
|
445
|
+
throw new Error(
|
|
446
|
+
markInternalOrigin(
|
|
447
|
+
`upstream_down: ${name} did not respond within ${timeoutMs / 1000}s. ` +
|
|
448
|
+
`That can be ${name} being slow or down, or this environment being unable to reach it ` +
|
|
449
|
+
`(some hosts refuse datacenter/Worker egress) — retry shortly, and check reachability ` +
|
|
450
|
+
`from elsewhere before concluding ${name} is down.`,
|
|
451
|
+
url,
|
|
452
|
+
),
|
|
453
|
+
);
|
|
454
|
+
}
|
|
455
|
+
throw err;
|
|
456
|
+
}
|
|
457
|
+
}
|
|
458
|
+
|
|
459
|
+
function detailSuffix(detail: string): string {
|
|
460
|
+
return detail ? ` — ${detail}` : '';
|
|
461
|
+
}
|
|
462
|
+
|
|
463
|
+
async function readDetail(res: Response): Promise<string> {
|
|
464
|
+
let raw: string;
|
|
465
|
+
try {
|
|
466
|
+
raw = await res.text();
|
|
467
|
+
} catch {
|
|
468
|
+
// Body already consumed, or the connection died mid-read. The status alone
|
|
469
|
+
// is still worth throwing — never let the error path throw its own error.
|
|
470
|
+
return '';
|
|
471
|
+
}
|
|
472
|
+
return summarizeErrorBody(raw);
|
|
473
|
+
}
|
|
474
|
+
|
|
475
|
+
/**
|
|
476
|
+
* Turn ANY error body — JSON, HTML, XML or plain text — into one short phrase
|
|
477
|
+
* that never contains markup.
|
|
478
|
+
*
|
|
479
|
+
* This used to just drop an HTML or XML body on the floor, on the reasoning
|
|
480
|
+
* that markup crowds out the status. That was half right. Dropping it loses the
|
|
481
|
+
* one sentence a caller could have acted on: an `Access Denied` title, an SDMX
|
|
482
|
+
* `<message:Error>` text, an OPS fault string. A 2026-08-30 support sweep
|
|
483
|
+
* measured 13 of 291 caller-facing error rows carrying a raw page or document
|
|
484
|
+
* verbatim, across 11 packs, and in every one of them the useful content —
|
|
485
|
+
* "Access Denied", "Invalid country code", "SCRAPE_TIMEOUT" — was in there,
|
|
486
|
+
* buried in markup the agent had to parse out of a string (fleet #712).
|
|
487
|
+
*
|
|
488
|
+
* So: extract the meaning, discard the markup. The output is passed through
|
|
489
|
+
* `stripMarkup` unconditionally, which is what lets `check:error-body-leak`
|
|
490
|
+
* assert mechanically that no caller-facing message can contain `<?xml`,
|
|
491
|
+
* `<!DOCTYPE` or `<html`.
|
|
492
|
+
*/
|
|
493
|
+
function summarizeErrorBody(raw: string): string {
|
|
494
|
+
if (!raw || !raw.trim()) return '';
|
|
495
|
+
|
|
496
|
+
const head = raw.slice(0, 400).trimStart().toLowerCase();
|
|
497
|
+
|
|
498
|
+
// An HTML error page (Cloudflare interstitial, nginx default, a login
|
|
499
|
+
// redirect) says what it is in its <title>, and almost nowhere else.
|
|
500
|
+
if (head.startsWith('<!doctype') || head.startsWith('<html')) {
|
|
501
|
+
const title = htmlTitle(raw);
|
|
502
|
+
return title
|
|
503
|
+
? `${title} (upstream returned an HTML error page, not an API response)`
|
|
504
|
+
: 'upstream returned an HTML error page, not an API response';
|
|
505
|
+
}
|
|
506
|
+
|
|
507
|
+
// XML fault documents — EPO OPS, SDMX (`<message:Error>`), SOAP faults. The
|
|
508
|
+
// human sentence sits in a child element whose tag name says what it is.
|
|
509
|
+
if (head.startsWith('<?xml') || head.startsWith('<')) {
|
|
510
|
+
const fault = xmlFaultText(raw);
|
|
511
|
+
return fault
|
|
512
|
+
? `${stripMarkup(fault).slice(0, MAX_DETAIL)} (from the upstream's XML error document)`
|
|
513
|
+
: 'upstream returned an XML error document with no readable message';
|
|
514
|
+
}
|
|
515
|
+
|
|
516
|
+
// Most JSON error bodies bury one human sentence among ids and echoed request
|
|
517
|
+
// params. Prefer that sentence; fall back to the whole body when the shape is
|
|
518
|
+
// unfamiliar, since an unfamiliar shape is exactly when we can least afford to
|
|
519
|
+
// guess wrong and show nothing.
|
|
520
|
+
const fromJson = messageFromJson(raw);
|
|
521
|
+
return stripMarkup(fromJson ?? raw).slice(0, MAX_DETAIL);
|
|
522
|
+
}
|
|
523
|
+
|
|
524
|
+
/** The `<title>` of an HTML error page, or its first `<h1>` — the two places a
|
|
525
|
+
* bot wall, a 502 and an "Access Denied" all state what happened. */
|
|
526
|
+
function htmlTitle(raw: string): string | null {
|
|
527
|
+
const head = raw.slice(0, 4000);
|
|
528
|
+
for (const re of [/<title[^>]*>([\s\S]*?)<\/title>/i, /<h1[^>]*>([\s\S]*?)<\/h1>/i]) {
|
|
529
|
+
const m = re.exec(head);
|
|
530
|
+
const text = m ? stripMarkup(m[1]) : '';
|
|
531
|
+
if (text) return text.slice(0, 160);
|
|
532
|
+
}
|
|
533
|
+
return null;
|
|
534
|
+
}
|
|
535
|
+
|
|
536
|
+
/** Tag names that carry the explanation in an XML fault document, namespace
|
|
537
|
+
* prefix optional (`<message:Error>`, `<com:Text>`, `<faultstring>`). */
|
|
538
|
+
const XML_FAULT_TAG_RE =
|
|
539
|
+
/<(?:[A-Za-z0-9_.-]+:)?(?:text|message|description|faultstring|reason|detail|title|errormessage|error)\b[^>]*>([^<]{2,400})</i;
|
|
540
|
+
|
|
541
|
+
function xmlFaultText(raw: string): string | null {
|
|
542
|
+
const head = raw.slice(0, 8000);
|
|
543
|
+
const tagged = XML_FAULT_TAG_RE.exec(head);
|
|
544
|
+
if (tagged && tagged[1].trim()) return tagged[1];
|
|
545
|
+
|
|
546
|
+
// Nothing conventionally named — take the longest text node instead. A fault
|
|
547
|
+
// document with one sentence in an oddly named element is still readable;
|
|
548
|
+
// returning nothing at all is not.
|
|
549
|
+
let best = '';
|
|
550
|
+
for (const m of head.matchAll(/>([^<>]{8,400})</g)) {
|
|
551
|
+
const text = m[1].trim();
|
|
552
|
+
if (text.length > best.length) best = text;
|
|
553
|
+
}
|
|
554
|
+
return best || null;
|
|
555
|
+
}
|
|
556
|
+
|
|
557
|
+
/**
|
|
558
|
+
* Remove every tag and stray angle bracket, then collapse whitespace.
|
|
559
|
+
*
|
|
560
|
+
* Applied to everything on the way out, including the JSON and plain-text
|
|
561
|
+
* paths, because an upstream is free to embed markup in a JSON string field —
|
|
562
|
+
* and a leak is a leak regardless of which branch produced it.
|
|
563
|
+
*/
|
|
564
|
+
function stripMarkup(s: string): string {
|
|
565
|
+
return collapse(decodeEntities(s.replace(/<[^>]*>/g, ' ')).replace(/[<>]/g, ' '));
|
|
566
|
+
}
|
|
567
|
+
|
|
568
|
+
/** The handful of entities that show up in error-page titles. Decoded AFTER
|
|
569
|
+
* tags are stripped and BEFORE the angle-bracket sweep, so `<script>`
|
|
570
|
+
* in a title cannot decode into markup that survives — EMBL-EBI's ChEMBL 500
|
|
571
|
+
* page renders as `500 Internal Server Error < EMBL-EBI` otherwise. */
|
|
572
|
+
function decodeEntities(s: string): string {
|
|
573
|
+
return s
|
|
574
|
+
.replace(/&(?:amp|#0*38);/gi, '&')
|
|
575
|
+
.replace(/&(?:lt|#0*60);/gi, '<')
|
|
576
|
+
.replace(/&(?:gt|#0*62);/gi, '>')
|
|
577
|
+
.replace(/&(?:quot|#0*34);/gi, '"')
|
|
578
|
+
.replace(/&(?:#0*39|apos|#x0*27);/gi, "'")
|
|
579
|
+
.replace(/ /gi, ' ');
|
|
580
|
+
}
|
|
581
|
+
|
|
582
|
+
/** The conventional "what went wrong" field, under any of the names upstreams
|
|
583
|
+
* actually use. Checked in order; first non-empty string wins. */
|
|
584
|
+
const MESSAGE_KEYS = [
|
|
585
|
+
'message', 'error_message', 'errorMessage', 'detail', 'details',
|
|
586
|
+
'description', 'error_description', 'reason', 'title', 'fault',
|
|
587
|
+
];
|
|
588
|
+
|
|
589
|
+
function messageFromJson(raw: string): string | null {
|
|
590
|
+
let parsed: unknown;
|
|
591
|
+
try {
|
|
592
|
+
parsed = JSON.parse(raw);
|
|
593
|
+
} catch {
|
|
594
|
+
return null;
|
|
595
|
+
}
|
|
596
|
+
return pickMessage(parsed, 0);
|
|
597
|
+
}
|
|
598
|
+
|
|
599
|
+
function pickMessage(node: unknown, depth: number): string | null {
|
|
600
|
+
// Two levels covers `{error: {message}}` and `{errors: [{detail}]}`, the two
|
|
601
|
+
// shapes that account for nearly all of them, without walking a large payload.
|
|
602
|
+
if (depth > 2 || node == null) return null;
|
|
603
|
+
|
|
604
|
+
if (typeof node === 'string') return node.trim() || null;
|
|
605
|
+
|
|
606
|
+
if (Array.isArray(node)) {
|
|
607
|
+
for (const item of node) {
|
|
608
|
+
const found = pickMessage(item, depth + 1);
|
|
609
|
+
if (found) return found;
|
|
610
|
+
}
|
|
611
|
+
return null;
|
|
612
|
+
}
|
|
613
|
+
|
|
614
|
+
if (typeof node !== 'object') return null;
|
|
615
|
+
const obj = node as Record<string, unknown>;
|
|
616
|
+
|
|
617
|
+
for (const key of MESSAGE_KEYS) {
|
|
618
|
+
const v = obj[key];
|
|
619
|
+
if (typeof v === 'string' && v.trim()) return v.trim();
|
|
620
|
+
}
|
|
621
|
+
// `{error: …}` where error is itself an object or a string — the single most
|
|
622
|
+
// common wrapper, so it is worth descending into by name rather than scanning
|
|
623
|
+
// every key and risking picking up an echoed request parameter.
|
|
624
|
+
for (const key of ['error', 'errors', 'fault', 'Error', 'data']) {
|
|
625
|
+
if (key in obj) {
|
|
626
|
+
const found = pickMessage(obj[key], depth + 1);
|
|
627
|
+
if (found) return found;
|
|
628
|
+
}
|
|
629
|
+
}
|
|
630
|
+
return null;
|
|
631
|
+
}
|
|
632
|
+
|
|
633
|
+
/** Errors are read in a single line of log output; newlines and runs of
|
|
634
|
+
* whitespace make a multi-line body unreadable there. */
|
|
635
|
+
function collapse(s: string): string {
|
|
636
|
+
return s.replace(/\s+/g, ' ').trim();
|
|
637
|
+
}
|
|
16
638
|
/**
|
|
17
639
|
* Census MCP — U.S. Census Bureau housing-relevant APIs.
|
|
18
640
|
*
|
|
19
641
|
* Tools:
|
|
642
|
+
* - census_population: population (plus median age, households, median income) for a county/city/ZIP/state by plain-English name
|
|
20
643
|
* - census_acs: American Community Survey 5-year data (housing units, median home value, owner-occupied, etc.)
|
|
21
644
|
* - census_building_permits: Monthly building permits from the residential construction survey
|
|
22
645
|
* - census_housing_starts: New residential construction (starts, under construction, completions)
|
|
@@ -27,6 +650,15 @@ interface McpToolExport {
|
|
|
27
650
|
*/
|
|
28
651
|
|
|
29
652
|
|
|
653
|
+
// Bound every fetch() in this pack to a fixed timeout — an upstream that
|
|
654
|
+
// degrades without erroring would otherwise hold the Worker in `await fetch()`
|
|
655
|
+
// until its own execution budget kills the request (minutes, not seconds).
|
|
656
|
+
// Mirrors the epoFetch / usaspending retryFetch pattern (fleet #685).
|
|
657
|
+
async function pwFetch(url: string | URL, init?: RequestInit): Promise<Response> {
|
|
658
|
+
return fetchWithTimeout(url, init ?? {}, 'Census');
|
|
659
|
+
}
|
|
660
|
+
|
|
661
|
+
|
|
30
662
|
const BASE = 'https://api.census.gov/data';
|
|
31
663
|
|
|
32
664
|
function extractKey(args: Record<string, unknown>): string {
|
|
@@ -37,12 +669,36 @@ function extractKey(args: Record<string, unknown>): string {
|
|
|
37
669
|
}
|
|
38
670
|
|
|
39
671
|
async function censusFetch(url: string): Promise<unknown> {
|
|
40
|
-
const res = await
|
|
672
|
+
const res = await pwFetch(url);
|
|
41
673
|
if (!res.ok) {
|
|
42
674
|
const text = await res.text();
|
|
43
675
|
throw new Error(`Census API error (${res.status}): ${text}`);
|
|
44
676
|
}
|
|
45
|
-
|
|
677
|
+
// A valid-format period that Census has not published yet comes back as
|
|
678
|
+
// HTTP 200 with an EMPTY BODY — not an error, not an empty array. Calling
|
|
679
|
+
// res.json() on that throws "Unexpected end of JSON input", which is what a
|
|
680
|
+
// caller asking for "the latest month" actually hit: the router reasonably
|
|
681
|
+
// computes the current month, Census is a month or two behind, and a
|
|
682
|
+
// reasonable question died on a parse error. Empty body is data-not-published,
|
|
683
|
+
// so report it as absence and let the caller decide.
|
|
684
|
+
const text = await res.text();
|
|
685
|
+
if (!text.trim()) return null;
|
|
686
|
+
try {
|
|
687
|
+
return JSON.parse(text);
|
|
688
|
+
} catch {
|
|
689
|
+
// Census answers a bad key with an HTML "Invalid Key" page at HTTP 200, so
|
|
690
|
+
// it lands here rather than in the !res.ok branch. Saying "the period or
|
|
691
|
+
// variable does not exist" for that sends the caller to rewrite a query
|
|
692
|
+
// that was already correct.
|
|
693
|
+
if (/invalid key/i.test(text)) {
|
|
694
|
+
throw new Error(
|
|
695
|
+
'Census rejected the API key. Register a free key at https://api.census.gov/data/key_signup.html and pass it as _apiKey — the geography and variables in this request were not the problem.',
|
|
696
|
+
);
|
|
697
|
+
}
|
|
698
|
+
throw new Error(
|
|
699
|
+
`Census API returned a non-JSON body (${text.slice(0, 120)}). This usually means the requested period or variable does not exist.`,
|
|
700
|
+
);
|
|
701
|
+
}
|
|
46
702
|
}
|
|
47
703
|
|
|
48
704
|
/** Convert Census 2D array response into array of objects using first row as headers */
|
|
@@ -59,10 +715,39 @@ function tableToObjects(data: unknown): Record<string, string>[] {
|
|
|
59
715
|
}
|
|
60
716
|
|
|
61
717
|
const tools: McpToolExport['tools'] = [
|
|
718
|
+
{
|
|
719
|
+
name: 'census_population',
|
|
720
|
+
description:
|
|
721
|
+
'HOW MANY PEOPLE LIVE somewhere in the United States — the population of a county, city, town, ZIP code or state from the American Community Survey. Answers "population of Travis County Texas", "how many people live in Austin", "what is the population of 78701", "Ohio population". Say the place the way a person says it ("Travis County, TX", "Austin, TX", "78701", "Texas"); no FIPS codes and no variable codes needed. Also returns median age, household count and median household income for the same place when the survey publishes them. Figures are 5-year survey estimates, so they describe a period rather than a census-day headcount. For what homes cost or rent there, use census_acs.',
|
|
722
|
+
inputSchema: {
|
|
723
|
+
type: 'object' as const,
|
|
724
|
+
properties: {
|
|
725
|
+
place: { type: 'string', description: 'The place, in plain English: "Travis County, TX", "Austin, TX", "78701", "Texas". A county or place name works best with its state.' },
|
|
726
|
+
year: { type: 'number', description: 'ACS 5-year survey year (default 2022; available from 2009).' },
|
|
727
|
+
_apiKey: { type: 'string', description: 'Census API key' },
|
|
728
|
+
},
|
|
729
|
+
required: ['place'],
|
|
730
|
+
},
|
|
731
|
+
outputSchema: {
|
|
732
|
+
type: 'object',
|
|
733
|
+
properties: {
|
|
734
|
+
found: { type: 'boolean' },
|
|
735
|
+
place: { type: 'string' },
|
|
736
|
+
population: { type: 'number' },
|
|
737
|
+
median_age: { type: 'number' },
|
|
738
|
+
households: { type: 'number' },
|
|
739
|
+
median_household_income_usd: { type: 'number' },
|
|
740
|
+
year: { type: 'number' },
|
|
741
|
+
estimate_note: { type: 'string' },
|
|
742
|
+
source: { type: 'string' },
|
|
743
|
+
},
|
|
744
|
+
required: ['found', 'place', 'population', 'year', 'source'],
|
|
745
|
+
},
|
|
746
|
+
},
|
|
62
747
|
{
|
|
63
748
|
name: 'census_acs',
|
|
64
749
|
description:
|
|
65
|
-
'
|
|
750
|
+
'Median home value and median rent for a US ZIP CODE, city, town, county or state, from the American Community Survey — the keyless way to answer "what do homes cost in 33158" or "median home price in Miami-Dade County" at a grain below metro level. Pass the geography the way a person says it: a 5-digit ZIP ("33158"), a place with its state ("Palmetto Bay, FL"), a county ("Miami-Dade County, FL"), or a state ("Florida"); FIPS codes and raw Census "for" syntax also work. Median home value is B25077_001E and median gross rent is B25064_001E (B25003 is tenure counts, not rent); the same call also serves ownership rates, vacancy and any other ACS variable code. Values are 5-year survey estimates, so they describe a period rather than this month\'s asking prices.',
|
|
66
751
|
inputSchema: {
|
|
67
752
|
type: 'object' as const,
|
|
68
753
|
properties: {
|
|
@@ -77,50 +762,45 @@ const tools: McpToolExport['tools'] = [
|
|
|
77
762
|
{
|
|
78
763
|
name: 'census_building_permits',
|
|
79
764
|
description:
|
|
80
|
-
'
|
|
765
|
+
'Check monthly building permits for new residential construction by geography. Returns count of authorized privately-owned housing units and construction activity trends.',
|
|
81
766
|
inputSchema: {
|
|
82
767
|
type: 'object' as const,
|
|
83
768
|
properties: {
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
category_code: { type: 'string', description: 'Category filter (e.g., "TOTAL" for total, "1UNIT" for single-family). Optional.' },
|
|
769
|
+
time: { type: 'string', description: 'Month as "YYYY-MM" (e.g. "2026-04"), or "from 2026-01 to 2026-04" for a range. Defaults to the latest published month.' },
|
|
770
|
+
category_code: { type: 'string', description: 'APERMITS (annual rate, default) or PERMITS (monthly level). Pass "ALL" to get every residential-construction series for the month.' },
|
|
87
771
|
_apiKey: { type: 'string', description: 'Census API key' },
|
|
88
772
|
},
|
|
89
|
-
required: ['variables', 'time', '_apiKey'],
|
|
90
773
|
},
|
|
91
774
|
},
|
|
92
775
|
{
|
|
93
776
|
name: 'census_housing_starts',
|
|
94
777
|
description:
|
|
95
|
-
'Get
|
|
778
|
+
'Get residential construction pipeline by geography: new starts, units under construction, and completed units. Returns housing supply and activity trends.',
|
|
96
779
|
inputSchema: {
|
|
97
780
|
type: 'object' as const,
|
|
98
781
|
properties: {
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
region: { type: 'string', description: 'Census region filter (e.g., "NE" for Northeast, "MW" for Midwest, "S" for South, "W" for West). Optional.' },
|
|
782
|
+
time: { type: 'string', description: 'Month as "YYYY-MM" (e.g. "2026-04"), or "from 2026-01 to 2026-04" for a range. Defaults to the latest published month.' },
|
|
783
|
+
category_code: { type: 'string', description: 'ASTARTS (annual rate, default), STARTS, COMPLETIONS, UNDERCONST, AUTHNOTSTD, or "ALL".' },
|
|
102
784
|
_apiKey: { type: 'string', description: 'Census API key' },
|
|
103
785
|
},
|
|
104
|
-
required: ['variables', 'time', '_apiKey'],
|
|
105
786
|
},
|
|
106
787
|
},
|
|
107
788
|
{
|
|
108
789
|
name: 'census_homeownership',
|
|
109
790
|
description:
|
|
110
|
-
'
|
|
791
|
+
'US homeownership rate and housing vacancy rates by quarter, from the Census Housing Vacancy Survey (HVS) — the official source. Returns `headline` (the national homeownership rate as a percent) plus the rental and homeowner vacancy rates. Defaults to the latest published quarter.',
|
|
111
792
|
inputSchema: {
|
|
112
793
|
type: 'object' as const,
|
|
113
794
|
properties: {
|
|
114
|
-
time: { type: 'string', description: '
|
|
795
|
+
time: { type: 'string', description: 'Quarter as "YYYY-QN" (e.g. "2026-Q1"). Defaults to the latest published quarter.' },
|
|
115
796
|
_apiKey: { type: 'string', description: 'Census API key' },
|
|
116
797
|
},
|
|
117
|
-
required: ['time', '_apiKey'],
|
|
118
798
|
},
|
|
119
799
|
},
|
|
120
800
|
{
|
|
121
801
|
name: 'census_available_datasets',
|
|
122
802
|
description:
|
|
123
|
-
'
|
|
803
|
+
'Discover Census datasets and their variables. Returns dataset names, descriptions, and variable codes (e.g., B25001_001E) for querying with other census tools.',
|
|
124
804
|
inputSchema: {
|
|
125
805
|
type: 'object' as const,
|
|
126
806
|
properties: {
|
|
@@ -133,6 +813,8 @@ const tools: McpToolExport['tools'] = [
|
|
|
133
813
|
|
|
134
814
|
async function callTool(name: string, args: Record<string, unknown>): Promise<unknown> {
|
|
135
815
|
switch (name) {
|
|
816
|
+
case 'census_population':
|
|
817
|
+
return censusPopulation(args);
|
|
136
818
|
case 'census_acs':
|
|
137
819
|
return censusAcs(args);
|
|
138
820
|
case 'census_building_permits':
|
|
@@ -148,75 +830,429 @@ async function callTool(name: string, args: Record<string, unknown>): Promise<un
|
|
|
148
830
|
}
|
|
149
831
|
}
|
|
150
832
|
|
|
833
|
+
/**
|
|
834
|
+
* Census "for" syntax needs FIPS codes nobody carries in their head: Miami-Dade
|
|
835
|
+
* County is `county:086&in=state:12`. An agent asked for the median home price
|
|
836
|
+
* in 33158 has a ZIP or a place name, not that, and the ZIP/county grain is the
|
|
837
|
+
* grain people actually ask about. So resolve plain English here.
|
|
838
|
+
*
|
|
839
|
+
* State FIPS are fixed by federal standard and do not churn, so they are a table.
|
|
840
|
+
* Counties and places are looked up live against the same ACS year being queried,
|
|
841
|
+
* which keeps the resolver honest when place definitions change between vintages.
|
|
842
|
+
*/
|
|
843
|
+
const STATE_FIPS: Record<string, string> = {
|
|
844
|
+
al: '01', ak: '02', az: '04', ar: '05', ca: '06', co: '08', ct: '09', de: '10',
|
|
845
|
+
dc: '11', fl: '12', ga: '13', hi: '15', id: '16', il: '17', in: '18', ia: '19',
|
|
846
|
+
ks: '20', ky: '21', la: '22', me: '23', md: '24', ma: '25', mi: '26', mn: '27',
|
|
847
|
+
ms: '28', mo: '29', mt: '30', ne: '31', nv: '32', nh: '33', nj: '34', nm: '35',
|
|
848
|
+
ny: '36', nc: '37', nd: '38', oh: '39', ok: '40', or: '41', pa: '42', ri: '44',
|
|
849
|
+
sc: '45', sd: '46', tn: '47', tx: '48', ut: '49', vt: '50', va: '51', wa: '53',
|
|
850
|
+
wv: '54', wi: '55', wy: '56', pr: '72',
|
|
851
|
+
};
|
|
852
|
+
const STATE_NAMES: Record<string, string> = {
|
|
853
|
+
alabama: 'al', alaska: 'ak', arizona: 'az', arkansas: 'ar', california: 'ca',
|
|
854
|
+
colorado: 'co', connecticut: 'ct', delaware: 'de', 'district of columbia': 'dc',
|
|
855
|
+
florida: 'fl', georgia: 'ga', hawaii: 'hi', idaho: 'id', illinois: 'il',
|
|
856
|
+
indiana: 'in', iowa: 'ia', kansas: 'ks', kentucky: 'ky', louisiana: 'la',
|
|
857
|
+
maine: 'me', maryland: 'md', massachusetts: 'ma', michigan: 'mi', minnesota: 'mn',
|
|
858
|
+
mississippi: 'ms', missouri: 'mo', montana: 'mt', nebraska: 'ne', nevada: 'nv',
|
|
859
|
+
'new hampshire': 'nh', 'new jersey': 'nj', 'new mexico': 'nm', 'new york': 'ny',
|
|
860
|
+
'north carolina': 'nc', 'north dakota': 'nd', ohio: 'oh', oklahoma: 'ok',
|
|
861
|
+
oregon: 'or', pennsylvania: 'pa', 'rhode island': 'ri', 'south carolina': 'sc',
|
|
862
|
+
'south dakota': 'sd', tennessee: 'tn', texas: 'tx', utah: 'ut', vermont: 'vt',
|
|
863
|
+
virginia: 'va', washington: 'wa', 'west virginia': 'wv', wisconsin: 'wi',
|
|
864
|
+
wyoming: 'wy', 'puerto rico': 'pr',
|
|
865
|
+
};
|
|
866
|
+
|
|
867
|
+
function stateFips(token: string): string | null {
|
|
868
|
+
const t = token.trim().toLowerCase().replace(/\.$/, '');
|
|
869
|
+
if (STATE_FIPS[t]) return STATE_FIPS[t];
|
|
870
|
+
const abbr = STATE_NAMES[t];
|
|
871
|
+
return abbr ? STATE_FIPS[abbr] : null;
|
|
872
|
+
}
|
|
873
|
+
|
|
874
|
+
/** Strip the Census entity suffix so "Palmetto Bay village, Florida" matches "Palmetto Bay". */
|
|
875
|
+
function bareName(name: string): string {
|
|
876
|
+
return name
|
|
877
|
+
.split(',')[0]
|
|
878
|
+
.replace(/\s+(village|city|town|borough|CDP|municipality|County|Parish|Census Area|Municipio)$/i, '')
|
|
879
|
+
.trim()
|
|
880
|
+
.toLowerCase();
|
|
881
|
+
}
|
|
882
|
+
|
|
883
|
+
async function lookupInState(
|
|
884
|
+
level: 'county' | 'place', name: string, stFips: string, year: number, key: string,
|
|
885
|
+
) {
|
|
886
|
+
const params = new URLSearchParams({ get: 'NAME', for: `${level}:*`, in: `state:${stFips}`, key });
|
|
887
|
+
const rows = tableToObjects(await censusFetch(`${BASE}/${year}/acs/acs5?${params}`)) as Record<string, string>[];
|
|
888
|
+
const want = bareName(name);
|
|
889
|
+
const exact = rows.filter((r) => bareName(r.NAME ?? '') === want);
|
|
890
|
+
const hits = exact.length ? exact : rows.filter((r) => bareName(r.NAME ?? '').startsWith(want));
|
|
891
|
+
return hits.map((r) => ({ name: r.NAME, fips: r[level] }));
|
|
892
|
+
}
|
|
893
|
+
|
|
894
|
+
type GeoResolution = { forClause: string; inClause?: string; resolved: string; note?: string };
|
|
895
|
+
|
|
896
|
+
async function resolveGeography(raw: string, year: number, key: string): Promise<GeoResolution> {
|
|
897
|
+
const geography = raw.trim();
|
|
898
|
+
// Already Census syntax — pass it straight through, unchanged.
|
|
899
|
+
if (geography.includes(':')) {
|
|
900
|
+
const [forClause, inClause] = geography.split('&in=');
|
|
901
|
+
return { forClause, inClause, resolved: geography };
|
|
902
|
+
}
|
|
903
|
+
|
|
904
|
+
const zip = geography.match(/\b(\d{5})\b/);
|
|
905
|
+
if (zip && !/[a-z]/i.test(geography.replace(/zip|code|zcta/gi, ''))) {
|
|
906
|
+
return {
|
|
907
|
+
forClause: `zip code tabulation area:${zip[1]}`,
|
|
908
|
+
resolved: `zip code tabulation area:${zip[1]}`,
|
|
909
|
+
note: `Read "${geography}" as ZIP Code Tabulation Area ${zip[1]}. A ZCTA approximates the ZIP's delivery area and is not identical to it.`,
|
|
910
|
+
};
|
|
911
|
+
}
|
|
912
|
+
|
|
913
|
+
// "<name>, <state>" — the shape people actually type.
|
|
914
|
+
const comma = geography.split(',');
|
|
915
|
+
if (comma.length >= 2) {
|
|
916
|
+
const stFips = stateFips(comma[comma.length - 1]);
|
|
917
|
+
const name = comma.slice(0, -1).join(',').trim();
|
|
918
|
+
if (stFips && name) {
|
|
919
|
+
const isCounty = /\b(county|parish|borough|municipio)\b/i.test(name);
|
|
920
|
+
const order: ('county' | 'place')[] = isCounty ? ['county'] : ['place', 'county'];
|
|
921
|
+
for (const level of order) {
|
|
922
|
+
const hits = await lookupInState(level, name, stFips, year, key);
|
|
923
|
+
if (hits.length === 1) {
|
|
924
|
+
return {
|
|
925
|
+
forClause: `${level}:${hits[0].fips}`,
|
|
926
|
+
inClause: `state:${stFips}`,
|
|
927
|
+
resolved: `${level}:${hits[0].fips}&in=state:${stFips}`,
|
|
928
|
+
note: `Read "${geography}" as ${hits[0].name}.`,
|
|
929
|
+
};
|
|
930
|
+
}
|
|
931
|
+
if (hits.length > 1) {
|
|
932
|
+
throw new Error(
|
|
933
|
+
`"${geography}" matches ${hits.length} ${level}s in that state: ${hits.map((h) => h.name).join('; ')}. Ask again with one of those exact names.`,
|
|
934
|
+
);
|
|
935
|
+
}
|
|
936
|
+
}
|
|
937
|
+
throw new Error(
|
|
938
|
+
`No county or place named "${name}" exists in that state for ACS ${year}. Census names carry a suffix ("Palmetto Bay village"), which this tool strips for you, so the mismatch is the name itself — check the spelling, or query the ZIP instead by passing just the 5-digit code.`,
|
|
939
|
+
);
|
|
940
|
+
}
|
|
941
|
+
}
|
|
942
|
+
|
|
943
|
+
const stOnly = stateFips(geography);
|
|
944
|
+
if (stOnly) return { forClause: `state:${stOnly}`, resolved: `state:${stOnly}`, note: `Read "${geography}" as state FIPS ${stOnly}.` };
|
|
945
|
+
|
|
946
|
+
throw new Error(
|
|
947
|
+
`Could not read "${geography}" as a geography. Pass a 5-digit ZIP ("33158"), a place or county with its state ("Palmetto Bay, FL" or "Miami-Dade County, FL"), a state ("Florida"), or raw Census "for" syntax ("county:086&in=state:12").`,
|
|
948
|
+
);
|
|
949
|
+
}
|
|
950
|
+
|
|
951
|
+
/**
|
|
952
|
+
* Population is the most-asked census question and this pack could not be asked
|
|
953
|
+
* it. The capability was here — census_acs resolves "Travis County, TX" and
|
|
954
|
+
* B01003_001E returns 1,289,054 — but tool selection is embedding similarity
|
|
955
|
+
* over the description, and census_acs's description is entirely home values
|
|
956
|
+
* and rents. So "population of Travis County Texas" could not match it, and
|
|
957
|
+
* did not: 13 asks from one PAID caller on 2026-09-09 all routed to
|
|
958
|
+
* hud_fair_market_rents and answered with rents. The caller would also have
|
|
959
|
+
* had to know the variable code. A question this common deserves a tool whose
|
|
960
|
+
* description is about it and whose only argument is the place.
|
|
961
|
+
*/
|
|
962
|
+
const POP_VARS = {
|
|
963
|
+
B01003_001E: 'population',
|
|
964
|
+
B01002_001E: 'median_age',
|
|
965
|
+
B11001_001E: 'households',
|
|
966
|
+
B19013_001E: 'median_household_income_usd',
|
|
967
|
+
} as const;
|
|
968
|
+
|
|
969
|
+
function censusNumber(raw: string | undefined): number | null {
|
|
970
|
+
if (raw === undefined || raw === null || raw === '') return null;
|
|
971
|
+
const n = Number(raw);
|
|
972
|
+
// Census uses large negative sentinels (-666666666 and friends) for
|
|
973
|
+
// suppressed or unavailable estimates. Returning one as a number would put a
|
|
974
|
+
// negative median income in front of a caller as though it were measured.
|
|
975
|
+
if (!Number.isFinite(n) || n <= -666666666) return null;
|
|
976
|
+
return n;
|
|
977
|
+
}
|
|
978
|
+
|
|
979
|
+
async function censusPopulation(args: Record<string, unknown>) {
|
|
980
|
+
const key = extractKey(args);
|
|
981
|
+
const year = (args.year as number) ?? 2022;
|
|
982
|
+
const place = typeof args.place === 'string' ? args.place.trim() : '';
|
|
983
|
+
if (!place) throw new Error('user_error: place is required — e.g. "Travis County, TX", "Austin, TX", "78701" or "Texas"');
|
|
984
|
+
|
|
985
|
+
const geo = await resolveGeography(place, year, key);
|
|
986
|
+
|
|
987
|
+
const fetchVars = async (vars: string) => {
|
|
988
|
+
const params = new URLSearchParams({ get: vars, for: geo.forClause, key });
|
|
989
|
+
if (geo.inClause) params.set('in', geo.inClause);
|
|
990
|
+
return tableToObjects(await censusFetch(`${BASE}/${year}/acs/acs5?${params}`));
|
|
991
|
+
};
|
|
992
|
+
|
|
993
|
+
// Ask for the extras in the same request, but never let them cost the
|
|
994
|
+
// answer: Census 400s the WHOLE call when one variable is not published for
|
|
995
|
+
// that geography (median household income is not available for every ZCTA),
|
|
996
|
+
// so a failure here falls back to population alone rather than returning
|
|
997
|
+
// nothing for a question that was answerable.
|
|
998
|
+
let rows: Record<string, string>[] = [];
|
|
999
|
+
let extras = true;
|
|
1000
|
+
try {
|
|
1001
|
+
rows = await fetchVars(`NAME,${Object.keys(POP_VARS).join(',')}`);
|
|
1002
|
+
} catch {
|
|
1003
|
+
extras = false;
|
|
1004
|
+
rows = await fetchVars('NAME,B01003_001E');
|
|
1005
|
+
}
|
|
1006
|
+
|
|
1007
|
+
const row = rows[0];
|
|
1008
|
+
const population = censusNumber(row?.B01003_001E);
|
|
1009
|
+
if (!row || population === null) {
|
|
1010
|
+
return {
|
|
1011
|
+
found: false,
|
|
1012
|
+
reason: 'no_estimate',
|
|
1013
|
+
place: geo.resolved,
|
|
1014
|
+
place_requested: place,
|
|
1015
|
+
year,
|
|
1016
|
+
hint: `The American Community Survey publishes no population estimate for "${place}" in ${year}. Try a larger geography (the county or state containing it) or an earlier year.`,
|
|
1017
|
+
source: 'U.S. Census Bureau American Community Survey 5-year estimates',
|
|
1018
|
+
};
|
|
1019
|
+
}
|
|
1020
|
+
|
|
1021
|
+
return {
|
|
1022
|
+
found: true,
|
|
1023
|
+
place: row.NAME ?? geo.resolved,
|
|
1024
|
+
...(geo.resolved !== place ? { place_requested: place } : {}),
|
|
1025
|
+
...(geo.note ? { geography_note: geo.note } : {}),
|
|
1026
|
+
population,
|
|
1027
|
+
...(extras
|
|
1028
|
+
? {
|
|
1029
|
+
median_age: censusNumber(row.B01002_001E),
|
|
1030
|
+
households: censusNumber(row.B11001_001E),
|
|
1031
|
+
median_household_income_usd: censusNumber(row.B19013_001E),
|
|
1032
|
+
}
|
|
1033
|
+
: {}),
|
|
1034
|
+
year,
|
|
1035
|
+
estimate_note: `${year} ACS 5-year estimate, covering ${year - 4}-${year}. Not a census-day headcount.`,
|
|
1036
|
+
source: 'U.S. Census Bureau American Community Survey 5-year estimates (api.census.gov)',
|
|
1037
|
+
};
|
|
1038
|
+
}
|
|
1039
|
+
|
|
151
1040
|
async function censusAcs(args: Record<string, unknown>) {
|
|
152
1041
|
const key = extractKey(args);
|
|
153
1042
|
const year = (args.year as number) ?? 2022;
|
|
154
1043
|
const variables = args.variables as string;
|
|
155
1044
|
const geography = args.geography as string;
|
|
156
1045
|
|
|
157
|
-
|
|
158
|
-
const parts = geography.split('&in=');
|
|
159
|
-
const forClause = parts[0];
|
|
160
|
-
const inClause = parts[1];
|
|
1046
|
+
const geo = await resolveGeography(geography, year, key);
|
|
161
1047
|
|
|
162
1048
|
const params = new URLSearchParams({
|
|
163
1049
|
get: variables,
|
|
164
|
-
for: forClause,
|
|
1050
|
+
for: geo.forClause,
|
|
165
1051
|
key,
|
|
166
1052
|
});
|
|
167
|
-
if (inClause) params.set('in', inClause);
|
|
1053
|
+
if (geo.inClause) params.set('in', geo.inClause);
|
|
168
1054
|
|
|
169
1055
|
const data = await censusFetch(`${BASE}/${year}/acs/acs5?${params}`);
|
|
170
|
-
return {
|
|
1056
|
+
return {
|
|
1057
|
+
year,
|
|
1058
|
+
variables: variables.split(','),
|
|
1059
|
+
geography: geo.resolved,
|
|
1060
|
+
...(geo.resolved !== geography ? { geography_requested: geography } : {}),
|
|
1061
|
+
...(geo.note ? { geography_note: geo.note } : {}),
|
|
1062
|
+
results: tableToObjects(data),
|
|
1063
|
+
};
|
|
171
1064
|
}
|
|
172
1065
|
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
1066
|
+
/**
|
|
1067
|
+
* The Census EITS `resconst` dataset does NOT have variables called PERMIT /
|
|
1068
|
+
* PERMIT_1UNIT / STARTS — those were invented in this pack's schema, so EVERY
|
|
1069
|
+
* documented call returned `400 unknown variable 'PERMIT'`. The real dataset is
|
|
1070
|
+
* a long table keyed by `category_code` (APERMITS, ASTARTS, COMPLETIONS,
|
|
1071
|
+
* UNDERCONST, …) × `data_type_code` (TOTAL / SINGLE / MULTI), and it REQUIRES
|
|
1072
|
+
* `seasonally_adj` and `time_slot_id` in the variable list or it 400s.
|
|
1073
|
+
*
|
|
1074
|
+
* Both tools now build that variable set themselves and default to the latest
|
|
1075
|
+
* published month, so a bare call works. `time` is honoured when given.
|
|
1076
|
+
*/
|
|
1077
|
+
// geo_level_code is NOT optional: without it the response contains five
|
|
1078
|
+
// identical-looking TOTAL rows (238 / 130 / 748 / 1423 / 307) that are actually
|
|
1079
|
+
// the four census regions plus the US, and nothing in the payload says which is
|
|
1080
|
+
// which. A reader — human or model — cannot pick the headline number out of
|
|
1081
|
+
// that, which is why "how many permits were issued?" came back as "the data
|
|
1082
|
+
// does not provide a single total" even after the 400 was fixed.
|
|
1083
|
+
const RESCONST_VARS =
|
|
1084
|
+
'cell_value,category_code,data_type_code,seasonally_adj,geo_level_code,time_slot_id,time_slot_name';
|
|
178
1085
|
|
|
179
|
-
|
|
180
|
-
|
|
1086
|
+
/** Latest EITS month with data. Building permits publish ~3 weeks after month
|
|
1087
|
+
* end; using 2-month lag gives safe availability margin. */
|
|
1088
|
+
function defaultResconstMonth(): string {
|
|
1089
|
+
const d = new Date();
|
|
1090
|
+
d.setUTCMonth(d.getUTCMonth() - 2);
|
|
1091
|
+
return `${d.getUTCFullYear()}-${String(d.getUTCMonth() + 1).padStart(2, '0')}`;
|
|
1092
|
+
}
|
|
1093
|
+
|
|
1094
|
+
async function resconst(
|
|
1095
|
+
args: Record<string, unknown>,
|
|
1096
|
+
defaultCategory: string,
|
|
1097
|
+
): Promise<unknown> {
|
|
1098
|
+
const key = args._apiKey as string | undefined;
|
|
1099
|
+
delete args._apiKey;
|
|
1100
|
+
const requestedTime = (args.time as string | undefined)?.trim() || defaultResconstMonth();
|
|
1101
|
+
const category = ((args.category_code as string | undefined) ?? defaultCategory).toUpperCase();
|
|
1102
|
+
|
|
1103
|
+
const fetchMonth = async (t: string) => {
|
|
1104
|
+
const params = new URLSearchParams({ get: RESCONST_VARS, time: t });
|
|
1105
|
+
if (category !== 'ALL') params.set('category_code', category);
|
|
1106
|
+
if (key) params.set('key', key);
|
|
1107
|
+
return tableToObjects(
|
|
1108
|
+
await censusFetch(`${BASE}/timeseries/eits/resconst?${params}`),
|
|
1109
|
+
) as Record<string, string>[];
|
|
1110
|
+
};
|
|
1111
|
+
|
|
1112
|
+
// Census publishes residential construction on a lag, so "the latest month"
|
|
1113
|
+
// is not this month. Asking for an unpublished month returns an empty body
|
|
1114
|
+
// (see censusFetch), which used to surface as a parse error on a perfectly
|
|
1115
|
+
// reasonable question. Walk back to the most recent month that HAS data and
|
|
1116
|
+
// say plainly which month answered — silently substituting a different period
|
|
1117
|
+
// would be worse than the error it replaces.
|
|
1118
|
+
const MAX_LOOKBACK_MONTHS = 14;
|
|
1119
|
+
let time = requestedTime;
|
|
1120
|
+
let rows = await fetchMonth(time);
|
|
1121
|
+
let monthsWalkedBack = 0;
|
|
1122
|
+
if (rows.length === 0 && /^\d{4}-\d{2}$/.test(requestedTime)) {
|
|
1123
|
+
const [y0, m0] = requestedTime.split('-').map(Number);
|
|
1124
|
+
for (let back = 1; back <= MAX_LOOKBACK_MONTHS && rows.length === 0; back++) {
|
|
1125
|
+
const d = new Date(Date.UTC(y0, m0 - 1 - back, 1));
|
|
1126
|
+
const candidate = `${d.getUTCFullYear()}-${String(d.getUTCMonth() + 1).padStart(2, '0')}`;
|
|
1127
|
+
rows = await fetchMonth(candidate);
|
|
1128
|
+
if (rows.length > 0) {
|
|
1129
|
+
time = candidate;
|
|
1130
|
+
monthsWalkedBack = back;
|
|
1131
|
+
}
|
|
1132
|
+
}
|
|
1133
|
+
}
|
|
1134
|
+
|
|
1135
|
+
if (rows.length === 0) {
|
|
1136
|
+
return {
|
|
1137
|
+
found: false,
|
|
1138
|
+
reason: 'no_data_for_period',
|
|
1139
|
+
requested_time: requestedTime,
|
|
1140
|
+
category_code: category,
|
|
1141
|
+
hint: `Census published nothing for ${requestedTime} or the ${MAX_LOOKBACK_MONTHS} months before it. Residential construction runs roughly two months behind, so try an explicit earlier month as time="YYYY-MM", or omit time to get the latest published month.`,
|
|
1142
|
+
};
|
|
1143
|
+
}
|
|
1144
|
+
|
|
1145
|
+
// Lead with the one number the question is actually asking for: the national,
|
|
1146
|
+
// seasonally-adjusted total for the requested category. Everything else stays
|
|
1147
|
+
// in `results` for anyone who wants the regional or single/multi split. A
|
|
1148
|
+
// correct payload the reader can't summarise is still a failed answer.
|
|
1149
|
+
const headlineRow = rows.find(
|
|
1150
|
+
(r) =>
|
|
1151
|
+
r.data_type_code === 'TOTAL' &&
|
|
1152
|
+
r.seasonally_adj === 'yes' &&
|
|
1153
|
+
(r.geo_level_code === 'US' || r.geo_level_code === 'us'),
|
|
1154
|
+
);
|
|
1155
|
+
const headline = headlineRow
|
|
1156
|
+
? {
|
|
1157
|
+
category_code: headlineRow.category_code,
|
|
1158
|
+
value_thousands: Number(headlineRow.cell_value),
|
|
1159
|
+
units: 'thousands of housing units, seasonally adjusted annual rate',
|
|
1160
|
+
geography: 'United States',
|
|
1161
|
+
period: headlineRow.time_slot_name ?? time,
|
|
1162
|
+
}
|
|
1163
|
+
: null;
|
|
1164
|
+
|
|
1165
|
+
return {
|
|
181
1166
|
time,
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
1167
|
+
date: `${time}-01`,
|
|
1168
|
+
category_code: category,
|
|
1169
|
+
...(monthsWalkedBack > 0
|
|
1170
|
+
? {
|
|
1171
|
+
requested_time: requestedTime,
|
|
1172
|
+
period_adjusted: true,
|
|
1173
|
+
period_note: `Census had not published ${requestedTime} yet; this is the latest available month (${time}), ${monthsWalkedBack} month(s) earlier. Residential construction runs roughly two months behind.`,
|
|
1174
|
+
}
|
|
1175
|
+
: {}),
|
|
1176
|
+
...(headline ? { headline } : {}),
|
|
1177
|
+
units: 'thousands of housing units, annual rate where seasonally adjusted',
|
|
1178
|
+
note: 'category_code: APERMITS/PERMITS = units authorized by building permits, ASTARTS/STARTS = starts, COMPLETIONS, UNDERCONST, AUTHNOTSTD. data_type_code: TOTAL / SINGLE (1-unit) / MULTI; E_* rows are the standard errors. geo_level_code: US = national, the rest are census regions. Codes prefixed A are the annual-rate series.',
|
|
1179
|
+
count: rows.length,
|
|
1180
|
+
results: rows,
|
|
1181
|
+
};
|
|
1182
|
+
}
|
|
185
1183
|
|
|
186
|
-
|
|
187
|
-
return
|
|
1184
|
+
async function censusBuildingPermits(args: Record<string, unknown>) {
|
|
1185
|
+
return resconst(args, 'APERMITS');
|
|
188
1186
|
}
|
|
189
1187
|
|
|
190
1188
|
async function censusHousingStarts(args: Record<string, unknown>) {
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
const time = args.time as string;
|
|
194
|
-
const region = args.region as string | undefined;
|
|
195
|
-
|
|
196
|
-
const params = new URLSearchParams({
|
|
197
|
-
get: variables,
|
|
198
|
-
time,
|
|
199
|
-
key,
|
|
200
|
-
});
|
|
201
|
-
if (region) params.set('geo', region);
|
|
1189
|
+
return resconst(args, 'ASTARTS');
|
|
1190
|
+
}
|
|
202
1191
|
|
|
203
|
-
|
|
204
|
-
|
|
1192
|
+
/** Latest published HVS quarter. The Housing Vacancy Survey lands ~4 weeks after
|
|
1193
|
+
* quarter end, so step back one full quarter for a safe default. */
|
|
1194
|
+
function defaultHvQuarter(): string {
|
|
1195
|
+
const d = new Date();
|
|
1196
|
+
const q = Math.floor(d.getUTCMonth() / 3); // 0-3 for the CURRENT quarter
|
|
1197
|
+
return q === 0 ? `${d.getUTCFullYear() - 1}-Q4` : `${d.getUTCFullYear()}-Q${q}`;
|
|
205
1198
|
}
|
|
206
1199
|
|
|
207
1200
|
async function censusHomeownership(args: Record<string, unknown>) {
|
|
208
1201
|
const key = extractKey(args);
|
|
209
|
-
const time = args.time as string;
|
|
1202
|
+
const time = (args.time as string | undefined)?.trim() || defaultHvQuarter();
|
|
210
1203
|
|
|
1204
|
+
// This used to send `get=HOR`, but HOR is a category_code in the EITS housing-
|
|
1205
|
+
// vacancy program, not a variable — so every call 400'd with "unknown variable
|
|
1206
|
+
// 'HOR'" and the official US homeownership rate was simply unanswerable. The
|
|
1207
|
+
// program takes the same shape as resconst above: ask for the standard cell
|
|
1208
|
+
// columns and pick the series you want out of the rows.
|
|
211
1209
|
const params = new URLSearchParams({
|
|
212
|
-
get: '
|
|
213
|
-
for: 'us:*',
|
|
1210
|
+
get: 'cell_value,category_code,data_type_code,seasonally_adj,geo_level_code,time_slot_id,time_slot_name',
|
|
214
1211
|
time,
|
|
215
1212
|
key,
|
|
216
1213
|
});
|
|
217
1214
|
|
|
218
|
-
const
|
|
219
|
-
|
|
1215
|
+
const rows = tableToObjects(
|
|
1216
|
+
await censusFetch(`${BASE}/timeseries/eits/hv?${params}`),
|
|
1217
|
+
) as Record<string, string>[];
|
|
1218
|
+
|
|
1219
|
+
// The rate series live under category_code=RATE and are told apart by
|
|
1220
|
+
// data_type_code: HOR = homeownership rate, RVR = rental vacancy rate, HVR =
|
|
1221
|
+
// homeowner vacancy rate, SAHOR = seasonally-adjusted homeownership. The E_*
|
|
1222
|
+
// twins are standard errors, not rates — picking one of those by accident is
|
|
1223
|
+
// how you report a 0.5% homeownership rate with a straight face.
|
|
1224
|
+
const national = (dataType: string) =>
|
|
1225
|
+
rows.find(
|
|
1226
|
+
(r) =>
|
|
1227
|
+
r.category_code === 'RATE' &&
|
|
1228
|
+
r.data_type_code === dataType &&
|
|
1229
|
+
r.geo_level_code.toUpperCase() === 'US',
|
|
1230
|
+
);
|
|
1231
|
+
const pct = (r?: Record<string, string>) =>
|
|
1232
|
+
r && r.cell_value !== '' ? Number(r.cell_value) : null;
|
|
1233
|
+
|
|
1234
|
+
const hor = national('HOR');
|
|
1235
|
+
return {
|
|
1236
|
+
metric: 'homeownership_rate',
|
|
1237
|
+
time,
|
|
1238
|
+
...(hor
|
|
1239
|
+
? {
|
|
1240
|
+
headline: {
|
|
1241
|
+
homeownership_rate_pct: pct(hor),
|
|
1242
|
+
seasonally_adjusted_pct: pct(national('SAHOR')),
|
|
1243
|
+
standard_error_pct: pct(national('E_HOR')),
|
|
1244
|
+
units: 'percent of occupied housing units that are owner-occupied',
|
|
1245
|
+
geography: 'United States',
|
|
1246
|
+
period: hor.time_slot_name ?? time,
|
|
1247
|
+
},
|
|
1248
|
+
}
|
|
1249
|
+
: {}),
|
|
1250
|
+
rental_vacancy_rate_pct: pct(national('RVR')),
|
|
1251
|
+
homeowner_vacancy_rate_pct: pct(national('HVR')),
|
|
1252
|
+
note: 'Source: Census Housing Vacancy Survey (HVS), quarterly, not seasonally adjusted unless stated. category_code RATE holds the rates (data_type_code HOR / RVR / HVR, E_* = standard errors, SAHOR = seasonally adjusted); ESTIMATE holds the unit counts in thousands. geo_level_code US = national, the rest are census regions.',
|
|
1253
|
+
count: rows.length,
|
|
1254
|
+
results: rows,
|
|
1255
|
+
};
|
|
220
1256
|
}
|
|
221
1257
|
|
|
222
1258
|
async function censusAvailableDatasets(args: Record<string, unknown>) {
|