@cyanheads/nasa-power-mcp-server 0.0.0-stage → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (109) hide show
  1. package/AGENTS.md +316 -0
  2. package/CLAUDE.md +316 -0
  3. package/Dockerfile +186 -0
  4. package/LICENSE +201 -0
  5. package/README.md +267 -2
  6. package/changelog/0.1.x/0.1.1.md +29 -0
  7. package/changelog/template.md +151 -0
  8. package/dist/config/server-config.d.ts +46 -0
  9. package/dist/config/server-config.d.ts.map +1 -0
  10. package/dist/config/server-config.js +54 -0
  11. package/dist/config/server-config.js.map +1 -0
  12. package/dist/index.d.ts +7 -0
  13. package/dist/index.d.ts.map +1 -0
  14. package/dist/index.js +73 -0
  15. package/dist/index.js.map +1 -0
  16. package/dist/mcp-server/tools/definitions/comparison-contracts.d.ts +850 -0
  17. package/dist/mcp-server/tools/definitions/comparison-contracts.d.ts.map +1 -0
  18. package/dist/mcp-server/tools/definitions/comparison-contracts.js +271 -0
  19. package/dist/mcp-server/tools/definitions/comparison-contracts.js.map +1 -0
  20. package/dist/mcp-server/tools/definitions/nasa-power-compare-locations.tool.d.ts +825 -0
  21. package/dist/mcp-server/tools/definitions/nasa-power-compare-locations.tool.d.ts.map +1 -0
  22. package/dist/mcp-server/tools/definitions/nasa-power-compare-locations.tool.js +122 -0
  23. package/dist/mcp-server/tools/definitions/nasa-power-compare-locations.tool.js.map +1 -0
  24. package/dist/mcp-server/tools/definitions/nasa-power-dataframe-describe.tool.d.ts +62 -0
  25. package/dist/mcp-server/tools/definitions/nasa-power-dataframe-describe.tool.d.ts.map +1 -0
  26. package/dist/mcp-server/tools/definitions/nasa-power-dataframe-describe.tool.js +60 -0
  27. package/dist/mcp-server/tools/definitions/nasa-power-dataframe-describe.tool.js.map +1 -0
  28. package/dist/mcp-server/tools/definitions/nasa-power-dataframe-drop.tool.d.ts +31 -0
  29. package/dist/mcp-server/tools/definitions/nasa-power-dataframe-drop.tool.d.ts.map +1 -0
  30. package/dist/mcp-server/tools/definitions/nasa-power-dataframe-drop.tool.js +59 -0
  31. package/dist/mcp-server/tools/definitions/nasa-power-dataframe-drop.tool.js.map +1 -0
  32. package/dist/mcp-server/tools/definitions/nasa-power-dataframe-query.tool.d.ts +99 -0
  33. package/dist/mcp-server/tools/definitions/nasa-power-dataframe-query.tool.d.ts.map +1 -0
  34. package/dist/mcp-server/tools/definitions/nasa-power-dataframe-query.tool.js +125 -0
  35. package/dist/mcp-server/tools/definitions/nasa-power-dataframe-query.tool.js.map +1 -0
  36. package/dist/mcp-server/tools/definitions/nasa-power-get-climatology.tool.d.ts +367 -0
  37. package/dist/mcp-server/tools/definitions/nasa-power-get-climatology.tool.d.ts.map +1 -0
  38. package/dist/mcp-server/tools/definitions/nasa-power-get-climatology.tool.js +87 -0
  39. package/dist/mcp-server/tools/definitions/nasa-power-get-climatology.tool.js.map +1 -0
  40. package/dist/mcp-server/tools/definitions/nasa-power-get-region.tool.d.ts +312 -0
  41. package/dist/mcp-server/tools/definitions/nasa-power-get-region.tool.d.ts.map +1 -0
  42. package/dist/mcp-server/tools/definitions/nasa-power-get-region.tool.js +121 -0
  43. package/dist/mcp-server/tools/definitions/nasa-power-get-region.tool.js.map +1 -0
  44. package/dist/mcp-server/tools/definitions/nasa-power-get-timeseries.tool.d.ts +465 -0
  45. package/dist/mcp-server/tools/definitions/nasa-power-get-timeseries.tool.d.ts.map +1 -0
  46. package/dist/mcp-server/tools/definitions/nasa-power-get-timeseries.tool.js +113 -0
  47. package/dist/mcp-server/tools/definitions/nasa-power-get-timeseries.tool.js.map +1 -0
  48. package/dist/mcp-server/tools/definitions/nasa-power-list-reference.tool.d.ts +42 -0
  49. package/dist/mcp-server/tools/definitions/nasa-power-list-reference.tool.d.ts.map +1 -0
  50. package/dist/mcp-server/tools/definitions/nasa-power-list-reference.tool.js +171 -0
  51. package/dist/mcp-server/tools/definitions/nasa-power-list-reference.tool.js.map +1 -0
  52. package/dist/mcp-server/tools/definitions/nasa-power-search-parameters.tool.d.ts +79 -0
  53. package/dist/mcp-server/tools/definitions/nasa-power-search-parameters.tool.d.ts.map +1 -0
  54. package/dist/mcp-server/tools/definitions/nasa-power-search-parameters.tool.js +111 -0
  55. package/dist/mcp-server/tools/definitions/nasa-power-search-parameters.tool.js.map +1 -0
  56. package/dist/mcp-server/tools/definitions/point-contracts.d.ts +421 -0
  57. package/dist/mcp-server/tools/definitions/point-contracts.d.ts.map +1 -0
  58. package/dist/mcp-server/tools/definitions/point-contracts.js +23 -0
  59. package/dist/mcp-server/tools/definitions/point-contracts.js.map +1 -0
  60. package/dist/services/canvas/canvas-service.d.ts +104 -0
  61. package/dist/services/canvas/canvas-service.d.ts.map +1 -0
  62. package/dist/services/canvas/canvas-service.js +524 -0
  63. package/dist/services/canvas/canvas-service.js.map +1 -0
  64. package/dist/services/canvas/errors.d.ts +16 -0
  65. package/dist/services/canvas/errors.d.ts.map +1 -0
  66. package/dist/services/canvas/errors.js +85 -0
  67. package/dist/services/canvas/errors.js.map +1 -0
  68. package/dist/services/canvas/format.d.ts +7 -0
  69. package/dist/services/canvas/format.d.ts.map +1 -0
  70. package/dist/services/canvas/format.js +48 -0
  71. package/dist/services/canvas/format.js.map +1 -0
  72. package/dist/services/canvas/index.d.ts +4 -0
  73. package/dist/services/canvas/index.d.ts.map +1 -0
  74. package/dist/services/canvas/index.js +4 -0
  75. package/dist/services/canvas/index.js.map +1 -0
  76. package/dist/services/canvas/types.d.ts +82 -0
  77. package/dist/services/canvas/types.d.ts.map +1 -0
  78. package/dist/services/canvas/types.js +49 -0
  79. package/dist/services/canvas/types.js.map +1 -0
  80. package/dist/services/power/errors.d.ts +23 -0
  81. package/dist/services/power/errors.d.ts.map +1 -0
  82. package/dist/services/power/errors.js +61 -0
  83. package/dist/services/power/errors.js.map +1 -0
  84. package/dist/services/power/index.d.ts +8 -0
  85. package/dist/services/power/index.d.ts.map +1 -0
  86. package/dist/services/power/index.js +8 -0
  87. package/dist/services/power/index.js.map +1 -0
  88. package/dist/services/power/normalize.d.ts +70 -0
  89. package/dist/services/power/normalize.d.ts.map +1 -0
  90. package/dist/services/power/normalize.js +274 -0
  91. package/dist/services/power/normalize.js.map +1 -0
  92. package/dist/services/power/power-service.d.ts +60 -0
  93. package/dist/services/power/power-service.d.ts.map +1 -0
  94. package/dist/services/power/power-service.js +447 -0
  95. package/dist/services/power/power-service.js.map +1 -0
  96. package/dist/services/power/presets.d.ts +13 -0
  97. package/dist/services/power/presets.d.ts.map +1 -0
  98. package/dist/services/power/presets.js +11 -0
  99. package/dist/services/power/presets.js.map +1 -0
  100. package/dist/services/power/summarize.d.ts +23 -0
  101. package/dist/services/power/summarize.d.ts.map +1 -0
  102. package/dist/services/power/summarize.js +187 -0
  103. package/dist/services/power/summarize.js.map +1 -0
  104. package/dist/services/power/types.d.ts +1082 -0
  105. package/dist/services/power/types.d.ts.map +1 -0
  106. package/dist/services/power/types.js +416 -0
  107. package/dist/services/power/types.js.map +1 -0
  108. package/package.json +107 -4
  109. package/server.json +161 -0
