@cyanheads/college-scorecard-mcp-server 0.1.6 → 0.1.8

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 (43) hide show
  1. package/CLAUDE.md +74 -81
  2. package/Dockerfile +22 -7
  3. package/LICENSE +201 -0
  4. package/README.md +1 -1
  5. package/changelog/0.1.x/0.1.7.md +22 -0
  6. package/changelog/0.1.x/0.1.8.md +38 -0
  7. package/changelog/template.md +60 -19
  8. package/dist/data/cip-codes.d.ts +2 -2
  9. package/dist/data/cip-codes.d.ts.map +1 -1
  10. package/dist/data/cip-codes.js +960 -160
  11. package/dist/data/cip-codes.js.map +1 -1
  12. package/dist/data/field-catalog.d.ts +6 -6
  13. package/dist/data/field-catalog.d.ts.map +1 -1
  14. package/dist/data/field-catalog.js +553 -79
  15. package/dist/data/field-catalog.js.map +1 -1
  16. package/dist/mcp-server/resources/definitions/example-schools.d.ts +13 -0
  17. package/dist/mcp-server/resources/definitions/example-schools.d.ts.map +1 -0
  18. package/dist/mcp-server/resources/definitions/example-schools.js +14 -0
  19. package/dist/mcp-server/resources/definitions/example-schools.js.map +1 -0
  20. package/dist/mcp-server/resources/definitions/programs.resource.d.ts.map +1 -1
  21. package/dist/mcp-server/resources/definitions/programs.resource.js +9 -0
  22. package/dist/mcp-server/resources/definitions/programs.resource.js.map +1 -1
  23. package/dist/mcp-server/resources/definitions/school.resource.d.ts.map +1 -1
  24. package/dist/mcp-server/resources/definitions/school.resource.js +9 -0
  25. package/dist/mcp-server/resources/definitions/school.resource.js.map +1 -1
  26. package/dist/mcp-server/tools/definitions/compare-schools.tool.d.ts +2 -2
  27. package/dist/mcp-server/tools/definitions/list-fields.tool.d.ts.map +1 -1
  28. package/dist/mcp-server/tools/definitions/list-fields.tool.js +1 -0
  29. package/dist/mcp-server/tools/definitions/list-fields.tool.js.map +1 -1
  30. package/dist/mcp-server/tools/definitions/lookup-cip.tool.d.ts.map +1 -1
  31. package/dist/mcp-server/tools/definitions/lookup-cip.tool.js +1 -0
  32. package/dist/mcp-server/tools/definitions/lookup-cip.tool.js.map +1 -1
  33. package/dist/mcp-server/tools/definitions/search-programs.tool.d.ts.map +1 -1
  34. package/dist/mcp-server/tools/definitions/search-programs.tool.js +1 -0
  35. package/dist/mcp-server/tools/definitions/search-programs.tool.js.map +1 -1
  36. package/dist/mcp-server/tools/definitions/search-schools.tool.d.ts.map +1 -1
  37. package/dist/mcp-server/tools/definitions/search-schools.tool.js +1 -0
  38. package/dist/mcp-server/tools/definitions/search-schools.tool.js.map +1 -1
  39. package/dist/services/scorecard/scorecard-service.d.ts.map +1 -1
  40. package/dist/services/scorecard/scorecard-service.js +2 -2
  41. package/dist/services/scorecard/scorecard-service.js.map +1 -1
  42. package/package.json +11 -9
  43. package/server.json +3 -3
package/CLAUDE.md CHANGED
@@ -1,29 +1,16 @@
1
1
  # Developer Protocol
2
2
 
3
3
  **Server:** college-scorecard-mcp-server
