@cyanheads/whois-mcp-server 0.1.3 → 0.1.5
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 +85 -47
- package/CLAUDE.md +85 -47
- package/Dockerfile +16 -7
- package/LICENSE +1 -1
- package/README.md +48 -58
- package/changelog/0.1.x/0.1.4.md +38 -0
- package/changelog/0.1.x/0.1.5.md +35 -0
- package/changelog/template.md +67 -43
- package/dist/app.d.ts +199 -0
- package/dist/app.d.ts.map +1 -0
- package/dist/app.js +47 -0
- package/dist/app.js.map +1 -0
- package/dist/index.js +2 -33
- package/dist/index.js.map +1 -1
- package/dist/mcp-server/tools/definitions/whois-get-dns.tool.d.ts +8 -8
- package/dist/mcp-server/tools/definitions/whois-lookup-asn.tool.d.ts +2 -0
- package/dist/mcp-server/tools/definitions/whois-lookup-asn.tool.d.ts.map +1 -1
- package/dist/mcp-server/tools/definitions/whois-lookup-asn.tool.js +2 -0
- package/dist/mcp-server/tools/definitions/whois-lookup-asn.tool.js.map +1 -1
- package/dist/mcp-server/tools/definitions/whois-lookup-ip.tool.d.ts +2 -0
- package/dist/mcp-server/tools/definitions/whois-lookup-ip.tool.d.ts.map +1 -1
- package/dist/mcp-server/tools/definitions/whois-lookup-ip.tool.js +2 -0
- package/dist/mcp-server/tools/definitions/whois-lookup-ip.tool.js.map +1 -1
- package/dist/services/doh/doh-service.d.ts.map +1 -1
- package/dist/services/doh/doh-service.js +2 -3
- package/dist/services/doh/doh-service.js.map +1 -1
- package/dist/services/rdap/rdap-service.d.ts +0 -1
- package/dist/services/rdap/rdap-service.d.ts.map +1 -1
- package/dist/services/rdap/rdap-service.js +72 -66
- package/dist/services/rdap/rdap-service.js.map +1 -1
- package/package.json +14 -12
- package/server.json +3 -3
package/AGENTS.md
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
# Developer Protocol
|
|
2
2
|
|
|
3
3
|
**Server:** whois-mcp-server
|
|
4
|
-
**Version:** 0.1.
|
|
5
|
-
**Framework:** [@cyanheads/mcp-ts-core](https://www.npmjs.com/package/@cyanheads/mcp-ts-core) `^0.
|
|
6
|
-
**Engines:** Bun ≥1.
|
|
7
|
-
**MCP SDK:** `@modelcontextprotocol/
|
|
8
|
-
**Zod:** ^4.
|
|
4
|
+
**Version:** 0.1.5
|
|
5
|
+
**Framework:** [@cyanheads/mcp-ts-core](https://www.npmjs.com/package/@cyanheads/mcp-ts-core) `^0.13.6`
|
|
6
|
+
**Engines:** Bun ≥1.4.0, Node ≥24.0.0
|
|
7
|
+
**MCP SDK:** `@modelcontextprotocol/server` ^2.0.0
|
|
8
|
+
**Zod:** ^4.6.5
|
|
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
|
|
|
@@ -35,8 +35,9 @@ Tailor suggestions to what's actually missing or stale — don't recite the full
|
|
|
35
35
|
- **Logic throws, framework catches.** Tool/resource handlers are pure — throw on failure, no `try/catch`. Plain `Error` is fine; the framework catches, classifies, and formats. Use error factories (`notFound()`, `validationError()`, etc.) when the error code matters.
|
|
36
36
|
- **Use `ctx.log`** for request-scoped logging. No `console` calls.
|
|
37
37
|
- **Use `ctx.state`** for tenant-scoped storage. Never access persistence directly.
|
|
38
|
-
- **
|
|
38
|
+
- **Need input the caller didn't supply?** `return ctx.requestInput(...)` and read `ctx.inputs` when the handler is re-entered. Never `await` for user input mid-handler.
|
|
39
39
|
- **Secrets in env vars only** — never hardcoded.
|
|
40
|
+
- **Cut noise.** Add only what earns its place: no speculative generality, no guards for states the framework already prevents (Zod-validated params, classified errors), no abstraction until a third caller proves it, no option nothing sets.
|
|
40
41
|
- **Close the loop on issues.** When implementing work tracked by a GitHub issue, comment on the issue with what landed and close it. Do both — a comment without a close leaves stale issues open; a close without a comment leaves no record of what shipped. The comment is for future readers — state the concrete changes, not the conversation that produced them.
|
|
41
42
|
|
|
42
43
|
---
|
|
@@ -105,7 +106,9 @@ export function getServerConfig() {
|
|
|
105
106
|
}
|
|
106
107
|
```
|
|
107
108
|
|
|
108
|
-
`parseEnvConfig` maps Zod schema paths → env var names so errors name the variable (`RDAP_TIMEOUT_MS`) not the path (`rdapTimeoutMs`). Throws `ConfigurationError`, which the framework prints as a clean startup banner.
|
|
109
|
+
`parseEnvConfig` maps Zod schema paths → env var names so errors name the variable (`RDAP_TIMEOUT_MS`) not the path (`rdapTimeoutMs`). Throws `ConfigurationError`, which the framework prints as a clean startup banner. An empty string and a whole-value unsubstituted `${…}` placeholder read as unset, so an optional field stays `undefined` and a defaulted field takes its default.
|
|
110
|
+
|
|
111
|
+
For env booleans use `z.stringbool()`, never `z.coerce.boolean()` — `Boolean("false")` is `true`, so a coerced flag can't be disabled through the environment. `z.stringbool()` parses `true/false/1/0/yes/no/on/off` and rejects anything else, so `=false` actually disables.
|
|
109
112
|
|
|
110
113
|
### Server identity and instructions
|
|
111
114
|
|
|
@@ -121,6 +124,24 @@ await createApp({
|
|
|
121
124
|
|
|
122
125
|
`instructions` is optional server-level orientation, sent on every `initialize` as session-level context. Use it for deployment guidance (connection aliases, regional notes, scope hints) instead of repeating the same context across tool descriptions. Client adoption is uneven, but there's no downside when set.
|
|
123
126
|
|
|
127
|
+
### Session posture and shutdown
|
|
128
|
+
|
|
129
|
+
Two more `createApp()` options shape how the server runs rather than how it presents itself:
|
|
130
|
+
|
|
131
|
+
```ts
|
|
132
|
+
await createApp({
|
|
133
|
+
sessionMode: 'stateless', // or { default: 'stateful', require: 'stateful' }
|
|
134
|
+
setup(core) { startMyWatcher(core.config); },
|
|
135
|
+
async teardown() { await stopMyWatcher(); },
|
|
136
|
+
});
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
`sessionMode` declares the HTTP session posture in `src/` instead of leaving it to a deployment's `MCP_SESSION_MODE`, which still wins whenever it carries a meaningful value (an empty string and an unsubstituted `${…}` placeholder read as unset and fall through to the option). Add `require: 'stateful'` when a tool asks the caller for input mid-handler via `ctx.requestInput`: startup then fails with a `ConfigurationError` rather than serving a mode in which a 2025-era client can never answer the prompt. Stdio is never refused.
|
|
140
|
+
|
|
141
|
+
`teardown(core)` is the `setup()` counterpart — release a watcher, socket, or non-`unref()`'d timer there. It runs after the transport stops and before the logger closes, on every shutdown path, and a signal-triggered shutdown then exits the process explicitly (0, or 1 if a step never settles within the framework's 10 s ceiling).
|
|
142
|
+
|
|
143
|
+
**This server declares `sessionMode: 'stateless'`.** It holds no per-session state and no handler calls `ctx.requestInput`, so the session store and the per-session `McpServer` allocation are pure overhead and the process scales horizontally. `MCP_SESSION_MODE=stateless` in `.env.example` and the `Dockerfile` restate the same posture rather than overriding it; `require: 'stateful'` is deliberately not set. Neither `RdapService` nor `DohService` allocates a watcher, socket, or ref'd timer, so no `teardown` hook is warranted.
|
|
144
|
+
|
|
124
145
|
---
|
|
125
146
|
|
|
126
147
|
## Context
|
|
@@ -129,12 +150,15 @@ Handlers receive a unified `ctx` object. Key properties:
|
|
|
129
150
|
|
|
130
151
|
| Property | Description |
|
|
131
152
|
|:---------|:------------|
|
|
132
|
-
| `ctx.log` | Request-scoped logger — `.debug()`, `.info()`, `.notice()`, `.warning()`, `.error()`. Auto-correlates requestId, traceId, tenantId. |
|
|
133
|
-
| `ctx.state` | Tenant-scoped KV — `.get(key)`, `.set(key, value, { ttl? })`, `.delete(key)`, `.list(prefix, { cursor, limit })`.
|
|
134
|
-
| `ctx.
|
|
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. |
|
|
155
|
+
| `ctx.requestInput` | Suspend and ask the caller for more input — `return ctx.requestInput({ inputRequests: { key: inputRequired.elicit({ message, requestedSchema }) } })`. Never returns; the handler is re-entered with the answers. Always present. |
|
|
156
|
+
| `ctx.inputs` | Reader over a retried request's responses — `.accepted(key, schema)`, `.view(key)`, `.state()`, `.dropped`. Empty on the first round. |
|
|
157
|
+
| `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). |
|
|
158
|
+
| `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`. |
|
|
135
159
|
| `ctx.signal` | `AbortSignal` for cancellation. |
|
|
136
160
|
| `ctx.requestId` | Unique request ID. |
|
|
137
|
-
| `ctx.tenantId` | Tenant ID from JWT
|
|
161
|
+
| `ctx.tenantId` | Tenant ID from JWT; `'default'` for stdio or HTTP with auth off. |
|
|
138
162
|
|
|
139
163
|
---
|
|
140
164
|
|
|
@@ -142,7 +166,7 @@ Handlers receive a unified `ctx` object. Key properties:
|
|
|
142
166
|
|
|
143
167
|
Handlers throw — the framework catches, classifies, and formats.
|
|
144
168
|
|
|
145
|
-
**Recommended: typed error contract.** Declare `errors: [{ reason, code, when, recovery, retryable? }]` 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
|
|
169
|
+
**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. Pass `ctx.recoveryFor('reason')` as the throw's data to put it on the wire (`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. Forwarding it is lint-enforced per throw site (`error-contract-recovery-unforwarded`). 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.
|
|
146
170
|
|
|
147
171
|
```ts
|
|
148
172
|
import { JsonRpcErrorCode } from '@cyanheads/mcp-ts-core/errors';
|
|
@@ -154,7 +178,7 @@ errors: [
|
|
|
154
178
|
],
|
|
155
179
|
async handler(input, ctx) {
|
|
156
180
|
const item = await db.find(input.id);
|
|
157
|
-
if (!item) throw ctx.fail('no_match', `No item ${input.id}
|
|
181
|
+
if (!item) throw ctx.fail('no_match', `No item ${input.id}`, ctx.recoveryFor('no_match'));
|
|
158
182
|
return item;
|
|
159
183
|
}
|
|
160
184
|
```
|
|
@@ -175,7 +199,7 @@ throw new Error('Invalid query format'); // → ValidationError
|
|
|
175
199
|
|
|
176
200
|
// McpError — when no factory exists for the code
|
|
177
201
|
import { McpError, JsonRpcErrorCode } from '@cyanheads/mcp-ts-core/errors';
|
|
178
|
-
throw new McpError(JsonRpcErrorCode.
|
|
202
|
+
throw new McpError(JsonRpcErrorCode.InitializationFailed, 'Connection failed', { pool: 'primary' });
|
|
179
203
|
```
|
|
180
204
|
|
|
181
205
|
See framework CLAUDE.md and the `api-errors` skill for the full auto-classification table, all available factories, and the contract reference.
|
|
@@ -186,7 +210,8 @@ See framework CLAUDE.md and the `api-errors` skill for the full auto-classificat
|
|
|
186
210
|
|
|
187
211
|
```text
|
|
188
212
|
src/
|
|
189
|
-
index.ts #
|
|
213
|
+
index.ts # Entry point — starts the app
|
|
214
|
+
app.ts # createApp() options — tools, services, session mode
|
|
190
215
|
config/
|
|
191
216
|
server-config.ts # Server-specific env vars (Zod schema)
|
|
192
217
|
services/
|
|
@@ -194,7 +219,7 @@ src/
|
|
|
194
219
|
rdap-service.ts # RDAP client — IANA bootstrap + domain/IP/ASN lookup
|
|
195
220
|
types.ts # RDAP domain/IP/ASN normalized types
|
|
196
221
|
doh/
|
|
197
|
-
doh-service.ts # DNS-over-HTTPS client — Cloudflare primary,
|
|
222
|
+
doh-service.ts # DNS-over-HTTPS client — Cloudflare primary, NextDNS fallback
|
|
198
223
|
types.ts # DoH record types
|
|
199
224
|
mcp-server/
|
|
200
225
|
tools/definitions/
|
|
@@ -222,9 +247,9 @@ src/
|
|
|
222
247
|
|
|
223
248
|
## Skills
|
|
224
249
|
|
|
225
|
-
Skills are modular instructions in `skills/` at the project root. Read them directly when a task matches — e.g., `skills/add-tool/SKILL.md` when adding a tool.
|
|
250
|
+
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.
|
|
226
251
|
|
|
227
|
-
**Agent skill directory:** Copy skills into the directory your agent discovers (Claude Code: `.claude/skills/`, others: equivalent). Skills then load as context without referencing `skills/` paths. After framework updates, run the `maintenance` skill — Phase B re-syncs the agent directory.
|
|
252
|
+
**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.
|
|
228
253
|
|
|
229
254
|
Available skills:
|
|
230
255
|
|
|
@@ -242,28 +267,29 @@ Available skills:
|
|
|
242
267
|
| `tool-defs-analysis` | Read-only audit of MCP definition language across the surface — voice, leaks, defaults, recovery hints, output descriptions |
|
|
243
268
|
| `security-pass` | Audit server for MCP-flavored security gaps: output injection, scope blast radius, input sinks, tenant isolation |
|
|
244
269
|
| `code-simplifier` | Post-session cleanup against `git diff` — modernize syntax, consolidate duplication, align with the codebase |
|
|
245
|
-
| `devcheck` | Lint, format, typecheck, audit |
|
|
246
270
|
| `polish-docs-meta` | Finalize docs, README, metadata, and agent protocol for shipping |
|
|
247
|
-
| `git-wrapup` | Land working-tree changes as a
|
|
248
|
-
| `release-
|
|
271
|
+
| `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 |
|
|
272
|
+
| `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 |
|
|
273
|
+
| `release-and-publish` | Fast-forward merge (release PR mode) + tag + push + npm + MCP Registry + GH Release + Docker. Picks up from `git-wrapup` |
|
|
249
274
|
| `maintenance` | Investigate changelogs, adopt upstream changes, sync skills to agent dirs |
|
|
250
275
|
| `orchestrations` | Chain task skills into a gated multi-phase pipeline — build-out, QA-fix, update-ship — when you can spawn sub-agents |
|
|
251
276
|
| `report-issue-framework` | File a bug or feature request against `@cyanheads/mcp-ts-core` via `gh` CLI |
|
|
252
277
|
| `report-issue-local` | File a bug or feature request against this server's own repo via `gh` CLI |
|
|
278
|
+
| `techniques` | Catalog of response/data-shaping techniques — overflow handling, payload shaping, retrieval patterns |
|
|
253
279
|
| `api-auth` | Auth modes, scopes, JWT/OAuth |
|
|
254
280
|
| `api-canvas` | DataCanvas: register tabular data, run SQL, export, plus the `spillover()` helper for big result sets — Tier 3 opt-in |
|
|
255
281
|
| `api-config` | AppConfig, parseConfig, env vars |
|
|
256
|
-
| `api-context` | Context interface, logger, state,
|
|
282
|
+
| `api-context` | Context interface, RequestContext, logger, state, multi-round-trip input |
|
|
257
283
|
| `api-errors` | McpError, JsonRpcErrorCode, error patterns |
|
|
258
284
|
| `api-linter` | Definition linter rule catalog — invoked by `bun run lint:mcp` and `devcheck` |
|
|
285
|
+
| `api-mirror` | MirrorService: persistent self-refreshing local mirror (embedded SQLite + FTS5) of a bulk upstream dataset — Tier 3 opt-in |
|
|
259
286
|
| `api-services` | LLM, Speech, Graph services |
|
|
260
287
|
| `api-testing` | createMockContext, test patterns |
|
|
261
288
|
| `api-utils` | Formatting, parsing, security, pagination, scheduling, telemetry helpers |
|
|
262
289
|
| `api-telemetry` | OTel catalog: spans, metrics, completion logs, env config, cardinality rules |
|
|
263
290
|
| `api-workers` | Cloudflare Workers runtime |
|
|
264
|
-
| `techniques` | Reusable response/data-shaping patterns — outline-on-overflow, spillover, capped-list disclosure |
|
|
265
291
|
|
|
266
|
-
**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*, `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.
|
|
292
|
+
**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.
|
|
267
293
|
|
|
268
294
|
When you complete a skill's checklist, check the boxes and add a completion timestamp at the end (e.g., `Completed: 2026-03-11`).
|
|
269
295
|
|
|
@@ -275,30 +301,36 @@ When you complete a skill's checklist, check the boxes and add a completion time
|
|
|
275
301
|
|
|
276
302
|
| Command | Purpose |
|
|
277
303
|
|:--------|:--------|
|
|
278
|
-
| `
|
|
279
|
-
| `
|
|
280
|
-
| `
|
|
281
|
-
| `
|
|
282
|
-
| `bun run audit:
|
|
283
|
-
| `
|
|
284
|
-
| `
|
|
285
|
-
| `
|
|
286
|
-
| `
|
|
287
|
-
| `
|
|
288
|
-
| `
|
|
289
|
-
| `
|
|
290
|
-
| `
|
|
291
|
-
| `
|
|
304
|
+
| `bun run build` | Compile TypeScript |
|
|
305
|
+
| `bun run rebuild` | Clean + build |
|
|
306
|
+
| `bun run clean` | Remove build artifacts |
|
|
307
|
+
| `bun run devcheck` | Lint + format + typecheck + security + changelog sync |
|
|
308
|
+
| `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` |
|
|
309
|
+
| `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` |
|
|
310
|
+
| `bun run lint:mcp` | Run the MCP definition linter standalone (rule catalog: `api-linter` skill) |
|
|
311
|
+
| `bun run lint:packaging` | Packaging surface checks — `server.json`/`manifest.json` env-var parity (run by devcheck) |
|
|
312
|
+
| `bun run list-skills` | Print the skill registry |
|
|
313
|
+
| `bun run tree` | Generate directory structure doc |
|
|
314
|
+
| `bun run format` | Auto-fix formatting (safe fixes only) |
|
|
315
|
+
| `bun run format:unsafe` | Also apply Biome's unsafe autofixes — review the diff; they can change behavior |
|
|
316
|
+
| `bun run test` | Run tests (Vitest — use `bun run test`, not `bun test`) |
|
|
317
|
+
| `bun run start:stdio` | Production mode (stdio) |
|
|
318
|
+
| `bun run start:http` | Production mode (HTTP) |
|
|
319
|
+
| `bun run changelog:build` | Regenerate `CHANGELOG.md` from `changelog/*.md` |
|
|
320
|
+
| `bun run changelog:check` | Verify `CHANGELOG.md` is in sync (used by devcheck) |
|
|
321
|
+
| `bun run bundle` | Build, pack, and clean a `.mcpb` for one-click Claude Desktop install |
|
|
322
|
+
|
|
323
|
+
**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.
|
|
292
324
|
|
|
293
325
|
---
|
|
294
326
|
|
|
295
327
|
## Bundling
|
|
296
328
|
|
|
297
|
-
`npm run bundle` produces a `.mcpb` extension bundle for one-click install in Claude Desktop. The pack step is followed by `scripts/clean-mcpb.ts`, which prunes dev dependencies (`mcpb clean`) and strips dependency-shipped agent docs (`
|
|
329
|
+
`npm run bundle` produces a `.mcpb` extension bundle for one-click install in Claude Desktop. The pack step is followed by `scripts/clean-mcpb.ts`, which prunes dev dependencies (`mcpb clean`) and strips two classes of `node_modules/**` content that root-anchored `.mcpbignore` patterns cannot reach: dependency-shipped agent docs (`framework-skills/`, `skills/`, `.claude/`, `.agents/`, `SKILL.md`) and platform-specific native bindings, which would otherwise lock the bundle to the platform it was packed on. MCPB is stdio-only — HTTP and Cloudflare Workers deployments are unaffected. Consumers who don't need it can delete `manifest.json` and `.mcpbignore`; `lint:packaging` skips cleanly.
|
|
298
330
|
|
|
299
|
-
**Adding an env var requires both files:** `server.json` (registry discovery, `environmentVariables[]`) and `manifest.json` (bundle install UX, `mcp_config.env` + `user_config`). `lint:packaging` (run by `devcheck`) verifies the env var names match.
|
|
331
|
+
**Adding an env var requires both files:** `server.json` (registry discovery, `environmentVariables[]`) and `manifest.json` (bundle install UX, `mcp_config.env` + `user_config`). `lint:packaging` (run by `devcheck`) verifies the env var names match, that every `user_config` option is wired into `mcp_config.env` as `"X": "${user_config.X}"` (the host substitutes nothing else — `"${X}"` reaches the server as that literal string), and that an optional string option carries `"default": ""`.
|
|
300
332
|
|
|
301
|
-
**README install badges** (Claude Desktop `.mcpb`, Cursor, VS Code) and the `base64` / `encodeURIComponent` config-generation commands are ship-time concerns — run the `polish-docs-meta` skill, which carries the badge format, layout, and generation snippets in `skills/polish-docs-meta/references/readme.md`.
|
|
333
|
+
**README install badges** (Claude Desktop `.mcpb`, Cursor, VS Code) and the `base64` / `encodeURIComponent` config-generation commands are ship-time concerns — run the `polish-docs-meta` skill, which carries the badge format, layout, and generation snippets in `framework-skills/polish-docs-meta/references/readme.md`.
|
|
302
334
|
|
|
303
335
|
---
|
|
304
336
|
|
|
@@ -312,23 +344,29 @@ Each per-version file opens with YAML frontmatter:
|
|
|
312
344
|
---
|
|
313
345
|
summary: "One-line headline, ≤350 chars" # required — powers the rollup index
|
|
314
346
|
breaking: false # optional — true flags breaking changes
|
|
315
|
-
security: false # optional — true
|
|
347
|
+
security: false # optional — true ONLY for a source-code security fix, never a dependency CVE bump
|
|
316
348
|
---
|
|
317
349
|
|
|
318
350
|
# 0.1.0 — YYYY-MM-DD
|
|
319
351
|
...
|
|
320
352
|
```
|
|
321
353
|
|
|
322
|
-
`breaking: true` renders a `· ⚠️ Breaking` badge — use it when consumers must update code on upgrade (signature changes, removed APIs, config renames). `security: true` renders a `· 🛡️ Security` badge and pairs with a `## Security` body section. When both are set, badges render `· ⚠️ Breaking · 🛡️ Security`.
|
|
354
|
+
`breaking: true` renders a `· ⚠️ Breaking` badge — use it when consumers must update code on upgrade (signature changes, removed APIs, config renames). `security: true` renders a `· 🛡️ Security` badge and pairs with a `## Security` body section — set it only for a security fix in this server's *own source code*, never for a routine dependency or transitive CVE bump (record those under `## Dependencies`). When both are set, badges render `· ⚠️ Breaking · 🛡️ Security`.
|
|
323
355
|
|
|
324
356
|
`agent-notes` is an optional free-form field for maintenance agents processing the release downstream. Content here won't appear in the rendered CHANGELOG — it's consumed by agents running the `maintenance` skill. Use it for adoption instructions that don't fit the human-facing sections: new files to create, fields to populate, one-time migration steps. Omit entirely when there's nothing to say.
|
|
325
357
|
|
|
326
|
-
**Section order
|
|
358
|
+
**Section order:** the Keep a Changelog sequence — Added, Changed, Deprecated, Removed, Fixed, Security — then `Dependencies` last. Include only sections with entries — don't ship empty headers.
|
|
327
359
|
|
|
328
360
|
**Tag annotations** render as GitHub Release bodies via `--notes-from-tag`. They must be structured markdown — never a flat comma-separated string. Subject omits the version number (GitHub prepends it). See `changelog/template.md` for the full format reference.
|
|
329
361
|
|
|
330
362
|
---
|
|
331
363
|
|
|
364
|
+
## Publishing
|
|
365
|
+
|
|
366
|
+
**Every release goes through a release PR, straight-through** — `git-wrapup`'s "Release PR mode", mode `straight-through`. One run: `git-wrapup` lands the commit stack on `release/<version>`, pushes it, and opens the PR (title = the release commit subject, body = the changelog entry plus a gates section); `release-and-publish` then 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. A caller's brief may run a given release as `gated` instead — a `release-pr-review` pass on the open PR before `release-and-publish`. **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.
|
|
367
|
+
|
|
368
|
+
---
|
|
369
|
+
|
|
332
370
|
## Imports
|
|
333
371
|
|
|
334
372
|
```ts
|
|
@@ -355,7 +393,7 @@ import { getMyService } from '@/services/my-domain/my-service.js';
|
|
|
355
393
|
- [ ] If wrapping external API: tests include at least one sparse payload case with omitted upstream fields
|
|
356
394
|
- [ ] Registered in `createApp()` arrays (directly or via barrel exports)
|
|
357
395
|
- [ ] Tests use `createMockContext()` from `@cyanheads/mcp-ts-core/testing`
|
|
358
|
-
- [ ] `.codex-plugin/plugin.json` populated — `name`, `version`, `description`, `repository`, `license` from `package.json`; `interface.displayName` =
|
|
359
|
-
- [ ] `.codex-plugin/mcp.json` updated — server name key
|
|
360
|
-
- [ ] `.claude-plugin/plugin.json` populated — `name`, `version`, `description`, `repository`, `license` from `package.json`; inline `mcpServers` entry
|
|
396
|
+
- [ ] `.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
|
|
397
|
+
- [ ] `.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
|
|
398
|
+
- [ ] `.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`
|
|
361
399
|
- [ ] `npm run devcheck` passes
|
package/CLAUDE.md
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
# Developer Protocol
|
|
2
2
|
|
|
3
3
|
**Server:** whois-mcp-server
|
|
4
|
-
**Version:** 0.1.
|
|
5
|
-
**Framework:** [@cyanheads/mcp-ts-core](https://www.npmjs.com/package/@cyanheads/mcp-ts-core) `^0.
|
|
6
|
-
**Engines:** Bun ≥1.
|
|
7
|
-
**MCP SDK:** `@modelcontextprotocol/
|
|
8
|
-
**Zod:** ^4.
|
|
4
|
+
**Version:** 0.1.5
|
|
5
|
+
**Framework:** [@cyanheads/mcp-ts-core](https://www.npmjs.com/package/@cyanheads/mcp-ts-core) `^0.13.6`
|
|
6
|
+
**Engines:** Bun ≥1.4.0, Node ≥24.0.0
|
|
7
|
+
**MCP SDK:** `@modelcontextprotocol/server` ^2.0.0
|
|
8
|
+
**Zod:** ^4.6.5
|
|
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
|
|
|
@@ -35,8 +35,9 @@ Tailor suggestions to what's actually missing or stale — don't recite the full
|
|
|
35
35
|
- **Logic throws, framework catches.** Tool/resource handlers are pure — throw on failure, no `try/catch`. Plain `Error` is fine; the framework catches, classifies, and formats. Use error factories (`notFound()`, `validationError()`, etc.) when the error code matters.
|
|
36
36
|
- **Use `ctx.log`** for request-scoped logging. No `console` calls.
|
|
37
37
|
- **Use `ctx.state`** for tenant-scoped storage. Never access persistence directly.
|
|
38
|
-
- **
|
|
38
|
+
- **Need input the caller didn't supply?** `return ctx.requestInput(...)` and read `ctx.inputs` when the handler is re-entered. Never `await` for user input mid-handler.
|
|
39
39
|
- **Secrets in env vars only** — never hardcoded.
|
|
40
|
+
- **Cut noise.** Add only what earns its place: no speculative generality, no guards for states the framework already prevents (Zod-validated params, classified errors), no abstraction until a third caller proves it, no option nothing sets.
|
|
40
41
|
- **Close the loop on issues.** When implementing work tracked by a GitHub issue, comment on the issue with what landed and close it. Do both — a comment without a close leaves stale issues open; a close without a comment leaves no record of what shipped. The comment is for future readers — state the concrete changes, not the conversation that produced them.
|
|
41
42
|
|
|
42
43
|
---
|
|
@@ -105,7 +106,9 @@ export function getServerConfig() {
|
|
|
105
106
|
}
|
|
106
107
|
```
|
|
107
108
|
|
|
108
|
-
`parseEnvConfig` maps Zod schema paths → env var names so errors name the variable (`RDAP_TIMEOUT_MS`) not the path (`rdapTimeoutMs`). Throws `ConfigurationError`, which the framework prints as a clean startup banner.
|
|
109
|
+
`parseEnvConfig` maps Zod schema paths → env var names so errors name the variable (`RDAP_TIMEOUT_MS`) not the path (`rdapTimeoutMs`). Throws `ConfigurationError`, which the framework prints as a clean startup banner. An empty string and a whole-value unsubstituted `${…}` placeholder read as unset, so an optional field stays `undefined` and a defaulted field takes its default.
|
|
110
|
+
|
|
111
|
+
For env booleans use `z.stringbool()`, never `z.coerce.boolean()` — `Boolean("false")` is `true`, so a coerced flag can't be disabled through the environment. `z.stringbool()` parses `true/false/1/0/yes/no/on/off` and rejects anything else, so `=false` actually disables.
|
|
109
112
|
|
|
110
113
|
### Server identity and instructions
|
|
111
114
|
|
|
@@ -121,6 +124,24 @@ await createApp({
|
|
|
121
124
|
|
|
122
125
|
`instructions` is optional server-level orientation, sent on every `initialize` as session-level context. Use it for deployment guidance (connection aliases, regional notes, scope hints) instead of repeating the same context across tool descriptions. Client adoption is uneven, but there's no downside when set.
|
|
123
126
|
|
|
127
|
+
### Session posture and shutdown
|
|
128
|
+
|
|
129
|
+
Two more `createApp()` options shape how the server runs rather than how it presents itself:
|
|
130
|
+
|
|
131
|
+
```ts
|
|
132
|
+
await createApp({
|
|
133
|
+
sessionMode: 'stateless', // or { default: 'stateful', require: 'stateful' }
|
|
134
|
+
setup(core) { startMyWatcher(core.config); },
|
|
135
|
+
async teardown() { await stopMyWatcher(); },
|
|
136
|
+
});
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
`sessionMode` declares the HTTP session posture in `src/` instead of leaving it to a deployment's `MCP_SESSION_MODE`, which still wins whenever it carries a meaningful value (an empty string and an unsubstituted `${…}` placeholder read as unset and fall through to the option). Add `require: 'stateful'` when a tool asks the caller for input mid-handler via `ctx.requestInput`: startup then fails with a `ConfigurationError` rather than serving a mode in which a 2025-era client can never answer the prompt. Stdio is never refused.
|
|
140
|
+
|
|
141
|
+
`teardown(core)` is the `setup()` counterpart — release a watcher, socket, or non-`unref()`'d timer there. It runs after the transport stops and before the logger closes, on every shutdown path, and a signal-triggered shutdown then exits the process explicitly (0, or 1 if a step never settles within the framework's 10 s ceiling).
|
|
142
|
+
|
|
143
|
+
**This server declares `sessionMode: 'stateless'`.** It holds no per-session state and no handler calls `ctx.requestInput`, so the session store and the per-session `McpServer` allocation are pure overhead and the process scales horizontally. `MCP_SESSION_MODE=stateless` in `.env.example` and the `Dockerfile` restate the same posture rather than overriding it; `require: 'stateful'` is deliberately not set. Neither `RdapService` nor `DohService` allocates a watcher, socket, or ref'd timer, so no `teardown` hook is warranted.
|
|
144
|
+
|
|
124
145
|
---
|
|
125
146
|
|
|
126
147
|
## Context
|
|
@@ -129,12 +150,15 @@ Handlers receive a unified `ctx` object. Key properties:
|
|
|
129
150
|
|
|
130
151
|
| Property | Description |
|
|
131
152
|
|:---------|:------------|
|
|
132
|
-
| `ctx.log` | Request-scoped logger — `.debug()`, `.info()`, `.notice()`, `.warning()`, `.error()`. Auto-correlates requestId, traceId, tenantId. |
|
|
133
|
-
| `ctx.state` | Tenant-scoped KV — `.get(key)`, `.set(key, value, { ttl? })`, `.delete(key)`, `.list(prefix, { cursor, limit })`.
|
|
134
|
-
| `ctx.
|
|
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. |
|
|
155
|
+
| `ctx.requestInput` | Suspend and ask the caller for more input — `return ctx.requestInput({ inputRequests: { key: inputRequired.elicit({ message, requestedSchema }) } })`. Never returns; the handler is re-entered with the answers. Always present. |
|
|
156
|
+
| `ctx.inputs` | Reader over a retried request's responses — `.accepted(key, schema)`, `.view(key)`, `.state()`, `.dropped`. Empty on the first round. |
|
|
157
|
+
| `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). |
|
|
158
|
+
| `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`. |
|
|
135
159
|
| `ctx.signal` | `AbortSignal` for cancellation. |
|
|
136
160
|
| `ctx.requestId` | Unique request ID. |
|
|
137
|
-
| `ctx.tenantId` | Tenant ID from JWT
|
|
161
|
+
| `ctx.tenantId` | Tenant ID from JWT; `'default'` for stdio or HTTP with auth off. |
|
|
138
162
|
|
|
139
163
|
---
|
|
140
164
|
|
|
@@ -142,7 +166,7 @@ Handlers receive a unified `ctx` object. Key properties:
|
|
|
142
166
|
|
|
143
167
|
Handlers throw — the framework catches, classifies, and formats.
|
|
144
168
|
|
|
145
|
-
**Recommended: typed error contract.** Declare `errors: [{ reason, code, when, recovery, retryable? }]` 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
|
|
169
|
+
**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. Pass `ctx.recoveryFor('reason')` as the throw's data to put it on the wire (`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. Forwarding it is lint-enforced per throw site (`error-contract-recovery-unforwarded`). 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.
|
|
146
170
|
|
|
147
171
|
```ts
|
|
148
172
|
import { JsonRpcErrorCode } from '@cyanheads/mcp-ts-core/errors';
|
|
@@ -154,7 +178,7 @@ errors: [
|
|
|
154
178
|
],
|
|
155
179
|
async handler(input, ctx) {
|
|
156
180
|
const item = await db.find(input.id);
|
|
157
|
-
if (!item) throw ctx.fail('no_match', `No item ${input.id}
|
|
181
|
+
if (!item) throw ctx.fail('no_match', `No item ${input.id}`, ctx.recoveryFor('no_match'));
|
|
158
182
|
return item;
|
|
159
183
|
}
|
|
160
184
|
```
|
|
@@ -175,7 +199,7 @@ throw new Error('Invalid query format'); // → ValidationError
|
|
|
175
199
|
|
|
176
200
|
// McpError — when no factory exists for the code
|
|
177
201
|
import { McpError, JsonRpcErrorCode } from '@cyanheads/mcp-ts-core/errors';
|
|
178
|
-
throw new McpError(JsonRpcErrorCode.
|
|
202
|
+
throw new McpError(JsonRpcErrorCode.InitializationFailed, 'Connection failed', { pool: 'primary' });
|
|
179
203
|
```
|
|
180
204
|
|
|
181
205
|
See framework CLAUDE.md and the `api-errors` skill for the full auto-classification table, all available factories, and the contract reference.
|
|
@@ -186,7 +210,8 @@ See framework CLAUDE.md and the `api-errors` skill for the full auto-classificat
|
|
|
186
210
|
|
|
187
211
|
```text
|
|
188
212
|
src/
|
|
189
|
-
index.ts #
|
|
213
|
+
index.ts # Entry point — starts the app
|
|
214
|
+
app.ts # createApp() options — tools, services, session mode
|
|
190
215
|
config/
|
|
191
216
|
server-config.ts # Server-specific env vars (Zod schema)
|
|
192
217
|
services/
|
|
@@ -194,7 +219,7 @@ src/
|
|
|
194
219
|
rdap-service.ts # RDAP client — IANA bootstrap + domain/IP/ASN lookup
|
|
195
220
|
types.ts # RDAP domain/IP/ASN normalized types
|
|
196
221
|
doh/
|
|
197
|
-
doh-service.ts # DNS-over-HTTPS client — Cloudflare primary,
|
|
222
|
+
doh-service.ts # DNS-over-HTTPS client — Cloudflare primary, NextDNS fallback
|
|
198
223
|
types.ts # DoH record types
|
|
199
224
|
mcp-server/
|
|
200
225
|
tools/definitions/
|
|
@@ -222,9 +247,9 @@ src/
|
|
|
222
247
|
|
|
223
248
|
## Skills
|
|
224
249
|
|
|
225
|
-
Skills are modular instructions in `skills/` at the project root. Read them directly when a task matches — e.g., `skills/add-tool/SKILL.md` when adding a tool.
|
|
250
|
+
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.
|
|
226
251
|
|
|
227
|
-
**Agent skill directory:** Copy skills into the directory your agent discovers (Claude Code: `.claude/skills/`, others: equivalent). Skills then load as context without referencing `skills/` paths. After framework updates, run the `maintenance` skill — Phase B re-syncs the agent directory.
|
|
252
|
+
**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.
|
|
228
253
|
|
|
229
254
|
Available skills:
|
|
230
255
|
|
|
@@ -242,28 +267,29 @@ Available skills:
|
|
|
242
267
|
| `tool-defs-analysis` | Read-only audit of MCP definition language across the surface — voice, leaks, defaults, recovery hints, output descriptions |
|
|
243
268
|
| `security-pass` | Audit server for MCP-flavored security gaps: output injection, scope blast radius, input sinks, tenant isolation |
|
|
244
269
|
| `code-simplifier` | Post-session cleanup against `git diff` — modernize syntax, consolidate duplication, align with the codebase |
|
|
245
|
-
| `devcheck` | Lint, format, typecheck, audit |
|
|
246
270
|
| `polish-docs-meta` | Finalize docs, README, metadata, and agent protocol for shipping |
|
|
247
|
-
| `git-wrapup` | Land working-tree changes as a
|
|
248
|
-
| `release-
|
|
271
|
+
| `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 |
|
|
272
|
+
| `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 |
|
|
273
|
+
| `release-and-publish` | Fast-forward merge (release PR mode) + tag + push + npm + MCP Registry + GH Release + Docker. Picks up from `git-wrapup` |
|
|
249
274
|
| `maintenance` | Investigate changelogs, adopt upstream changes, sync skills to agent dirs |
|
|
250
275
|
| `orchestrations` | Chain task skills into a gated multi-phase pipeline — build-out, QA-fix, update-ship — when you can spawn sub-agents |
|
|
251
276
|
| `report-issue-framework` | File a bug or feature request against `@cyanheads/mcp-ts-core` via `gh` CLI |
|
|
252
277
|
| `report-issue-local` | File a bug or feature request against this server's own repo via `gh` CLI |
|
|
278
|
+
| `techniques` | Catalog of response/data-shaping techniques — overflow handling, payload shaping, retrieval patterns |
|
|
253
279
|
| `api-auth` | Auth modes, scopes, JWT/OAuth |
|
|
254
280
|
| `api-canvas` | DataCanvas: register tabular data, run SQL, export, plus the `spillover()` helper for big result sets — Tier 3 opt-in |
|
|
255
281
|
| `api-config` | AppConfig, parseConfig, env vars |
|
|
256
|
-
| `api-context` | Context interface, logger, state,
|
|
282
|
+
| `api-context` | Context interface, RequestContext, logger, state, multi-round-trip input |
|
|
257
283
|
| `api-errors` | McpError, JsonRpcErrorCode, error patterns |
|
|
258
284
|
| `api-linter` | Definition linter rule catalog — invoked by `bun run lint:mcp` and `devcheck` |
|
|
285
|
+
| `api-mirror` | MirrorService: persistent self-refreshing local mirror (embedded SQLite + FTS5) of a bulk upstream dataset — Tier 3 opt-in |
|
|
259
286
|
| `api-services` | LLM, Speech, Graph services |
|
|
260
287
|
| `api-testing` | createMockContext, test patterns |
|
|
261
288
|
| `api-utils` | Formatting, parsing, security, pagination, scheduling, telemetry helpers |
|
|
262
289
|
| `api-telemetry` | OTel catalog: spans, metrics, completion logs, env config, cardinality rules |
|
|
263
290
|
| `api-workers` | Cloudflare Workers runtime |
|
|
264
|
-
| `techniques` | Reusable response/data-shaping patterns — outline-on-overflow, spillover, capped-list disclosure |
|
|
265
291
|
|
|
266
|
-
**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*, `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.
|
|
292
|
+
**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.
|
|
267
293
|
|
|
268
294
|
When you complete a skill's checklist, check the boxes and add a completion timestamp at the end (e.g., `Completed: 2026-03-11`).
|
|
269
295
|
|
|
@@ -275,30 +301,36 @@ When you complete a skill's checklist, check the boxes and add a completion time
|
|
|
275
301
|
|
|
276
302
|
| Command | Purpose |
|
|
277
303
|
|:--------|:--------|
|
|
278
|
-
| `
|
|
279
|
-
| `
|
|
280
|
-
| `
|
|
281
|
-
| `
|
|
282
|
-
| `bun run audit:
|
|
283
|
-
| `
|
|
284
|
-
| `
|
|
285
|
-
| `
|
|
286
|
-
| `
|
|
287
|
-
| `
|
|
288
|
-
| `
|
|
289
|
-
| `
|
|
290
|
-
| `
|
|
291
|
-
| `
|
|
304
|
+
| `bun run build` | Compile TypeScript |
|
|
305
|
+
| `bun run rebuild` | Clean + build |
|
|
306
|
+
| `bun run clean` | Remove build artifacts |
|
|
307
|
+
| `bun run devcheck` | Lint + format + typecheck + security + changelog sync |
|
|
308
|
+
| `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` |
|
|
309
|
+
| `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` |
|
|
310
|
+
| `bun run lint:mcp` | Run the MCP definition linter standalone (rule catalog: `api-linter` skill) |
|
|
311
|
+
| `bun run lint:packaging` | Packaging surface checks — `server.json`/`manifest.json` env-var parity (run by devcheck) |
|
|
312
|
+
| `bun run list-skills` | Print the skill registry |
|
|
313
|
+
| `bun run tree` | Generate directory structure doc |
|
|
314
|
+
| `bun run format` | Auto-fix formatting (safe fixes only) |
|
|
315
|
+
| `bun run format:unsafe` | Also apply Biome's unsafe autofixes — review the diff; they can change behavior |
|
|
316
|
+
| `bun run test` | Run tests (Vitest — use `bun run test`, not `bun test`) |
|
|
317
|
+
| `bun run start:stdio` | Production mode (stdio) |
|
|
318
|
+
| `bun run start:http` | Production mode (HTTP) |
|
|
319
|
+
| `bun run changelog:build` | Regenerate `CHANGELOG.md` from `changelog/*.md` |
|
|
320
|
+
| `bun run changelog:check` | Verify `CHANGELOG.md` is in sync (used by devcheck) |
|
|
321
|
+
| `bun run bundle` | Build, pack, and clean a `.mcpb` for one-click Claude Desktop install |
|
|
322
|
+
|
|
323
|
+
**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.
|
|
292
324
|
|
|
293
325
|
---
|
|
294
326
|
|
|
295
327
|
## Bundling
|
|
296
328
|
|
|
297
|
-
`npm run bundle` produces a `.mcpb` extension bundle for one-click install in Claude Desktop. The pack step is followed by `scripts/clean-mcpb.ts`, which prunes dev dependencies (`mcpb clean`) and strips dependency-shipped agent docs (`
|
|
329
|
+
`npm run bundle` produces a `.mcpb` extension bundle for one-click install in Claude Desktop. The pack step is followed by `scripts/clean-mcpb.ts`, which prunes dev dependencies (`mcpb clean`) and strips two classes of `node_modules/**` content that root-anchored `.mcpbignore` patterns cannot reach: dependency-shipped agent docs (`framework-skills/`, `skills/`, `.claude/`, `.agents/`, `SKILL.md`) and platform-specific native bindings, which would otherwise lock the bundle to the platform it was packed on. MCPB is stdio-only — HTTP and Cloudflare Workers deployments are unaffected. Consumers who don't need it can delete `manifest.json` and `.mcpbignore`; `lint:packaging` skips cleanly.
|
|
298
330
|
|
|
299
|
-
**Adding an env var requires both files:** `server.json` (registry discovery, `environmentVariables[]`) and `manifest.json` (bundle install UX, `mcp_config.env` + `user_config`). `lint:packaging` (run by `devcheck`) verifies the env var names match.
|
|
331
|
+
**Adding an env var requires both files:** `server.json` (registry discovery, `environmentVariables[]`) and `manifest.json` (bundle install UX, `mcp_config.env` + `user_config`). `lint:packaging` (run by `devcheck`) verifies the env var names match, that every `user_config` option is wired into `mcp_config.env` as `"X": "${user_config.X}"` (the host substitutes nothing else — `"${X}"` reaches the server as that literal string), and that an optional string option carries `"default": ""`.
|
|
300
332
|
|
|
301
|
-
**README install badges** (Claude Desktop `.mcpb`, Cursor, VS Code) and the `base64` / `encodeURIComponent` config-generation commands are ship-time concerns — run the `polish-docs-meta` skill, which carries the badge format, layout, and generation snippets in `skills/polish-docs-meta/references/readme.md`.
|
|
333
|
+
**README install badges** (Claude Desktop `.mcpb`, Cursor, VS Code) and the `base64` / `encodeURIComponent` config-generation commands are ship-time concerns — run the `polish-docs-meta` skill, which carries the badge format, layout, and generation snippets in `framework-skills/polish-docs-meta/references/readme.md`.
|
|
302
334
|
|
|
303
335
|
---
|
|
304
336
|
|
|
@@ -312,23 +344,29 @@ Each per-version file opens with YAML frontmatter:
|
|
|
312
344
|
---
|
|
313
345
|
summary: "One-line headline, ≤350 chars" # required — powers the rollup index
|
|
314
346
|
breaking: false # optional — true flags breaking changes
|
|
315
|
-
security: false # optional — true
|
|
347
|
+
security: false # optional — true ONLY for a source-code security fix, never a dependency CVE bump
|
|
316
348
|
---
|
|
317
349
|
|
|
318
350
|
# 0.1.0 — YYYY-MM-DD
|
|
319
351
|
...
|
|
320
352
|
```
|
|
321
353
|
|
|
322
|
-
`breaking: true` renders a `· ⚠️ Breaking` badge — use it when consumers must update code on upgrade (signature changes, removed APIs, config renames). `security: true` renders a `· 🛡️ Security` badge and pairs with a `## Security` body section. When both are set, badges render `· ⚠️ Breaking · 🛡️ Security`.
|
|
354
|
+
`breaking: true` renders a `· ⚠️ Breaking` badge — use it when consumers must update code on upgrade (signature changes, removed APIs, config renames). `security: true` renders a `· 🛡️ Security` badge and pairs with a `## Security` body section — set it only for a security fix in this server's *own source code*, never for a routine dependency or transitive CVE bump (record those under `## Dependencies`). When both are set, badges render `· ⚠️ Breaking · 🛡️ Security`.
|
|
323
355
|
|
|
324
356
|
`agent-notes` is an optional free-form field for maintenance agents processing the release downstream. Content here won't appear in the rendered CHANGELOG — it's consumed by agents running the `maintenance` skill. Use it for adoption instructions that don't fit the human-facing sections: new files to create, fields to populate, one-time migration steps. Omit entirely when there's nothing to say.
|
|
325
357
|
|
|
326
|
-
**Section order
|
|
358
|
+
**Section order:** the Keep a Changelog sequence — Added, Changed, Deprecated, Removed, Fixed, Security — then `Dependencies` last. Include only sections with entries — don't ship empty headers.
|
|
327
359
|
|
|
328
360
|
**Tag annotations** render as GitHub Release bodies via `--notes-from-tag`. They must be structured markdown — never a flat comma-separated string. Subject omits the version number (GitHub prepends it). See `changelog/template.md` for the full format reference.
|
|
329
361
|
|
|
330
362
|
---
|
|
331
363
|
|
|
364
|
+
## Publishing
|
|
365
|
+
|
|
366
|
+
**Every release goes through a release PR, straight-through** — `git-wrapup`'s "Release PR mode", mode `straight-through`. One run: `git-wrapup` lands the commit stack on `release/<version>`, pushes it, and opens the PR (title = the release commit subject, body = the changelog entry plus a gates section); `release-and-publish` then 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. A caller's brief may run a given release as `gated` instead — a `release-pr-review` pass on the open PR before `release-and-publish`. **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.
|
|
367
|
+
|
|
368
|
+
---
|
|
369
|
+
|
|
332
370
|
## Imports
|
|
333
371
|
|
|
334
372
|
```ts
|
|
@@ -355,7 +393,7 @@ import { getMyService } from '@/services/my-domain/my-service.js';
|
|
|
355
393
|
- [ ] If wrapping external API: tests include at least one sparse payload case with omitted upstream fields
|
|
356
394
|
- [ ] Registered in `createApp()` arrays (directly or via barrel exports)
|
|
357
395
|
- [ ] Tests use `createMockContext()` from `@cyanheads/mcp-ts-core/testing`
|
|
358
|
-
- [ ] `.codex-plugin/plugin.json` populated — `name`, `version`, `description`, `repository`, `license` from `package.json`; `interface.displayName` =
|
|
359
|
-
- [ ] `.codex-plugin/mcp.json` updated — server name key
|
|
360
|
-
- [ ] `.claude-plugin/plugin.json` populated — `name`, `version`, `description`, `repository`, `license` from `package.json`; inline `mcpServers` entry
|
|
396
|
+
- [ ] `.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
|
|
397
|
+
- [ ] `.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
|
|
398
|
+
- [ ] `.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`
|
|
361
399
|
- [ ] `npm run devcheck` passes
|