@pipeworx/mcp-ferc-eqr 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 +193 -0
- package/bin/cli.js +17 -0
- package/package.json +32 -0
- package/server.json +18 -0
- package/src/index.ts +976 -0
- package/src/server.ts +45 -0
- package/tsconfig.json +18 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Mojibake Inc.
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,193 @@
|
|
|
1
|
+
# ferc-eqr
|
|
2
|
+
|
|
3
|
+
Who sells wholesale power to whom: FERC Electric Quarterly Report (EQR)
|
|
4
|
+
filers, and the contracts between sellers and their counterparties.
|
|
5
|
+
|
|
6
|
+
Part of [Pipeworx](https://pipeworx.io) — an MCP gateway connecting AI agents to 1679+ live data sources.
|
|
7
|
+
|
|
8
|
+
Not the same thing as `ferc-elibrary`: that pack is FERC's docket/document
|
|
9
|
+
search (filings, orders, opinions). This pack is the underlying filer and
|
|
10
|
+
contract data — a different question entirely ("who sells to whom" vs. "what
|
|
11
|
+
did FERC file").
|
|
12
|
+
|
|
13
|
+
## Tools
|
|
14
|
+
|
|
15
|
+
| Tool | Answers |
|
|
16
|
+
|---|---|
|
|
17
|
+
| `eqr_seller_lookup` | Resolve a company name or FERC company id (e.g. "C000740") to its EQR filer record(s) — per-quarter filings and whether the filer reported transactions to an index price publisher. Company-level identity only, no filer contact details. |
|
|
18
|
+
| `eqr_contracts_search` | Search contracts by seller, counterparty and/or product, with a quarter range. Returns contract-level rate-period line items — quantity, rate, delivery/receipt points, term dates. |
|
|
19
|
+
| `eqr_counterparty_sellers` | "Who sells power to X" — sellers aggregated for a counterparty name match, with contract counts and the quarter range they appear in. |
|
|
20
|
+
| `eqr_coverage` | Row counts per table, the quarter range currently covered, and when it was last refreshed. Call this before treating an empty result as a negative answer. |
|
|
21
|
+
|
|
22
|
+
## Auth
|
|
23
|
+
|
|
24
|
+
None. No key, no account.
|
|
25
|
+
|
|
26
|
+
## No personal data
|
|
27
|
+
|
|
28
|
+
The upstream source also carries filer CONTACT fields per company — a named
|
|
29
|
+
individual's name, title, address, phone and email. **None of that is
|
|
30
|
+
loaded or returned by any tool.** Only company-level identity
|
|
31
|
+
(`company_id_ferc`, `filer_unique_id`, `company_name`) is kept.
|
|
32
|
+
|
|
33
|
+
## Coverage is not automatically "everything since 2013"
|
|
34
|
+
|
|
35
|
+
The upstream data spans 2013q3 through the present, but this pack's coverage
|
|
36
|
+
is loaded incrementally rather than all at once. **Call `eqr_coverage` for
|
|
37
|
+
the quarter range actually covered before treating an empty result as "no
|
|
38
|
+
such contract"** — a result outside the covered range is a coverage gap, not
|
|
39
|
+
a negative answer. Every tool's response says this too.
|
|
40
|
+
|
|
41
|
+
## Data source, licence, attribution
|
|
42
|
+
|
|
43
|
+
FERC itself publishes Electric Quarterly Reports only as quarterly nested ZIP
|
|
44
|
+
files, with no query interface of its own. [Catalyst Cooperative's PUDL
|
|
45
|
+
project](https://catalyst.coop/pudl/) — a widely-used open energy-data
|
|
46
|
+
project — normalizes EQR into structured per-quarter tables and republishes
|
|
47
|
+
them publicly.
|
|
48
|
+
|
|
49
|
+
**Licence: "Copyright 2016-2026, Catalyst Cooperative, CC-BY-4.0"**
|
|
50
|
+
(<https://docs.catalyst.coop/pudl/en/latest/LICENSE.html>) — explicit on the
|
|
51
|
+
DATA (their processing *code* carries a separate MIT licence, which is a
|
|
52
|
+
different thing and does not govern the data). CC-BY-4.0 permits
|
|
53
|
+
redistribution with attribution. **Every tool response carries an
|
|
54
|
+
`attribution` field; do not remove it if you touch this pack.**
|
|
55
|
+
|
|
56
|
+
## Refreshing
|
|
57
|
+
|
|
58
|
+
```bash
|
|
59
|
+
node scripts/ingest-ferc-eqr.mjs --since <yyyyqN>
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
Re-runnable and safe: rows upsert on a content hash of every loaded column,
|
|
63
|
+
so loading an already-covered quarter again is a no-op rather than a
|
|
64
|
+
duplicate. `node scripts/ingest-ferc-eqr.mjs --dry-run [--since <q> | --all]`
|
|
65
|
+
parses without writing anything, useful for checking a new quarter's row
|
|
66
|
+
counts before committing to a load. `listQuarters()` discovers what's
|
|
67
|
+
published live each run, so a newly published quarter needs no code change —
|
|
68
|
+
just a wider `--since`.
|
|
69
|
+
|
|
70
|
+
## Phase 1 vs Phase 2
|
|
71
|
+
|
|
72
|
+
**Phase 1 (this pack): filer identity, index-price-publisher reporting, and
|
|
73
|
+
contract terms** — one row per contract RATE-PERIOD line item, not one row
|
|
74
|
+
per contract (a single contract can carry several rows for different rate
|
|
75
|
+
periods over its life). A quantity or rate returned here comes from the
|
|
76
|
+
CONTRACT's stated terms, not from a settled trade.
|
|
77
|
+
|
|
78
|
+
**Phase 2 (not built): the actual settled trade-level price/volume data** —
|
|
79
|
+
what a contract's *terms* say vs. what was *actually transacted*. By far the
|
|
80
|
+
most valuable data for a "what did seller X actually sell at what price"
|
|
81
|
+
question, and by a wide margin the hardest: the upstream source for it is
|
|
82
|
+
roughly two orders of magnitude larger than everything Phase 1 covers, and a
|
|
83
|
+
single recent quarter alone is larger than this pack's entire current
|
|
84
|
+
coverage. It needs a different loading strategy than Phase 1's — most likely
|
|
85
|
+
a narrower rolling window rather than full history, or a different storage
|
|
86
|
+
shape entirely. Not filed as a task; scope it separately once real demand for
|
|
87
|
+
Phase 1 is measured (does anyone actually call `eqr_contracts_search` /
|
|
88
|
+
`eqr_counterparty_sellers`), because its infrastructure cost is substantial
|
|
89
|
+
enough to want that evidence first.
|
|
90
|
+
|
|
91
|
+
## Quick Start
|
|
92
|
+
|
|
93
|
+
Add to your MCP client (Claude Desktop, Cursor, Windsurf, etc.):
|
|
94
|
+
|
|
95
|
+
```json
|
|
96
|
+
{
|
|
97
|
+
"mcpServers": {
|
|
98
|
+
"ferc-eqr": {
|
|
99
|
+
"url": "https://gateway.pipeworx.io/ferc-eqr/mcp"
|
|
100
|
+
}
|
|
101
|
+
}
|
|
102
|
+
}
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
### What this endpoint actually serves
|
|
106
|
+
|
|
107
|
+
`tools/list` at `https://gateway.pipeworx.io/ferc-eqr/mcp` returns the tools in the table
|
|
108
|
+
above **plus the shared Pipeworx meta-tools** — `ask_pipeworx`,
|
|
109
|
+
`discover_tools`, `search_within`, `remember`/`recall` and the rest of the
|
|
110
|
+
gateway-wide set. So the tool count you see is larger than this table: a
|
|
111
|
+
single-pack endpoint currently lists roughly 30 shared tools alongside the
|
|
112
|
+
pack's own. The connection's `initialize` response states its exact scope, and
|
|
113
|
+
is the authoritative answer for a given day.
|
|
114
|
+
|
|
115
|
+
This is deliberate, not multiplexing by accident. The meta-tools are what let a
|
|
116
|
+
scoped connection answer a question this pack does not cover — via
|
|
117
|
+
`ask_pipeworx`, which routes across the whole catalog — without you adding a
|
|
118
|
+
second MCP server. There is currently no way to mount a pack endpoint without
|
|
119
|
+
them; if the extra schemas cost you more context than the routing is worth,
|
|
120
|
+
connect to the full gateway once rather than to several pack endpoints.
|
|
121
|
+
|
|
122
|
+
Or connect to the full Pipeworx gateway to get every pack's tools listed
|
|
123
|
+
directly, instead of just this one's:
|
|
124
|
+
|
|
125
|
+
```json
|
|
126
|
+
{
|
|
127
|
+
"mcpServers": {
|
|
128
|
+
"pipeworx": {
|
|
129
|
+
"url": "https://gateway.pipeworx.io/mcp"
|
|
130
|
+
}
|
|
131
|
+
}
|
|
132
|
+
}
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
Both URLs reach the same gateway and the same 1679+ data sources. The
|
|
136
|
+
only difference is which pack's tools are listed **directly**; `ask_pipeworx`
|
|
137
|
+
reaches all of them from either one.
|
|
138
|
+
|
|
139
|
+
## No MCP client? Call it over HTTP
|
|
140
|
+
|
|
141
|
+
```bash
|
|
142
|
+
curl -X POST https://gateway.pipeworx.io/v1/tools/eqr_seller_lookup \
|
|
143
|
+
-H 'Content-Type: application/json' \
|
|
144
|
+
-d '{"query":"NextEra"}'
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
No account needed for the first calls. Inspect any tool: `GET https://gateway.pipeworx.io/v1/tools/eqr_seller_lookup`. Find one: `POST https://gateway.pipeworx.io/v1/tools/search_packs` with `{"query":"..."}`.
|
|
148
|
+
|
|
149
|
+
## Standalone (no gateway account)
|
|
150
|
+
|
|
151
|
+
This package also runs as a local stdio MCP server — no Pipeworx account, no
|
|
152
|
+
gateway round-trip:
|
|
153
|
+
|
|
154
|
+
```json
|
|
155
|
+
{
|
|
156
|
+
"mcpServers": {
|
|
157
|
+
"ferc-eqr": {
|
|
158
|
+
"command": "npx",
|
|
159
|
+
"args": ["-y", "@pipeworx/mcp-ferc-eqr"]
|
|
160
|
+
}
|
|
161
|
+
}
|
|
162
|
+
}
|
|
163
|
+
```
|
|
164
|
+
|
|
165
|
+
Or run it directly to confirm it starts:
|
|
166
|
+
|
|
167
|
+
```bash
|
|
168
|
+
npx -y @pipeworx/mcp-ferc-eqr
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
It speaks MCP over stdin/stdout and answers `initialize`/`tools/list`/`tools/call`
|
|
172
|
+
for **only** this pack's tools — none of the shared meta-tools the gateway
|
|
173
|
+
connection above adds. Same source, same tools, no ask_pipeworx routing.
|
|
174
|
+
|
|
175
|
+
## Using with ask_pipeworx
|
|
176
|
+
|
|
177
|
+
Instead of calling tools directly, you can ask questions in plain English —
|
|
178
|
+
this works on the pack endpoint above as well as on the full gateway:
|
|
179
|
+
|
|
180
|
+
```
|
|
181
|
+
ask_pipeworx({ question: "your question about Ferc Eqr data" })
|
|
182
|
+
```
|
|
183
|
+
|
|
184
|
+
The gateway picks the right tool and fills the arguments automatically.
|
|
185
|
+
|
|
186
|
+
## More
|
|
187
|
+
|
|
188
|
+
- [Docs and guides](https://pipeworx.io/docs)
|
|
189
|
+
- [pipeworx.io](https://pipeworx.io)
|
|
190
|
+
|
|
191
|
+
## License
|
|
192
|
+
|
|
193
|
+
MIT
|
package/bin/cli.js
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
//
|
|
3
|
+
// Entry point for `npx @pipeworx/mcp-<slug>`.
|
|
4
|
+
//
|
|
5
|
+
// Packs ship as raw TypeScript (no build step — see publish-pack.sh for why:
|
|
6
|
+
// tsx sidesteps every extensionless-import / bare-JSON-import edge case a
|
|
7
|
+
// per-pack tsc build would have to solve one pack at a time). This file
|
|
8
|
+
// registers tsx's ESM loader programmatically, then hands off to src/server.ts,
|
|
9
|
+
// which wraps the pack's {tools, callTool} export in a stdio MCP server.
|
|
10
|
+
//
|
|
11
|
+
// Copied verbatim into every published pack repo by scripts/publish-pack.sh —
|
|
12
|
+
// edit this file, not a per-pack copy.
|
|
13
|
+
import { register } from 'tsx/esm/api';
|
|
14
|
+
|
|
15
|
+
register();
|
|
16
|
+
|
|
17
|
+
await import('../src/server.ts');
|
package/package.json
ADDED
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@pipeworx/mcp-ferc-eqr",
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"description": "FERC Electric Quarterly Reports (EQR) — wholesale power sales: who sells",
|
|
5
|
+
"type": "module",
|
|
6
|
+
"main": "src/index.ts",
|
|
7
|
+
"types": "src/index.ts",
|
|
8
|
+
"bin": {
|
|
9
|
+
"mcp-ferc-eqr": "bin/cli.js"
|
|
10
|
+
},
|
|
11
|
+
"keywords": ["mcp", "mcp-server", "model-context-protocol", "pipeworx", "ferc-eqr"],
|
|
12
|
+
"license": "MIT",
|
|
13
|
+
"repository": {
|
|
14
|
+
"type": "git",
|
|
15
|
+
"url": "git+https://github.com/pipeworx-io/mcp-ferc-eqr.git"
|
|
16
|
+
},
|
|
17
|
+
"scripts": {
|
|
18
|
+
"typecheck": "tsc --noEmit"
|
|
19
|
+
},
|
|
20
|
+
"dependencies": {
|
|
21
|
+
"@modelcontextprotocol/sdk": "^1.30.0",
|
|
22
|
+
"tsx": "^4.19.0"
|
|
23
|
+
},
|
|
24
|
+
"devDependencies": {
|
|
25
|
+
"typescript": "^5.9.3",
|
|
26
|
+
"@cloudflare/workers-types": "^4.20260405.1"
|
|
27
|
+
},
|
|
28
|
+
"pipeworx": {
|
|
29
|
+
"sourceHash": "v1-b1f40ee82b86217cd7e232937dd7ddbd09d29f8367d6afda41d76101abb3886c",
|
|
30
|
+
"sourceCommit": "b0fb3c31386cf0256dcf1e2f1b3440435a87ec35"
|
|
31
|
+
}
|
|
32
|
+
}
|
package/server.json
ADDED
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://static.modelcontextprotocol.io/schemas/2025-12-11/server.schema.json",
|
|
3
|
+
"name": "io.github.pipeworx-io/ferc-eqr",
|
|
4
|
+
"title": "Ferc Eqr",
|
|
5
|
+
"description": "FERC Electric Quarterly Reports (EQR) — wholesale power sales: who sells",
|
|
6
|
+
"version": "0.1.0",
|
|
7
|
+
"websiteUrl": "https://pipeworx.io/packs/ferc-eqr",
|
|
8
|
+
"repository": {
|
|
9
|
+
"url": "https://github.com/pipeworx-io/mcp-ferc-eqr",
|
|
10
|
+
"source": "github"
|
|
11
|
+
},
|
|
12
|
+
"remotes": [
|
|
13
|
+
{
|
|
14
|
+
"type": "streamable-http",
|
|
15
|
+
"url": "https://gateway.pipeworx.io/ferc-eqr/mcp"
|
|
16
|
+
}
|
|
17
|
+
]
|
|
18
|
+
}
|
package/src/index.ts
ADDED
|
@@ -0,0 +1,976 @@
|
|
|
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
|
+
* FERC Electric Quarterly Reports (EQR) — wholesale power sales: who sells
|
|
640
|
+
* to whom, under what contract, at what price and volume.
|
|
641
|
+
*
|
|
642
|
+
* NOT the same dataset as `ferc-elibrary`. `ferc-elibrary` is FERC's docket
|
|
643
|
+
* and document search (filings, orders, opinions — the regulatory PAPER
|
|
644
|
+
* TRAIL). This pack is the underlying TRANSACTION data every public utility,
|
|
645
|
+
* power marketer and generator is required to report each quarter: the
|
|
646
|
+
* sellers, the counterparties, the contracts between them, and (in a later
|
|
647
|
+
* phase) the actual trade-level prices/volumes. A question like "who sells
|
|
648
|
+
* power to PacifiCorp" or "what contracts does NextEra Energy Marketing
|
|
649
|
+
* have on file" has no answer in ferc-elibrary and is exactly what this
|
|
650
|
+
* pack is for.
|
|
651
|
+
*
|
|
652
|
+
* SOURCE: FERC itself publishes EQR only as quarterly nested ZIP files —
|
|
653
|
+
* no query API. Catalyst Cooperative's PUDL project (a widely-used open
|
|
654
|
+
* energy-data project) normalizes EQR into per-quarter Parquet tables and
|
|
655
|
+
* distributes them from a public, keyless S3 bucket
|
|
656
|
+
* (s3://pudl.catalyst.coop/ferceqr/, bucket listing enabled, no auth, no
|
|
657
|
+
* signed URLs). This pack does NOT call that bucket live — the files are
|
|
658
|
+
* bulk Parquet, not a per-query API, so the data is mirrored into our own
|
|
659
|
+
* Supabase tables by scripts/ingest-ferc-eqr.mjs and queried from there.
|
|
660
|
+
*
|
|
661
|
+
* LICENCE / ATTRIBUTION: "Copyright 2016-2026, Catalyst Cooperative,
|
|
662
|
+
* CC-BY-4.0" (https://docs.catalyst.coop/pudl/en/latest/LICENSE.html) —
|
|
663
|
+
* explicit on the DATA (their processing code carries a separate MIT
|
|
664
|
+
* licence that does not apply here). CC-BY-4.0 permits redistribution with
|
|
665
|
+
* attribution, which is why every tool response below carries the
|
|
666
|
+
* `attribution` field. Do not drop it.
|
|
667
|
+
*
|
|
668
|
+
* PHASE 1 ONLY. This pack covers three tables: quarterly_identity (who
|
|
669
|
+
* filed), quarterly_index_pub (who reports to an index price publisher) and
|
|
670
|
+
* contracts (the contract terms themselves — one row per RATE-PERIOD line
|
|
671
|
+
* item within a contract, not one row per contract; see the comment at the
|
|
672
|
+
* top of supabase/migrations/211_ferc_eqr.sql). It does NOT cover
|
|
673
|
+
* `core_ferceqr__transactions` (line-item trade price/volume detail,
|
|
674
|
+
* ~80GB/52 quarters) — see README.md "Phase 2" for that plan. A quantity or
|
|
675
|
+
* rate found here comes from the CONTRACT's stated terms, not from an
|
|
676
|
+
* actual settled trade.
|
|
677
|
+
*
|
|
678
|
+
* NO PERSONAL DATA. The source quarterly_identity table also carries filer
|
|
679
|
+
* CONTACT fields (name, title, address, city, state, zip, country, phone,
|
|
680
|
+
* email — a named individual per filer). None of that is loaded or exposed
|
|
681
|
+
* here — only company-level identity (company_id_ferc, filer_unique_id,
|
|
682
|
+
* company_name). See migration 211's header comment.
|
|
683
|
+
*
|
|
684
|
+
* COVERAGE IS NOT NECESSARILY "ALL QUARTERS SINCE 2013". The upstream source
|
|
685
|
+
* spans 2013q3-2026q2, but the FIRST LOAD is deliberately bounded to recent
|
|
686
|
+
* quarters (Supabase compute has run out before on an unbounded PostgREST
|
|
687
|
+
* backfill from a laptop). Call `eqr_coverage` for the ACTUAL loaded
|
|
688
|
+
* quarter range before assuming a
|
|
689
|
+
* miss means "no such contract" rather than "not loaded yet" — a result
|
|
690
|
+
* outside the covered range is a coverage gap, not a negative answer, and the
|
|
691
|
+
* full 2013-onward history is available on request (a wider `--since`
|
|
692
|
+
* backfill), not automatically loaded.
|
|
693
|
+
*
|
|
694
|
+
* Promoted from mcps/_incubator/ferc-eqr on 2026-09-23 (fleet task #2346)
|
|
695
|
+
* once migration 211 was applied and the first bounded load (last 4
|
|
696
|
+
* quarters) finished. See README.md for the refresh command and the Phase 2
|
|
697
|
+
* plan.
|
|
698
|
+
*/
|
|
699
|
+
|
|
700
|
+
|
|
701
|
+
async function pwFetch(url: string | URL, init?: RequestInit): Promise<Response> {
|
|
702
|
+
return fetchWithTimeout(url, init ?? {}, 'FERC EQR');
|
|
703
|
+
}
|
|
704
|
+
|
|
705
|
+
const ATTRIBUTION =
|
|
706
|
+
'Data: Catalyst Cooperative PUDL (processed from FERC Electric Quarterly Reports), CC-BY-4.0. https://docs.catalyst.coop/pudl/en/latest/LICENSE.html';
|
|
707
|
+
|
|
708
|
+
const PHASE1_NOTE =
|
|
709
|
+
'Phase 1 coverage only: filer identity, index-price-publisher reporting, and contract terms (one row per contract rate period). Does not include line-item transaction price/volume detail (Phase 2, not yet loaded). Recent quarters loaded first; call eqr_coverage for the exact quarter range currently loaded before treating an empty result as "no such contract" rather than "not loaded yet". Full history back to 2013q3 is available on request, not automatically loaded.';
|
|
710
|
+
|
|
711
|
+
interface SupabaseConfig { url: string; key: string }
|
|
712
|
+
|
|
713
|
+
async function pg<T>(cfg: SupabaseConfig, table: string, query: string, extraHeaders?: Record<string, string>): Promise<{ rows: T; total: number | null }> {
|
|
714
|
+
const res = await pwFetch(`${cfg.url}/rest/v1/${table}?${query}`, {
|
|
715
|
+
headers: { apikey: cfg.key, Authorization: `Bearer ${cfg.key}`, ...extraHeaders },
|
|
716
|
+
});
|
|
717
|
+
if (!res.ok) {
|
|
718
|
+
// Never echo the store's raw body or the table name to the caller.
|
|
719
|
+
throw new Error(`FERC EQR data request failed (${res.status}): ${summarizeErrorBody(await res.text())}`);
|
|
720
|
+
}
|
|
721
|
+
const rows = (await res.json()) as T;
|
|
722
|
+
// "0-24/1234" -> 1234. Absent (no Prefer: count=exact) -> null, which is a
|
|
723
|
+
// different fact from 0 rows and must not be reported as 0 (fleet #1081).
|
|
724
|
+
const range = res.headers.get('content-range') ?? '';
|
|
725
|
+
const total = range.includes('/') ? Number(range.split('/')[1]) : null;
|
|
726
|
+
return { rows, total: Number.isFinite(total) ? total : null };
|
|
727
|
+
}
|
|
728
|
+
|
|
729
|
+
async function rpc<T>(cfg: SupabaseConfig, fn: string, body: Record<string, unknown>): Promise<T[]> {
|
|
730
|
+
const res = await pwFetch(`${cfg.url}/rest/v1/rpc/${fn}`, {
|
|
731
|
+
method: 'POST',
|
|
732
|
+
headers: {
|
|
733
|
+
apikey: cfg.key,
|
|
734
|
+
Authorization: `Bearer ${cfg.key}`,
|
|
735
|
+
'Content-Type': 'application/json',
|
|
736
|
+
Accept: 'application/json',
|
|
737
|
+
},
|
|
738
|
+
body: JSON.stringify(body),
|
|
739
|
+
});
|
|
740
|
+
if (!res.ok) throw new Error(`FERC EQR data request failed (${res.status}): ${summarizeErrorBody(await res.text())}`);
|
|
741
|
+
return res.json() as Promise<T[]>;
|
|
742
|
+
}
|
|
743
|
+
|
|
744
|
+
function clampLimit(v: unknown, def: number, max: number): number {
|
|
745
|
+
const n = typeof v === 'number' ? Math.floor(v) : def;
|
|
746
|
+
return Math.max(1, Math.min(max, n));
|
|
747
|
+
}
|
|
748
|
+
|
|
749
|
+
const tools: McpToolExport['tools'] = [
|
|
750
|
+
{
|
|
751
|
+
name: 'eqr_seller_lookup',
|
|
752
|
+
description:
|
|
753
|
+
'Find a FERC Electric Quarterly Report filer (seller/power marketer/utility) by name or FERC company id (e.g. "C000740"). Returns their per-quarter filing records — company name(s) as filed and whether they reported transactions to an index price publisher (Argus, ICE, S&P Global/SNL, etc.). Company-level identity only, no filer contact details. Use this to resolve a company name to its company_id_ferc before calling eqr_contracts_search, or to check whether/when a company filed an EQR. Sourced from FERC EQR via PUDL (CC-BY-4.0). Distinct from ferc-elibrary, which is the FERC docket/document search, not filer or transaction data.',
|
|
754
|
+
inputSchema: {
|
|
755
|
+
type: 'object' as const,
|
|
756
|
+
properties: {
|
|
757
|
+
query: { type: 'string', description: 'Company name (substring match, e.g. "NextEra") or exact FERC company id (e.g. "C000740").' },
|
|
758
|
+
limit: { type: 'number', description: 'Max filing records to return (default 20, max 100).' },
|
|
759
|
+
},
|
|
760
|
+
required: ['query'],
|
|
761
|
+
},
|
|
762
|
+
},
|
|
763
|
+
{
|
|
764
|
+
name: 'eqr_contracts_search',
|
|
765
|
+
description:
|
|
766
|
+
'Search FERC EQR wholesale power contracts by seller, counterparty and/or product. Returns contract-level records: seller, customer, product (e.g. ENERGY, CAPACITY), quantity, rate, rate units, delivery/receipt points, and the contract execution/term dates. Each row is one RATE-PERIOD line item within a contract (a single contract can have several rows for different rate periods) — not a settled trade. Use eqr_seller_lookup first to resolve a company name to a company_id_ferc if you want an exact-seller match rather than a name substring. Sourced from FERC EQR via PUDL (CC-BY-4.0), Phase 1 (contract terms; no transaction-level price/volume yet).',
|
|
767
|
+
inputSchema: {
|
|
768
|
+
type: 'object' as const,
|
|
769
|
+
properties: {
|
|
770
|
+
seller: { type: 'string', description: 'Seller name (substring match) or exact company_id_ferc.' },
|
|
771
|
+
counterparty: { type: 'string', description: 'Counterparty/customer company name, substring match.' },
|
|
772
|
+
product: { type: 'string', description: 'Product name substring, e.g. "ENERGY", "CAPACITY", "TRANSMISSION".' },
|
|
773
|
+
quarter_from: { type: 'string', description: 'Earliest quarter to include, format "2020q1".' },
|
|
774
|
+
quarter_to: { type: 'string', description: 'Latest quarter to include, format "2026q2".' },
|
|
775
|
+
limit: { type: 'number', description: 'Max rows to return (default 20, max 100).' },
|
|
776
|
+
offset: { type: 'number', description: 'Row offset for paging beyond `limit` (default 0).' },
|
|
777
|
+
},
|
|
778
|
+
},
|
|
779
|
+
},
|
|
780
|
+
{
|
|
781
|
+
name: 'eqr_counterparty_sellers',
|
|
782
|
+
description:
|
|
783
|
+
'Who sells wholesale power TO a given counterparty — the reverse of eqr_contracts_search. Aggregates FERC EQR contracts by seller for a counterparty name match, returning each seller\'s contract count, the quarter range they appear in, and the distinct products sold. Answers "who sells power to PacifiCorp" / "which generators have contracts with <utility>" directly, which a single-table filter cannot (it needs a group-by across all matching contracts). Sourced from FERC EQR via PUDL (CC-BY-4.0), Phase 1 (contract terms only).',
|
|
784
|
+
inputSchema: {
|
|
785
|
+
type: 'object' as const,
|
|
786
|
+
properties: {
|
|
787
|
+
counterparty: { type: 'string', description: 'Counterparty/customer company name, substring match, e.g. "PacifiCorp".' },
|
|
788
|
+
quarter_from: { type: 'string', description: 'Earliest quarter to include, format "2020q1".' },
|
|
789
|
+
quarter_to: { type: 'string', description: 'Latest quarter to include, format "2026q2".' },
|
|
790
|
+
limit: { type: 'number', description: 'Max sellers to return (default 25, max 100).' },
|
|
791
|
+
},
|
|
792
|
+
required: ['counterparty'],
|
|
793
|
+
},
|
|
794
|
+
},
|
|
795
|
+
{
|
|
796
|
+
name: 'eqr_coverage',
|
|
797
|
+
description:
|
|
798
|
+
'What FERC EQR data is currently available and how fresh it is: row counts for the filer-identity, index-publisher and contracts tables, the quarter range covered, and when it was last refreshed. Use before relying on a result to confirm coverage includes the quarter you care about. Sourced from FERC EQR via PUDL (CC-BY-4.0).',
|
|
799
|
+
inputSchema: { type: 'object' as const, properties: {} },
|
|
800
|
+
},
|
|
801
|
+
];
|
|
802
|
+
|
|
803
|
+
// COMPANY-LEVEL IDENTITY ONLY — no filer contact name/address/phone/email.
|
|
804
|
+
// The source Parquet carries those fields; this pack never selects them (see
|
|
805
|
+
// migration 211's header and scripts/ingest-ferc-eqr.mjs's NO PERSONAL DATA
|
|
806
|
+
// note — the loader does not even read them off the source row).
|
|
807
|
+
interface IdentityRow {
|
|
808
|
+
year_quarter: string; filing_quarter: string | null; company_id_ferc: string; filer_unique_id: string | null;
|
|
809
|
+
company_name: string | null; transactions_reported_to_index_price_publishers: boolean | null;
|
|
810
|
+
}
|
|
811
|
+
|
|
812
|
+
interface ContractRow {
|
|
813
|
+
year_quarter: string; seller_company_id_ferc: string; contract_unique_id: string | null;
|
|
814
|
+
seller_company_name: string | null; customer_company_name: string | null; contract_affiliate: boolean | null;
|
|
815
|
+
ferc_tariff_reference: string | null; contract_service_agreement_id: string | null;
|
|
816
|
+
contract_execution_date: string | null; commencement_date_of_contract_term: string | null;
|
|
817
|
+
contract_termination_date: string | null; actual_termination_date: string | null;
|
|
818
|
+
extension_provision_description: string | null; class_name: string | null; term_name: string | null;
|
|
819
|
+
increment_name: string | null; increment_peaking_name: string | null; product_type_name: string | null;
|
|
820
|
+
product_name: string | null; quantity: number | null; units: string | null; rate: number | null;
|
|
821
|
+
rate_minimum: number | null; rate_maximum: number | null; rate_description: string | null;
|
|
822
|
+
rate_units: string | null; point_of_receipt_balancing_authority: string | null;
|
|
823
|
+
point_of_receipt_specific_location: string | null; point_of_delivery_balancing_authority: string | null;
|
|
824
|
+
point_of_delivery_specific_location: string | null; begin_date: string | null; end_date: string | null;
|
|
825
|
+
}
|
|
826
|
+
|
|
827
|
+
interface SellerAgg {
|
|
828
|
+
seller_company_id_ferc: string; seller_company_name: string | null; contract_count: number;
|
|
829
|
+
first_quarter: string; last_quarter: string; products: string[] | null;
|
|
830
|
+
}
|
|
831
|
+
|
|
832
|
+
interface CoverageRow {
|
|
833
|
+
contracts_rows: number; identity_rows: number; index_pub_rows: number;
|
|
834
|
+
quarter_min: string | null; quarter_max: string | null; last_loaded: string | null;
|
|
835
|
+
}
|
|
836
|
+
|
|
837
|
+
/** A bare company_id_ferc looks like "C000740" — 1 letter + digits. */
|
|
838
|
+
function looksLikeCompanyId(q: string): boolean {
|
|
839
|
+
return /^[A-Za-z]\d{3,}$/.test(q.trim());
|
|
840
|
+
}
|
|
841
|
+
|
|
842
|
+
async function callTool(name: string, args: Record<string, unknown>): Promise<unknown> {
|
|
843
|
+
const url = (args._supabaseUrl as string | undefined)?.trim();
|
|
844
|
+
const key = (args._supabaseKey as string | undefined)?.trim();
|
|
845
|
+
if (!url || !key) {
|
|
846
|
+
throw new Error('ferc-eqr is not configured on this deployment — an operator must enable its data credentials. This is a setup problem, not your arguments.');
|
|
847
|
+
}
|
|
848
|
+
const cfg: SupabaseConfig = { url, key };
|
|
849
|
+
|
|
850
|
+
switch (name) {
|
|
851
|
+
case 'eqr_seller_lookup': {
|
|
852
|
+
const q = typeof args.query === 'string' ? args.query.trim() : '';
|
|
853
|
+
if (!q) return { found: false, reason: 'no_query', hint: 'Pass query: a company name or a FERC company id like "C000740".' };
|
|
854
|
+
const limit = clampLimit(args.limit, 20, 100);
|
|
855
|
+
const filter = looksLikeCompanyId(q)
|
|
856
|
+
? `company_id_ferc=eq.${encodeURIComponent(q)}`
|
|
857
|
+
: `company_name=ilike.*${encodeURIComponent(q)}*`;
|
|
858
|
+
const { rows, total } = await pg<IdentityRow[]>(
|
|
859
|
+
cfg, 'ferc_eqr_quarterly_identity',
|
|
860
|
+
[filter, 'order=year_quarter.desc', `limit=${limit}`, 'select=year_quarter,filing_quarter,company_id_ferc,filer_unique_id,company_name,transactions_reported_to_index_price_publishers'].join('&'),
|
|
861
|
+
{ Prefer: 'count=exact' },
|
|
862
|
+
);
|
|
863
|
+
if (!rows.length) {
|
|
864
|
+
return {
|
|
865
|
+
found: false,
|
|
866
|
+
result: `No FERC EQR filer matching "${q}".`,
|
|
867
|
+
searched: q, phase1_note: PHASE1_NOTE, attribution: ATTRIBUTION,
|
|
868
|
+
};
|
|
869
|
+
}
|
|
870
|
+
const bySeller = new Map<string, { company_id_ferc: string; company_name: string | null; quarters_filed: string[]; reports_to_index_publisher: boolean }>();
|
|
871
|
+
for (const r of rows) {
|
|
872
|
+
const cur = bySeller.get(r.company_id_ferc) ?? { company_id_ferc: r.company_id_ferc, company_name: r.company_name, quarters_filed: [], reports_to_index_publisher: false };
|
|
873
|
+
cur.quarters_filed.push(r.year_quarter);
|
|
874
|
+
if (r.transactions_reported_to_index_price_publishers) cur.reports_to_index_publisher = true;
|
|
875
|
+
bySeller.set(r.company_id_ferc, cur);
|
|
876
|
+
}
|
|
877
|
+
return {
|
|
878
|
+
found: true,
|
|
879
|
+
matching_filers: bySeller.size,
|
|
880
|
+
filing_records_returned: rows.length,
|
|
881
|
+
filing_records_matched_total: total,
|
|
882
|
+
sellers: [...bySeller.values()],
|
|
883
|
+
latest_filing: rows[0],
|
|
884
|
+
phase1_note: PHASE1_NOTE,
|
|
885
|
+
attribution: ATTRIBUTION,
|
|
886
|
+
};
|
|
887
|
+
}
|
|
888
|
+
|
|
889
|
+
case 'eqr_contracts_search': {
|
|
890
|
+
const seller = typeof args.seller === 'string' ? args.seller.trim() : '';
|
|
891
|
+
const counterparty = typeof args.counterparty === 'string' ? args.counterparty.trim() : '';
|
|
892
|
+
const product = typeof args.product === 'string' ? args.product.trim() : '';
|
|
893
|
+
const quarterFrom = typeof args.quarter_from === 'string' ? args.quarter_from.trim() : '';
|
|
894
|
+
const quarterTo = typeof args.quarter_to === 'string' ? args.quarter_to.trim() : '';
|
|
895
|
+
if (!seller && !counterparty && !product) {
|
|
896
|
+
return {
|
|
897
|
+
found: false, reason: 'no_filter',
|
|
898
|
+
hint: 'Pass at least one of seller, counterparty or product — an unfiltered scan of ~9.5M contract rows is not served.',
|
|
899
|
+
};
|
|
900
|
+
}
|
|
901
|
+
const limit = clampLimit(args.limit, 20, 100);
|
|
902
|
+
const offset = Math.max(0, typeof args.offset === 'number' ? Math.floor(args.offset) : 0);
|
|
903
|
+
const filters: string[] = [];
|
|
904
|
+
if (seller) filters.push(looksLikeCompanyId(seller) ? `seller_company_id_ferc=eq.${encodeURIComponent(seller)}` : `seller_company_name=ilike.*${encodeURIComponent(seller)}*`);
|
|
905
|
+
if (counterparty) filters.push(`customer_company_name=ilike.*${encodeURIComponent(counterparty)}*`);
|
|
906
|
+
if (product) filters.push(`product_name=ilike.*${encodeURIComponent(product)}*`);
|
|
907
|
+
if (quarterFrom) filters.push(`year_quarter=gte.${encodeURIComponent(quarterFrom)}`);
|
|
908
|
+
if (quarterTo) filters.push(`year_quarter=lte.${encodeURIComponent(quarterTo)}`);
|
|
909
|
+
filters.push('order=year_quarter.desc', `limit=${limit}`, `offset=${offset}`);
|
|
910
|
+
const { rows, total } = await pg<ContractRow[]>(cfg, 'ferc_eqr_contracts', filters.join('&'), { Prefer: 'count=exact' });
|
|
911
|
+
if (!rows.length) {
|
|
912
|
+
return {
|
|
913
|
+
found: false,
|
|
914
|
+
result: 'No matching FERC EQR contracts.',
|
|
915
|
+
searched: { seller: seller || null, counterparty: counterparty || null, product: product || null, quarter_from: quarterFrom || null, quarter_to: quarterTo || null },
|
|
916
|
+
phase1_note: PHASE1_NOTE, attribution: ATTRIBUTION,
|
|
917
|
+
};
|
|
918
|
+
}
|
|
919
|
+
return {
|
|
920
|
+
found: true,
|
|
921
|
+
contracts_returned: rows.length,
|
|
922
|
+
contracts_matched_total: total,
|
|
923
|
+
next_offset: (total !== null && offset + rows.length < total) ? offset + rows.length : null,
|
|
924
|
+
contracts: rows,
|
|
925
|
+
phase1_note: PHASE1_NOTE,
|
|
926
|
+
attribution: ATTRIBUTION,
|
|
927
|
+
};
|
|
928
|
+
}
|
|
929
|
+
|
|
930
|
+
case 'eqr_counterparty_sellers': {
|
|
931
|
+
const counterparty = typeof args.counterparty === 'string' ? args.counterparty.trim() : '';
|
|
932
|
+
if (!counterparty) return { found: false, reason: 'no_query', hint: 'Pass counterparty: the buyer/customer company name to look up sellers for.' };
|
|
933
|
+
const quarterFrom = typeof args.quarter_from === 'string' && args.quarter_from.trim() ? args.quarter_from.trim() : null;
|
|
934
|
+
const quarterTo = typeof args.quarter_to === 'string' && args.quarter_to.trim() ? args.quarter_to.trim() : null;
|
|
935
|
+
const limit = clampLimit(args.limit, 25, 100);
|
|
936
|
+
const sellers = await rpc<SellerAgg>(cfg, 'ferc_eqr_sellers_to_counterparty', {
|
|
937
|
+
counterparty_q: counterparty, quarter_from: quarterFrom, quarter_to: quarterTo, lim: limit,
|
|
938
|
+
});
|
|
939
|
+
if (!sellers.length) {
|
|
940
|
+
return {
|
|
941
|
+
found: false,
|
|
942
|
+
result: `No FERC EQR contracts found with a counterparty matching "${counterparty}".`,
|
|
943
|
+
searched: { counterparty, quarter_from: quarterFrom, quarter_to: quarterTo },
|
|
944
|
+
phase1_note: PHASE1_NOTE, attribution: ATTRIBUTION,
|
|
945
|
+
};
|
|
946
|
+
}
|
|
947
|
+
return {
|
|
948
|
+
found: true,
|
|
949
|
+
counterparty_searched: counterparty,
|
|
950
|
+
sellers_found: sellers.length,
|
|
951
|
+
sellers,
|
|
952
|
+
phase1_note: PHASE1_NOTE,
|
|
953
|
+
attribution: ATTRIBUTION,
|
|
954
|
+
};
|
|
955
|
+
}
|
|
956
|
+
|
|
957
|
+
case 'eqr_coverage': {
|
|
958
|
+
const [c] = await rpc<CoverageRow>(cfg, 'ferc_eqr_coverage', {});
|
|
959
|
+
return {
|
|
960
|
+
found: true,
|
|
961
|
+
contracts_rows: c?.contracts_rows ?? 0,
|
|
962
|
+
identity_rows: c?.identity_rows ?? 0,
|
|
963
|
+
index_pub_rows: c?.index_pub_rows ?? 0,
|
|
964
|
+
quarter_range: c ? { from: c.quarter_min, to: c.quarter_max } : null,
|
|
965
|
+
data_as_of: c?.last_loaded ?? null,
|
|
966
|
+
phase1_note: PHASE1_NOTE,
|
|
967
|
+
attribution: ATTRIBUTION,
|
|
968
|
+
};
|
|
969
|
+
}
|
|
970
|
+
|
|
971
|
+
default:
|
|
972
|
+
throw new Error(`unknown tool: ${name}`);
|
|
973
|
+
}
|
|
974
|
+
}
|
|
975
|
+
|
|
976
|
+
export default { tools, callTool } satisfies McpToolExport;
|
package/src/server.ts
ADDED
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Stdio MCP server entry point for @pipeworx/mcp-ferc-eqr.
|
|
3
|
+
* Generated by scripts/publish-pack.sh — do not hand-edit in the pack repo;
|
|
4
|
+
* edit scripts/publish-pack.sh (the server.ts heredoc) and republish instead.
|
|
5
|
+
*/
|
|
6
|
+
import { Server } from '@modelcontextprotocol/sdk/server/index.js';
|
|
7
|
+
import { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js';
|
|
8
|
+
import { CallToolRequestSchema, ListToolsRequestSchema } from '@modelcontextprotocol/sdk/types.js';
|
|
9
|
+
import pack from './index.js';
|
|
10
|
+
|
|
11
|
+
const server = new Server(
|
|
12
|
+
{ name: '@pipeworx/mcp-ferc-eqr', version: '0.1.0' },
|
|
13
|
+
{ capabilities: { tools: {} } },
|
|
14
|
+
);
|
|
15
|
+
|
|
16
|
+
server.setRequestHandler(ListToolsRequestSchema, async () => ({
|
|
17
|
+
tools: pack.tools.map((t) => ({
|
|
18
|
+
name: t.name,
|
|
19
|
+
description: t.description,
|
|
20
|
+
inputSchema: t.inputSchema,
|
|
21
|
+
})),
|
|
22
|
+
}));
|
|
23
|
+
|
|
24
|
+
server.setRequestHandler(CallToolRequestSchema, async (request) => {
|
|
25
|
+
const { name, arguments: args } = request.params;
|
|
26
|
+
try {
|
|
27
|
+
const result = await pack.callTool(name, (args ?? {}) as Record<string, unknown>);
|
|
28
|
+
return { content: [{ type: 'text', text: JSON.stringify(result, null, 2) }] };
|
|
29
|
+
} catch (err) {
|
|
30
|
+
return {
|
|
31
|
+
content: [{ type: 'text', text: err instanceof Error ? err.message : String(err) }],
|
|
32
|
+
isError: true,
|
|
33
|
+
};
|
|
34
|
+
}
|
|
35
|
+
});
|
|
36
|
+
|
|
37
|
+
async function main() {
|
|
38
|
+
const transport = new StdioServerTransport();
|
|
39
|
+
await server.connect(transport);
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
main().catch((err) => {
|
|
43
|
+
console.error('Fatal error running server:', err);
|
|
44
|
+
process.exit(1);
|
|
45
|
+
});
|
package/tsconfig.json
ADDED
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
{
|
|
2
|
+
"compilerOptions": {
|
|
3
|
+
"target": "ES2022",
|
|
4
|
+
"module": "ESNext",
|
|
5
|
+
"moduleResolution": "bundler",
|
|
6
|
+
"lib": ["ES2022"],
|
|
7
|
+
"types": ["@cloudflare/workers-types"],
|
|
8
|
+
"strict": true,
|
|
9
|
+
"esModuleInterop": true,
|
|
10
|
+
"skipLibCheck": true,
|
|
11
|
+
"resolveJsonModule": true,
|
|
12
|
+
"outDir": "dist",
|
|
13
|
+
"rootDir": "src",
|
|
14
|
+
"declaration": true
|
|
15
|
+
},
|
|
16
|
+
"include": ["src"],
|
|
17
|
+
"exclude": ["src/server.ts"]
|
|
18
|
+
}
|