@cyanheads/ris-austria-mcp-server 0.4.1 → 0.4.3
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 +106 -105
- package/CLAUDE.md +106 -105
- package/Dockerfile +11 -6
- package/README.md +54 -6
- package/changelog/0.4.x/0.4.2.md +26 -0
- package/changelog/0.4.x/0.4.3.md +33 -0
- package/changelog/template.md +62 -40
- package/dist/index.js +6 -0
- package/dist/index.js.map +1 -1
- package/dist/mcp-server/resources/definitions/ris-document.resource.d.ts.map +1 -1
- package/dist/mcp-server/resources/definitions/ris-document.resource.js +2 -1
- package/dist/mcp-server/resources/definitions/ris-document.resource.js.map +1 -1
- package/dist/mcp-server/tools/definitions/_shared.d.ts.map +1 -1
- package/dist/mcp-server/tools/definitions/_shared.js +0 -2
- package/dist/mcp-server/tools/definitions/_shared.js.map +1 -1
- package/dist/mcp-server/tools/definitions/ris-lookup-citation.tool.d.ts +3 -3
- package/dist/mcp-server/tools/definitions/ris-lookup-citation.tool.d.ts.map +1 -1
- package/dist/mcp-server/tools/definitions/ris-lookup-citation.tool.js +5 -6
- package/dist/mcp-server/tools/definitions/ris-lookup-citation.tool.js.map +1 -1
- package/dist/mcp-server/tools/definitions/ris-track-changes.tool.js +2 -2
- package/dist/mcp-server/tools/definitions/ris-track-changes.tool.js.map +1 -1
- package/dist/services/ris/normalizer.d.ts +1 -1
- package/dist/services/ris/normalizer.d.ts.map +1 -1
- package/dist/services/ris/normalizer.js +3 -3
- package/dist/services/ris/normalizer.js.map +1 -1
- package/dist/services/ris/ris-service.d.ts +3 -4
- package/dist/services/ris/ris-service.d.ts.map +1 -1
- package/dist/services/ris/ris-service.js +9 -38
- package/dist/services/ris/ris-service.js.map +1 -1
- package/package.json +11 -10
- package/server.json +31 -3
package/AGENTS.md
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
# Developer Protocol
|
|
2
2
|
|
|
3
3
|
**Server:** ris-austria-mcp-server
|
|
4
|
-
**Version:** 0.4.
|
|
5
|
-
**Framework:** [@cyanheads/mcp-ts-core](https://www.npmjs.com/package/@cyanheads/mcp-ts-core) `^0.
|
|
6
|
-
**Engines:** Bun ≥1.
|
|
7
|
-
**MCP SDK:** `@modelcontextprotocol/
|
|
8
|
-
**Zod:** ^4.
|
|
4
|
+
**Version:** 0.4.3
|
|
5
|
+
**Framework:** [@cyanheads/mcp-ts-core](https://www.npmjs.com/package/@cyanheads/mcp-ts-core) `^0.13.0`
|
|
6
|
+
**Engines:** Bun ≥1.4.0, Node ≥24.0.0
|
|
7
|
+
**MCP SDK:** `@modelcontextprotocol/server` ^2.0.0
|
|
8
|
+
**Zod:** ^4.6.1
|
|
9
9
|
|
|
10
10
|
> **Read the framework docs first:** `node_modules/@cyanheads/mcp-ts-core/CLAUDE.md` contains the full API reference — builders, Context, error codes, exports, patterns. This file covers server-specific conventions only.
|
|
11
11
|
|
|
@@ -35,85 +35,81 @@ Tailor suggestions to what's actually missing or stale — don't recite the full
|
|
|
35
35
|
- **Logic throws, framework catches.** Tool/resource handlers are pure — throw on failure, no `try/catch`. Plain `Error` is fine; the framework catches, classifies, and formats. Use error factories (`notFound()`, `validationError()`, etc.) when the error code matters.
|
|
36
36
|
- **Use `ctx.log`** for request-scoped logging. No `console` calls.
|
|
37
37
|
- **Use `ctx.state`** for tenant-scoped storage. Never access persistence directly.
|
|
38
|
-
- **
|
|
38
|
+
- **Need input the caller didn't supply?** `return ctx.requestInput(...)` and read `ctx.inputs` when the handler is re-entered. Never `await` for user input mid-handler.
|
|
39
39
|
- **Secrets in env vars only** — never hardcoded.
|
|
40
|
+
- **Cut noise.** Add only what earns its place: no speculative generality, no guards for states the framework already prevents (Zod-validated params, classified errors), no abstraction until a third caller proves it, no option nothing sets.
|
|
40
41
|
- **Close the loop on issues.** When implementing work tracked by a GitHub issue, comment on the issue with what landed and close it. Do both — a comment without a close leaves stale issues open; a close without a comment leaves no record of what shipped. The comment is for future readers — state the concrete changes, not the conversation that produced them.
|
|
41
42
|
|
|
42
43
|
---
|
|
43
44
|
|
|
44
45
|
## Patterns
|
|
45
46
|
|
|
47
|
+
These are representative excerpts; the named source files remain canonical for complete schemas,
|
|
48
|
+
contracts, and rendering logic.
|
|
49
|
+
|
|
46
50
|
### Tool
|
|
47
51
|
|
|
48
52
|
```ts
|
|
49
53
|
import { tool, z } from '@cyanheads/mcp-ts-core';
|
|
50
54
|
|
|
51
|
-
export const
|
|
52
|
-
|
|
53
|
-
|
|
55
|
+
export const risListReference = tool('ris_list_reference', {
|
|
56
|
+
title: 'RIS Reference Lists',
|
|
57
|
+
description: 'Return one static RIS vocabulary table without an upstream call.',
|
|
58
|
+
annotations: { readOnlyHint: true, idempotentHint: true, openWorldHint: false },
|
|
54
59
|
input: z.object({
|
|
55
|
-
|
|
56
|
-
limit: z.number().default(10).describe('Max results'),
|
|
57
|
-
}),
|
|
58
|
-
output: z.object({
|
|
59
|
-
items: z.array(z.object({
|
|
60
|
-
id: z.string().describe('Item ID'),
|
|
61
|
-
name: z.string().describe('Item name'),
|
|
62
|
-
})).describe('Matching items'),
|
|
60
|
+
topic: z.enum(TOPICS).describe('Reference table to return.'),
|
|
63
61
|
}),
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
const items = await findItems(input.query, input.limit);
|
|
68
|
-
ctx.log.info('Search completed', { query: input.query, count: items.length });
|
|
69
|
-
return { items };
|
|
62
|
+
output: z.object({ /* topic, summary, entries, notes — see the full definition */ }),
|
|
63
|
+
handler(input) {
|
|
64
|
+
return { topic: input.topic, ...TOPIC_BUILDERS[input.topic]() };
|
|
70
65
|
},
|
|
71
|
-
|
|
72
|
-
// format() populates content[] — the markdown twin of structuredContent.
|
|
73
|
-
// Different clients read different surfaces (Claude Code → structuredContent,
|
|
74
|
-
// Claude Desktop → content[]); both must carry the same data.
|
|
75
|
-
// Enforced at lint time: every field in `output` must appear in the rendered text.
|
|
76
|
-
format: (result) => [{
|
|
77
|
-
type: 'text',
|
|
78
|
-
text: result.items.map(i => `**${i.id}**: ${i.name}`).join('\n'),
|
|
79
|
-
}],
|
|
66
|
+
format: (result) => { /* render every entry, detail pair, and note as markdown */ },
|
|
80
67
|
});
|
|
81
68
|
```
|
|
82
69
|
|
|
70
|
+
The full output schema, `TOPIC_BUILDERS`, and markdown renderer stay local to
|
|
71
|
+
`ris-list-reference.tool.ts`; every other `ris_*` tool links to these vocabularies from its
|
|
72
|
+
descriptions and recovery hints.
|
|
73
|
+
|
|
83
74
|
### Resource
|
|
84
75
|
|
|
85
76
|
```ts
|
|
86
77
|
import { resource, z } from '@cyanheads/mcp-ts-core';
|
|
87
|
-
import {
|
|
78
|
+
import { JsonRpcErrorCode } from '@cyanheads/mcp-ts-core/errors';
|
|
88
79
|
|
|
89
|
-
export const
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
80
|
+
export const risDocumentResource = resource('ris://document/{application}/{documentNumber}', {
|
|
81
|
+
name: 'ris_document',
|
|
82
|
+
title: 'RIS Document (Markdown)',
|
|
83
|
+
description: 'Markdown text of one RIS document by application and technical ID.',
|
|
84
|
+
mimeType: 'text/markdown',
|
|
85
|
+
cacheHint: { ttlMs: 86_400_000, cacheScope: 'public' },
|
|
86
|
+
params: z.object({
|
|
87
|
+
application: z.enum(APPLICATION_CODES).describe('RIS application code.'),
|
|
88
|
+
documentNumber: z.string().describe('Technical RIS document number.'),
|
|
89
|
+
}),
|
|
90
|
+
errors: [
|
|
91
|
+
{
|
|
92
|
+
reason: 'document_not_found',
|
|
93
|
+
code: JsonRpcErrorCode.NotFound,
|
|
94
|
+
when: 'The application/document-number pair does not resolve.',
|
|
95
|
+
recovery: 'Copy both values from a fresh RIS search result.',
|
|
96
|
+
},
|
|
97
|
+
],
|
|
93
98
|
async handler(params, ctx) {
|
|
94
|
-
const
|
|
95
|
-
|
|
96
|
-
|
|
99
|
+
const rendition = await renderDocument(
|
|
100
|
+
params.application,
|
|
101
|
+
params.documentNumber,
|
|
102
|
+
'markdown',
|
|
103
|
+
ctx,
|
|
104
|
+
);
|
|
105
|
+
// Map errors to the declared contract and return full text or a section outline.
|
|
106
|
+
return rendition.text ?? rendition.unavailableNotice ?? '';
|
|
97
107
|
},
|
|
98
108
|
});
|
|
99
109
|
```
|
|
100
110
|
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
```ts
|
|
104
|
-
import { prompt, z } from '@cyanheads/mcp-ts-core';
|
|
105
|
-
|
|
106
|
-
export const reviewCode = prompt('review_code', {
|
|
107
|
-
description: 'Review code for issues and best practices.',
|
|
108
|
-
args: z.object({
|
|
109
|
-
code: z.string().describe('Code to review'),
|
|
110
|
-
language: z.string().optional().describe('Programming language'),
|
|
111
|
-
}),
|
|
112
|
-
generate: (args) => [
|
|
113
|
-
{ role: 'user', content: { type: 'text', text: `Review this ${args.language ?? ''} code:\n${args.code}` } },
|
|
114
|
-
],
|
|
115
|
-
});
|
|
116
|
-
```
|
|
111
|
+
The real handler maps `renderDocument` failures onto the resource's three-entry error contract and
|
|
112
|
+
degrades oversized documents to the same section outline as `ris_get_document`.
|
|
117
113
|
|
|
118
114
|
### Server config
|
|
119
115
|
|
|
@@ -123,42 +119,48 @@ import { z } from '@cyanheads/mcp-ts-core';
|
|
|
123
119
|
import { parseEnvConfig } from '@cyanheads/mcp-ts-core/config';
|
|
124
120
|
|
|
125
121
|
const ServerConfigSchema = z.object({
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
122
|
+
apiBaseUrl: z.url().default('https://data.bka.gv.at/ris/api/v2.6'),
|
|
123
|
+
contentBaseUrl: z.url().default('https://www.ris.bka.gv.at'),
|
|
124
|
+
contact: z.string().optional(),
|
|
129
125
|
});
|
|
130
126
|
|
|
131
127
|
let _config: z.infer<typeof ServerConfigSchema> | undefined;
|
|
132
128
|
export function getServerConfig() {
|
|
133
129
|
_config ??= parseEnvConfig(ServerConfigSchema, {
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
130
|
+
apiBaseUrl: 'RIS_API_BASE_URL',
|
|
131
|
+
contentBaseUrl: 'RIS_CONTENT_BASE_URL',
|
|
132
|
+
contact: 'RIS_CONTACT',
|
|
137
133
|
});
|
|
138
134
|
return _config;
|
|
139
135
|
}
|
|
140
136
|
```
|
|
141
137
|
|
|
142
|
-
|
|
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.
|
|
138
|
+
All RIS variables are optional because the OGD API is keyless. `parseEnvConfig` maps schema paths
|
|
139
|
+
to env-var names so a configuration failure names the variable the operator can fix.
|
|
145
140
|
|
|
146
141
|
### Server identity and instructions
|
|
147
142
|
|
|
148
|
-
|
|
143
|
+
The entry point pins the machine identity and immutable public catalog cache hints:
|
|
149
144
|
|
|
150
145
|
```ts
|
|
151
146
|
await createApp({
|
|
152
|
-
name: '
|
|
153
|
-
title: '
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
147
|
+
name: 'ris-austria-mcp-server',
|
|
148
|
+
title: 'ris-austria-mcp-server',
|
|
149
|
+
cacheHints: {
|
|
150
|
+
'tools/list': { ttlMs: 3_600_000, cacheScope: 'public' },
|
|
151
|
+
'resources/list': { ttlMs: 3_600_000, cacheScope: 'public' },
|
|
152
|
+
'resources/templates/list': { ttlMs: 3_600_000, cacheScope: 'public' },
|
|
153
|
+
'server/discover': { ttlMs: 3_600_000, cacheScope: 'public' },
|
|
154
|
+
},
|
|
155
|
+
tools: [/* nine ris_* definitions */],
|
|
156
|
+
resources: [risDocumentResource],
|
|
157
|
+
setup(core) {
|
|
158
|
+
initRisService(core.config);
|
|
159
|
+
},
|
|
158
160
|
});
|
|
159
161
|
```
|
|
160
162
|
|
|
161
|
-
`
|
|
163
|
+
`package.json` is the canonical description source; do not duplicate it into `createApp()`.
|
|
162
164
|
|
|
163
165
|
---
|
|
164
166
|
|
|
@@ -168,15 +170,10 @@ Handlers receive a unified `ctx` object. Key properties:
|
|
|
168
170
|
|
|
169
171
|
| Property | Description |
|
|
170
172
|
|:---------|:------------|
|
|
171
|
-
| `ctx.log` | Request-scoped logger — `.debug()`, `.info()`, `.notice()`, `.warning()`, `.error()`. Auto-correlates requestId, traceId, tenantId. |
|
|
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.elicit` | Ask user for structured input — form call `(message, schema)` or `.url(message, url)` for an external link. **Check for presence first:** `if (ctx.elicit) { ... }` |
|
|
173
|
+
| `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. |
|
|
174
174
|
| `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). |
|
|
175
|
-
| `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`. |
|
|
176
175
|
| `ctx.signal` | `AbortSignal` for cancellation. |
|
|
177
|
-
| `ctx.
|
|
178
|
-
| `ctx.requestId` | Unique request ID. |
|
|
179
|
-
| `ctx.tenantId` | Tenant ID from JWT; `'default'` for stdio or HTTP with auth off. |
|
|
176
|
+
| `ctx.requestId` / `traceId` / `spanId` / `tenantId` | Correlation fields inherited by each RIS service request context. |
|
|
180
177
|
|
|
181
178
|
---
|
|
182
179
|
|
|
@@ -184,7 +181,7 @@ Handlers receive a unified `ctx` object. Key properties:
|
|
|
184
181
|
|
|
185
182
|
Handlers throw — the framework catches, classifies, and formats.
|
|
186
183
|
|
|
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.
|
|
184
|
+
**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`, `RequestCancelled`) bubble freely and don't need declaring.
|
|
188
185
|
|
|
189
186
|
```ts
|
|
190
187
|
import { JsonRpcErrorCode } from '@cyanheads/mcp-ts-core/errors';
|
|
@@ -217,7 +214,7 @@ throw new Error('Invalid query format'); // → ValidationError
|
|
|
217
214
|
|
|
218
215
|
// McpError — when no factory exists for the code
|
|
219
216
|
import { McpError, JsonRpcErrorCode } from '@cyanheads/mcp-ts-core/errors';
|
|
220
|
-
throw new McpError(JsonRpcErrorCode.
|
|
217
|
+
throw new McpError(JsonRpcErrorCode.InitializationFailed, 'Connection failed', { pool: 'primary' });
|
|
221
218
|
```
|
|
222
219
|
|
|
223
220
|
See framework CLAUDE.md and the `api-errors` skill for the full auto-classification table, all available factories, and the contract reference.
|
|
@@ -228,20 +225,22 @@ See framework CLAUDE.md and the `api-errors` skill for the full auto-classificat
|
|
|
228
225
|
|
|
229
226
|
```text
|
|
230
227
|
src/
|
|
231
|
-
index.ts
|
|
228
|
+
index.ts # createApp() entry point
|
|
232
229
|
config/
|
|
233
|
-
server-config.ts
|
|
230
|
+
server-config.ts # Optional RIS endpoint/contact config
|
|
234
231
|
services/
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
232
|
+
ris/
|
|
233
|
+
ris-service.ts # Search/content HTTP gateway
|
|
234
|
+
request-builder.ts # Per-application request mapping
|
|
235
|
+
normalizer.ts # Raw RIS envelope normalization
|
|
236
|
+
types.ts # Raw/domain types
|
|
237
|
+
reference/ # Static RIS vocabularies
|
|
238
238
|
mcp-server/
|
|
239
239
|
tools/definitions/
|
|
240
|
-
|
|
240
|
+
ris-*.tool.ts # Nine tool definitions
|
|
241
|
+
_shared.ts # Shared date/error-contract helpers
|
|
241
242
|
resources/definitions/
|
|
242
|
-
|
|
243
|
-
prompts/definitions/
|
|
244
|
-
[prompt-name].prompt.ts # Prompt definitions
|
|
243
|
+
ris-document.resource.ts # Markdown document resource
|
|
245
244
|
```
|
|
246
245
|
|
|
247
246
|
---
|
|
@@ -259,9 +258,9 @@ src/
|
|
|
259
258
|
|
|
260
259
|
## Skills
|
|
261
260
|
|
|
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.
|
|
261
|
+
Skills are modular instructions in `framework-skills/` at the project root. Read them directly when a task matches — e.g., `framework-skills/add-tool/SKILL.md` when adding a tool. `bun run list-skills` prints the full registry.
|
|
263
262
|
|
|
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.
|
|
263
|
+
**Agent skill directory:** Copy skills into the directory your agent discovers (Claude Code: `.claude/skills/`, others: equivalent). Skills then load as context without referencing `framework-skills/` paths. After framework updates, run the `maintenance` skill — Phase B re-syncs the agent directory.
|
|
265
264
|
|
|
266
265
|
Available skills:
|
|
267
266
|
|
|
@@ -280,8 +279,9 @@ Available skills:
|
|
|
280
279
|
| `security-pass` | Audit server for MCP-flavored security gaps: output injection, scope blast radius, input sinks, tenant isolation |
|
|
281
280
|
| `code-simplifier` | Post-session cleanup against `git diff` — modernize syntax, consolidate duplication, align with the codebase |
|
|
282
281
|
| `polish-docs-meta` | Finalize docs, README, metadata, and agent protocol for shipping |
|
|
283
|
-
| `git-wrapup` |
|
|
284
|
-
| `release-and-publish` |
|
|
282
|
+
| `git-wrapup` | Version bump, changelog, verification, and commit stack; leaves tagging to release-and-publish |
|
|
283
|
+
| `release-and-publish` | Tag, push, npm, MCP Registry, GitHub Release, and Docker publication after git-wrapup |
|
|
284
|
+
| `release-pr-review` | Review an opt-in gated release PR before publishing |
|
|
285
285
|
| `maintenance` | Investigate changelogs, adopt upstream changes, sync skills to agent dirs |
|
|
286
286
|
| `orchestrations` | Chain task skills into a gated multi-phase pipeline — build-out, QA-fix, update-ship — when you can spawn sub-agents |
|
|
287
287
|
| `report-issue-framework` | File a bug or feature request against `@cyanheads/mcp-ts-core` via `gh` CLI |
|
|
@@ -290,7 +290,7 @@ Available skills:
|
|
|
290
290
|
| `api-auth` | Auth modes, scopes, JWT/OAuth |
|
|
291
291
|
| `api-canvas` | DataCanvas: register tabular data, run SQL, export, plus the `spillover()` helper for big result sets — Tier 3 opt-in |
|
|
292
292
|
| `api-config` | AppConfig, parseConfig, env vars |
|
|
293
|
-
| `api-context` | Context interface, logger, state,
|
|
293
|
+
| `api-context` | Context interface, RequestContext, logger, state, multi-round-trip input |
|
|
294
294
|
| `api-errors` | McpError, JsonRpcErrorCode, error patterns |
|
|
295
295
|
| `api-linter` | Definition linter rule catalog — invoked by `bun run lint:mcp` and `devcheck` |
|
|
296
296
|
| `api-mirror` | MirrorService: persistent self-refreshing local mirror (embedded SQLite + FTS5) of a bulk upstream dataset — Tier 3 opt-in |
|
|
@@ -300,7 +300,7 @@ Available skills:
|
|
|
300
300
|
| `api-telemetry` | OTel catalog: spans, metrics, completion logs, env config, cardinality rules |
|
|
301
301
|
| `api-workers` | Cloudflare Workers runtime |
|
|
302
302
|
|
|
303
|
-
**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.
|
|
303
|
+
**Chaining skills into pipelines.** When the user wants a multi-phase effort — build this server out, QA-and-fix the surface, update-and-ship — *and you can spawn sub-agents*, `framework-skills/orchestrations/SKILL.md` sequences the task skills above into a gated pipeline with verification at each step. Read it to drive the run. Optional: skip it if you can't orchestrate sub-agents, and ignore it entirely if you were *spawned* as one — you've already been scoped to a single phase.
|
|
304
304
|
|
|
305
305
|
When you complete a skill's checklist, check the boxes and add a completion timestamp at the end (e.g., `Completed: 2026-03-11`).
|
|
306
306
|
|
|
@@ -316,7 +316,8 @@ When you complete a skill's checklist, check the boxes and add a completion time
|
|
|
316
316
|
| `bun run rebuild` | Clean + build |
|
|
317
317
|
| `bun run clean` | Remove build artifacts |
|
|
318
318
|
| `bun run devcheck` | Lint + format + typecheck + security + changelog sync |
|
|
319
|
-
| `bun run audit:
|
|
319
|
+
| `bun run audit:fix` | Run `bun audit fix` to upgrade vulnerable packages within existing ranges. First response to a transitive advisory; then `bun update <name>`, then `bun dedupe`. |
|
|
320
|
+
| `bun run audit:refresh` | Delete `bun.lock` and reinstall. Last resort after targeted fixes; every ranged dependency re-resolves. |
|
|
320
321
|
| `bun run lint:mcp` | Run the MCP definition linter standalone (rule catalog: `api-linter` skill) |
|
|
321
322
|
| `bun run lint:packaging` | Packaging surface checks — `server.json`/`manifest.json` env-var parity (run by devcheck) |
|
|
322
323
|
| `bun run list-skills` | Print the skill registry |
|
|
@@ -334,11 +335,11 @@ When you complete a skill's checklist, check the boxes and add a completion time
|
|
|
334
335
|
|
|
335
336
|
## Bundling
|
|
336
337
|
|
|
337
|
-
`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. A server using DataCanvas therefore ships a portable bundle without the DuckDB native — `@duckdb/node-api` is an optional peer loaded lazily, so canvas tools report an actionable install hint and every other tool works normally. 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.
|
|
338
|
+
`npm run bundle` produces a `.mcpb` extension bundle for one-click install in Claude Desktop. The pack step is followed by `scripts/clean-mcpb.ts`, which prunes dev dependencies (`mcpb clean`) and strips two classes of `node_modules/**` content that root-anchored `.mcpbignore` patterns cannot reach: dependency-shipped agent docs (`framework-skills/`, `.claude/`, `.agents/`, `SKILL.md`) and platform-specific native bindings, which would otherwise lock the bundle to the platform it was packed on. A server using DataCanvas therefore ships a portable bundle without the DuckDB native — `@duckdb/node-api` is an optional peer loaded lazily, so canvas tools report an actionable install hint and every other tool works normally. 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.
|
|
338
339
|
|
|
339
340
|
**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.
|
|
340
341
|
|
|
341
|
-
**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`.
|
|
342
|
+
**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`.
|
|
342
343
|
|
|
343
344
|
---
|
|
344
345
|
|
|
@@ -363,9 +364,9 @@ security: false # optional — true ONLY for a source
|
|
|
363
364
|
|
|
364
365
|
`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.
|
|
365
366
|
|
|
366
|
-
**Section order
|
|
367
|
+
**Section order:** Added, Changed, Deprecated, Removed, Fixed, Security, then Dependencies. Include only sections with entries — don't ship empty headers.
|
|
367
368
|
|
|
368
|
-
**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 `
|
|
369
|
+
**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 `framework-skills/release-and-publish/SKILL.md` for the tag format.
|
|
369
370
|
|
|
370
371
|
---
|
|
371
372
|
|
|
@@ -395,7 +396,7 @@ import { getMyService } from '@/services/my-domain/my-service.js';
|
|
|
395
396
|
- [ ] If wrapping external API: tests include at least one sparse payload case with omitted upstream fields
|
|
396
397
|
- [ ] Registered in `createApp()` arrays (directly or via barrel exports)
|
|
397
398
|
- [ ] Tests use `createMockContext()` from `@cyanheads/mcp-ts-core/testing`
|
|
398
|
-
- [ ] `.codex-plugin/plugin.json` populated — `name`, `version`, `description`, `repository`, `license` from `package.json`; `interface.displayName` =
|
|
399
|
-
- [ ] `.codex-plugin/mcp.json` updated — server name key
|
|
400
|
-
- [ ] `.claude-plugin/plugin.json` populated — `name`, `version`, `description`, `repository`, `license` from `package.json`; inline `mcpServers` entry
|
|
399
|
+
- [ ] `.codex-plugin/plugin.json` populated — `name`, `version`, `description`, `repository`, `license` from `package.json`; `interface.displayName` = the unscoped repo name; `interface.shortDescription` from `package.json` description
|
|
400
|
+
- [ ] `.codex-plugin/mcp.json` updated — server name key is the unscoped repo name; user-supplied variables are listed in `env_vars`, never empty `env` values
|
|
401
|
+
- [ ] `.claude-plugin/plugin.json` populated — `name`, `version`, `description`, `repository`, `license` from `package.json`; inline `mcpServers` entry keyed by the unscoped repo name; user-supplied variables declared in `userConfig` and referenced as `${user_config.<option>}`
|
|
401
402
|
- [ ] `npm run devcheck` passes
|