4
- **Version:** 0.1.6
5
- **Framework:** [@cyanheads/mcp-ts-core](https://www.npmjs.com/package/@cyanheads/mcp-ts-core) `^0.10.6`
4
+ **Version:** 0.1.8
5
+ **Framework:** [@cyanheads/mcp-ts-core](https://www.npmjs.com/package/@cyanheads/mcp-ts-core) `^0.12.3`
6
6
  **Engines:** Bun ≥1.3.0, Node ≥24.0.0
7
- **MCP SDK:** `@modelcontextprotocol/sdk` ^1.29.0
7
+ **MCP SDK:** `@modelcontextprotocol/server` ^2.0.0
8
8
  **Zod:** ^4.4.3
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
 
12
12
  ---
13
13
 
14
- ## First Session
15
-
16
- This project was just scaffolded with `bunx @cyanheads/mcp-ts-core init`. The framework, skills, and example definitions are in place — the domain isn't. The user's first messages will set direction; wait for them before proceeding.
17
-
18
- > **Remove this section** from CLAUDE.md / AGENTS.md after completing these steps. The skills and conventions below remain — this block is one-time onboarding only.
19
-
20
- 1. **Get your bearings.** Take stock of the project tree, the skills in `skills/`, and the tools/MCP servers available. Light tool use is fine for context-building — you're mapping the territory, not committing yet.
21
- 2. **Read the framework docs** — `node_modules/@cyanheads/mcp-ts-core/CLAUDE.md` (builders, Context, errors, exports, conventions)
22
- 3. **Run the `setup` skill** — read `skills/setup/SKILL.md` and follow its checklist (project orientation, agent protocol file selection, echo definition cleanup, skill sync)
23
- 4. **Design the server** — read `skills/design-mcp-server/SKILL.md` and work through it with the user to map the domain into tools, resources, and services before scaffolding
24
-
25
- ---
26
-
27
14
  ## What's Next?
28
15
 
29
16
  When the user asks what's next or needs direction, suggest options based on the current project state. Common next steps:
@@ -46,11 +33,11 @@ Tailor suggestions to what's actually missing or stale — don't recite the full
46
33
  ## Core Rules
47
34
 
48
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.
49
- - **Use `ctx.log`** for request-scoped logging. No `console` calls.
36
+ - **Use `ctx.log`** for request-scoped logging. No `console` calls. Dual-sink: Pino **and** `notifications/message` to the client — treat it as client-visible.
50
37
  - **Use `ctx.state`** for tenant-scoped storage. Never access persistence directly.
51
- - **Check `ctx.elicit` / `ctx.sample`** for presence before calling.
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.
52
39
  - **Secrets in env vars only** — never hardcoded.
53
- - **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.
40
+ - **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.
54
41
 
55
42
  ---
56
43
 
@@ -104,7 +91,7 @@ export const itemData = resource('inventory://{itemId}', {
104
91
  params: z.object({ itemId: z.string().describe('Item identifier') }),
105
92
  auth: ['inventory:read'],
106
93
  async handler(params, ctx) {
107
- const item = await ctx.state.get(`item:${params.itemId}`);
94
+ const item = await ctx.state.get(`item/${params.itemId}`);
108
95
  if (!item) throw notFound(`Item ${params.itemId} not found`, { itemId: params.itemId });
109
96
  return item;
110
97
  },
@@ -138,6 +125,7 @@ import { parseEnvConfig } from '@cyanheads/mcp-ts-core/config';
138
125
  const ServerConfigSchema = z.object({
139
126
  apiKey: z.string().describe('External API key'),
140
127
  maxResults: z.coerce.number().default(100),
128
+ verboseLogging: z.stringbool().default(false).describe('Enable verbose logging'),
141
129
  });
142
130
 
143
131
  let _config: z.infer<typeof ServerConfigSchema> | undefined;
@@ -145,6 +133,7 @@ export function getServerConfig() {
145
133
  _config ??= parseEnvConfig(ServerConfigSchema, {
146
134
  apiKey: 'MY_API_KEY',
147
135
  maxResults: 'MY_MAX_RESULTS',
136
+ verboseLogging: 'MY_VERBOSE_LOGGING',
148
137
  });
149
138
  return _config;
150
139
  }
@@ -152,6 +141,25 @@ export function getServerConfig() {
152
141
 
153
142
  `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.
154
143
 
144
+ 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.
145
+
146
+ ### Server identity and instructions
147
+
148
+ `createApp()` accepts optional identity fields forwarded to the SDK's `initialize` response and the server manifest (`/.well-known/mcp.json`):
149
+
150
+ ```ts
151
+ await createApp({
152
+ name: 'my-mcp-server',
153
+ title: 'My Server', // human-readable display name
154
+ websiteUrl: 'https://github.com/owner/repo', // canonical homepage URL
155
+ description: 'One-line description.', // wins over MCP_SERVER_DESCRIPTION
156
+ icons: [{ src: 'https://example.com/icon.png', sizes: ['48x48'], mimeType: 'image/png' }],
157
+ instructions: 'Use shortcut alpha for the most common case.', // session-level context
158
+ });
159
+ ```
160
+
161
+ `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.
162
+
155
163
  ---
156
164
 
157
165
  ## Context
@@ -160,14 +168,15 @@ Handlers receive a unified `ctx` object. Key properties:
160
168
 
161
169
  | Property | Description |
162
170
  |:---------|:------------|
163
- | `ctx.log` | Request-scoped logger — `.debug()`, `.info()`, `.notice()`, `.warning()`, `.error()`. Auto-correlates requestId, traceId, tenantId. |
164
- | `ctx.state` | Tenant-scoped KV — `.get(key)`, `.set(key, value, { ttl? })`, `.delete(key)`, `.list(prefix, { cursor, limit })`. Accepts any serializable value. |
165
- | `ctx.elicit` | Ask user for structured input. **Check for presence first:** `if (ctx.elicit) { ... }` |
166
- | `ctx.sample` | Request LLM completion from the client. **Check for presence first:** `if (ctx.sample) { ... }` |
171
+ | `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. |
172
+ | `ctx.state` | Tenant-scoped KV — `.get(key)`, `.set(key, value, { ttl? })`, `.delete(key)`, `.getMany(keys)`, `.list(prefix, { cursor, limit })`. Accepts any serializable value. |
173
+ | `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. |
174
+ | `ctx.inputs` | Reader over a retried request's responses — `.accepted(key, schema)`, `.view(key)`, `.state()`, `.dropped`. Empty on the first round. |
175
+ | `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). |
176
+ | `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`. |
167
177
  | `ctx.signal` | `AbortSignal` for cancellation. |
168
- | `ctx.progress` | Task progress (present when `task: true`) — `.setTotal(n)`, `.increment()`, `.update(message)`. |
169
178
  | `ctx.requestId` | Unique request ID. |
170
- | `ctx.tenantId` | Tenant ID from JWT or `'default'` for stdio. |
179
+ | `ctx.tenantId` | Tenant ID from JWT; `'default'` for stdio or HTTP with auth off. |
171
180
 
172
181
  ---
173
182
 
@@ -175,9 +184,11 @@ Handlers receive a unified `ctx` object. Key properties:
175
184
 
176
185
  Handlers throw — the framework catches, classifies, and formats.
177
186
 
178
- **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 descriptive metadata for the agent's next move (≥ 5 words, lint-validated); for the wire `data.recovery.hint` (mirrored into `content[]` text), pass explicitly at the throw site when dynamic context matters: `ctx.fail('reason', msg, { recovery: { hint: '...' } })`. Baseline codes (`InternalError`, `ServiceUnavailable`, `Timeout`, `ValidationError`, `SerializationError`) bubble freely and don't need declaring.
187
+ **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 (≥ 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); override with an explicit `{ recovery: { hint: '...' } }` when dynamic runtime context matters. Baseline codes (`InternalError`, `ServiceUnavailable`, `Timeout`, `ValidationError`, `SerializationError`) bubble freely and don't need declaring.
179
188
 
180
189
  ```ts
190
+ import { JsonRpcErrorCode } from '@cyanheads/mcp-ts-core/errors';
191
+
181
192
  errors: [
182
193
  { reason: 'no_match', code: JsonRpcErrorCode.NotFound,
183
194
  when: 'No item matched the query',
@@ -185,7 +196,7 @@ errors: [
185
196
  ],
186
197
  async handler(input, ctx) {
187
198
  const item = await db.find(input.id);
188
- if (!item) throw ctx.fail('no_match', `No item ${input.id}`);
199
+ if (!item) throw ctx.fail('no_match', `No item ${input.id}`, ctx.recoveryFor('no_match'));
189
200
  return item;
190
201
  }
191
202
  ```
@@ -248,7 +259,7 @@ src/
248
259
 
249
260
  ## Skills
250
261
 
251
- 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.
262
+ 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. `bun run list-skills` prints the full registry.
252
263
 
253
264
  **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.
254
265
 
@@ -276,84 +287,61 @@ Available skills:
276
287
  | `orchestrations` | Chain task skills into a gated multi-phase pipeline — build-out, QA-fix, update-ship — when you can spawn sub-agents |
277
288
  | `report-issue-framework` | File a bug or feature request against `@cyanheads/mcp-ts-core` via `gh` CLI |
278
289
  | `report-issue-local` | File a bug or feature request against this server's own repo via `gh` CLI |
290
+ | `techniques` | Catalog of response/data-shaping techniques — overflow handling, payload shaping, retrieval patterns |
279
291
  | `api-auth` | Auth modes, scopes, JWT/OAuth |
280
292
  | `api-canvas` | DataCanvas: register tabular data, run SQL, export, plus the `spillover()` helper for big result sets — Tier 3 opt-in |
281
293
  | `api-config` | AppConfig, parseConfig, env vars |
282
- | `api-context` | Context interface, logger, state, progress |
294
+ | `api-context` | Context interface, RequestContext, logger, state, multi-round-trip input |
283
295
  | `api-errors` | McpError, JsonRpcErrorCode, error patterns |
284
296
  | `api-linter` | Definition linter rule catalog — invoked by `bun run lint:mcp` and `devcheck` |
297
+ | `api-mirror` | MirrorService: persistent self-refreshing local mirror (embedded SQLite + FTS5) of a bulk upstream dataset — Tier 3 opt-in |
285
298
  | `api-services` | LLM, Speech, Graph services |
286
299
  | `api-testing` | createMockContext, test patterns |
287
300
  | `api-utils` | Formatting, parsing, security, pagination, scheduling, telemetry helpers |
288
301
  | `api-telemetry` | OTel catalog: spans, metrics, completion logs, env config, cardinality rules |
289
302
  | `api-workers` | Cloudflare Workers runtime |
290
303
 
304
+ **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.
305
+
291
306
  When you complete a skill's checklist, check the boxes and add a completion timestamp at the end (e.g., `Completed: 2026-03-11`).
292
307
 
293
308
  ---
294
309
 
295
310
  ## Commands
296
311
 
297
- **Runtime:** Scripts use `tsx` — both `npm run <cmd>` and `bun run <cmd>` work. `bun` is slightly faster for script invocation but not required.
312
+ **Runtime:** Scripts use Bun's native TypeScript execution — `bun run <cmd>` is the standard invocation. `npm run <cmd>` also works (npm delegates to bun).
298
313
 
299
314
  | Command | Purpose |
300
315
  |:--------|:--------|
301
- | `npm run build` | Compile TypeScript |
302
- | `npm run rebuild` | Clean + build |
303
- | `npm run clean` | Remove build artifacts |
304
- | `npm run devcheck` | Lint + format + typecheck + security + changelog sync |
305
- | `bun run audit:refresh` | Delete `bun.lock`, reinstall, re-audit. Use when `devcheck` flags a transitive advisory — stale lockfile can mask already-patched deps. If advisory survives, it's real. |
306
- | `npm run tree` | Generate directory structure doc |
307
- | `npm run format` | Auto-fix formatting |
308
- | `npm test` | Run tests |
309
- | `npm run start:stdio` | Production mode (stdio) |
310
- | `npm run start:http` | Production mode (HTTP) |
311
- | `npm run changelog:build` | Regenerate `CHANGELOG.md` from `changelog/*.md` |
312
- | `npm run changelog:check` | Verify `CHANGELOG.md` is in sync (used by devcheck) |
313
- | `npm run bundle` | Build and pack as `.mcpb` for one-click Claude Desktop install |
316
+ | `bun run build` | Compile TypeScript |
317
+ | `bun run rebuild` | Clean + build |
318
+ | `bun run clean` | Remove build artifacts |
319
+ | `bun run devcheck` | Lint + format + typecheck + security + changelog sync |
320
+ | `bun run audit:refresh` | Delete `bun.lock`, reinstall, and re-run `bun audit`. Use when `devcheck` flags a transitive advisory — Bun's `update` is sticky on transitive resolutions, so the advisory may be a stale-lockfile false positive. If it survives the refresh, it's real. |
321
+ | `bun run lint:mcp` | Run the MCP definition linter standalone (rule catalog: `api-linter` skill) |
322
+ | `bun run lint:packaging` | Packaging surface checks — `server.json`/`manifest.json` env-var parity (run by devcheck) |
323
+ | `bun run list-skills` | Print the skill registry |
324
+ | `bun run tree` | Generate directory structure doc |
325
+ | `bun run format` | Auto-fix formatting (safe fixes only) |
326
+ | `bun run format:unsafe` | Also apply Biome's unsafe autofixes — review the diff; they can change behavior |
327
+ | `bun run test` | Run tests (Vitest — use `bun run test`, not `bun test`) |
328
+ | `bun run start:stdio` | Production mode (stdio) |
329
+ | `bun run start:http` | Production mode (HTTP) |
330
+ | `bun run changelog:build` | Regenerate `CHANGELOG.md` from `changelog/*.md` |
331
+ | `bun run changelog:check` | Verify `CHANGELOG.md` is in sync (used by devcheck) |
332
+ | `bun run bundle` | Build, pack, and clean a `.mcpb` for one-click Claude Desktop install |
333
+ | `bun run release:github` | Create the GitHub release for the current tag |
334
+ | `bun run publish-mcp` | Publish to the MCP registry via `mcp-publisher` |
314
335
 
315
336
  ---
316
337
 
317
338
  ## Bundling
318
339
 
319
- `npm run bundle` produces a `.mcpb` extension bundle for one-click install in Claude Desktop. 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.
340
+ `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 (`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.
320
341
 
321
342
  **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.
322
343
 
323
- **README install badges.** Drop these into the project README to give users one-click install paths. Fill in `<OWNER>` / `<REPO>` / `<PACKAGE_NAME>` and encode the per-server config. Cursor + VS Code badges assume the server is published to npm; Claude Desktop downloads the `.mcpb` directly so npm publishing isn't required.
324
-
325
- | Client | Mechanism |
326
- |:-------|:----------|
327
- | 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. |
328
- | Cursor | Official `https://cursor.com/en/install-mcp` endpoint with base64 JSON config. |
329
- | 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. |
330
- | Claude Code / Codex | CLI only (`claude mcp add` / `codex mcp add`); no URL scheme. |
331
-
332
- ```markdown
333
- [![Install in Claude Desktop](https://img.shields.io/badge/Install_in-Claude_Desktop-D97757?style=for-the-badge&logo=anthropic&logoColor=white)](https://github.com/<OWNER>/<REPO>/releases/latest/download/<PACKAGE_NAME>.mcpb)
334
- [![Install in Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en/install-mcp?name=<PACKAGE_NAME>&config=<BASE64_CONFIG>)
335
- [![Install in VS Code](https://img.shields.io/badge/VS_Code-Install_Server-0098FF?style=for-the-badge&logo=visualstudiocode&logoColor=white)](https://vscode.dev/redirect?url=vscode:mcp/install?<URLENCODED_JSON>)
336
- ```
337
-
338
- 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.
339
-
340
- Generate the encoded configs (replace `<PACKAGE_NAME>` and add env vars for any required API keys):
341
-
342
- ```bash
343
- # Cursor: base64-encoded JSON. Split command/args, add env when keys are needed.
344
- echo -n '{"command":"npx","args":["-y","<PACKAGE_NAME>"],"env":{"API_KEY":"your-api-key"}}' | base64
345
- # Without env (no required keys):
346
- echo -n '{"command":"npx","args":["-y","<PACKAGE_NAME>"]}' | base64
347
-
348
- # VS Code: URL-encoded JSON. Same shape plus a `name` field.
349
- node -p 'encodeURIComponent(JSON.stringify({name:"<SHORT_NAME>",command:"npx",args:["-y","<PACKAGE_NAME>"],env:{API_KEY:"your-api-key"}}))'
350
- # Without env:
351
- node -p 'encodeURIComponent(JSON.stringify({name:"<SHORT_NAME>",command:"npx",args:["-y","<PACKAGE_NAME>"]}))'
352
- ```
353
-
354
- 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`.
355
-
356
- 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.
344
+ **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`.
357
345
 
358
346
  ---
359
347
 
@@ -367,14 +355,16 @@ Each per-version file opens with YAML frontmatter:
367
355
  ---
368
356
  summary: "One-line headline, ≤350 chars" # required — powers the rollup index
369
357
  breaking: false # optional — true flags breaking changes
370
- security: false # optional — true flags security fixes
358
+ security: false # optional — true ONLY for a source-code security fix, never a dependency CVE bump
371
359
  ---
372
360
 
373
361
  # 0.1.0 — YYYY-MM-DD
374
362
  ...
375
363
  ```
376
364
 
377
- `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`.
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 — 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`.
366
+
367
+ `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.
378
368
 
379
369
  **Section order** (Keep a Changelog): Added, Changed, Deprecated, Removed, Fixed, Security. Include only sections with entries — don't ship empty headers.
380
370
 
@@ -408,4 +398,7 @@ import { getMyService } from '@/services/my-domain/my-service.js';
408
398
  - [ ] If wrapping external API: tests include at least one sparse payload case with omitted upstream fields
409
399
  - [ ] Registered in `createApp()` arrays (directly or via barrel exports)
410
400
  - [ ] Tests use `createMockContext()` from `@cyanheads/mcp-ts-core/testing`
401
+ - [ ] `.codex-plugin/plugin.json` populated — `name`, `version`, `description`, `repository`, `license` from `package.json`; `interface.displayName` = package name; `interface.shortDescription` from `package.json` description
402
+ - [ ] `.codex-plugin/mcp.json` updated — server name key matches `package.json` name; env vars added for any required API keys
403
+ - [ ] `.claude-plugin/plugin.json` populated — `name`, `version`, `description`, `repository`, `license` from `package.json`; inline `mcpServers` entry with server name key, env vars for any required API keys
411
404
  - [ ] `npm run devcheck` passes
package/Dockerfile CHANGED
@@ -4,15 +4,23 @@
4
4
  # This stage installs all dependencies (including dev), builds the TypeScript
5
5
  # source code into JavaScript, and prepares the production assets.
6
6
  # ==============================================================================
7
- FROM oven/bun:1.3 AS build
7
+ # --platform pins the build stage to the invocation platform: the output is
8
+ # platform-independent JS, and without it the amd64 leg of a multi-arch
9
+ # buildx from an arm64 host runs under QEMU emulation, where Bun 1.4's JSC
10
+ # aborts with MemoryExhaustion.
11
+ FROM --platform=$BUILDPLATFORM oven/bun:1.4.0 AS build
8
12
 
9
13
  WORKDIR /usr/src/app
10
14
 
11
15
  # Copy dependency manifests for optimized layer caching
12
16
  COPY package.json bun.lock ./
13
17
 
14
- # Install all dependencies (including dev dependencies for building)
15
- RUN bun install --frozen-lockfile
18
+ # Install all dependencies (including dev dependencies for building).
19
+ # The BuildKit cache mount persists Bun's global package cache across builds.
20
+ # --ignore-scripts: the build only runs tsc, which needs type declarations,
21
+ # not compiled native bindings.
22
+ RUN --mount=type=cache,target=/root/.bun/install/cache \
23
+ bun install --frozen-lockfile --ignore-scripts
16
24
 
17
25
  # Copy the rest of the source code
18
26
  COPY . .
@@ -28,7 +36,7 @@ RUN bun run build
28
36
  # application. It uses a slim base image and only includes production
29
37
  # dependencies and build artifacts.
30
38
  # ==============================================================================
31
- FROM oven/bun:1.3-slim AS production
39
+ FROM oven/bun:1.4.0-slim AS production
32
40
 
33
41
  WORKDIR /usr/src/app
34
42
 
@@ -49,14 +57,21 @@ COPY package.json bun.lock ./
49
57
 
50
58
  # Install only production dependencies, ignoring any lifecycle scripts (like 'prepare')
51
59
  # that are not needed in the final production image.
52
- RUN bun install --production --frozen-lockfile --ignore-scripts
60
+ # `--omit=peer` drops the framework's optional peer tiers (test runner, service
61
+ # SDKs, parsers) that Bun would otherwise auto-install. Anything this server
62
+ # actually imports belongs in its own `dependencies`, so nothing needed at
63
+ # runtime is lost. The OTEL step below carries the same flag — without it, that
64
+ # install re-resolves the graph and pulls every optional peer back in.
65
+ RUN --mount=type=cache,target=/root/.bun/install/cache \
66
+ bun install --production --omit=peer --frozen-lockfile --ignore-scripts
53
67
 
54
68
  # Conditionally install OpenTelemetry optional peer dependencies (Tier 3).
55
69
  # These are not bundled by default to keep the base image lean. Enable at build time
56
70
  # with: docker build --build-arg OTEL_ENABLED=true
57
71
  ARG OTEL_ENABLED=true
58
- RUN if [ "$OTEL_ENABLED" = "true" ]; then \
59
- bun add @hono/otel \
72
+ RUN --mount=type=cache,target=/root/.bun/install/cache \
73
+ if [ "$OTEL_ENABLED" = "true" ]; then \
74
+ bun add --omit=dev --omit=peer --ignore-scripts @hono/otel \
60
75
  @opentelemetry/instrumentation-http \
61
76
  @opentelemetry/exporter-metrics-otlp-http \
62
77
  @opentelemetry/exporter-trace-otlp-http \
package/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright 2026 Casey Hand @cyanheads
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
package/README.md CHANGED
@@ -7,7 +7,7 @@
7
7
 
8
8
  <div align="center">
9
9
 
10
- [![Version](https://img.shields.io/badge/Version-0.1.6-blue.svg?style=flat-square)](./CHANGELOG.md) [![License](https://img.shields.io/badge/License-Apache%202.0-orange.svg?style=flat-square)](./LICENSE) [![Docker](https://img.shields.io/badge/Docker-ghcr.io-2496ED?style=flat-square&logo=docker&logoColor=white)](https://github.com/users/cyanheads/packages/container/package/college-scorecard-mcp-server) [![MCP SDK](https://img.shields.io/badge/MCP%20SDK-^1.29.0-green.svg?style=flat-square)](https://modelcontextprotocol.io/) [![npm](https://img.shields.io/npm/v/@cyanheads/college-scorecard-mcp-server?style=flat-square&logo=npm&logoColor=white)](https://www.npmjs.com/package/@cyanheads/college-scorecard-mcp-server) [![TypeScript](https://img.shields.io/badge/TypeScript-^6.0.3-3178C6.svg?style=flat-square)](https://www.typescriptlang.org/) [![Bun](https://img.shields.io/badge/Bun-v1.3.0-blueviolet.svg?style=flat-square)](https://bun.sh/)
10
+ [![Version](https://img.shields.io/badge/Version-0.1.8-blue.svg?style=flat-square)](./CHANGELOG.md) [![License](https://img.shields.io/badge/License-Apache%202.0-orange.svg?style=flat-square)](./LICENSE) [![Docker](https://img.shields.io/badge/Docker-ghcr.io-2496ED?style=flat-square&logo=docker&logoColor=white)](https://github.com/users/cyanheads/packages/container/package/college-scorecard-mcp-server) [![MCP SDK](https://img.shields.io/badge/MCP%20SDK-^2.0.0-green.svg?style=flat-square)](https://modelcontextprotocol.io/) [![npm](https://img.shields.io/npm/v/@cyanheads/college-scorecard-mcp-server?style=flat-square&logo=npm&logoColor=white)](https://www.npmjs.com/package/@cyanheads/college-scorecard-mcp-server) [![TypeScript](https://img.shields.io/badge/TypeScript-^7.0.2-3178C6.svg?style=flat-square)](https://www.typescriptlang.org/) [![Bun](https://img.shields.io/badge/Bun-v1.4.0-blueviolet.svg?style=flat-square)](https://bun.sh/)
11
11
 
12
12
  </div>
13
13
 
@@ -0,0 +1,22 @@
1
+ ---
2
+ summary: "Adopt @cyanheads/mcp-ts-core ^0.10.8 — devcheck fresh-scaffold guards, check-skill-versions worktree-deletion guard, seven re-synced skills, biome 2.5; plus @types/node ^26 and a dependency refresh. No tool surface changes."
3
+ breaking: false
4
+ security: false
5
+ ---
6
+
7
+ # 0.1.7 — 2026-06-19
8
+
9
+ ## Changed
10
+
11
+ - **`@cyanheads/mcp-ts-core` `^0.10.6` → `^0.10.8`** — framework maintenance pickup. Tool, resource, and prompt surface unchanged. Relevant deltas:
12
+ - `devcheck` no longer false-fails on a fresh, pre-`git init` scaffold: the TODOs/FIXMEs, Tracked Secrets, and Framework Antipatterns checks share an `isGitRepo()` guard, and `build-changelog.ts --check` exits cleanly when only `changelog/template.md` is present ([mcp-ts-core #242](https://github.com/cyanheads/mcp-ts-core/issues/242), [#243](https://github.com/cyanheads/mcp-ts-core/issues/243)).
13
+ - `check-skill-versions.ts` skips a `SKILL.md` deleted from the worktree instead of crashing with ENOENT, so a maintenance pass that prunes an upstream-removed skill no longer breaks ([mcp-ts-core #237](https://github.com/cyanheads/mcp-ts-core/issues/237)).
14
+ - `biome.json` migrated to the biome `2.5.0` schema (`recommended` → `"preset": "recommended"`); inherited via `@cyanheads/mcp-ts-core/biome`.
15
+ - `DuckdbProvider.describe()` filter qualification and the canvas SQL-gate `invalid_sql` prepare-failure classification ([mcp-ts-core #235](https://github.com/cyanheads/mcp-ts-core/issues/235), [#236](https://github.com/cyanheads/mcp-ts-core/issues/236)) — framework-internal; this server exposes no DataCanvas/SQL surface.
16
+ - **Re-synced project skills** — seven `skills/<name>/SKILL.md` `metadata.version` bumps propagate upstream body drift ([mcp-ts-core #238](https://github.com/cyanheads/mcp-ts-core/issues/238)): `api-auth`, `api-errors`, `api-services`, `api-telemetry`, `field-test`, `report-issue-local`, `tool-defs-analysis`. `git-wrapup` (v1.4) and `orchestrations` (v1.4) reworded; `add-tool`, `api-canvas`, `api-config`, `api-context` bodies refreshed. Scripts (`build-changelog.ts`, `check-framework-antipatterns.ts`, `check-skill-versions.ts`, `devcheck.ts`) re-synced from the framework.
17
+ - **`devcheck.config.json`** — emptied `outdated.allowlist` (`@cyanheads/mcp-ts-core`, `@types/node` no longer held back) and `skillVersions.ignore` (`report-issue-local`), both now in sync.
18
+
19
+ ### Dependency bumps
20
+
21
+ - `@cyanheads/mcp-ts-core` `^0.10.6` → `^0.10.8`
22
+ - `@types/node` `^25.9.4` → `^26.0.0`