package/AGENTS.md ADDED
@@ -0,0 +1,316 @@
1
+ # Developer Protocol
2
+
3
+ **Server:** nasa-power-mcp-server
4
+ **Version:** 0.1.1
5
+ **Framework:** [@cyanheads/mcp-ts-core](https://www.npmjs.com/package/@cyanheads/mcp-ts-core) `^0.13.15`
6
+ **Engines:** Bun ≥1.4.0, Node ≥24.0.0
7
+ **MCP SDK:** `@modelcontextprotocol/server` ^2.3.1
8
+ **Zod:** ^4.6.7
9
+
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
+
12
+ ---
13
+
14
+ ## What's Next?
15
+
16
+ When the user asks what's next or needs direction, suggest options based on the current project state. Common next steps:
17
+
18
+ 1. **Re-run the `setup` skill** — ensures CLAUDE.md, skills, structure, and metadata are populated and up to date with the current codebase
19
+ 2. **Run the `design-mcp-server` skill** — if the tool/resource surface hasn't been mapped yet, work through domain design
20
+ 3. **Add tools/resources/prompts** — scaffold new definitions using the `add-tool`, `add-app-tool`, `add-resource`, `add-prompt` skills
21
+ 4. **Add services** — scaffold domain service integrations using the `add-service` skill
22
+ 5. **Add tests** — scaffold tests for existing definitions using the `add-test` skill
23
+ 6. **Field-test definitions** — exercise tools/resources/prompts with real inputs using the `field-test` skill, get a report of issues and pain points
24
+ 7. **Run `devcheck`** — lint, format, typecheck, and security audit
25
+ 8. **Run the `security-pass` skill** — audit handlers for MCP-specific security gaps: output injection, scope blast radius, input sinks, tenant isolation
26
+ 9. **Run the `polish-docs-meta` skill** — finalize README, CHANGELOG, metadata, and agent protocol for shipping
27
+ 10. **Run the `maintenance` skill** — investigate changelogs, adopt upstream changes, and sync skills after `bun update --latest`
28
+
29
+ Tailor suggestions to what's actually missing or stale — don't recite the full list every time.
30
+
31
+ ---
32
+
33
+ ## Core Rules
34
+
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
+ - **Use `ctx.log`** for request-scoped logging. No `console` calls.
37
+ - **Use `ctx.state`** for tenant-scoped storage. Never access persistence directly.
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
+ - **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.
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.
42
+
43
+ ---
44
+
45
+ ## Patterns
46
+
47
+ Read the real contracts before extending them:
48
+
49
+ - `nasa-power-search-parameters.tool.ts` filters the complete community/resolution dictionary before pagination and enriches empty results.
50
+ - `nasa-power-get-timeseries.tool.ts` composes a strict scientific request with an optional explicit `canvas_id`.
51
+ - `nasa-power-dataframe-query.tool.ts` declares read-only SQL limits and typed recovery contracts.
52
+ - `src/services/power/power-service.ts` owns fixed-origin requests, bounded pacing, cache and deadlines.
53
+ - `src/services/canvas/canvas-service.ts` owns explicit-token admission, provenance, staging and cleanup.
54
+
55
+ Tool files live in `src/mcp-server/tools/definitions/`. Nine tools are registered; eight are enabled by default. `NASA_POWER_DATAFRAME_DROP_ENABLED=true` exposes explicit table removal. No resources or prompts are registered.
56
+
57
+ ### Configuration and distribution
58
+
59
+ `src/config/server-config.ts` lazily parses the drop flag with `z.stringbool().default(false)` and exports fixed `POWER_LIMITS`. Never use `z.coerce.boolean()` for environment flags.
60
+
61
+ `src/index.ts` fixes DuckDB to 256 MiB engine memory, four canvases per tenant, a one-hour sliding TTL and a six-hour absolute cap. The service further enforces eight tables per canvas, eight canvases per process and a 30-minute table TTL. Engine memory is not total RSS or temporary-disk capacity.
62
+
63
+ The portable MCPB fixes `CANVAS_PROVIDER_TYPE=none`. npm and Docker install the native dependency normally on supported platforms and permit `CANVAS_PROVIDER_TYPE=duckdb`. Keep those option sets distinct.
64
+
65
+ ### Identity and lifecycle
66
+
67
+ `createApp()` sets both `name` and `title` to `nasa-power-mcp-server`. npm install surfaces use `@cyanheads/nasa-power-mcp-server`; registry identity is `io.github.cyanheads/nasa-power-mcp-server`. Derive descriptions from `package.json`; do not duplicate one into the entrypoint.
68
+
69
+ The app declares stateless HTTP. Canvas tokens still authorize ephemeral process-local state and must be supplied explicitly; stateless transport does not make canvases portable across processes. Shutdown disposes upstream pacing and drains canvas work.
70
+
71
+ ---
72
+
73
+ ## Context
74
+
75
+ Handlers receive a unified `ctx` object. Key properties:
76
+
77
+ | Property | Description |
78
+ |:---------|:------------|
79
+ | `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. |
80
+ | `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). |
81
+ | `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. |
82
+ | `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). |
83
+ | `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. |
84
+ | `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). |
85
+ | `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`. |
86
+ | `ctx.signal` | `AbortSignal` for cancellation. |
87
+ | `ctx.requestId` | Request ID — the one every log record of the call carries and its error envelope returns as `data.requestId`. |
88
+ | `ctx.tenantId` | Tenant ID from JWT; `'default'` for stdio or HTTP with auth off. |
89
+
90
+ ---
91
+
92
+ ## Errors
93
+
94
+ Handlers throw — the framework catches, classifies, and formats.
95
+
96
+ **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.
97
+
98
+ ```ts
99
+ import { JsonRpcErrorCode } from '@cyanheads/mcp-ts-core/errors';
100
+
101
+ errors: [
102
+ { reason: 'no_match', code: JsonRpcErrorCode.NotFound,
103
+ when: 'No item matched the query',
104
+ recovery: 'Broaden the query or check the spelling and try again.' },
105
+ ],
106
+ async handler(input, ctx) {
107
+ const item = await db.find(input.id);
108
+ if (!item) throw ctx.fail('no_match', `No item ${input.id}`);
109
+ return item;
110
+ }
111
+ ```
112
+
113
+ **Declare contracts inline on each tool.** The contract is part of the tool's public surface — one file should give the full picture. Don't extract a shared `errors[]` constant; per-tool repetition is the intended cost of locality.
114
+
115
+ **Fallback (no contract entry fits):** throw via factories or plain `Error`.
116
+
117
+ ```ts
118
+ // Error factories — explicit code
119
+ import { notFound, serviceUnavailable } from '@cyanheads/mcp-ts-core/errors';
120
+ throw notFound('Item not found', { itemId });
121
+ throw serviceUnavailable('API unavailable', { url }, { cause: err });
122
+
123
+ // Plain Error — framework auto-classifies from message patterns
124
+ throw new Error('Item not found'); // → NotFound
125
+ throw new Error('Invalid query format'); // → ValidationError
126
+
127
+ // McpError — when no factory exists for the code
128
+ import { McpError, JsonRpcErrorCode } from '@cyanheads/mcp-ts-core/errors';
129
+ throw new McpError(JsonRpcErrorCode.InitializationFailed, 'Connection failed', { pool: 'primary' });
130
+ ```
131
+
132
+ See framework CLAUDE.md and the `api-errors` skill for the full auto-classification table, all available factories, and the contract reference.
133
+
134
+ ---
135
+
136
+ ## Structure
137
+
138
+ ```text
139
+ src/
140
+ index.ts
141
+ config/server-config.ts
142
+ services/
143
+ power/ # Source client, types, normalization and summaries
144
+ canvas/ # Explicit-token staging, SQL and lifecycle
145
+ mcp-server/tools/definitions/
146
+ # Nine tools and shared scientific contracts
147
+ tests/ # Offline and native integration tests
148
+ scripts/ # Build, validation and packaging
149
+ ```
150
+
151
+ ---
152
+
153
+ ## Naming
154
+
155
+ | What | Convention | Example |
156
+ |:-----|:-----------|:--------|
157
+ | Files | kebab-case with suffix | `search-docs.tool.ts` |
158
+ | Tool/resource/prompt names | snake_case | `search_docs` |
159
+ | Directories | kebab-case | `src/services/doc-search/` |
160
+ | Descriptions | Single string or template literal, no `+` concatenation | `'Search items by query and filter.'` |
161
+
162
+ ---
163
+
164
+ ## Skills
165
+
166
+ 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.
167
+
168
+ **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.
169
+
170
+ Available skills:
171
+
172
+ | Skill | Purpose |
173
+ |:------|:--------|
174
+ | `setup` | Post-init project orientation |
175
+ | `design-mcp-server` | Design tool surface, resources, and services for a new server |
176
+ | `add-tool` | Scaffold a new tool definition |
177
+ | `add-app-tool` | Scaffold an MCP App tool + paired UI resource |
178
+ | `add-resource` | Scaffold a new resource definition |
179
+ | `add-prompt` | Scaffold a new prompt definition |
180
+ | `add-service` | Scaffold a new service integration |
181
+ | `add-test` | Scaffold test file for a tool, resource, or service |
182
+ | `field-test` | Exercise tools/resources/prompts with real inputs, verify behavior, report issues |
183
+ | `tool-defs-analysis` | Read-only audit of MCP definition language across the surface — voice, leaks, defaults, recovery hints, output descriptions |
184
+ | `security-pass` | Audit server for MCP-flavored security gaps: output injection, scope blast radius, input sinks, tenant isolation |
185
+ | `code-simplifier` | Post-session cleanup against `git diff` — modernize syntax, consolidate duplication, align with the codebase |
186
+ | `polish-docs-meta` | Finalize docs, README, metadata, and agent protocol for shipping |
187
+ | `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 |
188
+ | `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 |
189
+ | `release-and-publish` | Fast-forward merge (release PR mode) + tag + push + npm + MCP Registry + GH Release + Docker. Picks up from `git-wrapup` |
190
+ | `maintenance` | Investigate changelogs, adopt upstream changes, sync skills to agent dirs |
191
+ | `orchestrations` | Chain task skills into a gated multi-phase pipeline — build-out, QA-fix, update-ship — when you can spawn sub-agents |
192
+ | `report-issue-framework` | File a bug or feature request against `@cyanheads/mcp-ts-core` via `gh` CLI |
193
+ | `report-issue-local` | File a bug or feature request against this server's own repo via `gh` CLI |
194
+ | `techniques` | Catalog of response/data-shaping techniques — overflow handling, payload shaping, retrieval patterns |
195
+ | `api-auth` | Auth modes, scopes, JWT/OAuth |
196
+ | `api-canvas` | DataCanvas: register tabular data, run SQL, export, plus the `spillover()` helper for big result sets — Tier 3 opt-in |
197
+ | `api-config` | AppConfig, parseConfig, env vars |
198
+ | `api-context` | Context interface, RequestContext, logger, state, multi-round-trip input |
199
+ | `api-errors` | McpError, JsonRpcErrorCode, error patterns |
200
+ | `api-linter` | Definition linter rule catalog — invoked by `bun run lint:mcp` and `devcheck` |
201
+ | `api-mirror` | MirrorService: persistent self-refreshing local mirror (embedded SQLite + FTS5) of a bulk upstream dataset — Tier 3 opt-in |
202
+ | `api-services` | LLM, Speech, Graph services |
203
+ | `api-testing` | createMockContext, test patterns |
204
+ | `api-utils` | Formatting, parsing, security, pagination, scheduling, telemetry helpers |
205
+ | `api-telemetry` | OTel catalog: spans, metrics, completion logs, env config, cardinality rules |
206
+ | `api-workers` | Cloudflare Workers runtime |
207
+
208
+ **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.
209
+
210
+ When you complete a skill's checklist, check the boxes and add a completion timestamp at the end (e.g., `Completed: 2026-03-11`).
211
+
212
+ ---
213
+
214
+ ## Commands
215
+
216
+ **Runtime:** Scripts use Bun's native TypeScript execution — `bun run <cmd>` is the standard invocation. `npm run <cmd>` also works (npm delegates to bun).
217
+
218
+ | Command | Purpose |
219
+ |:--------|:--------|
220
+ | `bun run build` | Compile TypeScript |
221
+ | `bun run rebuild` | Clean + build |
222
+ | `bun run clean` | Remove build artifacts |
223
+ | `bun run devcheck` | Lint + format + typecheck + security + changelog sync |
224
+ | `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` |
225
+ | `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` |
226
+ | `bun run lint:mcp` | Run the MCP definition linter standalone (rule catalog: `api-linter` skill) |
227
+ | `bun run lint:packaging` | Packaging surface checks — `server.json`/`manifest.json` env-var parity (run by devcheck) |
228
+ | `bun run list-skills` | Print the skill registry |
229
+ | `bun run tree` | Generate directory structure doc |
230
+ | `bun run format` | Auto-fix formatting (safe fixes only) |
231
+ | `bun run format:unsafe` | Also apply Biome's unsafe autofixes — review the diff; they can change behavior |
232
+ | `bun run test` | Run tests (Vitest — use `bun run test`, not `bun test`) |
233
+ | `bun run start:stdio` | Production mode (stdio) |
234
+ | `bun run start:http` | Production mode (HTTP) |
235
+ | `bun run changelog:build` | Regenerate `CHANGELOG.md` from `changelog/*.md` |
236
+ | `bun run changelog:check` | Verify `CHANGELOG.md` is in sync (used by devcheck) |
237
+ | `bun run bundle` | Build, pack, and clean a `.mcpb` for one-click Claude Desktop install |
238
+ | `bun run publish-mcp` | Authenticate with the macOS Keychain token and publish registry metadata |
239
+
240
+ **CI is one file.** `.github/workflows/codeql.yml` (scaffolded) 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.
241
+
242
+ ---
243
+
244
+ ## Bundling
245
+
246
+ `bun run bundle` builds the stdio-only portable MCPB for Claude Desktop. `scripts/clean-mcpb.ts` prunes development dependencies, dependency-shipped agent docs and platform-specific native bindings. The manifest fixes `CANVAS_PROVIDER_TYPE=none`: inline observations work, oversized source requests fail with narrowing guidance, and dataframe tools report that the provider is unavailable. `@duckdb/node-api` is a direct dependency for npm and Docker installs on supported platforms; bundle pruning does not change that package contract.
247
+
248
+ **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": ""`.
249
+
250
+ **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`.
251
+
252
+ ---
253
+
254
+ ## Changelog
255
+
256
+ Directory-based, grouped by minor series via the `.x` semver-wildcard convention. Source of truth: `changelog/<major.minor>.x/<version>.md` (e.g. `changelog/0.1.x/0.1.0.md`) — one file per release, shipped in the npm package. At release, author the per-version file with a concrete version and date, then run `npm run changelog:build` to regenerate the rollup. `changelog/template.md` is a **pristine format reference** — never edited or moved; read it for the frontmatter + section layout when scaffolding. `CHANGELOG.md` is a **navigation index** (header + link + summary per version), regenerated by `npm run changelog:build` — devcheck hard-fails on drift; never hand-edit it.
257
+
258
+ Each per-version file opens with YAML frontmatter:
259
+
260
+ ```markdown
261
+ ---
262
+ summary: "One-line headline, ≤350 chars" # required — powers the rollup index
263
+ breaking: false # optional — true flags breaking changes
264
+ security: false # optional — true ONLY for a source-code security fix, never a dependency CVE bump
265
+ ---
266
+
267
+ # 0.1.0 — YYYY-MM-DD
268
+ ...
269
+ ```
270
+
271
+ `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`.
272
+
273
+ `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.
274
+
275
+ **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.
276
+
277
+ **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.
278
+
279
+ ---
280
+
281
+ ## Publishing
282
+
283
+ Every release goes through a release PR — `git-wrapup`'s "Release PR mode", mode `straight-through`. Follow `git-wrapup` to create `release/<version>` and open the PR, then `release-and-publish` to fast-forward `main`, tag, publish, and clean up the release branch. Never merge through the GitHub UI or `gh pr merge`.
284
+
285
+ ---
286
+
287
+ ## Imports
288
+
289
+ ```ts
290
+ // Framework — z is re-exported, no separate zod import needed
291
+ import { tool, z } from '@cyanheads/mcp-ts-core';
292
+ import { McpError, JsonRpcErrorCode } from '@cyanheads/mcp-ts-core/errors';
293
+
294
+ // Server's own code — via path alias
295
+ import { getMyService } from '@/services/my-domain/my-service.js';
296
+ ```
297
+
298
+ ---
299
+
300
+ ## Checklist
301
+
302
+ - [ ] Zod schemas: all fields have `.describe()`, only JSON-Schema-serializable types (no `z.custom()`, `z.date()`, `z.transform()`, `z.bigint()`, `z.symbol()`, `z.void()`, `z.map()`, `z.set()`, `z.function()`, `z.nan()`)
303
+ - [ ] Optional nested objects: handler guards for empty inner values from form-based clients (`if (input.obj?.field && ...)`, not just `if (input.obj)`). When regex/length constraints matter, use `z.union([z.literal(''), z.string().regex(...).describe(...)])` — literal variants are exempt from `describe-on-fields`.
304
+ - [ ] JSDoc `@fileoverview` + `@module` on every file
305
+ - [ ] `ctx.log` for logging, `ctx.state` for storage
306
+ - [ ] Handlers throw on failure — error factories or plain `Error`, no try/catch
307
+ - [ ] `format()` renders all data the LLM needs — different clients forward different surfaces (Claude Code → `structuredContent`, Claude Desktop → `content[]`); both must carry the same data
308
+ - [ ] If wrapping external API: raw/domain/output schemas reviewed against real upstream sparsity/nullability before finalizing required vs optional fields
309
+ - [ ] If wrapping external API: normalization and `format()` preserve uncertainty; do not fabricate facts from missing upstream data
310
+ - [ ] If wrapping external API: tests include at least one sparse payload case with omitted upstream fields
311
+ - [ ] Registered in `createApp()` arrays (directly or via barrel exports)
312
+ - [ ] Tests use `createMockContext()` from `@cyanheads/mcp-ts-core/testing`
313
+ - [ ] `.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
314
+ - [ ] `.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
315
+ - [ ] `.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`
316
+ - [ ] `npm run devcheck` passes