@pipeworx/mcp-openalex 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 CHANGED
@@ -1,6 +1,6 @@
1
1
  MIT License
2
2
 
3
- Copyright (c) 2026 Pipeworx
3
+ Copyright (c) 2026 Mojibake Inc.
4
4
 
5
5
  Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  of this software and associated documentation files (the "Software"), to deal
package/README.md CHANGED
@@ -1,32 +1,149 @@
1
- # @pipeworx/mcp-openalex
1
+ # OpenAlex — Open Catalog of Scholarly Works
2
2
 
3
- MCP server for scholarly works, authors, and institutions via the [OpenAlex API](https://openalex.org/). Free, no authentication required.
3
+ OpenAlex is a free, open replacement for Microsoft Academic Graph (which shut down in 2022). 240M+ scholarly works with structured data on authors, institutions, concepts, citations, and venues. Open-source data model, generous API. Free, no auth (polite User-Agent + email recommended).
4
4
 
5
- ## Tools
5
+ Part of [Pipeworx](https://pipeworx.io) — an MCP gateway connecting AI agents to 1679+ live data sources.
6
6
 
7
- | Tool | Description |
8
- |------|-------------|
9
- | `search_works` | Search scholarly works (papers, books, datasets) by keyword |
10
- | `search_authors` | Search researchers and authors by name |
11
- | `search_institutions` | Search academic institutions by name |
12
- | `get_concept` | Look up an academic concept or field of study |
7
+ ## Why this matters for AI agents
13
8
 
14
- ## Quickstart via Pipeworx Gateway
9
+ Where [Semantic Scholar](/docs/reference/semantic-scholar) is search-focused and [Crossref](/docs/reference/crossref) is DOI-focused, OpenAlex is the most comprehensive structured graph: papers + authors + institutions + funders + concepts, all linked. For institutional analysis, citation networks, or systematic literature review, OpenAlex covers ground the others don't.
10
+
11
+ Common flows:
12
+
13
+ - **Work lookup.** Find a paper by DOI, title, or OpenAlex ID; get full structured record.
14
+ - **Author / institution.** Search Yale's CS department's papers in 2024.
15
+ - **Concept browsing.** Papers tagged with "transformer architecture" or "CRISPR Cas9."
16
+ - **Citation graph.** "Who cites paper X?" or "What does paper X cite?"
17
+
18
+ Citable URI: `pipeworx://openalex/work/{work_id}`.
19
+
20
+ ## Auth
21
+
22
+ Free, public. OpenAlex strongly encourages identifying yourself via `mailto=` query parameter or User-Agent for "polite pool" priority. Pipeworx forwards `mailto=support@pipeworx.io` and `User-Agent: Pipeworx (mailto:support@pipeworx.io)` automatically.
23
+
24
+ ## Entity types
25
+
26
+ OpenAlex models 5 entity types, each with stable IDs:
27
+
28
+ | Entity | ID prefix | Example |
29
+ |---|---|---|
30
+ | Work (paper) | W | W2741809807 |
31
+ | Author | A | A1234567890 |
32
+ | Institution | I | I97018004 (Yale) |
33
+ | Venue (journal/conference) | V | V202381698 |
34
+ | Concept (subject taxonomy) | C | C41008148 (computer science) |
35
+
36
+ Works are linked to authors, institutions (where authors are affiliated), venues (where they were published), and concepts (what they're about). Cross-entity queries are powerful.
37
+
38
+ ## Common pitfalls
39
+
40
+ - **Author disambiguation.** OpenAlex makes a serious effort but isn't perfect. The same person may have separate Author IDs across early-career vs late-career; common-name authors split across entities. Cross-reference with ORCID where available.
41
+ - **Concept hierarchy depth.** OpenAlex concepts form a 6-level tree. "Computer science" level 0 is too coarse for most queries; level 3-4 ("transformer model", "BERT model") is more useful.
42
+ - **Open access status.** OpenAlex tracks `oa_status` (gold, green, hybrid, bronze, closed). Use it to surface free-to-read versions in your output.
43
+ - **Citation count vs. cited-by.** OpenAlex computes citation counts from its own corpus. Same paper can show different counts in Google Scholar (broader) and Web of Science (narrower).
44
+ - **Lag.** New papers appear within weeks. Citations to those papers take longer because citing papers must themselves be indexed.
45
+ - **Tied to Semantic Scholar?** OpenAlex and Semantic Scholar are separate projects with separate data. Some overlap in coverage; some divergence in metadata. Use both for comprehensive lookups.
46
+
47
+ ## Quick Start
48
+
49
+ Add to your MCP client (Claude Desktop, Cursor, Windsurf, etc.):
50
+
51
+ ```json
52
+ {
53
+ "mcpServers": {
54
+ "openalex": {
55
+ "url": "https://gateway.pipeworx.io/openalex/mcp"
56
+ }
57
+ }
58
+ }
59
+ ```
60
+
61
+ ### What this endpoint actually serves
62
+
63
+ `tools/list` at `https://gateway.pipeworx.io/openalex/mcp` returns the tools in the table
64
+ above **plus the shared Pipeworx meta-tools** — `ask_pipeworx`,
65
+ `discover_tools`, `search_within`, `remember`/`recall` and the rest of the
66
+ gateway-wide set. So the tool count you see is larger than this table: a
67
+ single-pack endpoint currently lists roughly 30 shared tools alongside the
68
+ pack's own. The connection's `initialize` response states its exact scope, and
69
+ is the authoritative answer for a given day.
70
+
71
+ This is deliberate, not multiplexing by accident. The meta-tools are what let a
72
+ scoped connection answer a question this pack does not cover — via
73
+ `ask_pipeworx`, which routes across the whole catalog — without you adding a
74
+ second MCP server. There is currently no way to mount a pack endpoint without
75
+ them; if the extra schemas cost you more context than the routing is worth,
76
+ connect to the full gateway once rather than to several pack endpoints.
77
+
78
+ Or connect to the full Pipeworx gateway to get every pack's tools listed
79
+ directly, instead of just this one's:
80
+
81
+ ```json
82
+ {
83
+ "mcpServers": {
84
+ "pipeworx": {
85
+ "url": "https://gateway.pipeworx.io/mcp"
86
+ }
87
+ }
88
+ }
89
+ ```
90
+
91
+ Both URLs reach the same gateway and the same 1679+ data sources. The
92
+ only difference is which pack's tools are listed **directly**; `ask_pipeworx`
93
+ reaches all of them from either one.
94
+
95
+ ## No MCP client? Call it over HTTP
96
+
97
+ ```bash
98
+ curl -X POST https://gateway.pipeworx.io/v1/tools/openalex_search_works \
99
+ -H 'Content-Type: application/json' \
100
+ -d '{"query":"transformer neural networks"}'
101
+ ```
102
+
103
+ No account needed for the first calls. Inspect any tool: `GET https://gateway.pipeworx.io/v1/tools/openalex_search_works`. Find one: `POST https://gateway.pipeworx.io/v1/tools/search_packs` with `{"query":"..."}`.
104
+
105
+ ## Standalone (no gateway account)
106
+
107
+ This package also runs as a local stdio MCP server — no Pipeworx account, no
108
+ gateway round-trip:
109
+
110
+ ```json
111
+ {
112
+ "mcpServers": {
113
+ "openalex": {
114
+ "command": "npx",
115
+ "args": ["-y", "@pipeworx/mcp-openalex"]
116
+ }
117
+ }
118
+ }
119
+ ```
120
+
121
+ Or run it directly to confirm it starts:
15
122
 
16
123
  ```bash
17
- curl -X POST https://gateway.pipeworx.io/mcp \
18
- -H "Content-Type: application/json" \
19
- -d '{
20
- "jsonrpc": "2.0",
21
- "method": "tools/call",
22
- "params": {
23
- "name": "openalex__search_works",
24
- "arguments": { "query": "transformer neural networks", "limit": 5 }
25
- },
26
- "id": 1
27
- }'
124
+ npx -y @pipeworx/mcp-openalex
125
+ ```
126
+
127
+ It speaks MCP over stdin/stdout and answers `initialize`/`tools/list`/`tools/call`
128
+ for **only** this pack's tools — none of the shared meta-tools the gateway
129
+ connection above adds. Same source, same tools, no ask_pipeworx routing.
130
+
131
+ ## Using with ask_pipeworx
132
+
133
+ Instead of calling tools directly, you can ask questions in plain English —
134
+ this works on the pack endpoint above as well as on the full gateway:
135
+
136
+ ```
137
+ ask_pipeworx({ question: "your question about Openalex data" })
28
138
  ```
29
139
 
140
+ The gateway picks the right tool and fills the arguments automatically.
141
+
142
+ ## More
143
+
144
+ - [Docs and guides](https://pipeworx.io/docs)
145
+ - [pipeworx.io](https://pipeworx.io)
146
+
30
147
  ## License
31
148
 
32
149
  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 CHANGED
@@ -1,18 +1,32 @@
1
1
  {
2
2
  "name": "@pipeworx/mcp-openalex",
3
- "version": "0.1.0",
4
- "description": "MCP server for scholarly works, authors, and institutions via OpenAlex API",
3
+ "version": "0.1.1",
4
+ "description": "OpenAlex MCP — wraps the OpenAlex API (scholarly works, free, no auth)",
5
+ "type": "module",
5
6
  "main": "src/index.ts",
6
7
  "types": "src/index.ts",
7
- "files": ["src"],
8
- "scripts": {
9
- "build": "tsc",
10
- "check": "tsc --noEmit"
8
+ "bin": {
9
+ "mcp-openalex": "bin/cli.js"
11
10
  },
12
- "keywords": ["mcp", "mcp-server", "model-context-protocol", "pipeworx", "openalex", "academic", "scholarly", "research"],
13
- "author": "Pipeworx",
11
+ "keywords": ["mcp", "mcp-server", "model-context-protocol", "pipeworx", "openalex"],
14
12
  "license": "MIT",
13
+ "repository": {
14
+ "type": "git",
15
+ "url": "git+https://github.com/pipeworx-io/mcp-openalex.git"
16
+ },
17
+ "scripts": {
18
+ "typecheck": "tsc --noEmit"
19
+ },
20
+ "dependencies": {
21
+ "@modelcontextprotocol/sdk": "^1.30.0",
22
+ "tsx": "^4.19.0"
23
+ },
15
24
  "devDependencies": {
16
- "typescript": "^5.0.0"
25
+ "typescript": "^5.9.3",
26
+ "@cloudflare/workers-types": "^4.20260405.1"
27
+ },
28
+ "pipeworx": {
29
+ "sourceHash": "v1-2d66460ac1f15612983a703ec9f32f4566fbeeea58f930162d884e7d0f4470f1",
30
+ "sourceCommit": "adb69d997f82a62e8e22b594488c7d04a227db35"
17
31
  }
18
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/openalex",
4
+ "title": "Openalex",
5
+ "description": "OpenAlex MCP — wraps the OpenAlex API (scholarly works, free, no auth)",
6
+ "version": "0.1.1",
7
+ "websiteUrl": "https://pipeworx.io/packs/openalex",
8
+ "repository": {
9
+ "url": "https://github.com/pipeworx-io/mcp-openalex",
10
+ "source": "github"
11
+ },
12
+ "remotes": [
13
+ {
14
+ "type": "streamable-http",
15
+ "url": "https://gateway.pipeworx.io/openalex/mcp"
16
+ }
17
+ ]
18
+ }
package/src/index.ts CHANGED
@@ -1,31 +1,691 @@
1
- /**
2
- * OpenAlex MCP — wraps the OpenAlex API (scholarly works, free, no auth)
3
- *
4
- * Tools:
5
- * - search_works: search scholarly works by keyword
6
- * - search_authors: search researchers/authors by name
7
- * - search_institutions: search academic institutions by name
8
- * - get_concept: look up an academic concept/field of study
9
- */
10
-
11
1
  interface McpToolDefinition {
12
2
  name: string;
13
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;
14
8
  inputSchema: {
15
9
  type: 'object';
16
10
  properties: Record<string, unknown>;
17
11
  required?: string[];
12
+ anyOf?: Array<{ required: string[] }>;
13
+ oneOf?: Array<{ required: string[] }>;
14
+ allOf?: Array<{ required: string[] }>;
18
15
  };
16
+ outputSchema?: Record<string, unknown>;
19
17
  }
20
18
 
21
19
  interface McpToolExport {
22
20
  tools: McpToolDefinition[];
23
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;
24
208
  }
25
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 `&lt;script&gt;`
570
+ * in a title cannot decode into markup that survives — EMBL-EBI's ChEMBL 500
571
+ * page renders as `500 Internal Server Error &lt; 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(/&nbsp;/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
+ * OpenAlex MCP — wraps the OpenAlex API (scholarly works, free, no auth)
640
+ *
641
+ * Tools:
642
+ * - search_works: search scholarly works by keyword
643
+ * - search_authors: search researchers/authors by name
644
+ * - search_institutions: search academic institutions by name
645
+ * - get_concept: look up an academic concept/field of study
646
+ */
647
+
648
+
649
+ // Bound every fetch() in this pack to a fixed timeout — an upstream that
650
+ // degrades without erroring would otherwise hold the Worker in `await fetch()`
651
+ // until its own execution budget kills the request (minutes, not seconds).
652
+ // Mirrors the epoFetch / usaspending retryFetch pattern (fleet #685).
653
+ async function pwFetch(url: string | URL, init?: RequestInit): Promise<Response> {
654
+ return fetchWithTimeout(url, init ?? {}, 'Openalex');
655
+ }
656
+
657
+
26
658
  const BASE = 'https://api.openalex.org';
27
659
 
28
- // -- API Response Types --
660
+ // OpenAlex grants priority pool access to requests that identify themselves.
661
+ // See https://docs.openalex.org/how-to-use-the-api/rate-limits-and-authentication
662
+ const POLITE_EMAIL = 'support@pipeworx.io';
663
+ const USER_AGENT = `Pipeworx (mailto:${POLITE_EMAIL})`;
664
+
665
+ // The key is THREADED, never held in module scope: a Worker isolate serves
666
+ // concurrent requests, so a shared mutable "current key" could hand one caller's
667
+ // BYO key to another caller's request.
668
+ async function openAlexFetch(path: string, params: URLSearchParams, apiKey?: string): Promise<Response> {
669
+ params.set('mailto', POLITE_EMAIL);
670
+ // Keyless requests are metered PER IP, and ours is a shared Cloudflare egress
671
+ // that other tenants exhaust — hence "Insufficient budget ... $0 remaining"
672
+ // from the gateway while the identical call succeeds from a laptop (verified
673
+ // both ways 2026-08-08). An authenticated key bills our own account instead.
674
+ if (apiKey) params.set('api_key', apiKey);
675
+ const url = `${BASE}${path}?${params}`;
676
+
677
+ // One retry on 429 (rare in the polite pool, but be a good citizen if it happens)
678
+ for (let attempt = 0; attempt < 2; attempt++) {
679
+ const res = await pwFetch(url, { headers: { 'User-Agent': USER_AGENT } });
680
+ if (res.status !== 429) return res;
681
+ const retryAfter = Number(res.headers.get('retry-after') ?? '1');
682
+ await new Promise((r) => setTimeout(r, Math.min(2000, Math.max(500, retryAfter * 1000))));
683
+ }
684
+ // Final attempt without further retry
685
+ return pwFetch(url, { headers: { 'User-Agent': USER_AGENT } });
686
+ }
687
+
688
+ // ── API Response Types ────────────────────────────────────────────────
29
689
 
30
690
  type OpenAlexMeta = {
31
691
  count: number;
@@ -87,7 +747,15 @@ type OpenAlexInstitution = {
87
747
  works_count: number;
88
748
  cited_by_count: number;
89
749
  homepage_url: string | null;
90
- x_concepts: OpenAlexConcept[];
750
+ // OpenAlex dropped `x_concepts` from the institutions response entirely
751
+ // (still present on /authors, absent here — verified live 2026-09-07) in
752
+ // favour of `topics`. Calling .slice() on the missing field threw
753
+ // "Cannot read properties of undefined (reading 'slice')" on every single
754
+ // institutions call. Both are optional here; the mapper below prefers the
755
+ // current field and falls back rather than crashing if OpenAlex reshuffles
756
+ // again.
757
+ x_concepts?: OpenAlexConcept[];
758
+ topics?: Array<{ display_name: string }>;
91
759
  };
92
760
 
93
761
  type OpenAlexConceptFull = {
@@ -106,7 +774,7 @@ type OpenAlexListResponse<T> = {
106
774
  results: T[];
107
775
  };
108
776
 
109
- // -- Helpers --
777
+ // ── Helpers ───────────────────────────────────────────────────────────
110
778
 
111
779
  /**
112
780
  * Reconstruct abstract from OpenAlex's inverted index format.
@@ -135,23 +803,27 @@ function mapWork(w: OpenAlexWork) {
135
803
  oa_url: w.open_access?.oa_url ?? null,
136
804
  cited_by_count: w.cited_by_count,
137
805
  journal: w.primary_location?.source?.display_name ?? null,
138
- authors: w.authorships.map((a) => a.author.display_name),
139
- concepts: w.concepts.slice(0, 5).map((c) => c.display_name),
806
+ // Defensive for the same reason: these are arrays today, but `concepts` is
807
+ // part of the deprecated surface and one field going null takes down every
808
+ // work-returning tool at once.
809
+ authors: (w.authorships ?? []).map((a) => a.author.display_name),
810
+ concepts: (w.concepts ?? []).slice(0, 5).map((c) => c.display_name),
140
811
  abstract: reconstructAbstract(w.abstract_inverted_index),
141
812
  };
142
813
  }
143
814
 
144
- // -- Tool Definitions --
815
+ // ── Tool Definitions ──────────────────────────────────────────────────
145
816
 
146
817
  const tools: McpToolExport['tools'] = [
147
818
  {
148
819
  name: 'search_works',
149
820
  description:
150
- 'Search scholarly works (papers, books, datasets) in the OpenAlex index. Returns title, authors, journal, year, citation count, and abstract.',
821
+ 'Search scholarly/academic research across ALL fields — medicine, biology, neuroscience, genetics, chemistry, physics, materials science, computer science, economics, and beyond. Find recent studies, papers, and findings on any topic, gene, disease, drug, material, method, or theory by title, author, or keyword — e.g. "latest research on Kv7 potassium channels in epilepsy", "recent studies on semaglutide", "what has been published on X". Returns title, authors, journal, publication year, citation count, and abstract.',
151
822
  inputSchema: {
152
823
  type: 'object',
153
824
  properties: {
154
825
  query: { type: 'string', description: 'Search query (e.g., "transformer neural networks")' },
826
+ _apiKey: { type: 'string', description: 'OpenAlex API key. Optional — Pipeworx supplies one; pass your own to bill your account instead.' },
155
827
  limit: {
156
828
  type: 'number',
157
829
  description: 'Number of results to return (1-25, default 10)',
@@ -163,11 +835,12 @@ const tools: McpToolExport['tools'] = [
163
835
  {
164
836
  name: 'search_authors',
165
837
  description:
166
- 'Search researchers and authors by name in OpenAlex. Returns display name, ORCID, institution, works count, and citation count.',
838
+ 'Find researchers by name or institution affiliation. Returns author name, ORCID, institution, publication count, and total citations.',
167
839
  inputSchema: {
168
840
  type: 'object',
169
841
  properties: {
170
842
  query: { type: 'string', description: 'Author name to search for (e.g., "Yoshua Bengio")' },
843
+ _apiKey: { type: 'string', description: 'OpenAlex API key. Optional — Pipeworx supplies one; pass your own to bill your account instead.' },
171
844
  limit: {
172
845
  type: 'number',
173
846
  description: 'Number of results to return (1-25, default 10)',
@@ -179,11 +852,12 @@ const tools: McpToolExport['tools'] = [
179
852
  {
180
853
  name: 'search_institutions',
181
854
  description:
182
- 'Search academic institutions (universities, research labs) by name in OpenAlex. Returns name, country, type, works count, and top concepts.',
855
+ 'Find academic institutions by name or location (e.g., country code \'US\', \'GB\'). Returns institution name, country, type, publication count, and research areas.',
183
856
  inputSchema: {
184
857
  type: 'object',
185
858
  properties: {
186
859
  query: { type: 'string', description: 'Institution name to search for (e.g., "MIT")' },
860
+ _apiKey: { type: 'string', description: 'OpenAlex API key. Optional — Pipeworx supplies one; pass your own to bill your account instead.' },
187
861
  limit: {
188
862
  type: 'number',
189
863
  description: 'Number of results to return (1-25, default 10)',
@@ -195,25 +869,37 @@ const tools: McpToolExport['tools'] = [
195
869
  {
196
870
  name: 'get_concept',
197
871
  description:
198
- 'Look up an academic concept or field of study by name. Returns description, works count, related concepts, and ancestor concepts in the hierarchy.',
872
+ 'Look up research fields or topics by name. Returns concept description, publication count, related concepts, and parent concepts in the academic hierarchy.',
199
873
  inputSchema: {
200
874
  type: 'object',
201
875
  properties: {
202
876
  query: { type: 'string', description: 'Concept name to look up (e.g., "deep learning")' },
877
+ _apiKey: { type: 'string', description: 'OpenAlex API key. Optional — Pipeworx supplies one; pass your own to bill your account instead.' },
203
878
  },
204
879
  required: ['query'],
205
880
  },
206
881
  },
882
+ {
883
+ name: 'get_scholarly_work',
884
+ description:
885
+ 'Fetch a single scholarly work from OpenAlex by its OpenAlex ID (e.g. "W2741809807") or DOI (e.g. "10.1038/s41586-021-03819-2"). Returns the full record + reconstructed abstract and the works it CITES (referenced_works) — for backward citation-graph navigation. Use after search_works, or whenever you have a DOI/ID. (Named get_scholarly_work to avoid colliding with Crossref get_work.)',
886
+ inputSchema: {
887
+ type: 'object',
888
+ properties: {
889
+ id: { type: 'string', description: 'OpenAlex work ID ("W...") or a DOI ("10.xxxx/yyyy" or a full doi.org URL).' },
890
+ _apiKey: { type: 'string', description: 'OpenAlex API key. Optional — Pipeworx supplies one; pass your own to bill your account instead.' },
891
+ },
892
+ required: ['id'],
893
+ },
894
+ },
207
895
  ];
208
896
 
209
- // -- Tool Implementations --
897
+ // ── Tool Implementations ──────────────────────────────────────────────
210
898
 
211
- async function searchWorks(query: string, limit: number) {
899
+ async function searchWorks(query: string, limit: number, apiKey?: string) {
212
900
  const perPage = Math.min(25, Math.max(1, limit));
213
- const params = new URLSearchParams({ search: query, per_page: String(perPage) });
214
-
215
- const res = await fetch(`${BASE}/works?${params}`);
216
- if (!res.ok) throw new Error(`OpenAlex works search error: ${res.status}`);
901
+ const res = await openAlexFetch('/works', new URLSearchParams({ search: query, per_page: String(perPage) }), apiKey);
902
+ if (!res.ok) throw await httpError(res, 'OpenAlex works search error');
217
903
 
218
904
  const data = (await res.json()) as OpenAlexListResponse<OpenAlexWork>;
219
905
 
@@ -223,12 +909,10 @@ async function searchWorks(query: string, limit: number) {
223
909
  };
224
910
  }
225
911
 
226
- async function searchAuthors(query: string, limit: number) {
912
+ async function searchAuthors(query: string, limit: number, apiKey?: string) {
227
913
  const perPage = Math.min(25, Math.max(1, limit));
228
- const params = new URLSearchParams({ search: query, per_page: String(perPage) });
229
-
230
- const res = await fetch(`${BASE}/authors?${params}`);
231
- if (!res.ok) throw new Error(`OpenAlex authors search error: ${res.status}`);
914
+ const res = await openAlexFetch('/authors', new URLSearchParams({ search: query, per_page: String(perPage) }), apiKey);
915
+ if (!res.ok) throw await httpError(res, 'OpenAlex authors search error');
232
916
 
233
917
  const data = (await res.json()) as OpenAlexListResponse<OpenAlexAuthor>;
234
918
 
@@ -247,12 +931,10 @@ async function searchAuthors(query: string, limit: number) {
247
931
  };
248
932
  }
249
933
 
250
- async function searchInstitutions(query: string, limit: number) {
934
+ async function searchInstitutions(query: string, limit: number, apiKey?: string) {
251
935
  const perPage = Math.min(25, Math.max(1, limit));
252
- const params = new URLSearchParams({ search: query, per_page: String(perPage) });
253
-
254
- const res = await fetch(`${BASE}/institutions?${params}`);
255
- if (!res.ok) throw new Error(`OpenAlex institutions search error: ${res.status}`);
936
+ const res = await openAlexFetch('/institutions', new URLSearchParams({ search: query, per_page: String(perPage) }), apiKey);
937
+ if (!res.ok) throw await httpError(res, 'OpenAlex institutions search error');
256
938
 
257
939
  const data = (await res.json()) as OpenAlexListResponse<OpenAlexInstitution>;
258
940
 
@@ -267,54 +949,92 @@ async function searchInstitutions(query: string, limit: number) {
267
949
  works_count: i.works_count,
268
950
  cited_by_count: i.cited_by_count,
269
951
  homepage_url: i.homepage_url ?? null,
270
- top_concepts: i.x_concepts.slice(0, 5).map((c) => c.display_name),
952
+ top_concepts: (i.topics ?? i.x_concepts ?? []).slice(0, 5).map((c) => c.display_name),
271
953
  })),
272
954
  };
273
955
  }
274
956
 
275
- async function getConcept(query: string) {
276
- const params = new URLSearchParams({ search: query, per_page: '1' });
277
-
278
- const res = await fetch(`${BASE}/concepts?${params}`);
279
- if (!res.ok) throw new Error(`OpenAlex concepts search error: ${res.status}`);
957
+ async function getConcept(query: string, apiKey?: string) {
958
+ const res = await openAlexFetch('/concepts', new URLSearchParams({ search: query, per_page: '1' }), apiKey);
959
+ if (!res.ok) throw await httpError(res, 'OpenAlex concepts search error');
280
960
 
281
961
  const data = (await res.json()) as OpenAlexListResponse<OpenAlexConceptFull>;
282
962
 
283
963
  if (data.results.length === 0) {
284
- throw new Error(`No concept found for: "${query}"`);
964
+ return { query, found: false };
285
965
  }
286
966
 
287
967
  const c = data.results[0];
288
968
 
289
969
  return {
970
+ query,
971
+ found: true,
290
972
  id: c.id,
291
973
  display_name: c.display_name,
292
974
  level: c.level,
293
975
  description: c.description ?? null,
294
976
  works_count: c.works_count,
295
977
  cited_by_count: c.cited_by_count,
296
- ancestors: c.ancestors.map((a) => ({ name: a.display_name, level: a.level })),
297
- related_concepts: c.related_concepts
978
+ // OpenAlex deprecated Concepts in favour of Topics and now returns
979
+ // ancestors/related_concepts as NULL rather than []. Calling .map on that
980
+ // threw, and the gateway rewrites any "Cannot read properties of null" into
981
+ // "received an invalid argument", so a dead upstream field surfaced to
982
+ // callers as THEIR mistake — the tool looked like it was rejecting a
983
+ // perfectly good `query` (#174). Verified 2026-08-10: /concepts returns
984
+ // ancestors:null, related_concepts:null.
985
+ ancestors: (c.ancestors ?? []).map((a) => ({ name: a.display_name, level: a.level })),
986
+ related_concepts: (c.related_concepts ?? [])
298
987
  .slice(0, 10)
299
988
  .map((r) => ({ name: r.display_name, level: r.level, score: r.score })),
300
989
  };
301
990
  }
302
991
 
303
- // -- Dispatcher --
992
+ // Resolve an OpenAlex work id from a W-id, DOI, or doi.org/openalex URL.
993
+ function resolveWorkId(raw: string): string {
994
+ const s = String(raw ?? '').trim();
995
+ if (!s) throw new Error('Required argument "id" is missing (an OpenAlex W-id like "W2741809807" or a DOI like "10.1038/...").');
996
+ const doiM = s.match(/10\.\d{4,9}\/[^\s?#]+/);
997
+ if (doiM) return 'doi:' + doiM[0];
998
+ const wM = s.match(/W\d+/);
999
+ if (wM) return wM[0];
1000
+ return s;
1001
+ }
1002
+
1003
+ async function getWork(id: string, apiKey?: string) {
1004
+ const wid = resolveWorkId(id);
1005
+ // Do NOT encodeURIComponent: OpenAlex needs the colon + DOI slashes intact in the path (e.g. /works/doi:10.1038/...).
1006
+ const res = await openAlexFetch(`/works/${wid}`, new URLSearchParams(), apiKey);
1007
+ if (res.status === 404) return { id, resolved: wid, error: 'not_found', message: `No OpenAlex work for "${id}".` };
1008
+ if (!res.ok) throw await httpError(res, 'OpenAlex work fetch error');
1009
+ const w = (await res.json()) as OpenAlexWork & { referenced_works?: string[] };
1010
+ const refs = Array.isArray(w.referenced_works) ? w.referenced_works : [];
1011
+ const shortId = (w.id ?? '').split('/').pop() ?? '';
1012
+
1013
+ return {
1014
+ ...mapWork(w),
1015
+ references_count: refs.length,
1016
+ references: refs.slice(0, 50),
1017
+ };
1018
+ }
1019
+
1020
+ // ── Dispatcher ────────────────────────────────────────────────────────
304
1021
 
305
1022
  async function callTool(name: string, args: Record<string, unknown>): Promise<unknown> {
1023
+ const apiKey = typeof args._apiKey === 'string' && args._apiKey.trim() ? args._apiKey.trim() : undefined;
306
1024
  switch (name) {
307
1025
  case 'search_works':
308
- return searchWorks(args.query as string, (args.limit as number) ?? 10);
1026
+ return searchWorks(args.query as string, (args.limit as number) ?? 10, apiKey);
309
1027
  case 'search_authors':
310
- return searchAuthors(args.query as string, (args.limit as number) ?? 10);
1028
+ return searchAuthors(args.query as string, (args.limit as number) ?? 10, apiKey);
311
1029
  case 'search_institutions':
312
- return searchInstitutions(args.query as string, (args.limit as number) ?? 10);
1030
+ return searchInstitutions(args.query as string, (args.limit as number) ?? 10, apiKey);
313
1031
  case 'get_concept':
314
- return getConcept(args.query as string);
1032
+ return getConcept(args.query as string, apiKey);
1033
+ case 'get_scholarly_work':
1034
+ return getWork(args.id as string, apiKey);
315
1035
  default:
316
1036
  throw new Error(`Unknown tool: ${name}`);
317
1037
  }
318
1038
  }
319
1039
 
320
- export default { tools, callTool } satisfies McpToolExport;
1040
+ export default { tools, callTool, meter: { credits: 5 } } satisfies McpToolExport;
package/src/server.ts ADDED
@@ -0,0 +1,45 @@
1
+ /**
2
+ * Stdio MCP server entry point for @pipeworx/mcp-openalex.
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-openalex', version: '0.1.1' },
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
+ }