@cyanheads/epa-mcp-server 0.3.0 → 0.3.2
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 +413 -0
- package/CLAUDE.md +91 -77
- package/Dockerfile +14 -7
- package/LICENSE +1 -1
- package/README.md +109 -97
- package/changelog/0.3.x/0.3.1.md +27 -0
- package/changelog/0.3.x/0.3.2.md +40 -0
- package/changelog/template.md +67 -43
- package/dist/config/server-config.d.ts +2 -2
- package/dist/config/server-config.d.ts.map +1 -1
- package/dist/config/server-config.js +6 -8
- package/dist/config/server-config.js.map +1 -1
- package/dist/index.js +2 -12
- package/dist/index.js.map +1 -1
- package/dist/mcp-server/tools/definitions/get-ejscreen.tool.d.ts +2 -1
- package/dist/mcp-server/tools/definitions/get-ejscreen.tool.d.ts.map +1 -1
- package/dist/mcp-server/tools/definitions/get-ejscreen.tool.js +1 -0
- package/dist/mcp-server/tools/definitions/get-ejscreen.tool.js.map +1 -1
- package/dist/mcp-server/tools/definitions/index.d.ts +12 -20
- package/dist/mcp-server/tools/definitions/index.d.ts.map +1 -1
- package/dist/mcp-server/tools/definitions/search-facilities.tool.d.ts +1 -6
- package/dist/mcp-server/tools/definitions/search-facilities.tool.d.ts.map +1 -1
- package/dist/mcp-server/tools/definitions/search-facilities.tool.js +0 -6
- package/dist/mcp-server/tools/definitions/search-facilities.tool.js.map +1 -1
- package/dist/mcp-server/tools/definitions/search-violations.tool.d.ts +3 -3
- package/dist/services/airnow/airnow-service.d.ts.map +1 -1
- package/dist/services/airnow/airnow-service.js +2 -2
- package/dist/services/airnow/airnow-service.js.map +1 -1
- package/dist/services/dmap/dmap-service.d.ts.map +1 -1
- package/dist/services/dmap/dmap-service.js +57 -41
- package/dist/services/dmap/dmap-service.js.map +1 -1
- package/dist/services/echo/echo-service.d.ts.map +1 -1
- package/dist/services/echo/echo-service.js +32 -10
- package/dist/services/echo/echo-service.js.map +1 -1
- package/dist/services/echo/types.d.ts +1 -0
- package/dist/services/echo/types.d.ts.map +1 -1
- package/dist/services/ejscreen/ejscreen-service.d.ts.map +1 -1
- package/dist/services/ejscreen/ejscreen-service.js +6 -8
- package/dist/services/ejscreen/ejscreen-service.js.map +1 -1
- package/package.json +16 -14
- package/server.json +4 -4
package/CLAUDE.md
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
# Developer Protocol
|
|
2
2
|
|
|
3
3
|
**Server:** epa-mcp-server
|
|
4
|
-
**Version:** 0.3.
|
|
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.3.2
|
|
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.** No speculative abstractions, guards for states the framework prevents, or unused options.
|
|
40
41
|
- **Close the loop on issues.** When implementing work tracked by a GitHub issue, comment on the issue with what landed before moving on. The comment is for future readers — state the concrete changes, not the conversation that produced them.
|
|
41
42
|
|
|
42
43
|
---
|
|
@@ -91,7 +92,7 @@ export const itemData = resource('inventory://{itemId}', {
|
|
|
91
92
|
params: z.object({ itemId: z.string().describe('Item identifier') }),
|
|
92
93
|
auth: ['inventory:read'],
|
|
93
94
|
async handler(params, ctx) {
|
|
94
|
-
const item = await ctx.state.get(`item
|
|
95
|
+
const item = await ctx.state.get(`item/${params.itemId}`);
|
|
95
96
|
if (!item) throw notFound(`Item ${params.itemId} not found`, { itemId: params.itemId });
|
|
96
97
|
return item;
|
|
97
98
|
},
|
|
@@ -125,6 +126,7 @@ import { parseEnvConfig } from '@cyanheads/mcp-ts-core/config';
|
|
|
125
126
|
const ServerConfigSchema = z.object({
|
|
126
127
|
apiKey: z.string().describe('External API key'),
|
|
127
128
|
maxResults: z.coerce.number().default(100),
|
|
129
|
+
verboseLogging: z.stringbool().default(false).describe('Enable verbose logging'),
|
|
128
130
|
});
|
|
129
131
|
|
|
130
132
|
let _config: z.infer<typeof ServerConfigSchema> | undefined;
|
|
@@ -132,6 +134,7 @@ export function getServerConfig() {
|
|
|
132
134
|
_config ??= parseEnvConfig(ServerConfigSchema, {
|
|
133
135
|
apiKey: 'MY_API_KEY',
|
|
134
136
|
maxResults: 'MY_MAX_RESULTS',
|
|
137
|
+
verboseLogging: 'MY_VERBOSE_LOGGING',
|
|
135
138
|
});
|
|
136
139
|
return _config;
|
|
137
140
|
}
|
|
@@ -139,6 +142,28 @@ export function getServerConfig() {
|
|
|
139
142
|
|
|
140
143
|
`parseEnvConfig` maps Zod schema paths → env var names so errors name the variable (`MY_API_KEY`) not the path (`apiKey`). Throws `ConfigurationError`, which the framework prints as a clean startup banner.
|
|
141
144
|
|
|
145
|
+
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.
|
|
146
|
+
|
|
147
|
+
### Server identity and instructions
|
|
148
|
+
|
|
149
|
+
The canonical `createApp()` identity block is the unscoped repository name in both fields. Package description and website metadata derive from `package.json`; do not duplicate them here.
|
|
150
|
+
|
|
151
|
+
```ts
|
|
152
|
+
await createApp({
|
|
153
|
+
name: 'epa-mcp-server',
|
|
154
|
+
title: 'epa-mcp-server',
|
|
155
|
+
instructions: 'Server-level orientation forwarded to the model on every initialize.',
|
|
156
|
+
});
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
`instructions` is optional server-level orientation, sent on every `initialize` as session-level context. Use it for deployment guidance, data-vintage notes, scope limits, and cross-tool workflows instead of repeating the same context across tool descriptions.
|
|
160
|
+
|
|
161
|
+
### Session posture and shutdown
|
|
162
|
+
|
|
163
|
+
EPA declares `sessionMode: 'stateless'` in `createApp()`. `MCP_SESSION_MODE` overrides that default when set to `auto`, `stateful`, or `stateless`; `auto` resolves to stateful. Empty strings and whole-value `${…}` placeholders use the server default. Tenant-scoped `ctx.state` storage is independent of sessions. If a future tool uses `ctx.requestInput`, require stateful HTTP with `{ default: 'stateful', require: 'stateful' }` for 2025-era clients.
|
|
164
|
+
|
|
165
|
+
Release service-owned watchers, sockets, and timers in `createApp({ teardown(core) })`. The hook runs after transport shutdown and before core storage and logging are disposed.
|
|
166
|
+
|
|
142
167
|
---
|
|
143
168
|
|
|
144
169
|
## Context
|
|
@@ -147,14 +172,15 @@ Handlers receive a unified `ctx` object. Key properties:
|
|
|
147
172
|
|
|
148
173
|
| Property | Description |
|
|
149
174
|
|:---------|:------------|
|
|
150
|
-
| `ctx.log` | Request-scoped logger — `.debug()`, `.info()`, `.notice()`, `.warning()`, `.error()`. Auto-correlates requestId, traceId, tenantId. |
|
|
151
|
-
| `ctx.state` | Tenant-scoped KV — `.get(key)`, `.set(key, value, { ttl? })`, `.delete(key)`, `.list(prefix, { cursor, limit })`. Accepts any serializable value. |
|
|
152
|
-
| `ctx.
|
|
153
|
-
| `ctx.
|
|
175
|
+
| `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. |
|
|
176
|
+
| `ctx.state` | Tenant-scoped KV — `.get(key)`, `.set(key, value, { ttl? })`, `.delete(key)`, `.getMany(keys)`, `.list(prefix, { cursor, limit })`. Accepts any serializable value. |
|
|
177
|
+
| `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. |
|
|
178
|
+
| `ctx.inputs` | Reader over a retried request's responses — `.accepted(key, schema)`, `.view(key)`, `.state()`, `.dropped`. Empty on the first round. |
|
|
179
|
+
| `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). |
|
|
180
|
+
| `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`. |
|
|
154
181
|
| `ctx.signal` | `AbortSignal` for cancellation. |
|
|
155
|
-
| `ctx.progress` | Task progress (present when `task: true`) — `.setTotal(n)`, `.increment()`, `.update(message)`. |
|
|
156
182
|
| `ctx.requestId` | Unique request ID. |
|
|
157
|
-
| `ctx.tenantId` | Tenant ID from JWT
|
|
183
|
+
| `ctx.tenantId` | Tenant ID from JWT; `'default'` for stdio or HTTP with auth off. |
|
|
158
184
|
|
|
159
185
|
---
|
|
160
186
|
|
|
@@ -162,9 +188,11 @@ Handlers receive a unified `ctx` object. Key properties:
|
|
|
162
188
|
|
|
163
189
|
Handlers throw — the framework catches, classifies, and formats.
|
|
164
190
|
|
|
165
|
-
**Recommended: typed error contract.** Declare `errors: [{ reason, code, when, recovery, retryable? }]` on `tool()` / `resource()` to receive `ctx.fail(reason, …)` typed against the reason union.
|
|
191
|
+
**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. `recovery` is required (≥ 5 words, lint-validated). Forward it with `ctx.recoveryFor('reason')` in the throw's data; both client surfaces receive it, with duplicate hints omitted from the text. Use explicit `{ recovery: { hint } }` for runtime guidance. Mark reasons produced below the handler with `thrownBy: 'service'`; remove unused entries. Baseline codes (`InternalError`, `ServiceUnavailable`, `Timeout`, `ValidationError`, `SerializationError`, `RequestCancelled`) need no declaration.
|
|
166
192
|
|
|
167
193
|
```ts
|
|
194
|
+
import { JsonRpcErrorCode } from '@cyanheads/mcp-ts-core/errors';
|
|
195
|
+
|
|
168
196
|
errors: [
|
|
169
197
|
{ reason: 'no_match', code: JsonRpcErrorCode.NotFound,
|
|
170
198
|
when: 'No item matched the query',
|
|
@@ -172,7 +200,7 @@ errors: [
|
|
|
172
200
|
],
|
|
173
201
|
async handler(input, ctx) {
|
|
174
202
|
const item = await db.find(input.id);
|
|
175
|
-
if (!item) throw ctx.fail('no_match', `No item ${input.id}
|
|
203
|
+
if (!item) throw ctx.fail('no_match', `No item ${input.id}`, ctx.recoveryFor('no_match'));
|
|
176
204
|
return item;
|
|
177
205
|
}
|
|
178
206
|
```
|
|
@@ -235,9 +263,9 @@ src/
|
|
|
235
263
|
|
|
236
264
|
## Skills
|
|
237
265
|
|
|
238
|
-
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.
|
|
266
|
+
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. Reserve root `skills/` for end-user plugin skills; plugin hosts automatically load that directory.
|
|
239
267
|
|
|
240
|
-
**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.
|
|
268
|
+
**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.
|
|
241
269
|
|
|
242
270
|
Available skills:
|
|
243
271
|
|
|
@@ -255,99 +283,74 @@ Available skills:
|
|
|
255
283
|
| `tool-defs-analysis` | Read-only audit of MCP definition language across the surface — voice, leaks, defaults, recovery hints, output descriptions |
|
|
256
284
|
| `security-pass` | Audit server for MCP-flavored security gaps: output injection, scope blast radius, input sinks, tenant isolation |
|
|
257
285
|
| `code-simplifier` | Post-session cleanup against `git diff` — modernize syntax, consolidate duplication, align with the codebase |
|
|
258
|
-
| `devcheck` | Lint, format, typecheck, audit |
|
|
259
286
|
| `polish-docs-meta` | Finalize docs, README, metadata, and agent protocol for shipping |
|
|
260
|
-
| `git-wrapup` |
|
|
261
|
-
| `release-
|
|
287
|
+
| `git-wrapup` | Commit the work by concern, then release metadata; open the release PR. No tag or push to main |
|
|
288
|
+
| `release-pr-review` | Review an open release PR; fixes land as ordinary commits on top of the stack |
|
|
289
|
+
| `release-and-publish` | Fast-forward merge + tag + push + npm + MCP Registry + GH Release + Docker |
|
|
262
290
|
| `maintenance` | Investigate changelogs, adopt upstream changes, sync skills to agent dirs |
|
|
263
291
|
| `orchestrations` | Chain task skills into a gated multi-phase pipeline — build-out, QA-fix, update-ship — when you can spawn sub-agents |
|
|
264
292
|
| `report-issue-framework` | File a bug or feature request against `@cyanheads/mcp-ts-core` via `gh` CLI |
|
|
265
293
|
| `report-issue-local` | File a bug or feature request against this server's own repo via `gh` CLI |
|
|
294
|
+
| `techniques` | Catalog of response/data-shaping techniques — overflow handling, payload shaping, retrieval patterns |
|
|
266
295
|
| `api-auth` | Auth modes, scopes, JWT/OAuth |
|
|
267
296
|
| `api-canvas` | DataCanvas: register tabular data, run SQL, export, plus the `spillover()` helper for big result sets — Tier 3 opt-in |
|
|
268
297
|
| `api-config` | AppConfig, parseConfig, env vars |
|
|
269
|
-
| `api-context` | Context interface, logger, state,
|
|
298
|
+
| `api-context` | Context interface, RequestContext, logger, state, multi-round-trip input |
|
|
270
299
|
| `api-errors` | McpError, JsonRpcErrorCode, error patterns |
|
|
271
300
|
| `api-linter` | Definition linter rule catalog — invoked by `bun run lint:mcp` and `devcheck` |
|
|
272
|
-
| `api-mirror` | MirrorService: persistent local mirror of a bulk upstream dataset
|
|
301
|
+
| `api-mirror` | MirrorService: persistent self-refreshing local mirror (embedded SQLite + FTS5) of a bulk upstream dataset — Tier 3 opt-in |
|
|
273
302
|
| `api-services` | LLM, Speech, Graph services |
|
|
274
303
|
| `api-testing` | createMockContext, test patterns |
|
|
275
304
|
| `api-utils` | Formatting, parsing, security, pagination, scheduling, telemetry helpers |
|
|
276
305
|
| `api-telemetry` | OTel catalog: spans, metrics, completion logs, env config, cardinality rules |
|
|
277
306
|
| `api-workers` | Cloudflare Workers runtime |
|
|
278
307
|
|
|
308
|
+
**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.
|
|
309
|
+
|
|
279
310
|
When you complete a skill's checklist, check the boxes and add a completion timestamp at the end (e.g., `Completed: 2026-03-11`).
|
|
280
311
|
|
|
281
312
|
---
|
|
282
313
|
|
|
283
314
|
## Commands
|
|
284
315
|
|
|
285
|
-
**Runtime:** Scripts use
|
|
316
|
+
**Runtime:** Scripts use Bun's native TypeScript execution — use `bun run <cmd>`.
|
|
286
317
|
|
|
287
318
|
| Command | Purpose |
|
|
288
319
|
|:--------|:--------|
|
|
289
|
-
| `
|
|
290
|
-
| `
|
|
291
|
-
| `
|
|
292
|
-
| `
|
|
293
|
-
| `bun run audit:
|
|
294
|
-
| `
|
|
295
|
-
| `
|
|
296
|
-
| `
|
|
297
|
-
| `
|
|
298
|
-
| `
|
|
299
|
-
| `
|
|
300
|
-
| `
|
|
301
|
-
| `
|
|
320
|
+
| `bun run build` | Compile TypeScript |
|
|
321
|
+
| `bun run rebuild` | Clean + build |
|
|
322
|
+
| `bun run clean` | Remove build artifacts |
|
|
323
|
+
| `bun run devcheck` | Lint + format + typecheck + security + changelog sync |
|
|
324
|
+
| `bun run audit:fix` | `bun audit fix`: upgrade vulnerable packages within existing ranges; first response to an advisory, then `bun update <name>` and `bun dedupe` |
|
|
325
|
+
| `bun run audit:refresh` | Last resort: delete the lockfile and reinstall; every ranged dependency, including the framework, re-resolves |
|
|
326
|
+
| `bun run lint:mcp` | Run the MCP definition linter standalone (rule catalog: `api-linter` skill) |
|
|
327
|
+
| `bun run lint:packaging` | Packaging surface checks — `server.json`/`manifest.json` env-var parity (run by devcheck) |
|
|
328
|
+
| `bun run list-skills` | Print the skill registry |
|
|
329
|
+
| `bun run tree` | Generate directory structure doc |
|
|
330
|
+
| `bun run format` | Auto-fix formatting (safe fixes only) |
|
|
331
|
+
| `bun run format:unsafe` | Also apply Biome's unsafe autofixes — review the diff; they can change behavior |
|
|
332
|
+
| `bun run test` | Run tests (Vitest — use `bun run test`, not `bun test`) |
|
|
333
|
+
| `bun run start:stdio` | Production mode (stdio) |
|
|
334
|
+
| `bun run start:http` | Production mode (HTTP) |
|
|
335
|
+
| `bun run changelog:build` | Regenerate `CHANGELOG.md` from `changelog/*.md` |
|
|
336
|
+
| `bun run changelog:check` | Verify `CHANGELOG.md` is in sync (used by devcheck) |
|
|
337
|
+
| `bun run bundle` | Build, pack, and clean a `.mcpb` for one-click Claude Desktop install |
|
|
302
338
|
|
|
303
339
|
---
|
|
304
340
|
|
|
305
341
|
## Bundling
|
|
306
342
|
|
|
307
|
-
`
|
|
308
|
-
|
|
309
|
-
**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.
|
|
343
|
+
`bun 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 plus platform-specific native bindings. 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.
|
|
310
344
|
|
|
311
|
-
**
|
|
345
|
+
**Adding an env var requires both files:** `server.json` (registry discovery, `environmentVariables[]`) and `manifest.json` (bundle install UX, `mcp_config.env` + `user_config`). Wire bundle options as `${user_config.KEY}` and give optional string options `default: ""`. Plugin user variables belong in Claude `userConfig` with matching references and Codex `env_vars`, never empty `env` values. `lint:packaging` checks parity and wiring.
|
|
312
346
|
|
|
313
|
-
|
|
314
|
-
|:-------|:----------|
|
|
315
|
-
| Claude Desktop | Browser downloads the `.mcpb` from the latest GitHub Release; OS file handler routes it to Claude Desktop, which opens the install dialog. No deep-link URL scheme yet — this is the canonical path. |
|
|
316
|
-
| Cursor | Official `https://cursor.com/en/install-mcp` endpoint with base64 JSON config. |
|
|
317
|
-
| VS Code / Insiders | Official `vscode:mcp/install?...` deep link, wrapped in `https://vscode.dev/redirect?url=` so GitHub-rendered markdown doesn't strip the non-HTTP scheme. |
|
|
318
|
-
| Claude Code / Codex | CLI only (`claude mcp add` / `codex mcp add`); no URL scheme. |
|
|
319
|
-
|
|
320
|
-
```markdown
|
|
321
|
-
[](https://github.com/<OWNER>/<REPO>/releases/latest/download/<PACKAGE_NAME>.mcpb)
|
|
322
|
-
[](https://cursor.com/en/install-mcp?name=<PACKAGE_NAME>&config=<BASE64_CONFIG>)
|
|
323
|
-
[](https://vscode.dev/redirect?url=vscode:mcp/install?<URLENCODED_JSON>)
|
|
324
|
-
```
|
|
325
|
-
|
|
326
|
-
Both install links route through HTTPS endpoints (`cursor.com/en/install-mcp` and `vscode.dev/redirect`) — GitHub-rendered markdown strips non-HTTP URL schemes from anchors, so a raw `cursor://` or `vscode:` link won't click through from github.com.
|
|
327
|
-
|
|
328
|
-
Generate the encoded configs (replace `<PACKAGE_NAME>` and add env vars for any required API keys):
|
|
329
|
-
|
|
330
|
-
```bash
|
|
331
|
-
# Cursor: base64-encoded JSON. Split command/args, add env when keys are needed.
|
|
332
|
-
echo -n '{"command":"npx","args":["-y","<PACKAGE_NAME>"],"env":{"API_KEY":"your-api-key"}}' | base64
|
|
333
|
-
# Without env (no required keys):
|
|
334
|
-
echo -n '{"command":"npx","args":["-y","<PACKAGE_NAME>"]}' | base64
|
|
335
|
-
|
|
336
|
-
# VS Code: URL-encoded JSON. Same shape plus a `name` field.
|
|
337
|
-
node -p 'encodeURIComponent(JSON.stringify({name:"<SHORT_NAME>",command:"npx",args:["-y","<PACKAGE_NAME>"],env:{API_KEY:"your-api-key"}}))'
|
|
338
|
-
# Without env:
|
|
339
|
-
node -p 'encodeURIComponent(JSON.stringify({name:"<SHORT_NAME>",command:"npx",args:["-y","<PACKAGE_NAME>"]}))'
|
|
340
|
-
```
|
|
341
|
-
|
|
342
|
-
Both clients use the same `{command, args, env}` shape (matching `mcp.json` schema). VS Code adds a top-level `name` field. Omit `env` entirely when no API keys are needed — don't include empty objects or framework-only vars like `MCP_TRANSPORT_TYPE`.
|
|
343
|
-
|
|
344
|
-
The Claude Desktop badge requires the bundle to ship with a stable filename — `bun run bundle` outputs `dist/<PACKAGE_NAME>.mcpb`, and `release-and-publish` attaches that file to the GitHub Release. `releases/latest/download/<PACKAGE_NAME>.mcpb` then redirects to the most recent release.
|
|
347
|
+
**README install badges** (Claude Desktop `.mcpb`, Cursor, VS Code) and the 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`.
|
|
345
348
|
|
|
346
349
|
---
|
|
347
350
|
|
|
348
351
|
## Changelog
|
|
349
352
|
|
|
350
|
-
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 `
|
|
353
|
+
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 `bun 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 `bun run changelog:build` — devcheck hard-fails on drift; never hand-edit it.
|
|
351
354
|
|
|
352
355
|
Each per-version file opens with YAML frontmatter:
|
|
353
356
|
|
|
@@ -355,21 +358,29 @@ Each per-version file opens with YAML frontmatter:
|
|
|
355
358
|
---
|
|
356
359
|
summary: "One-line headline, ≤350 chars" # required — powers the rollup index
|
|
357
360
|
breaking: false # optional — true flags breaking changes
|
|
358
|
-
security: false # optional — true
|
|
361
|
+
security: false # optional — true ONLY for a source-code security fix, never a dependency CVE bump
|
|
359
362
|
---
|
|
360
363
|
|
|
361
364
|
# 0.1.0 — YYYY-MM-DD
|
|
362
365
|
...
|
|
363
366
|
```
|
|
364
367
|
|
|
365
|
-
`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`.
|
|
368
|
+
`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. When both are set, badges render `· ⚠️ Breaking · 🛡️ Security`.
|
|
366
369
|
|
|
367
|
-
|
|
370
|
+
`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, and one-time migration steps. Omit it when there's nothing to say.
|
|
371
|
+
|
|
372
|
+
**Section order** (Keep a Changelog): Added, Changed, Deprecated, Removed, Fixed, Security, then Dependencies. Include only sections with entries — don't ship empty headers.
|
|
368
373
|
|
|
369
374
|
**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.
|
|
370
375
|
|
|
371
376
|
---
|
|
372
377
|
|
|
378
|
+
## Publishing
|
|
379
|
+
|
|
380
|
+
**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.
|
|
381
|
+
|
|
382
|
+
---
|
|
383
|
+
|
|
373
384
|
## Imports
|
|
374
385
|
|
|
375
386
|
```ts
|
|
@@ -396,4 +407,7 @@ import { getMyService } from '@/services/my-domain/my-service.js';
|
|
|
396
407
|
- [ ] If wrapping external API: tests include at least one sparse payload case with omitted upstream fields
|
|
397
408
|
- [ ] Registered in `createApp()` arrays (directly or via barrel exports)
|
|
398
409
|
- [ ] Tests use `createMockContext()` from `@cyanheads/mcp-ts-core/testing`
|
|
399
|
-
- [ ] `
|
|
410
|
+
- [ ] `.codex-plugin/plugin.json` populated — `name`, `version`, `description`, `repository`, `license` from `package.json`; `interface.displayName` = unscoped repo name; `interface.shortDescription` is concise and target-specific
|
|
411
|
+
- [ ] `.codex-plugin/mcp.json` updated — server name key matches the unscoped repo name; env vars added for any required API keys
|
|
412
|
+
- [ ] `.claude-plugin/plugin.json` populated — `name`, `version`, `description`, `repository`, `license` from `package.json`; inline `mcpServers` entry uses the unscoped repo name
|
|
413
|
+
- [ ] `bun run devcheck` passes
|
package/Dockerfile
CHANGED
|
@@ -3,8 +3,12 @@
|
|
|
3
3
|
#
|
|
4
4
|
# This stage installs all dependencies (including dev), builds the TypeScript
|
|
5
5
|
# source code into JavaScript, and prepares the production assets.
|
|
6
|
+
#
|
|
7
|
+
# The build emits platform-independent JavaScript, so pin it to the native
|
|
8
|
+
# BuildKit platform. Bun's JavaScriptCore does not run reliably under QEMU
|
|
9
|
+
# during cross-architecture builds.
|
|
6
10
|
# ==============================================================================
|
|
7
|
-
FROM oven/bun:1.
|
|
11
|
+
FROM --platform=$BUILDPLATFORM oven/bun:1.4.0 AS build
|
|
8
12
|
|
|
9
13
|
WORKDIR /usr/src/app
|
|
10
14
|
|
|
@@ -19,8 +23,8 @@ RUN --mount=type=cache,target=/root/.bun/install/cache \
|
|
|
19
23
|
# Copy the rest of the source code
|
|
20
24
|
COPY . .
|
|
21
25
|
|
|
22
|
-
# Build
|
|
23
|
-
RUN
|
|
26
|
+
# Build the application
|
|
27
|
+
RUN bun run build
|
|
24
28
|
|
|
25
29
|
|
|
26
30
|
# ==============================================================================
|
|
@@ -30,7 +34,7 @@ RUN node_modules/.bin/tsc --project tsconfig.build.json && node_modules/.bin/tsc
|
|
|
30
34
|
# application. It uses a slim base image and only includes production
|
|
31
35
|
# dependencies and build artifacts.
|
|
32
36
|
# ==============================================================================
|
|
33
|
-
FROM oven/bun:1.
|
|
37
|
+
FROM oven/bun:1.4.0-slim AS production
|
|
34
38
|
|
|
35
39
|
WORKDIR /usr/src/app
|
|
36
40
|
|
|
@@ -41,7 +45,7 @@ ENV NODE_ENV=production
|
|
|
41
45
|
# OCI image metadata (https://github.com/opencontainers/image-spec/blob/main/annotations.md)
|
|
42
46
|
ARG APP_VERSION
|
|
43
47
|
LABEL org.opencontainers.image.title="epa-mcp-server"
|
|
44
|
-
LABEL org.opencontainers.image.description="
|
|
48
|
+
LABEL org.opencontainers.image.description="Search and retrieve EPA environmental data: facility compliance (ECHO), toxic releases (TRI), Superfund sites, drinking water systems, environmental-justice screening (EJScreen), and real-time air quality (AirNow). STDIO or Streamable HTTP."
|
|
45
49
|
LABEL org.opencontainers.image.licenses="Apache-2.0"
|
|
46
50
|
LABEL org.opencontainers.image.version="${APP_VERSION}"
|
|
47
51
|
LABEL org.opencontainers.image.source="https://github.com/cyanheads/epa-mcp-server"
|
|
@@ -51,8 +55,11 @@ COPY package.json bun.lock ./
|
|
|
51
55
|
|
|
52
56
|
# Install only production dependencies, ignoring any lifecycle scripts (like 'prepare')
|
|
53
57
|
# that are not needed in the final production image.
|
|
58
|
+
# `--omit=peer` drops the framework's optional peer tiers that Bun would
|
|
59
|
+
# otherwise auto-install. The OTEL step below carries the same flag so that
|
|
60
|
+
# install does not re-resolve the optional peer graph.
|
|
54
61
|
RUN --mount=type=cache,target=/root/.bun/install/cache \
|
|
55
|
-
bun install --production --frozen-lockfile --ignore-scripts
|
|
62
|
+
bun install --production --omit=peer --frozen-lockfile --ignore-scripts
|
|
56
63
|
|
|
57
64
|
# Conditionally install OpenTelemetry optional peer dependencies (Tier 3).
|
|
58
65
|
# These are not bundled by default to keep the base image lean. Enable at build time
|
|
@@ -60,7 +67,7 @@ RUN --mount=type=cache,target=/root/.bun/install/cache \
|
|
|
60
67
|
ARG OTEL_ENABLED=true
|
|
61
68
|
RUN --mount=type=cache,target=/root/.bun/install/cache \
|
|
62
69
|
if [ "$OTEL_ENABLED" = "true" ]; then \
|
|
63
|
-
bun add @hono/otel \
|
|
70
|
+
bun add --omit=dev --omit=peer --ignore-scripts @hono/otel \
|
|
64
71
|
@opentelemetry/instrumentation-http \
|
|
65
72
|
@opentelemetry/exporter-metrics-otlp-http \
|
|
66
73
|
@opentelemetry/exporter-trace-otlp-http \
|
package/LICENSE
CHANGED
|
@@ -186,7 +186,7 @@ Apache License
|
|
|
186
186
|
same "printed page" as the copyright notice for easier
|
|
187
187
|
identification within third-party archives.
|
|
188
188
|
|
|
189
|
-
Copyright
|
|
189
|
+
Copyright 2026 Casey Hand @cyanheads
|
|
190
190
|
|
|
191
191
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
192
|
you may not use this file except in compliance with the License.
|