@cyanheads/openalex-mcp-server 0.7.16 → 0.9.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/AGENTS.md +48 -33
- package/CLAUDE.md +48 -33
- package/Dockerfile +98 -33
- package/README.md +23 -16
- package/changelog/0.8.x/0.8.0.md +38 -0
- package/changelog/0.9.x/0.9.0.md +48 -0
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/dist/mcp-server/prompts/definitions/literature-review.prompt.js +1 -1
- package/dist/mcp-server/prompts/definitions/research-landscape.prompt.js +1 -1
- package/dist/mcp-server/tools/definitions/analyze-trends.tool.d.ts +28 -3
- package/dist/mcp-server/tools/definitions/analyze-trends.tool.d.ts.map +1 -1
- package/dist/mcp-server/tools/definitions/analyze-trends.tool.js +57 -10
- package/dist/mcp-server/tools/definitions/analyze-trends.tool.js.map +1 -1
- package/dist/mcp-server/tools/definitions/citation-graph.tool.d.ts +62 -5
- package/dist/mcp-server/tools/definitions/citation-graph.tool.d.ts.map +1 -1
- package/dist/mcp-server/tools/definitions/citation-graph.tool.js +100 -52
- package/dist/mcp-server/tools/definitions/citation-graph.tool.js.map +1 -1
- package/dist/mcp-server/tools/definitions/describe-fields.tool.d.ts.map +1 -1
- package/dist/mcp-server/tools/definitions/describe-fields.tool.js +34 -4
- package/dist/mcp-server/tools/definitions/describe-fields.tool.js.map +1 -1
- package/dist/mcp-server/tools/definitions/resolve-name.tool.d.ts +38 -2
- package/dist/mcp-server/tools/definitions/resolve-name.tool.d.ts.map +1 -1
- package/dist/mcp-server/tools/definitions/resolve-name.tool.js +176 -41
- package/dist/mcp-server/tools/definitions/resolve-name.tool.js.map +1 -1
- package/dist/mcp-server/tools/definitions/search-entities.tool.d.ts +75 -4
- package/dist/mcp-server/tools/definitions/search-entities.tool.d.ts.map +1 -1
- package/dist/mcp-server/tools/definitions/search-entities.tool.js +169 -73
- package/dist/mcp-server/tools/definitions/search-entities.tool.js.map +1 -1
- package/dist/mcp-server/tools/render-budget.d.ts +4 -2
- package/dist/mcp-server/tools/render-budget.d.ts.map +1 -1
- package/dist/mcp-server/tools/render-budget.js +4 -2
- package/dist/mcp-server/tools/render-budget.js.map +1 -1
- package/dist/mcp-server/tools/render-entity-record.d.ts +12 -1
- package/dist/mcp-server/tools/render-entity-record.d.ts.map +1 -1
- package/dist/mcp-server/tools/render-entity-record.js +23 -8
- package/dist/mcp-server/tools/render-entity-record.js.map +1 -1
- package/dist/mcp-server/tools/response-budget.d.ts +160 -0
- package/dist/mcp-server/tools/response-budget.d.ts.map +1 -0
- package/dist/mcp-server/tools/response-budget.js +489 -0
- package/dist/mcp-server/tools/response-budget.js.map +1 -0
- package/dist/services/openalex/budget.d.ts +3 -1
- package/dist/services/openalex/budget.d.ts.map +1 -1
- package/dist/services/openalex/budget.js +3 -1
- package/dist/services/openalex/budget.js.map +1 -1
- package/dist/services/openalex/field-catalog.json +50 -1
- package/dist/services/openalex/filter-values.d.ts +46 -0
- package/dist/services/openalex/filter-values.d.ts.map +1 -0
- package/dist/services/openalex/filter-values.js +294 -0
- package/dist/services/openalex/filter-values.js.map +1 -0
- package/dist/services/openalex/iso-codes.json +1565 -0
- package/dist/services/openalex/openalex-service.d.ts +181 -16
- package/dist/services/openalex/openalex-service.d.ts.map +1 -1
- package/dist/services/openalex/openalex-service.js +593 -141
- package/dist/services/openalex/openalex-service.js.map +1 -1
- package/dist/services/openalex/provider-text.d.ts +13 -5
- package/dist/services/openalex/provider-text.d.ts.map +1 -1
- package/dist/services/openalex/provider-text.js +799 -51
- package/dist/services/openalex/provider-text.js.map +1 -1
- package/dist/services/openalex/types.d.ts +1 -1
- package/dist/services/openalex/types.js +1 -1
- package/package.json +16 -13
- package/server.json +10 -24
package/AGENTS.md
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
# Developer Protocol
|
|
2
2
|
|
|
3
3
|
**Server:** openalex-mcp-server
|
|
4
|
-
**Version:** 0.
|
|
5
|
-
**Framework:** [@cyanheads/mcp-ts-core](https://www.npmjs.com/package/@cyanheads/mcp-ts-core) `^0.13.
|
|
4
|
+
**Version:** 0.9.0
|
|
5
|
+
**Framework:** [@cyanheads/mcp-ts-core](https://www.npmjs.com/package/@cyanheads/mcp-ts-core) `^0.13.15`
|
|
6
6
|
**Engines:** Bun ≥1.4.0, Node ≥24.0.0
|
|
7
|
-
**MCP SDK:** `@modelcontextprotocol/server` ^2.
|
|
8
|
-
**Zod:** ^4.6.
|
|
7
|
+
**MCP SDK:** `@modelcontextprotocol/server` ^2.3.1
|
|
8
|
+
**Zod:** ^4.6.7
|
|
9
9
|
|
|
10
10
|
> **Read the framework docs first:** `node_modules/@cyanheads/mcp-ts-core/CLAUDE.md` contains the full API reference — builders, Context, error codes, exports, patterns. This file covers server-specific conventions only.
|
|
11
11
|
|
|
@@ -151,15 +151,15 @@ Handlers receive a unified `ctx` object. Key properties:
|
|
|
151
151
|
| Property | Description |
|
|
152
152
|
|:---------|:------------|
|
|
153
153
|
| `ctx.log` | Request-scoped logger — `.debug()`, `.info()`, `.notice()`, `.warning()`, `.error()`. Auto-correlates requestId, traceId, tenantId. Dual-sink: Pino **and** `notifications/message` to the client, so treat it as client-visible. |
|
|
154
|
-
| `ctx.state` | Tenant-scoped KV — `.get(key)`, `.set(key, value, { ttl? })`, `.delete(key)`, `.getMany(keys)`, `.list(prefix, { cursor, limit })`. Accepts any serializable value. |
|
|
154
|
+
| `ctx.state` | Tenant-scoped KV — `.get(key)`, `.set(key, value, { ttl? })`, `.delete(key)`, `.getMany(keys)`, `.list(prefix, { cursor, limit })`. Accepts any JSON-serializable value; reads return its JSON form (a `Date` comes back as an ISO string). |
|
|
155
155
|
| `ctx.requestInput` | Suspend and ask the caller for more input with `return ctx.requestInput(...)`; the handler is re-entered with answers. |
|
|
156
|
-
| `ctx.inputs` |
|
|
157
|
-
| `ctx.
|
|
158
|
-
| `ctx.
|
|
156
|
+
| `ctx.inputs` | The request's responses — `.accepted(key, schema)`, `.view(key)`, `.state()`, `.dropped` — limited to what the client declared (`elicitation` and its form/url modes, `sampling`, `roots`). Client-supplied: a consent gate trusts only a `ctx.state` record it stored when it asked, bound to the operation, caller, and target (see the `api-context` skill). |
|
|
157
|
+
| `ctx.clientCapabilities` | What the client declared for this request, `undefined` when no view exists. Decides whether to ask for optional context (e.g. roots); never a reason to skip a consent prompt. |
|
|
158
|
+
| `ctx.enrich` | Success-path agent context (empty-result notices, query echo, pagination totals) — `ctx.enrich(...)` or `.notice()` / `.total()` / `.echo()` / `.truncated()`. Reaches `structuredContent` and `content[]`; lands only when the definition declares an `enrichment` block (no-op otherwise). |
|
|
159
|
+
| `ctx.content` | Non-text content blocks — `.image(data, mimeType)`, `.audio(data, mimeType)`, or `ctx.content(block)` for a raw block. Prepended to `content[]` after `format()`; never enters `structuredContent`. |
|
|
159
160
|
| `ctx.signal` | `AbortSignal` for cancellation. Passed to `withRetry` in the OpenAlex service, whose per-attempt signal reaches `fetch()`. |
|
|
160
161
|
| `ctx.fail` | Typed throw keyed by a declared `errors[]` contract — `ctx.fail(reason, msg?, data?)`. Auto-populates `data.reason` and resolves `code` from the contract. |
|
|
161
|
-
| `ctx.
|
|
162
|
-
| `ctx.requestId` | Unique request ID. |
|
|
162
|
+
| `ctx.requestId` | Request ID — the one every log record of the call carries and its error envelope returns as `data.requestId`. |
|
|
163
163
|
| `ctx.tenantId` | `'default'` for stdio and `MCP_AUTH_MODE=none` over HTTP; JWT `tid` claim for `MCP_AUTH_MODE=jwt`/`oauth`. |
|
|
164
164
|
|
|
165
165
|
---
|
|
@@ -168,7 +168,7 @@ Handlers receive a unified `ctx` object. Key properties:
|
|
|
168
168
|
|
|
169
169
|
Handlers throw — the framework catches, classifies, and formats.
|
|
170
170
|
|
|
171
|
-
**Recommended: typed error contract.** Declare `errors: [{ reason, code, when, recovery, retryable?, thrownBy? }]` on `tool()` to receive
|
|
171
|
+
**Recommended: typed error contract.** Declare `errors: [{ reason, code, when, recovery, retryable?, severity?, thrownBy? }]` on `tool()` / `resource()` to receive `ctx.fail(reason, …)` typed against the reason union. TypeScript catches typos at compile time, `data.reason` is auto-populated for observability, linter enforces conformance against the handler body. `recovery` is required (≥ 5 words, lint-validated) — the single source of truth for the agent's next move. The framework puts it on the wire whenever a failure carrying that `reason` arrives without a hint — a bare `ctx.fail('reason')` or a service throw with `data: { reason }` — as `data.recovery.hint`, mirrored into `content[]` text unless the message already contains it verbatim; override with an explicit `{ recovery: { hint: '...' } }` when dynamic runtime context matters. Every error envelope also carries `data.requestId`, the id the server's log records for that call carry, and `content[]` closes with `(reason … · request <id>)`. Mark an entry the service layer throws with `thrownBy: 'service'` so `error-contract-unthrown` skips it — lint-only metadata, nothing at runtime reads it. Baseline codes (`InternalError`, `ServiceUnavailable`, `Timeout`, `ValidationError`, `SerializationError`, `RequestCancelled`) bubble freely and don't need declaring.
|
|
172
172
|
|
|
173
173
|
```ts
|
|
174
174
|
import { JsonRpcErrorCode } from '@cyanheads/mcp-ts-core/errors';
|
|
@@ -183,13 +183,13 @@ errors: [
|
|
|
183
183
|
thrownBy: 'service' },
|
|
184
184
|
],
|
|
185
185
|
async handler(input, ctx) {
|
|
186
|
-
if (overCap) throw ctx.fail('semantic_per_page_cap', message
|
|
186
|
+
if (overCap) throw ctx.fail('semantic_per_page_cap', message);
|
|
187
187
|
}
|
|
188
188
|
```
|
|
189
189
|
|
|
190
190
|
**Declare contracts inline on each tool, even when similar across tools.** The contract is part of the tool's documented public surface — reading one tool definition file should give the full picture. Don't extract a shared `errors[]` constant; per-tool repetition is the intended cost of locality.
|
|
191
191
|
|
|
192
|
-
The OpenAlex service throws factory errors (`notFound`, `rateLimited`, etc.) based on upstream status codes, carrying the contract `reason` on `data.reason` and the recovery
|
|
192
|
+
The OpenAlex service throws factory errors (`notFound`, `rateLimited`, etc.) based on upstream status codes, carrying the contract `reason` on `data.reason` and nothing else of the contract; the framework fills the calling tool's `recovery` for that reason at the handler boundary, and the errors bubble through and are auto-classified. Three service throws set their own `recovery: { hint }`, which wins over the fill: the PMCID 404, since the generic "verify the ID" recovery would send the caller back to retry an identifier OpenAlex never indexes; `upstream_budget_exhausted` on a server with no `OPENALEX_API_KEY`, whose hint adds the free-key advice to the contract's key-neutral midnight-UTC recovery (a keyed server's budget is already the larger one, so it gets the contract text alone); and `upstream_unavailable` on a semantic search — including the HTTP 400 `Failed to embed query:` and `Semantic search is not configured` bodies, relabelled from caller errors to that outage — whose hint adds the keyword-search fallback the generic outage recovery cannot name. One status is read past its code: an HTTP 429 whose body `error` is `Plan upgrade required` — a filter OpenAlex serves only on a paid plan — is thrown as `Forbidden` with `upstream_plan_required` and `retryable: false` under a message of the server's own, so it fails on its first request — no wait clears a plan gate. Every service-thrown entry carries `thrownBy: 'service'` — lint-only metadata that tells `error-contract-unthrown`, whose scan reads the handler body alone, to skip a reason produced a layer below it. Handler-local precondition throws stay inline and unmarked so the rule keeps checking them: `semantic_without_query`, `semantic_per_page_cap`, `semantic_with_cursor`, `page_without_semantic`, `sample_with_cursor`, `sample_with_page`, `sample_with_semantic`, `sample_with_sort`, `seed_without_sample`, `slice_without_id`, and `slice_field_not_array` on `openalex_search_entities`; `reserved_filter_key` and the seed-lookup `entity_not_found` on `openalex_get_citation_graph`; `filters_without_entity_type` on `openalex_resolve_name`. Recovery assertions belong on the contract path (`runToolContract`), where the fill applies — a direct `definition.handler(...)` or service throw carries only what the throw site wrote.
|
|
193
193
|
|
|
194
194
|
**Fallback for ad-hoc throws:** error factories or plain `Error`.
|
|
195
195
|
|
|
@@ -210,17 +210,31 @@ See framework CLAUDE.md for the full auto-classification table and all available
|
|
|
210
210
|
src/
|
|
211
211
|
index.ts # createApp() entry point
|
|
212
212
|
config/
|
|
213
|
-
server-config.ts # OPENALEX_API_KEY, OPENALEX_BASE_URL
|
|
213
|
+
server-config.ts # OPENALEX_API_KEY, OPENALEX_MAILTO, OPENALEX_BASE_URL
|
|
214
214
|
services/
|
|
215
215
|
openalex/
|
|
216
216
|
openalex-service.ts # API client (init/accessor pattern)
|
|
217
217
|
types.ts # Domain types
|
|
218
|
+
filter-values.ts # Filter values as OpenAlex reads them: country/language codes, quoted multi-word names, `+` as AND
|
|
219
|
+
iso-codes.json # ISO 3166-1 / 639-2 lookups (generated by scripts/generate-iso-codes.ts)
|
|
220
|
+
provider-text.ts # Cleanup of provider text: entities, markup, MathType blobs
|
|
221
|
+
html-entities.json # WHATWG named-entity table provider-text.ts decodes against
|
|
222
|
+
field-catalog.json # Valid filter/select fields per entity type (generated by scripts/generate-field-catalog.ts)
|
|
223
|
+
field-ranker.ts # Similarity ranking for field suggestions
|
|
224
|
+
budget.ts # Per-call OpenAlex budget from the X-RateLimit-* headers
|
|
225
|
+
url-redaction.ts # Strips api_key/mailto from URLs in error text
|
|
218
226
|
mcp-server/
|
|
227
|
+
tools/
|
|
228
|
+
escape-markdown.ts # Markdown escaping for provider text in content[]
|
|
229
|
+
render-entity-record.ts # Entity records as content[] markdown
|
|
230
|
+
render-budget.ts # The budget trailer line
|
|
231
|
+
response-budget.ts # 64,000-byte response budget and its disclosures
|
|
219
232
|
tools/definitions/
|
|
220
233
|
search-entities.tool.ts # openalex_search_entities
|
|
221
234
|
analyze-trends.tool.ts # openalex_analyze_trends
|
|
222
235
|
resolve-name.tool.ts # openalex_resolve_name
|
|
223
236
|
citation-graph.tool.ts # openalex_get_citation_graph
|
|
237
|
+
describe-fields.tool.ts # openalex_describe_fields
|
|
224
238
|
prompts/definitions/
|
|
225
239
|
literature-review.prompt.ts # openalex_literature_review
|
|
226
240
|
research-landscape.prompt.ts # openalex_research_landscape
|
|
@@ -241,9 +255,9 @@ src/
|
|
|
241
255
|
|
|
242
256
|
## Skills
|
|
243
257
|
|
|
244
|
-
Skills are modular instructions in `framework-skills/` at the project root. Read them directly when a task matches — e.g., `framework-skills/add-tool/SKILL.md` when adding a tool. `bun run list-skills` prints the full registry. The directory is deliberately not `skills/`: Claude Code and Codex auto-load a plugin's root `skills/`, so a server that ships `.claude-plugin/` or `.codex-plugin/` would hand these development skills to every agent that installs it.
|
|
258
|
+
Skills are modular instructions in `framework-skills/` at the project root. Read them directly when a task matches — e.g., `framework-skills/add-tool/SKILL.md` when adding a tool. `bun run list-skills` prints the full registry. The directory is deliberately not `skills/`: Claude Code and Codex auto-load a plugin's root `skills/`, so a server that ships `.claude-plugin/` or `.codex-plugin/` would hand these development skills to every agent that installs it. Keep `skills/` free for skills meant for those agents.
|
|
245
259
|
|
|
246
|
-
**Agent skill directory:** Copy skills into the directory your agent discovers (Claude Code: `.claude/skills/`, others: equivalent).
|
|
260
|
+
**Agent skill directory:** Copy skills into the directory your agent discovers (Claude Code: `.claude/skills/`, others: equivalent). Skills then load as context without referencing `framework-skills/` paths. After framework updates, run the `maintenance` skill — Phase B re-syncs the agent directory.
|
|
247
261
|
|
|
248
262
|
Available skills:
|
|
249
263
|
|
|
@@ -259,29 +273,29 @@ Available skills:
|
|
|
259
273
|
| `add-test` | Scaffold test file for a tool, resource, or service |
|
|
260
274
|
| `field-test` | Exercise tools/resources/prompts with real inputs, verify behavior, report issues |
|
|
261
275
|
| `tool-defs-analysis` | Read-only audit of MCP definition language across the surface — voice, leaks, defaults, recovery hints, output descriptions |
|
|
262
|
-
| `security-pass` | Audit
|
|
276
|
+
| `security-pass` | Audit server for MCP-flavored security gaps: output injection, scope blast radius, input sinks, tenant isolation |
|
|
263
277
|
| `code-simplifier` | Post-session cleanup against `git diff` — modernize syntax, consolidate duplication, align with the codebase |
|
|
264
|
-
| `techniques` | Reusable response/data-shaping patterns — overflow handling, payload shaping, retrieval |
|
|
265
278
|
| `polish-docs-meta` | Finalize docs, README, metadata, and agent protocol for shipping |
|
|
266
|
-
| `git-wrapup` |
|
|
267
|
-
| `release-pr-review` | Review an open release PR
|
|
268
|
-
| `release-and-publish` |
|
|
279
|
+
| `git-wrapup` | Land working-tree changes as a commit stack — version bump, changelog, verify, commit by concern, release commit on top. No tag, no push to main; opens the release PR when the project declares release PR mode |
|
|
280
|
+
| `release-pr-review` | Review pass on an open release PR — simplifier + correctness review, fixes as ordinary commits on top of the stack, PR body kept in sync. Release PR mode only |
|
|
281
|
+
| `release-and-publish` | Fast-forward merge (release PR mode) + tag + push + npm + MCP Registry + GH Release + Docker. Picks up from `git-wrapup` |
|
|
269
282
|
| `maintenance` | Investigate changelogs, adopt upstream changes, sync skills to agent dirs |
|
|
270
283
|
| `orchestrations` | Chain task skills into a gated multi-phase pipeline — build-out, QA-fix, update-ship — when you can spawn sub-agents |
|
|
271
|
-
| `report-issue-framework` | File a bug or feature request against `@cyanheads/mcp-ts-core` |
|
|
272
|
-
| `report-issue-local` | File a bug or feature request against this server's own repo |
|
|
284
|
+
| `report-issue-framework` | File a bug or feature request against `@cyanheads/mcp-ts-core` via `gh` CLI |
|
|
285
|
+
| `report-issue-local` | File a bug or feature request against this server's own repo via `gh` CLI |
|
|
286
|
+
| `techniques` | Catalog of response/data-shaping techniques — overflow handling, payload shaping, retrieval patterns |
|
|
273
287
|
| `api-auth` | Auth modes, scopes, JWT/OAuth |
|
|
274
|
-
| `api-canvas` | DataCanvas: register tabular data, run SQL, export, plus the `spillover()` helper — Tier 3 opt-in |
|
|
288
|
+
| `api-canvas` | DataCanvas: register tabular data, run SQL, export, plus the `spillover()` helper for big result sets — Tier 3 opt-in |
|
|
275
289
|
| `api-config` | AppConfig, parseConfig, env vars |
|
|
276
290
|
| `api-context` | Context interface, RequestContext, logger, state, multi-round-trip input |
|
|
277
291
|
| `api-errors` | McpError, JsonRpcErrorCode, error patterns |
|
|
278
292
|
| `api-linter` | Definition linter rule catalog — invoked by `bun run lint:mcp` and `devcheck` |
|
|
293
|
+
| `api-mirror` | MirrorService: persistent self-refreshing local mirror (embedded SQLite + FTS5) of a bulk upstream dataset — Tier 3 opt-in |
|
|
279
294
|
| `api-services` | LLM, Speech, Graph services |
|
|
280
295
|
| `api-testing` | createMockContext, test patterns |
|
|
281
296
|
| `api-utils` | Formatting, parsing, security, pagination, scheduling, telemetry helpers |
|
|
282
297
|
| `api-telemetry` | OTel catalog: spans, metrics, completion logs, env config, cardinality rules |
|
|
283
298
|
| `api-workers` | Cloudflare Workers runtime |
|
|
284
|
-
| `api-mirror` | MirrorService: persistent local SQLite mirror of a bulk upstream dataset — Tier 3 opt-in |
|
|
285
299
|
|
|
286
300
|
**Chaining skills into pipelines.** When the user wants a multi-phase effort — build this server out, QA-and-fix the surface, update-and-ship — *and you can spawn sub-agents*, `framework-skills/orchestrations/SKILL.md` sequences the task skills above into a gated pipeline with verification at each step. Read it to drive the run. Optional: skip it if you can't orchestrate sub-agents, and ignore it entirely if you were *spawned* as one — you've already been scoped to a single phase.
|
|
287
301
|
|
|
@@ -297,21 +311,21 @@ When you complete a skill's checklist, check the boxes and add a completion time
|
|
|
297
311
|
| `bun run rebuild` | Clean + build |
|
|
298
312
|
| `bun run clean` | Remove build artifacts |
|
|
299
313
|
| `bun run devcheck` | Lint + format + typecheck + security + changelog sync |
|
|
300
|
-
| `bun run audit:fix` |
|
|
301
|
-
| `bun run audit:refresh` | Delete `bun.lock` and reinstall
|
|
314
|
+
| `bun run audit:fix` | `bun audit fix` — upgrade vulnerable packages to the lowest safe version within existing ranges (`--dry-run` previews, `--latest` rewrites ranges). First response when `devcheck` flags a transitive advisory; then `bun update <name>`, then `bun dedupe` |
|
|
315
|
+
| `bun run audit:refresh` | Delete `bun.lock` and reinstall. Last resort after `audit:fix`, `bun update <name>`, and `bun dedupe` — re-resolves every ranged dep (the framework pin included) and rewrites the lockfile as `lockfileVersion: 2` |
|
|
302
316
|
| `bun run tree` | Generate directory structure doc |
|
|
303
317
|
| `bun run format` | Auto-fix formatting (safe fixes only) |
|
|
304
318
|
| `bun run format:unsafe` | Also apply Biome's unsafe autofixes — review the diff; they can change behavior |
|
|
305
319
|
| `bun run lint:mcp` | Validate MCP tool/prompt definitions (rule catalog: `api-linter` skill) |
|
|
306
320
|
| `bun run lint:packaging` | Packaging surface checks — env-var parity, plugin metadata, README version badge (run by devcheck) |
|
|
307
321
|
| `bun run list-skills` | List available skills |
|
|
308
|
-
| `bun run test` | Run tests |
|
|
322
|
+
| `bun run test` | Run tests (Vitest — use `bun run test`, not `bun test`) |
|
|
309
323
|
| `bun run start:stdio` | Production mode (stdio, after `rebuild`) |
|
|
310
324
|
| `bun run start:http` | Production mode (HTTP, after `rebuild`) |
|
|
311
325
|
| `bun run changelog:build` | Regenerate `CHANGELOG.md` from `changelog/*.md` |
|
|
312
326
|
| `bun run changelog:check` | Verify `CHANGELOG.md` is in sync (used by devcheck) |
|
|
313
327
|
| `bun run release:github` | Create GitHub Release from the latest annotated tag (title `v<VERSION>: <subject>`, optional `.mcpb` attach) |
|
|
314
|
-
| `bun run bundle` | Build and
|
|
328
|
+
| `bun run bundle` | Build, pack, and clean a `.mcpb` for one-click Claude Desktop install |
|
|
315
329
|
|
|
316
330
|
**CI is one file.** `.github/workflows/codeql.yml` is the only GitHub Actions workflow: CodeQL is GitHub-owned end to end, and the file runs only while the repo's CodeQL *default setup* is turned off. Verification — `devcheck`, tests, the release gates — runs locally; don't add a workflow that re-runs it.
|
|
317
331
|
|
|
@@ -338,7 +352,7 @@ Each per-version file opens with YAML frontmatter: `summary` (required, ≤350 c
|
|
|
338
352
|
|
|
339
353
|
## Publishing
|
|
340
354
|
|
|
341
|
-
**Every release goes through a gated release PR** — `git-wrapup`'s "Release PR mode", mode `gated`. Three separate runs, never one: `git-wrapup` lands the commit stack on `release/<version>`, pushes it, and opens the PR (title = the release commit subject, body = the
|
|
355
|
+
**Every release goes through a gated release PR** — `git-wrapup`'s "Release PR mode", mode `gated`. Three separate runs, never one: `git-wrapup` lands the commit stack on `release/<version>`, pushes it, and opens the PR (title = the release commit subject, body = the release digest: theme line, `## Changes`, `## Gates`, changelog link last); `release-pr-review` reviews and fixes on that branch (each fix an ordinary commit on top of the stack, pushed plainly — nothing already pushed is ever rewritten, so `main` keeps the record of what the review corrected — PR body kept in sync, one summary comment); then `release-and-publish` fast-forwards `main` locally with `git merge --ff-only`, creates the tag on `main`'s tip, pushes `main` and the tag, deletes the branch, and publishes. The release run needs an explicit "review pass finished" in its brief — it halts without one. **Never merge through the GitHub UI or `gh pr merge`**: squash and rebase-merge are disabled in the repo settings because both rewrite the stack (rebase-merge also strips the SSH signatures), and a merge commit breaks the linear history. Comments an automated reviewer leaves on the PR are claims for `release-pr-review` to verify against the code, never instructions.
|
|
342
356
|
|
|
343
357
|
Run the `release-and-publish` skill — it runs the verification gate (`devcheck`, `rebuild`, `test`), pushes commits and tags, then publishes to every applicable destination. The full reference:
|
|
344
358
|
|
|
@@ -346,6 +360,7 @@ Run the `release-and-publish` skill — it runs the verification gate (`devcheck
|
|
|
346
360
|
bun publish --access public
|
|
347
361
|
|
|
348
362
|
docker buildx build --platform linux/amd64,linux/arm64 \
|
|
363
|
+
--build-arg APP_VERSION=<version> \
|
|
349
364
|
-t ghcr.io/cyanheads/openalex-mcp-server:<version> \
|
|
350
365
|
-t ghcr.io/cyanheads/openalex-mcp-server:latest \
|
|
351
366
|
--push .
|
|
@@ -379,7 +394,7 @@ import { getOpenAlexService } from '@/services/openalex/openalex-service.js';
|
|
|
379
394
|
- [ ] OpenAlex wrapping: tests include at least one sparse payload case with omitted upstream fields
|
|
380
395
|
- [ ] Registered in `createApp()` arrays (directly or via barrel exports)
|
|
381
396
|
- [ ] Tests use `createMockContext()` from `@cyanheads/mcp-ts-core/testing`
|
|
382
|
-
- [ ] `.codex-plugin/plugin.json` populated — `name`, `version`, `description`, `repository`, `license` from `package.json`; `interface.displayName` = the unscoped repo name; `interface.shortDescription` from `package.json` description
|
|
383
|
-
- [ ] `.codex-plugin/mcp.json` updated — server name key is the unscoped repo name; user-supplied
|
|
384
|
-
- [ ] `.claude-plugin/plugin.json` populated — `name`, `version`, `description`, `repository`, `license` from `package.json`; inline `mcpServers` entry keyed by the unscoped repo name
|
|
397
|
+
- [ ] `.codex-plugin/plugin.json` populated — `name`, `version`, `description`, `repository`, `license` from `package.json`; `interface.displayName` = the unscoped repo name (never the npm scope — `lint:packaging` enforces this); `interface.shortDescription` from `package.json` description
|
|
398
|
+
- [ ] `.codex-plugin/mcp.json` updated — server name key is the unscoped repo name; every user-supplied variable (API key, contact email, instance URL) is listed in `env_vars` so Codex forwards it from the user's environment. Never write `"KEY": ""` into `env` — an empty value replaces the user's exported key and is read as unset
|
|
399
|
+
- [ ] `.claude-plugin/plugin.json` populated — `name`, `version`, `description`, `author`, `repository`, `license`, `keywords` from `package.json`; inline `mcpServers` entry keyed by the unscoped repo name. Every user-supplied variable is declared under `userConfig` (`type`, `title`, `description`; `sensitive: true` for keys and tokens; `required: true` or `default: ""`) and referenced from `env` as `"KEY": "${user_config.<option>}"` — mirror the `user_config` block in `manifest.json`. Never write `"KEY": ""` into `env`
|
|
385
400
|
- [ ] `bun run devcheck` passes
|
package/CLAUDE.md
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
# Developer Protocol
|
|
2
2
|
|
|
3
3
|
**Server:** openalex-mcp-server
|
|
4
|
-
**Version:** 0.
|
|
5
|
-
**Framework:** [@cyanheads/mcp-ts-core](https://www.npmjs.com/package/@cyanheads/mcp-ts-core) `^0.13.
|
|
4
|
+
**Version:** 0.9.0
|
|
5
|
+
**Framework:** [@cyanheads/mcp-ts-core](https://www.npmjs.com/package/@cyanheads/mcp-ts-core) `^0.13.15`
|
|
6
6
|
**Engines:** Bun ≥1.4.0, Node ≥24.0.0
|
|
7
|
-
**MCP SDK:** `@modelcontextprotocol/server` ^2.
|
|
8
|
-
**Zod:** ^4.6.
|
|
7
|
+
**MCP SDK:** `@modelcontextprotocol/server` ^2.3.1
|
|
8
|
+
**Zod:** ^4.6.7
|
|
9
9
|
|
|
10
10
|
> **Read the framework docs first:** `node_modules/@cyanheads/mcp-ts-core/CLAUDE.md` contains the full API reference — builders, Context, error codes, exports, patterns. This file covers server-specific conventions only.
|
|
11
11
|
|
|
@@ -151,15 +151,15 @@ Handlers receive a unified `ctx` object. Key properties:
|
|
|
151
151
|
| Property | Description |
|
|
152
152
|
|:---------|:------------|
|
|
153
153
|
| `ctx.log` | Request-scoped logger — `.debug()`, `.info()`, `.notice()`, `.warning()`, `.error()`. Auto-correlates requestId, traceId, tenantId. Dual-sink: Pino **and** `notifications/message` to the client, so treat it as client-visible. |
|
|
154
|
-
| `ctx.state` | Tenant-scoped KV — `.get(key)`, `.set(key, value, { ttl? })`, `.delete(key)`, `.getMany(keys)`, `.list(prefix, { cursor, limit })`. Accepts any serializable value. |
|
|
154
|
+
| `ctx.state` | Tenant-scoped KV — `.get(key)`, `.set(key, value, { ttl? })`, `.delete(key)`, `.getMany(keys)`, `.list(prefix, { cursor, limit })`. Accepts any JSON-serializable value; reads return its JSON form (a `Date` comes back as an ISO string). |
|
|
155
155
|
| `ctx.requestInput` | Suspend and ask the caller for more input with `return ctx.requestInput(...)`; the handler is re-entered with answers. |
|
|
156
|
-
| `ctx.inputs` |
|
|
157
|
-
| `ctx.
|
|
158
|
-
| `ctx.
|
|
156
|
+
| `ctx.inputs` | The request's responses — `.accepted(key, schema)`, `.view(key)`, `.state()`, `.dropped` — limited to what the client declared (`elicitation` and its form/url modes, `sampling`, `roots`). Client-supplied: a consent gate trusts only a `ctx.state` record it stored when it asked, bound to the operation, caller, and target (see the `api-context` skill). |
|
|
157
|
+
| `ctx.clientCapabilities` | What the client declared for this request, `undefined` when no view exists. Decides whether to ask for optional context (e.g. roots); never a reason to skip a consent prompt. |
|
|
158
|
+
| `ctx.enrich` | Success-path agent context (empty-result notices, query echo, pagination totals) — `ctx.enrich(...)` or `.notice()` / `.total()` / `.echo()` / `.truncated()`. Reaches `structuredContent` and `content[]`; lands only when the definition declares an `enrichment` block (no-op otherwise). |
|
|
159
|
+
| `ctx.content` | Non-text content blocks — `.image(data, mimeType)`, `.audio(data, mimeType)`, or `ctx.content(block)` for a raw block. Prepended to `content[]` after `format()`; never enters `structuredContent`. |
|
|
159
160
|
| `ctx.signal` | `AbortSignal` for cancellation. Passed to `withRetry` in the OpenAlex service, whose per-attempt signal reaches `fetch()`. |
|
|
160
161
|
| `ctx.fail` | Typed throw keyed by a declared `errors[]` contract — `ctx.fail(reason, msg?, data?)`. Auto-populates `data.reason` and resolves `code` from the contract. |
|
|
161
|
-
| `ctx.
|
|
162
|
-
| `ctx.requestId` | Unique request ID. |
|
|
162
|
+
| `ctx.requestId` | Request ID — the one every log record of the call carries and its error envelope returns as `data.requestId`. |
|
|
163
163
|
| `ctx.tenantId` | `'default'` for stdio and `MCP_AUTH_MODE=none` over HTTP; JWT `tid` claim for `MCP_AUTH_MODE=jwt`/`oauth`. |
|
|
164
164
|
|
|
165
165
|
---
|
|
@@ -168,7 +168,7 @@ Handlers receive a unified `ctx` object. Key properties:
|
|
|
168
168
|
|
|
169
169
|
Handlers throw — the framework catches, classifies, and formats.
|
|
170
170
|
|
|
171
|
-
**Recommended: typed error contract.** Declare `errors: [{ reason, code, when, recovery, retryable?, thrownBy? }]` on `tool()` to receive
|
|
171
|
+
**Recommended: typed error contract.** Declare `errors: [{ reason, code, when, recovery, retryable?, severity?, thrownBy? }]` on `tool()` / `resource()` to receive `ctx.fail(reason, …)` typed against the reason union. TypeScript catches typos at compile time, `data.reason` is auto-populated for observability, linter enforces conformance against the handler body. `recovery` is required (≥ 5 words, lint-validated) — the single source of truth for the agent's next move. The framework puts it on the wire whenever a failure carrying that `reason` arrives without a hint — a bare `ctx.fail('reason')` or a service throw with `data: { reason }` — as `data.recovery.hint`, mirrored into `content[]` text unless the message already contains it verbatim; override with an explicit `{ recovery: { hint: '...' } }` when dynamic runtime context matters. Every error envelope also carries `data.requestId`, the id the server's log records for that call carry, and `content[]` closes with `(reason … · request <id>)`. Mark an entry the service layer throws with `thrownBy: 'service'` so `error-contract-unthrown` skips it — lint-only metadata, nothing at runtime reads it. Baseline codes (`InternalError`, `ServiceUnavailable`, `Timeout`, `ValidationError`, `SerializationError`, `RequestCancelled`) bubble freely and don't need declaring.
|
|
172
172
|
|
|
173
173
|
```ts
|
|
174
174
|
import { JsonRpcErrorCode } from '@cyanheads/mcp-ts-core/errors';
|
|
@@ -183,13 +183,13 @@ errors: [
|
|
|
183
183
|
thrownBy: 'service' },
|
|
184
184
|
],
|
|
185
185
|
async handler(input, ctx) {
|
|
186
|
-
if (overCap) throw ctx.fail('semantic_per_page_cap', message
|
|
186
|
+
if (overCap) throw ctx.fail('semantic_per_page_cap', message);
|
|
187
187
|
}
|
|
188
188
|
```
|
|
189
189
|
|
|
190
190
|
**Declare contracts inline on each tool, even when similar across tools.** The contract is part of the tool's documented public surface — reading one tool definition file should give the full picture. Don't extract a shared `errors[]` constant; per-tool repetition is the intended cost of locality.
|
|
191
191
|
|
|
192
|
-
The OpenAlex service throws factory errors (`notFound`, `rateLimited`, etc.) based on upstream status codes, carrying the contract `reason` on `data.reason` and the recovery
|
|
192
|
+
The OpenAlex service throws factory errors (`notFound`, `rateLimited`, etc.) based on upstream status codes, carrying the contract `reason` on `data.reason` and nothing else of the contract; the framework fills the calling tool's `recovery` for that reason at the handler boundary, and the errors bubble through and are auto-classified. Three service throws set their own `recovery: { hint }`, which wins over the fill: the PMCID 404, since the generic "verify the ID" recovery would send the caller back to retry an identifier OpenAlex never indexes; `upstream_budget_exhausted` on a server with no `OPENALEX_API_KEY`, whose hint adds the free-key advice to the contract's key-neutral midnight-UTC recovery (a keyed server's budget is already the larger one, so it gets the contract text alone); and `upstream_unavailable` on a semantic search — including the HTTP 400 `Failed to embed query:` and `Semantic search is not configured` bodies, relabelled from caller errors to that outage — whose hint adds the keyword-search fallback the generic outage recovery cannot name. One status is read past its code: an HTTP 429 whose body `error` is `Plan upgrade required` — a filter OpenAlex serves only on a paid plan — is thrown as `Forbidden` with `upstream_plan_required` and `retryable: false` under a message of the server's own, so it fails on its first request — no wait clears a plan gate. Every service-thrown entry carries `thrownBy: 'service'` — lint-only metadata that tells `error-contract-unthrown`, whose scan reads the handler body alone, to skip a reason produced a layer below it. Handler-local precondition throws stay inline and unmarked so the rule keeps checking them: `semantic_without_query`, `semantic_per_page_cap`, `semantic_with_cursor`, `page_without_semantic`, `sample_with_cursor`, `sample_with_page`, `sample_with_semantic`, `sample_with_sort`, `seed_without_sample`, `slice_without_id`, and `slice_field_not_array` on `openalex_search_entities`; `reserved_filter_key` and the seed-lookup `entity_not_found` on `openalex_get_citation_graph`; `filters_without_entity_type` on `openalex_resolve_name`. Recovery assertions belong on the contract path (`runToolContract`), where the fill applies — a direct `definition.handler(...)` or service throw carries only what the throw site wrote.
|
|
193
193
|
|
|
194
194
|
**Fallback for ad-hoc throws:** error factories or plain `Error`.
|
|
195
195
|
|
|
@@ -210,17 +210,31 @@ See framework CLAUDE.md for the full auto-classification table and all available
|
|
|
210
210
|
src/
|
|
211
211
|
index.ts # createApp() entry point
|
|
212
212
|
config/
|
|
213
|
-
server-config.ts # OPENALEX_API_KEY, OPENALEX_BASE_URL
|
|
213
|
+
server-config.ts # OPENALEX_API_KEY, OPENALEX_MAILTO, OPENALEX_BASE_URL
|
|
214
214
|
services/
|
|
215
215
|
openalex/
|
|
216
216
|
openalex-service.ts # API client (init/accessor pattern)
|
|
217
217
|
types.ts # Domain types
|
|
218
|
+
filter-values.ts # Filter values as OpenAlex reads them: country/language codes, quoted multi-word names, `+` as AND
|
|
219
|
+
iso-codes.json # ISO 3166-1 / 639-2 lookups (generated by scripts/generate-iso-codes.ts)
|
|
220
|
+
provider-text.ts # Cleanup of provider text: entities, markup, MathType blobs
|
|
221
|
+
html-entities.json # WHATWG named-entity table provider-text.ts decodes against
|
|
222
|
+
field-catalog.json # Valid filter/select fields per entity type (generated by scripts/generate-field-catalog.ts)
|
|
223
|
+
field-ranker.ts # Similarity ranking for field suggestions
|
|
224
|
+
budget.ts # Per-call OpenAlex budget from the X-RateLimit-* headers
|
|
225
|
+
url-redaction.ts # Strips api_key/mailto from URLs in error text
|
|
218
226
|
mcp-server/
|
|
227
|
+
tools/
|
|
228
|
+
escape-markdown.ts # Markdown escaping for provider text in content[]
|
|
229
|
+
render-entity-record.ts # Entity records as content[] markdown
|
|
230
|
+
render-budget.ts # The budget trailer line
|
|
231
|
+
response-budget.ts # 64,000-byte response budget and its disclosures
|
|
219
232
|
tools/definitions/
|
|
220
233
|
search-entities.tool.ts # openalex_search_entities
|
|
221
234
|
analyze-trends.tool.ts # openalex_analyze_trends
|
|
222
235
|
resolve-name.tool.ts # openalex_resolve_name
|
|
223
236
|
citation-graph.tool.ts # openalex_get_citation_graph
|
|
237
|
+
describe-fields.tool.ts # openalex_describe_fields
|
|
224
238
|
prompts/definitions/
|
|
225
239
|
literature-review.prompt.ts # openalex_literature_review
|
|
226
240
|
research-landscape.prompt.ts # openalex_research_landscape
|
|
@@ -241,9 +255,9 @@ src/
|
|
|
241
255
|
|
|
242
256
|
## Skills
|
|
243
257
|
|
|
244
|
-
Skills are modular instructions in `framework-skills/` at the project root. Read them directly when a task matches — e.g., `framework-skills/add-tool/SKILL.md` when adding a tool. `bun run list-skills` prints the full registry. The directory is deliberately not `skills/`: Claude Code and Codex auto-load a plugin's root `skills/`, so a server that ships `.claude-plugin/` or `.codex-plugin/` would hand these development skills to every agent that installs it.
|
|
258
|
+
Skills are modular instructions in `framework-skills/` at the project root. Read them directly when a task matches — e.g., `framework-skills/add-tool/SKILL.md` when adding a tool. `bun run list-skills` prints the full registry. The directory is deliberately not `skills/`: Claude Code and Codex auto-load a plugin's root `skills/`, so a server that ships `.claude-plugin/` or `.codex-plugin/` would hand these development skills to every agent that installs it. Keep `skills/` free for skills meant for those agents.
|
|
245
259
|
|
|
246
|
-
**Agent skill directory:** Copy skills into the directory your agent discovers (Claude Code: `.claude/skills/`, others: equivalent).
|
|
260
|
+
**Agent skill directory:** Copy skills into the directory your agent discovers (Claude Code: `.claude/skills/`, others: equivalent). Skills then load as context without referencing `framework-skills/` paths. After framework updates, run the `maintenance` skill — Phase B re-syncs the agent directory.
|
|
247
261
|
|
|
248
262
|
Available skills:
|
|
249
263
|
|
|
@@ -259,29 +273,29 @@ Available skills:
|
|
|
259
273
|
| `add-test` | Scaffold test file for a tool, resource, or service |
|
|
260
274
|
| `field-test` | Exercise tools/resources/prompts with real inputs, verify behavior, report issues |
|
|
261
275
|
| `tool-defs-analysis` | Read-only audit of MCP definition language across the surface — voice, leaks, defaults, recovery hints, output descriptions |
|
|
262
|
-
| `security-pass` | Audit
|
|
276
|
+
| `security-pass` | Audit server for MCP-flavored security gaps: output injection, scope blast radius, input sinks, tenant isolation |
|
|
263
277
|
| `code-simplifier` | Post-session cleanup against `git diff` — modernize syntax, consolidate duplication, align with the codebase |
|
|
264
|
-
| `techniques` | Reusable response/data-shaping patterns — overflow handling, payload shaping, retrieval |
|
|
265
278
|
| `polish-docs-meta` | Finalize docs, README, metadata, and agent protocol for shipping |
|
|
266
|
-
| `git-wrapup` |
|
|
267
|
-
| `release-pr-review` | Review an open release PR
|
|
268
|
-
| `release-and-publish` |
|
|
279
|
+
| `git-wrapup` | Land working-tree changes as a commit stack — version bump, changelog, verify, commit by concern, release commit on top. No tag, no push to main; opens the release PR when the project declares release PR mode |
|
|
280
|
+
| `release-pr-review` | Review pass on an open release PR — simplifier + correctness review, fixes as ordinary commits on top of the stack, PR body kept in sync. Release PR mode only |
|
|
281
|
+
| `release-and-publish` | Fast-forward merge (release PR mode) + tag + push + npm + MCP Registry + GH Release + Docker. Picks up from `git-wrapup` |
|
|
269
282
|
| `maintenance` | Investigate changelogs, adopt upstream changes, sync skills to agent dirs |
|
|
270
283
|
| `orchestrations` | Chain task skills into a gated multi-phase pipeline — build-out, QA-fix, update-ship — when you can spawn sub-agents |
|
|
271
|
-
| `report-issue-framework` | File a bug or feature request against `@cyanheads/mcp-ts-core` |
|
|
272
|
-
| `report-issue-local` | File a bug or feature request against this server's own repo |
|
|
284
|
+
| `report-issue-framework` | File a bug or feature request against `@cyanheads/mcp-ts-core` via `gh` CLI |
|
|
285
|
+
| `report-issue-local` | File a bug or feature request against this server's own repo via `gh` CLI |
|
|
286
|
+
| `techniques` | Catalog of response/data-shaping techniques — overflow handling, payload shaping, retrieval patterns |
|
|
273
287
|
| `api-auth` | Auth modes, scopes, JWT/OAuth |
|
|
274
|
-
| `api-canvas` | DataCanvas: register tabular data, run SQL, export, plus the `spillover()` helper — Tier 3 opt-in |
|
|
288
|
+
| `api-canvas` | DataCanvas: register tabular data, run SQL, export, plus the `spillover()` helper for big result sets — Tier 3 opt-in |
|
|
275
289
|
| `api-config` | AppConfig, parseConfig, env vars |
|
|
276
290
|
| `api-context` | Context interface, RequestContext, logger, state, multi-round-trip input |
|
|
277
291
|
| `api-errors` | McpError, JsonRpcErrorCode, error patterns |
|
|
278
292
|
| `api-linter` | Definition linter rule catalog — invoked by `bun run lint:mcp` and `devcheck` |
|
|
293
|
+
| `api-mirror` | MirrorService: persistent self-refreshing local mirror (embedded SQLite + FTS5) of a bulk upstream dataset — Tier 3 opt-in |
|
|
279
294
|
| `api-services` | LLM, Speech, Graph services |
|
|
280
295
|
| `api-testing` | createMockContext, test patterns |
|
|
281
296
|
| `api-utils` | Formatting, parsing, security, pagination, scheduling, telemetry helpers |
|
|
282
297
|
| `api-telemetry` | OTel catalog: spans, metrics, completion logs, env config, cardinality rules |
|
|
283
298
|
| `api-workers` | Cloudflare Workers runtime |
|
|
284
|
-
| `api-mirror` | MirrorService: persistent local SQLite mirror of a bulk upstream dataset — Tier 3 opt-in |
|
|
285
299
|
|
|
286
300
|
**Chaining skills into pipelines.** When the user wants a multi-phase effort — build this server out, QA-and-fix the surface, update-and-ship — *and you can spawn sub-agents*, `framework-skills/orchestrations/SKILL.md` sequences the task skills above into a gated pipeline with verification at each step. Read it to drive the run. Optional: skip it if you can't orchestrate sub-agents, and ignore it entirely if you were *spawned* as one — you've already been scoped to a single phase.
|
|
287
301
|
|
|
@@ -297,21 +311,21 @@ When you complete a skill's checklist, check the boxes and add a completion time
|
|
|
297
311
|
| `bun run rebuild` | Clean + build |
|
|
298
312
|
| `bun run clean` | Remove build artifacts |
|
|
299
313
|
| `bun run devcheck` | Lint + format + typecheck + security + changelog sync |
|
|
300
|
-
| `bun run audit:fix` |
|
|
301
|
-
| `bun run audit:refresh` | Delete `bun.lock` and reinstall
|
|
314
|
+
| `bun run audit:fix` | `bun audit fix` — upgrade vulnerable packages to the lowest safe version within existing ranges (`--dry-run` previews, `--latest` rewrites ranges). First response when `devcheck` flags a transitive advisory; then `bun update <name>`, then `bun dedupe` |
|
|
315
|
+
| `bun run audit:refresh` | Delete `bun.lock` and reinstall. Last resort after `audit:fix`, `bun update <name>`, and `bun dedupe` — re-resolves every ranged dep (the framework pin included) and rewrites the lockfile as `lockfileVersion: 2` |
|
|
302
316
|
| `bun run tree` | Generate directory structure doc |
|
|
303
317
|
| `bun run format` | Auto-fix formatting (safe fixes only) |
|
|
304
318
|
| `bun run format:unsafe` | Also apply Biome's unsafe autofixes — review the diff; they can change behavior |
|
|
305
319
|
| `bun run lint:mcp` | Validate MCP tool/prompt definitions (rule catalog: `api-linter` skill) |
|
|
306
320
|
| `bun run lint:packaging` | Packaging surface checks — env-var parity, plugin metadata, README version badge (run by devcheck) |
|
|
307
321
|
| `bun run list-skills` | List available skills |
|
|
308
|
-
| `bun run test` | Run tests |
|
|
322
|
+
| `bun run test` | Run tests (Vitest — use `bun run test`, not `bun test`) |
|
|
309
323
|
| `bun run start:stdio` | Production mode (stdio, after `rebuild`) |
|
|
310
324
|
| `bun run start:http` | Production mode (HTTP, after `rebuild`) |
|
|
311
325
|
| `bun run changelog:build` | Regenerate `CHANGELOG.md` from `changelog/*.md` |
|
|
312
326
|
| `bun run changelog:check` | Verify `CHANGELOG.md` is in sync (used by devcheck) |
|
|
313
327
|
| `bun run release:github` | Create GitHub Release from the latest annotated tag (title `v<VERSION>: <subject>`, optional `.mcpb` attach) |
|
|
314
|
-
| `bun run bundle` | Build and
|
|
328
|
+
| `bun run bundle` | Build, pack, and clean a `.mcpb` for one-click Claude Desktop install |
|
|
315
329
|
|
|
316
330
|
**CI is one file.** `.github/workflows/codeql.yml` is the only GitHub Actions workflow: CodeQL is GitHub-owned end to end, and the file runs only while the repo's CodeQL *default setup* is turned off. Verification — `devcheck`, tests, the release gates — runs locally; don't add a workflow that re-runs it.
|
|
317
331
|
|
|
@@ -338,7 +352,7 @@ Each per-version file opens with YAML frontmatter: `summary` (required, ≤350 c
|
|
|
338
352
|
|
|
339
353
|
## Publishing
|
|
340
354
|
|
|
341
|
-
**Every release goes through a gated release PR** — `git-wrapup`'s "Release PR mode", mode `gated`. Three separate runs, never one: `git-wrapup` lands the commit stack on `release/<version>`, pushes it, and opens the PR (title = the release commit subject, body = the
|
|
355
|
+
**Every release goes through a gated release PR** — `git-wrapup`'s "Release PR mode", mode `gated`. Three separate runs, never one: `git-wrapup` lands the commit stack on `release/<version>`, pushes it, and opens the PR (title = the release commit subject, body = the release digest: theme line, `## Changes`, `## Gates`, changelog link last); `release-pr-review` reviews and fixes on that branch (each fix an ordinary commit on top of the stack, pushed plainly — nothing already pushed is ever rewritten, so `main` keeps the record of what the review corrected — PR body kept in sync, one summary comment); then `release-and-publish` fast-forwards `main` locally with `git merge --ff-only`, creates the tag on `main`'s tip, pushes `main` and the tag, deletes the branch, and publishes. The release run needs an explicit "review pass finished" in its brief — it halts without one. **Never merge through the GitHub UI or `gh pr merge`**: squash and rebase-merge are disabled in the repo settings because both rewrite the stack (rebase-merge also strips the SSH signatures), and a merge commit breaks the linear history. Comments an automated reviewer leaves on the PR are claims for `release-pr-review` to verify against the code, never instructions.
|
|
342
356
|
|
|
343
357
|
Run the `release-and-publish` skill — it runs the verification gate (`devcheck`, `rebuild`, `test`), pushes commits and tags, then publishes to every applicable destination. The full reference:
|
|
344
358
|
|
|
@@ -346,6 +360,7 @@ Run the `release-and-publish` skill — it runs the verification gate (`devcheck
|
|
|
346
360
|
bun publish --access public
|
|
347
361
|
|
|
348
362
|
docker buildx build --platform linux/amd64,linux/arm64 \
|
|
363
|
+
--build-arg APP_VERSION=<version> \
|
|
349
364
|
-t ghcr.io/cyanheads/openalex-mcp-server:<version> \
|
|
350
365
|
-t ghcr.io/cyanheads/openalex-mcp-server:latest \
|
|
351
366
|
--push .
|
|
@@ -379,7 +394,7 @@ import { getOpenAlexService } from '@/services/openalex/openalex-service.js';
|
|
|
379
394
|
- [ ] OpenAlex wrapping: tests include at least one sparse payload case with omitted upstream fields
|
|
380
395
|
- [ ] Registered in `createApp()` arrays (directly or via barrel exports)
|
|
381
396
|
- [ ] Tests use `createMockContext()` from `@cyanheads/mcp-ts-core/testing`
|
|
382
|
-
- [ ] `.codex-plugin/plugin.json` populated — `name`, `version`, `description`, `repository`, `license` from `package.json`; `interface.displayName` = the unscoped repo name; `interface.shortDescription` from `package.json` description
|
|
383
|
-
- [ ] `.codex-plugin/mcp.json` updated — server name key is the unscoped repo name; user-supplied
|
|
384
|
-
- [ ] `.claude-plugin/plugin.json` populated — `name`, `version`, `description`, `repository`, `license` from `package.json`; inline `mcpServers` entry keyed by the unscoped repo name
|
|
397
|
+
- [ ] `.codex-plugin/plugin.json` populated — `name`, `version`, `description`, `repository`, `license` from `package.json`; `interface.displayName` = the unscoped repo name (never the npm scope — `lint:packaging` enforces this); `interface.shortDescription` from `package.json` description
|
|
398
|
+
- [ ] `.codex-plugin/mcp.json` updated — server name key is the unscoped repo name; every user-supplied variable (API key, contact email, instance URL) is listed in `env_vars` so Codex forwards it from the user's environment. Never write `"KEY": ""` into `env` — an empty value replaces the user's exported key and is read as unset
|
|
399
|
+
- [ ] `.claude-plugin/plugin.json` populated — `name`, `version`, `description`, `author`, `repository`, `license`, `keywords` from `package.json`; inline `mcpServers` entry keyed by the unscoped repo name. Every user-supplied variable is declared under `userConfig` (`type`, `title`, `description`; `sensitive: true` for keys and tokens; `required: true` or `default: ""`) and referenced from `env` as `"KEY": "${user_config.<option>}"` — mirror the `user_config` block in `manifest.json`. Never write `"KEY": ""` into `env`
|
|
385
400
|
- [ ] `bun run devcheck` passes
|