@cyanheads/nonprofit-explorer-mcp-server 0.1.9 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS.md +43 -20
- package/CLAUDE.md +43 -20
- package/Dockerfile +111 -39
- package/README.md +10 -7
- package/changelog/0.1.x/0.1.10.md +35 -0
- package/changelog/0.1.x/0.1.9.md +3 -3
- package/changelog/0.2.x/0.2.0.md +31 -0
- package/dist/index.js +3 -7
- package/dist/index.js.map +1 -1
- package/dist/mcp-server/tools/definitions/nonprofit-get-filings.tool.d.ts +19 -1
- package/dist/mcp-server/tools/definitions/nonprofit-get-filings.tool.d.ts.map +1 -1
- package/dist/mcp-server/tools/definitions/nonprofit-get-filings.tool.js +72 -20
- package/dist/mcp-server/tools/definitions/nonprofit-get-filings.tool.js.map +1 -1
- package/dist/mcp-server/tools/definitions/nonprofit-get-organization.tool.d.ts +16 -1
- package/dist/mcp-server/tools/definitions/nonprofit-get-organization.tool.d.ts.map +1 -1
- package/dist/mcp-server/tools/definitions/nonprofit-get-organization.tool.js +35 -8
- package/dist/mcp-server/tools/definitions/nonprofit-get-organization.tool.js.map +1 -1
- package/dist/mcp-server/tools/definitions/{nonprofit-search.tool.d.ts → nonprofit-search-organizations.tool.d.ts} +17 -3
- package/dist/mcp-server/tools/definitions/nonprofit-search-organizations.tool.d.ts.map +1 -0
- package/dist/mcp-server/tools/definitions/{nonprofit-search.tool.js → nonprofit-search-organizations.tool.js} +20 -4
- package/dist/mcp-server/tools/definitions/nonprofit-search-organizations.tool.js.map +1 -0
- package/dist/services/nonprofit-explorer/nonprofit-explorer-service.d.ts +3 -3
- package/dist/services/nonprofit-explorer/nonprofit-explorer-service.d.ts.map +1 -1
- package/dist/services/nonprofit-explorer/nonprofit-explorer-service.js +44 -48
- package/dist/services/nonprofit-explorer/nonprofit-explorer-service.js.map +1 -1
- package/dist/services/nonprofit-explorer/types.d.ts +12 -0
- package/dist/services/nonprofit-explorer/types.d.ts.map +1 -1
- package/package.json +14 -11
- package/server.json +11 -25
- package/dist/mcp-server/tools/definitions/nonprofit-search.tool.d.ts.map +0 -1
- package/dist/mcp-server/tools/definitions/nonprofit-search.tool.js.map +0 -1
package/AGENTS.md
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
# Developer Protocol
|
|
2
2
|
|
|
3
3
|
**Server:** nonprofit-explorer-mcp-server
|
|
4
|
-
**Version:** 0.
|
|
5
|
-
**Framework:** [@cyanheads/mcp-ts-core](https://www.npmjs.com/package/@cyanheads/mcp-ts-core) `^0.13.
|
|
4
|
+
**Version:** 0.2.0
|
|
5
|
+
**Framework:** [@cyanheads/mcp-ts-core](https://www.npmjs.com/package/@cyanheads/mcp-ts-core) `^0.13.15`
|
|
6
6
|
**Engines:** Bun ≥1.4.0, Node ≥24.0.0
|
|
7
|
-
**MCP SDK:** `@modelcontextprotocol/server` ^2.
|
|
8
|
-
**Zod:** ^4.6.
|
|
7
|
+
**MCP SDK:** `@modelcontextprotocol/server` ^2.3.1
|
|
8
|
+
**Zod:** ^4.6.7
|
|
9
9
|
|
|
10
10
|
> **Read the framework docs first:** `node_modules/@cyanheads/mcp-ts-core/CLAUDE.md` contains the full API reference — builders, Context, error codes, exports, patterns. This file covers server-specific conventions only.
|
|
11
11
|
|
|
@@ -18,6 +18,7 @@
|
|
|
18
18
|
- **Use `ctx.state`** for tenant-scoped storage. Never access persistence directly.
|
|
19
19
|
- **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.
|
|
20
20
|
- **Secrets in env vars only** — never hardcoded.
|
|
21
|
+
- **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.
|
|
21
22
|
- **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.
|
|
22
23
|
|
|
23
24
|
---
|
|
@@ -31,7 +32,7 @@ import { tool, z } from '@cyanheads/mcp-ts-core';
|
|
|
31
32
|
import { JsonRpcErrorCode } from '@cyanheads/mcp-ts-core/errors';
|
|
32
33
|
import { getNonprofitExplorerService } from '@/services/nonprofit-explorer/nonprofit-explorer-service.js';
|
|
33
34
|
|
|
34
|
-
export const
|
|
35
|
+
export const nonprofitSearchOrganizations = tool('nonprofit_search_organizations', {
|
|
35
36
|
title: 'Search Nonprofits',
|
|
36
37
|
description: 'Search 1.8M+ IRS-recognized tax-exempt organizations by name, keyword, city, or phrase.',
|
|
37
38
|
annotations: { readOnlyHint: true },
|
|
@@ -75,6 +76,22 @@ export const nonprofitSearch = tool('nonprofit_search', {
|
|
|
75
76
|
|
|
76
77
|
`createApp({ instructions })` — sent to clients on every `initialize` as session-level context. The nonprofit server uses this to orient agents on the search-first workflow and the filing-year lag.
|
|
77
78
|
|
|
79
|
+
### Session posture and shutdown
|
|
80
|
+
|
|
81
|
+
Two more `createApp()` options shape how the server runs rather than how it presents itself:
|
|
82
|
+
|
|
83
|
+
```ts
|
|
84
|
+
await createApp({
|
|
85
|
+
sessionMode: 'stateless', // or { default: 'stateful', require: 'stateful' }
|
|
86
|
+
setup(core) { startMyWatcher(core.config); },
|
|
87
|
+
async teardown() { await stopMyWatcher(); },
|
|
88
|
+
});
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
`sessionMode` declares the HTTP session posture in `src/` instead of leaving it to a deployment's `MCP_SESSION_MODE`, which still wins whenever it carries a meaningful value (an empty string and an unsubstituted `${…}` placeholder read as unset and fall through to the option). Add `require: 'stateful'` when a tool asks the caller for input mid-handler via `ctx.requestInput`: startup then fails with a `ConfigurationError` rather than serving a mode in which a 2025-era client can never answer the prompt. Stdio is never refused. This server declares `sessionMode: 'stateless'`: no handler calls `ctx.requestInput`.
|
|
92
|
+
|
|
93
|
+
`teardown(core)` is the `setup()` counterpart — release a watcher, socket, or non-`unref()`'d timer there. It runs after the transport stops and before the logger closes, on every shutdown path, and a signal-triggered shutdown then exits the process explicitly (0, or 1 if a step never settles within the framework's 10 s ceiling).
|
|
94
|
+
|
|
78
95
|
---
|
|
79
96
|
|
|
80
97
|
## Context
|
|
@@ -84,11 +101,14 @@ Handlers receive a unified `ctx` object. Key properties:
|
|
|
84
101
|
| Property | Description |
|
|
85
102
|
|:---------|:------------|
|
|
86
103
|
| `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. |
|
|
87
|
-
| `ctx.state` | Tenant-scoped KV — `.get(key)`, `.set(key, value, { ttl? })`, `.delete(key)`, `.getMany(keys)`, `.list(prefix, { cursor, limit })`. Accepts any serializable value. |
|
|
104
|
+
| `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). |
|
|
105
|
+
| `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. |
|
|
106
|
+
| `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). |
|
|
107
|
+
| `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. |
|
|
88
108
|
| `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). |
|
|
89
109
|
| `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`. |
|
|
90
110
|
| `ctx.signal` | `AbortSignal` for cancellation. |
|
|
91
|
-
| `ctx.requestId` |
|
|
111
|
+
| `ctx.requestId` | Request ID — the one every log record of the call carries and its error envelope returns as `data.requestId`. |
|
|
92
112
|
| `ctx.tenantId` | Tenant ID from JWT; `'default'` for stdio or HTTP with auth off. |
|
|
93
113
|
|
|
94
114
|
---
|
|
@@ -97,7 +117,7 @@ Handlers receive a unified `ctx` object. Key properties:
|
|
|
97
117
|
|
|
98
118
|
Handlers throw — the framework catches, classifies, and formats.
|
|
99
119
|
|
|
100
|
-
**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.
|
|
120
|
+
**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.
|
|
101
121
|
|
|
102
122
|
```ts
|
|
103
123
|
import { JsonRpcErrorCode } from '@cyanheads/mcp-ts-core/errors';
|
|
@@ -105,7 +125,7 @@ import { JsonRpcErrorCode } from '@cyanheads/mcp-ts-core/errors';
|
|
|
105
125
|
errors: [
|
|
106
126
|
{ reason: 'not_found', code: JsonRpcErrorCode.NotFound,
|
|
107
127
|
when: 'EIN does not correspond to a known org',
|
|
108
|
-
recovery: 'Verify the EIN with
|
|
128
|
+
recovery: 'Verify the EIN with nonprofit_search_organizations. Use the integer EIN value.' },
|
|
109
129
|
],
|
|
110
130
|
async handler(input, ctx) {
|
|
111
131
|
const org = await svc.getOrganization(normalizeEin(input.ein), ctx);
|
|
@@ -121,7 +141,7 @@ async handler(input, ctx) {
|
|
|
121
141
|
```ts
|
|
122
142
|
import { notFound, serviceUnavailable } from '@cyanheads/mcp-ts-core/errors';
|
|
123
143
|
throw notFound('Organization not found', { ein });
|
|
124
|
-
throw serviceUnavailable('ProPublica API unavailable', {
|
|
144
|
+
throw serviceUnavailable('ProPublica API unavailable', { reason: 'upstream_error' }, { cause: err });
|
|
125
145
|
```
|
|
126
146
|
|
|
127
147
|
See framework CLAUDE.md and the `api-errors` skill for the full auto-classification table, all available factories, and the contract reference.
|
|
@@ -139,7 +159,7 @@ src/
|
|
|
139
159
|
types.ts # Domain types (RawOrg, RawFiling, etc.)
|
|
140
160
|
mcp-server/
|
|
141
161
|
tools/definitions/
|
|
142
|
-
nonprofit-search.tool.ts #
|
|
162
|
+
nonprofit-search-organizations.tool.ts # nonprofit_search_organizations
|
|
143
163
|
nonprofit-get-organization.tool.ts# nonprofit_get_organization
|
|
144
164
|
nonprofit-get-filings.tool.ts # nonprofit_get_filings
|
|
145
165
|
```
|
|
@@ -150,8 +170,8 @@ src/
|
|
|
150
170
|
|
|
151
171
|
| What | Convention | Example |
|
|
152
172
|
|:-----|:-----------|:--------|
|
|
153
|
-
| Files | kebab-case with suffix | `nonprofit-search.tool.ts` |
|
|
154
|
-
| Tool/resource/prompt names | snake_case | `
|
|
173
|
+
| Files | kebab-case with suffix | `nonprofit-search-organizations.tool.ts` |
|
|
174
|
+
| Tool/resource/prompt names | snake_case | `nonprofit_search_organizations` |
|
|
155
175
|
| Directories | kebab-case | `src/services/nonprofit-explorer/` |
|
|
156
176
|
| Descriptions | Single string or template literal, no `+` concatenation | `'Search orgs by name and filter.'` |
|
|
157
177
|
|
|
@@ -217,7 +237,8 @@ When you complete a skill's checklist, check the boxes and add a completion time
|
|
|
217
237
|
| `bun run rebuild` | Clean + build |
|
|
218
238
|
| `bun run clean` | Remove build artifacts |
|
|
219
239
|
| `bun run devcheck` | Lint + format + typecheck + security + changelog sync |
|
|
220
|
-
| `bun run audit:
|
|
240
|
+
| `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` |
|
|
241
|
+
| `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` |
|
|
221
242
|
| `bun run lint:mcp` | Run the MCP definition linter standalone (rule catalog: `api-linter` skill) |
|
|
222
243
|
| `bun run lint:packaging` | Packaging surface checks — `server.json`/`manifest.json` env-var parity (run by devcheck) |
|
|
223
244
|
| `bun run list-skills` | Print the skill registry |
|
|
@@ -231,13 +252,15 @@ When you complete a skill's checklist, check the boxes and add a completion time
|
|
|
231
252
|
| `bun run changelog:check` | Verify `CHANGELOG.md` is in sync (used by devcheck) |
|
|
232
253
|
| `bun run bundle` | Build, pack, and clean a `.mcpb` for one-click Claude Desktop install |
|
|
233
254
|
|
|
255
|
+
**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.
|
|
256
|
+
|
|
234
257
|
---
|
|
235
258
|
|
|
236
259
|
## Bundling
|
|
237
260
|
|
|
238
261
|
`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 two classes of `node_modules/**` content that root-anchored `.mcpbignore` patterns cannot reach: dependency-shipped agent docs (`framework-skills/`, `skills/`, `.claude/`, `.agents/`, `SKILL.md`) and platform-specific native bindings, which would otherwise lock the bundle to the platform it was packed on. MCPB is stdio-only — HTTP and Cloudflare Workers deployments are unaffected. Consumers who don't need it can delete `manifest.json` and `.mcpbignore`; `lint:packaging` skips cleanly.
|
|
239
262
|
|
|
240
|
-
**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.
|
|
263
|
+
**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": ""`.
|
|
241
264
|
|
|
242
265
|
**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`.
|
|
243
266
|
|
|
@@ -264,7 +287,7 @@ security: false # optional — true ONLY for a source
|
|
|
264
287
|
|
|
265
288
|
`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.
|
|
266
289
|
|
|
267
|
-
**Section order
|
|
290
|
+
**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.
|
|
268
291
|
|
|
269
292
|
**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.
|
|
270
293
|
|
|
@@ -272,7 +295,7 @@ security: false # optional — true ONLY for a source
|
|
|
272
295
|
|
|
273
296
|
## Publishing
|
|
274
297
|
|
|
275
|
-
**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
|
|
298
|
+
**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 release digest: theme line, `## Changes`, `## Gates`, changelog link last); `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.
|
|
276
299
|
|
|
277
300
|
---
|
|
278
301
|
|
|
@@ -302,7 +325,7 @@ import { getNonprofitExplorerService } from '@/services/nonprofit-explorer/nonpr
|
|
|
302
325
|
- [ ] If wrapping external API: tests include at least one sparse payload case with omitted upstream fields
|
|
303
326
|
- [ ] Registered in `createApp()` arrays (directly or via barrel exports)
|
|
304
327
|
- [ ] Tests use `createMockContext()` from `@cyanheads/mcp-ts-core/testing`
|
|
305
|
-
- [ ] `.codex-plugin/plugin.json` populated — `name`, `version`, `description`, `repository`, `license` from `package.json`; `interface.displayName` =
|
|
306
|
-
- [ ] `.codex-plugin/mcp.json` updated — server name key
|
|
307
|
-
- [ ] `.claude-plugin/plugin.json` populated — `name`, `version`, `description`, `repository`, `license` from `package.json`; inline `mcpServers` entry
|
|
328
|
+
- [ ] `.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
|
|
329
|
+
- [ ] `.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
|
|
330
|
+
- [ ] `.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`
|
|
308
331
|
- [ ] `bun run devcheck` passes
|
package/CLAUDE.md
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
# Developer Protocol
|
|
2
2
|
|
|
3
3
|
**Server:** nonprofit-explorer-mcp-server
|
|
4
|
-
**Version:** 0.
|
|
5
|
-
**Framework:** [@cyanheads/mcp-ts-core](https://www.npmjs.com/package/@cyanheads/mcp-ts-core) `^0.13.
|
|
4
|
+
**Version:** 0.2.0
|
|
5
|
+
**Framework:** [@cyanheads/mcp-ts-core](https://www.npmjs.com/package/@cyanheads/mcp-ts-core) `^0.13.15`
|
|
6
6
|
**Engines:** Bun ≥1.4.0, Node ≥24.0.0
|
|
7
|
-
**MCP SDK:** `@modelcontextprotocol/server` ^2.
|
|
8
|
-
**Zod:** ^4.6.
|
|
7
|
+
**MCP SDK:** `@modelcontextprotocol/server` ^2.3.1
|
|
8
|
+
**Zod:** ^4.6.7
|
|
9
9
|
|
|
10
10
|
> **Read the framework docs first:** `node_modules/@cyanheads/mcp-ts-core/CLAUDE.md` contains the full API reference — builders, Context, error codes, exports, patterns. This file covers server-specific conventions only.
|
|
11
11
|
|
|
@@ -18,6 +18,7 @@
|
|
|
18
18
|
- **Use `ctx.state`** for tenant-scoped storage. Never access persistence directly.
|
|
19
19
|
- **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.
|
|
20
20
|
- **Secrets in env vars only** — never hardcoded.
|
|
21
|
+
- **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.
|
|
21
22
|
- **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.
|
|
22
23
|
|
|
23
24
|
---
|
|
@@ -31,7 +32,7 @@ import { tool, z } from '@cyanheads/mcp-ts-core';
|
|
|
31
32
|
import { JsonRpcErrorCode } from '@cyanheads/mcp-ts-core/errors';
|
|
32
33
|
import { getNonprofitExplorerService } from '@/services/nonprofit-explorer/nonprofit-explorer-service.js';
|
|
33
34
|
|
|
34
|
-
export const
|
|
35
|
+
export const nonprofitSearchOrganizations = tool('nonprofit_search_organizations', {
|
|
35
36
|
title: 'Search Nonprofits',
|
|
36
37
|
description: 'Search 1.8M+ IRS-recognized tax-exempt organizations by name, keyword, city, or phrase.',
|
|
37
38
|
annotations: { readOnlyHint: true },
|
|
@@ -75,6 +76,22 @@ export const nonprofitSearch = tool('nonprofit_search', {
|
|
|
75
76
|
|
|
76
77
|
`createApp({ instructions })` — sent to clients on every `initialize` as session-level context. The nonprofit server uses this to orient agents on the search-first workflow and the filing-year lag.
|
|
77
78
|
|
|
79
|
+
### Session posture and shutdown
|
|
80
|
+
|
|
81
|
+
Two more `createApp()` options shape how the server runs rather than how it presents itself:
|
|
82
|
+
|
|
83
|
+
```ts
|
|
84
|
+
await createApp({
|
|
85
|
+
sessionMode: 'stateless', // or { default: 'stateful', require: 'stateful' }
|
|
86
|
+
setup(core) { startMyWatcher(core.config); },
|
|
87
|
+
async teardown() { await stopMyWatcher(); },
|
|
88
|
+
});
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
`sessionMode` declares the HTTP session posture in `src/` instead of leaving it to a deployment's `MCP_SESSION_MODE`, which still wins whenever it carries a meaningful value (an empty string and an unsubstituted `${…}` placeholder read as unset and fall through to the option). Add `require: 'stateful'` when a tool asks the caller for input mid-handler via `ctx.requestInput`: startup then fails with a `ConfigurationError` rather than serving a mode in which a 2025-era client can never answer the prompt. Stdio is never refused. This server declares `sessionMode: 'stateless'`: no handler calls `ctx.requestInput`.
|
|
92
|
+
|
|
93
|
+
`teardown(core)` is the `setup()` counterpart — release a watcher, socket, or non-`unref()`'d timer there. It runs after the transport stops and before the logger closes, on every shutdown path, and a signal-triggered shutdown then exits the process explicitly (0, or 1 if a step never settles within the framework's 10 s ceiling).
|
|
94
|
+
|
|
78
95
|
---
|
|
79
96
|
|
|
80
97
|
## Context
|
|
@@ -84,11 +101,14 @@ Handlers receive a unified `ctx` object. Key properties:
|
|
|
84
101
|
| Property | Description |
|
|
85
102
|
|:---------|:------------|
|
|
86
103
|
| `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. |
|
|
87
|
-
| `ctx.state` | Tenant-scoped KV — `.get(key)`, `.set(key, value, { ttl? })`, `.delete(key)`, `.getMany(keys)`, `.list(prefix, { cursor, limit })`. Accepts any serializable value. |
|
|
104
|
+
| `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). |
|
|
105
|
+
| `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. |
|
|
106
|
+
| `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). |
|
|
107
|
+
| `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. |
|
|
88
108
|
| `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). |
|
|
89
109
|
| `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`. |
|
|
90
110
|
| `ctx.signal` | `AbortSignal` for cancellation. |
|
|
91
|
-
| `ctx.requestId` |
|
|
111
|
+
| `ctx.requestId` | Request ID — the one every log record of the call carries and its error envelope returns as `data.requestId`. |
|
|
92
112
|
| `ctx.tenantId` | Tenant ID from JWT; `'default'` for stdio or HTTP with auth off. |
|
|
93
113
|
|
|
94
114
|
---
|
|
@@ -97,7 +117,7 @@ Handlers receive a unified `ctx` object. Key properties:
|
|
|
97
117
|
|
|
98
118
|
Handlers throw — the framework catches, classifies, and formats.
|
|
99
119
|
|
|
100
|
-
**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.
|
|
120
|
+
**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.
|
|
101
121
|
|
|
102
122
|
```ts
|
|
103
123
|
import { JsonRpcErrorCode } from '@cyanheads/mcp-ts-core/errors';
|
|
@@ -105,7 +125,7 @@ import { JsonRpcErrorCode } from '@cyanheads/mcp-ts-core/errors';
|
|
|
105
125
|
errors: [
|
|
106
126
|
{ reason: 'not_found', code: JsonRpcErrorCode.NotFound,
|
|
107
127
|
when: 'EIN does not correspond to a known org',
|
|
108
|
-
recovery: 'Verify the EIN with
|
|
128
|
+
recovery: 'Verify the EIN with nonprofit_search_organizations. Use the integer EIN value.' },
|
|
109
129
|
],
|
|
110
130
|
async handler(input, ctx) {
|
|
111
131
|
const org = await svc.getOrganization(normalizeEin(input.ein), ctx);
|
|
@@ -121,7 +141,7 @@ async handler(input, ctx) {
|
|
|
121
141
|
```ts
|
|
122
142
|
import { notFound, serviceUnavailable } from '@cyanheads/mcp-ts-core/errors';
|
|
123
143
|
throw notFound('Organization not found', { ein });
|
|
124
|
-
throw serviceUnavailable('ProPublica API unavailable', {
|
|
144
|
+
throw serviceUnavailable('ProPublica API unavailable', { reason: 'upstream_error' }, { cause: err });
|
|
125
145
|
```
|
|
126
146
|
|
|
127
147
|
See framework CLAUDE.md and the `api-errors` skill for the full auto-classification table, all available factories, and the contract reference.
|
|
@@ -139,7 +159,7 @@ src/
|
|
|
139
159
|
types.ts # Domain types (RawOrg, RawFiling, etc.)
|
|
140
160
|
mcp-server/
|
|
141
161
|
tools/definitions/
|
|
142
|
-
nonprofit-search.tool.ts #
|
|
162
|
+
nonprofit-search-organizations.tool.ts # nonprofit_search_organizations
|
|
143
163
|
nonprofit-get-organization.tool.ts# nonprofit_get_organization
|
|
144
164
|
nonprofit-get-filings.tool.ts # nonprofit_get_filings
|
|
145
165
|
```
|
|
@@ -150,8 +170,8 @@ src/
|
|
|
150
170
|
|
|
151
171
|
| What | Convention | Example |
|
|
152
172
|
|:-----|:-----------|:--------|
|
|
153
|
-
| Files | kebab-case with suffix | `nonprofit-search.tool.ts` |
|
|
154
|
-
| Tool/resource/prompt names | snake_case | `
|
|
173
|
+
| Files | kebab-case with suffix | `nonprofit-search-organizations.tool.ts` |
|
|
174
|
+
| Tool/resource/prompt names | snake_case | `nonprofit_search_organizations` |
|
|
155
175
|
| Directories | kebab-case | `src/services/nonprofit-explorer/` |
|
|
156
176
|
| Descriptions | Single string or template literal, no `+` concatenation | `'Search orgs by name and filter.'` |
|
|
157
177
|
|
|
@@ -217,7 +237,8 @@ When you complete a skill's checklist, check the boxes and add a completion time
|
|
|
217
237
|
| `bun run rebuild` | Clean + build |
|
|
218
238
|
| `bun run clean` | Remove build artifacts |
|
|
219
239
|
| `bun run devcheck` | Lint + format + typecheck + security + changelog sync |
|
|
220
|
-
| `bun run audit:
|
|
240
|
+
| `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` |
|
|
241
|
+
| `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` |
|
|
221
242
|
| `bun run lint:mcp` | Run the MCP definition linter standalone (rule catalog: `api-linter` skill) |
|
|
222
243
|
| `bun run lint:packaging` | Packaging surface checks — `server.json`/`manifest.json` env-var parity (run by devcheck) |
|
|
223
244
|
| `bun run list-skills` | Print the skill registry |
|
|
@@ -231,13 +252,15 @@ When you complete a skill's checklist, check the boxes and add a completion time
|
|
|
231
252
|
| `bun run changelog:check` | Verify `CHANGELOG.md` is in sync (used by devcheck) |
|
|
232
253
|
| `bun run bundle` | Build, pack, and clean a `.mcpb` for one-click Claude Desktop install |
|
|
233
254
|
|
|
255
|
+
**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.
|
|
256
|
+
|
|
234
257
|
---
|
|
235
258
|
|
|
236
259
|
## Bundling
|
|
237
260
|
|
|
238
261
|
`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 two classes of `node_modules/**` content that root-anchored `.mcpbignore` patterns cannot reach: dependency-shipped agent docs (`framework-skills/`, `skills/`, `.claude/`, `.agents/`, `SKILL.md`) and platform-specific native bindings, which would otherwise lock the bundle to the platform it was packed on. MCPB is stdio-only — HTTP and Cloudflare Workers deployments are unaffected. Consumers who don't need it can delete `manifest.json` and `.mcpbignore`; `lint:packaging` skips cleanly.
|
|
239
262
|
|
|
240
|
-
**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.
|
|
263
|
+
**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": ""`.
|
|
241
264
|
|
|
242
265
|
**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`.
|
|
243
266
|
|
|
@@ -264,7 +287,7 @@ security: false # optional — true ONLY for a source
|
|
|
264
287
|
|
|
265
288
|
`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.
|
|
266
289
|
|
|
267
|
-
**Section order
|
|
290
|
+
**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.
|
|
268
291
|
|
|
269
292
|
**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.
|
|
270
293
|
|
|
@@ -272,7 +295,7 @@ security: false # optional — true ONLY for a source
|
|
|
272
295
|
|
|
273
296
|
## Publishing
|
|
274
297
|
|
|
275
|
-
**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
|
|
298
|
+
**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 release digest: theme line, `## Changes`, `## Gates`, changelog link last); `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.
|
|
276
299
|
|
|
277
300
|
---
|
|
278
301
|
|
|
@@ -302,7 +325,7 @@ import { getNonprofitExplorerService } from '@/services/nonprofit-explorer/nonpr
|
|
|
302
325
|
- [ ] If wrapping external API: tests include at least one sparse payload case with omitted upstream fields
|
|
303
326
|
- [ ] Registered in `createApp()` arrays (directly or via barrel exports)
|
|
304
327
|
- [ ] Tests use `createMockContext()` from `@cyanheads/mcp-ts-core/testing`
|
|
305
|
-
- [ ] `.codex-plugin/plugin.json` populated — `name`, `version`, `description`, `repository`, `license` from `package.json`; `interface.displayName` =
|
|
306
|
-
- [ ] `.codex-plugin/mcp.json` updated — server name key
|
|
307
|
-
- [ ] `.claude-plugin/plugin.json` populated — `name`, `version`, `description`, `repository`, `license` from `package.json`; inline `mcpServers` entry
|
|
328
|
+
- [ ] `.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
|
|
329
|
+
- [ ] `.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
|
|
330
|
+
- [ ] `.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`
|
|
308
331
|
- [ ] `bun run devcheck` passes
|
package/Dockerfile
CHANGED
|
@@ -3,8 +3,18 @@
|
|
|
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
|
+
# Pinned to $BUILDPLATFORM rather than the target platform: `bun run build` emits
|
|
8
|
+
# JavaScript, and only `dist/` crosses into the production stage. Built for the
|
|
9
|
+
# target instead, the non-native leg of a `--platform linux/amd64,linux/arm64`
|
|
10
|
+
# build runs under QEMU, where bun >= 1.4 aborts with a JavaScriptCore allocator
|
|
11
|
+
# assertion and fails the multi-arch push.
|
|
12
|
+
#
|
|
13
|
+
# The constraint this assumes: the build stage produces platform-independent
|
|
14
|
+
# output. A stage that compiles a native addon needs the target-arch toolchain
|
|
15
|
+
# and cannot cross-compile this way — drop the flag there.
|
|
6
16
|
# ==============================================================================
|
|
7
|
-
FROM --platform=$BUILDPLATFORM oven/bun:1.4.
|
|
17
|
+
FROM --platform=$BUILDPLATFORM oven/bun:1.4.3 AS build
|
|
8
18
|
|
|
9
19
|
WORKDIR /usr/src/app
|
|
10
20
|
|
|
@@ -24,68 +34,132 @@ RUN bun run build
|
|
|
24
34
|
|
|
25
35
|
|
|
26
36
|
# ==============================================================================
|
|
27
|
-
# Production Stage
|
|
37
|
+
# Production Dependencies Stage
|
|
28
38
|
#
|
|
29
|
-
#
|
|
30
|
-
#
|
|
31
|
-
#
|
|
39
|
+
# Installs the production dependency tree for the target platform. Every step
|
|
40
|
+
# here can run JavaScript — bunfig.toml's security scanner runs as a Bun
|
|
41
|
+
# program, and so do the OTel and musl-prune scripts — so the stage runs on
|
|
42
|
+
# $BUILDPLATFORM and cross-installs with `--os`/`--cpu`, which pick each
|
|
43
|
+
# platform-specific optional dependency (native bindings such as DuckDB's) for
|
|
44
|
+
# the target. Only `node_modules` leaves this stage.
|
|
45
|
+
#
|
|
46
|
+
# A clean image rather than `FROM build`: the build stage's node_modules holds
|
|
47
|
+
# devDependencies.
|
|
32
48
|
# ==============================================================================
|
|
33
|
-
FROM oven/bun:1.4.
|
|
49
|
+
FROM --platform=$BUILDPLATFORM oven/bun:1.4.3 AS deps
|
|
34
50
|
|
|
35
51
|
WORKDIR /usr/src/app
|
|
36
52
|
|
|
37
|
-
#
|
|
38
|
-
#
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
#
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
#
|
|
50
|
-
|
|
53
|
+
# Copy dependency manifests. `bunfig.toml` rides along so every install below
|
|
54
|
+
# passes its release-age gate and security scanner, as a local install does.
|
|
55
|
+
COPY package.json bun.lock bunfig.toml ./
|
|
56
|
+
|
|
57
|
+
# The scanner bunfig.toml names is a devDependency, and Bun installs a missing
|
|
58
|
+
# scanner through the same production-filtered install, which omits it and
|
|
59
|
+
# aborts. Seed it from the build stage's full install instead. Remove this line,
|
|
60
|
+
# and the `rm` at the end of this stage, if bunfig.toml stops naming a scanner.
|
|
61
|
+
COPY --from=build /usr/src/app/node_modules/@socketsecurity/bun-security-scanner ./node_modules/@socketsecurity/bun-security-scanner
|
|
62
|
+
|
|
63
|
+
# Docker names the target architecture `amd64`/`arm64`; Bun's `--cpu` takes
|
|
64
|
+
# `x64`/`arm64`. Mapped once here, read by both installs below. `oven/bun`
|
|
65
|
+
# publishes only these two architectures, so any other target fails here.
|
|
66
|
+
ARG TARGETOS
|
|
67
|
+
ARG TARGETARCH
|
|
68
|
+
RUN case "$TARGETARCH" in \
|
|
69
|
+
amd64) echo x64 ;; \
|
|
70
|
+
arm64) echo arm64 ;; \
|
|
71
|
+
*) echo "Unsupported TARGETARCH '$TARGETARCH': expected amd64 or arm64" >&2; exit 1 ;; \
|
|
72
|
+
esac > .bun-cpu
|
|
51
73
|
|
|
52
74
|
# Install only production dependencies, ignoring any lifecycle scripts (like 'prepare')
|
|
53
75
|
# that are not needed in the final production image.
|
|
54
76
|
# `--omit=peer` drops the framework's optional peer tiers (test runner, service
|
|
55
77
|
# SDKs, parsers) that Bun would otherwise auto-install. Anything this server
|
|
56
78
|
# actually imports belongs in its own `dependencies`, so nothing needed at
|
|
57
|
-
# runtime is lost.
|
|
58
|
-
# install re-resolves the graph and pulls every optional peer back in.
|
|
79
|
+
# runtime is lost.
|
|
59
80
|
RUN --mount=type=cache,target=/root/.bun/install/cache \
|
|
60
|
-
bun install --production --omit=peer --frozen-lockfile --ignore-scripts
|
|
81
|
+
bun install --production --omit=peer --frozen-lockfile --ignore-scripts \
|
|
82
|
+
--os="$TARGETOS" --cpu="$(cat .bun-cpu)"
|
|
61
83
|
|
|
62
84
|
# Conditionally install OpenTelemetry optional peer dependencies (Tier 3).
|
|
63
|
-
#
|
|
64
|
-
# with: docker build --build-arg OTEL_ENABLED=
|
|
85
|
+
# Installed by default. Omit them for a leaner image at build time
|
|
86
|
+
# with: docker build --build-arg OTEL_ENABLED=false
|
|
87
|
+
# The script reads the list and each range from the installed framework's
|
|
88
|
+
# `peerDependencies` and passes the target flags on to its `bun install`.
|
|
89
|
+
COPY scripts/install-otel.ts ./scripts/
|
|
65
90
|
ARG OTEL_ENABLED=true
|
|
66
91
|
RUN --mount=type=cache,target=/root/.bun/install/cache \
|
|
67
92
|
if [ "$OTEL_ENABLED" = "true" ]; then \
|
|
68
|
-
bun
|
|
69
|
-
@opentelemetry/instrumentation-http \
|
|
70
|
-
@opentelemetry/exporter-metrics-otlp-http \
|
|
71
|
-
@opentelemetry/exporter-trace-otlp-http \
|
|
72
|
-
@opentelemetry/instrumentation-pino \
|
|
73
|
-
@opentelemetry/resources \
|
|
74
|
-
@opentelemetry/sdk-metrics \
|
|
75
|
-
@opentelemetry/sdk-node \
|
|
76
|
-
@opentelemetry/sdk-trace-node \
|
|
77
|
-
@opentelemetry/semantic-conventions; \
|
|
93
|
+
bun scripts/install-otel.ts --os="$TARGETOS" --cpu="$(cat .bun-cpu)"; \
|
|
78
94
|
fi
|
|
79
95
|
|
|
96
|
+
# `--os`/`--cpu` have no libc counterpart, so a native dependency published in
|
|
97
|
+
# glibc and musl variants (DuckDB's bindings, for one) installs both. The
|
|
98
|
+
# runtime image is Debian (glibc) and never loads the musl copy; the script
|
|
99
|
+
# deletes every package whose own `libc` admits only musl. It follows every
|
|
100
|
+
# install, since a later `bun install` restores what it removes. A server on a
|
|
101
|
+
# musl (Alpine) runtime image drops these two lines.
|
|
102
|
+
COPY scripts/prune-musl-packages.ts ./scripts/
|
|
103
|
+
RUN bun scripts/prune-musl-packages.ts
|
|
104
|
+
|
|
105
|
+
# The seeded scanner served only the installs above; keep it out of the image.
|
|
106
|
+
RUN rm -rf node_modules/@socketsecurity/bun-security-scanner
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
# ==============================================================================
|
|
110
|
+
# Production Stage
|
|
111
|
+
#
|
|
112
|
+
# This stage creates a minimal, optimized, and secure image for running the
|
|
113
|
+
# application. It uses a slim base image and only includes production
|
|
114
|
+
# dependencies and build artifacts. Its only Bun invocations are HEALTHCHECK
|
|
115
|
+
# and CMD, which run on the real target at container start.
|
|
116
|
+
# ==============================================================================
|
|
117
|
+
FROM oven/bun:1.4.3-slim AS production
|
|
118
|
+
|
|
119
|
+
WORKDIR /usr/src/app
|
|
120
|
+
|
|
121
|
+
# Set the environment to production for performance.
|
|
122
|
+
ENV NODE_ENV=production
|
|
123
|
+
|
|
124
|
+
# OCI image metadata (https://github.com/opencontainers/image-spec/blob/main/annotations.md)
|
|
125
|
+
ARG APP_VERSION
|
|
126
|
+
LABEL org.opencontainers.image.title="nonprofit-explorer-mcp-server"
|
|
127
|
+
LABEL org.opencontainers.image.description="Search and explore 1.8M+ US nonprofits, fetch Form 990 financials, and access IRS filing history via MCP. STDIO or Streamable HTTP."
|
|
128
|
+
LABEL org.opencontainers.image.licenses="Apache-2.0"
|
|
129
|
+
LABEL org.opencontainers.image.version="${APP_VERSION}"
|
|
130
|
+
LABEL org.opencontainers.image.source="https://github.com/cyanheads/nonprofit-explorer-mcp-server"
|
|
131
|
+
|
|
132
|
+
# The manifest comes from the build context: the deps stage's copy was rewritten
|
|
133
|
+
# by the OTel install, and the runtime reads only its name, version, and type.
|
|
134
|
+
COPY package.json ./
|
|
135
|
+
COPY --from=deps /usr/src/app/node_modules ./node_modules
|
|
136
|
+
|
|
80
137
|
# Copy the compiled application code from the build stage
|
|
81
138
|
COPY --from=build /usr/src/app/dist ./dist
|
|
82
139
|
|
|
140
|
+
# Mirror CLI (MirrorService adopters only — Tier 3, opt-in):
|
|
141
|
+
# Copy your mirror lifecycle scripts and emit a runtime tsconfig so Bun resolves
|
|
142
|
+
# the @/ path alias against ./dist/ rather than ./src/.
|
|
143
|
+
# See the api-mirror skill for the full recipe.
|
|
144
|
+
#
|
|
145
|
+
# COPY --from=build /usr/src/app/scripts/<your>-mirror-init.ts \
|
|
146
|
+
# /usr/src/app/scripts/<your>-mirror-refresh.ts \
|
|
147
|
+
# /usr/src/app/scripts/<your>-mirror-verify.ts \
|
|
148
|
+
# /usr/src/app/scripts/_mirror-context.ts \
|
|
149
|
+
# ./scripts/
|
|
150
|
+
# RUN echo '{"compilerOptions":{"baseUrl":".","paths":{"@/*":["./dist/*"]}}}' > tsconfig.json
|
|
151
|
+
|
|
83
152
|
# The 'oven/bun' image already provides a non-root user named 'bun'.
|
|
84
153
|
# We will use this existing user for enhanced security.
|
|
85
154
|
|
|
86
155
|
# Create and set permissions for the log directory, assigning ownership to the 'bun' user.
|
|
87
156
|
RUN mkdir -p /var/log/nonprofit-explorer-mcp-server && chown -R bun:bun /var/log/nonprofit-explorer-mcp-server
|
|
88
157
|
|
|
158
|
+
# Writable data dirs for on-disk SQLite stores (catalog index / observations
|
|
159
|
+
# mirror), owned by the runtime user. Mount a volume over either in production.
|
|
160
|
+
RUN mkdir -p /usr/src/app/.cache /usr/src/app/.mirror \
|
|
161
|
+
&& chown -R bun:bun /usr/src/app/.cache /usr/src/app/.mirror
|
|
162
|
+
|
|
89
163
|
# Switch to the non-root user
|
|
90
164
|
USER bun
|
|
91
165
|
|
|
@@ -101,14 +175,12 @@ ENV MCP_TRANSPORT_TYPE="http"
|
|
|
101
175
|
ENV MCP_SESSION_MODE="stateless"
|
|
102
176
|
ENV MCP_LOG_LEVEL="info"
|
|
103
177
|
ENV LOGS_DIR="/var/log/nonprofit-explorer-mcp-server"
|
|
104
|
-
ENV MCP_FORCE_CONSOLE_LOGGING="true"
|
|
105
178
|
|
|
106
179
|
# Expose the port the server listens on
|
|
107
180
|
EXPOSE ${MCP_HTTP_PORT}
|
|
108
181
|
|
|
109
|
-
# Health check
|
|
110
|
-
HEALTHCHECK --interval=30s --timeout=5s --start-period=10s --retries=3
|
|
111
|
-
CMD bun -e "fetch('http://localhost:' + (process.env.MCP_HTTP_PORT || 3010) + '/healthz').then(r => process.exit(r.ok ? 0 : 1)).catch(() => process.exit(1))"
|
|
182
|
+
# Health check using a bun-native fetch (slim image ships no curl/wget)
|
|
183
|
+
HEALTHCHECK --interval=30s --timeout=5s --start-period=10s --retries=3 CMD bun -e "fetch('http://localhost:'+(process.env.MCP_HTTP_PORT??'3010')+'/healthz').then((r)=>process.exit(r.ok?0:1)).catch(()=>process.exit(1))"
|
|
112
184
|
|
|
113
185
|
# The command to start the server
|
|
114
186
|
CMD ["bun", "run", "dist/index.js"]
|