@cyanheads/mcp-ts-core 0.9.10 → 0.9.12
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/CLAUDE.md +2 -1
- package/README.md +1 -1
- package/biome.json +1 -1
- package/changelog/0.9.x/0.9.11.md +38 -0
- package/changelog/0.9.x/0.9.12.md +26 -0
- package/dist/cli/init.js +16 -3
- package/dist/cli/init.js.map +1 -1
- package/dist/config/index.d.ts +6 -0
- package/dist/config/index.d.ts.map +1 -1
- package/dist/config/index.js +10 -0
- package/dist/config/index.js.map +1 -1
- package/dist/core/serverManifest.d.ts +1 -0
- package/dist/core/serverManifest.d.ts.map +1 -1
- package/dist/core/serverManifest.js +1 -0
- package/dist/core/serverManifest.js.map +1 -1
- package/dist/mcp-server/transports/http/httpTransport.d.ts.map +1 -1
- package/dist/mcp-server/transports/http/httpTransport.js +1 -0
- package/dist/mcp-server/transports/http/httpTransport.js.map +1 -1
- package/package.json +4 -4
- package/skills/code-simplifier/SKILL.md +130 -0
- package/skills/git-wrapup/SKILL.md +1 -3
- package/skills/orchestrations/SKILL.md +223 -0
- package/skills/orchestrations/workflows/field-test-fix.md +206 -0
- package/skills/orchestrations/workflows/fix-wrapup-release.md +175 -0
- package/skills/orchestrations/workflows/greenfield-build.md +143 -0
- package/skills/orchestrations/workflows/maintenance-release.md +173 -0
- package/skills/polish-docs-meta/SKILL.md +2 -1
- package/skills/report-issue-framework/SKILL.md +4 -1
- package/templates/AGENTS.md +6 -0
- package/templates/CLAUDE.md +6 -0
- package/dist/logs/combined.log +0 -4
- package/dist/logs/error.log +0 -2
- package/dist/logs/interactions.log +0 -0
- package/skills/migrate-mcp-ts-template/SKILL.md +0 -162
- package/skills/multi-server-orchestration/SKILL.md +0 -137
- package/skills/multi-server-orchestration/references/greenfield-buildout.md +0 -246
- package/skills/multi-server-orchestration/references/maintenance-pass.md +0 -148
- package/skills/multi-server-orchestration/references/release-and-publish-pass.md +0 -184
- package/skills/multi-server-orchestration/references/wrapup-pass.md +0 -150
|
@@ -0,0 +1,175 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: fix-wrapup-release
|
|
3
|
+
description: >
|
|
4
|
+
Workflow for landing known work (handoff document findings, tracked GH issues, observed gaps) and shipping it: fix → optional simplify and field-test verification → wrap-up → release across one or more MCP server projects. Generalizes "I have known issues to fix and ship" regardless of how the issues were surfaced. Chains the `field-test`, `report-issue-local`, `code-simplifier`, `git-wrapup`, and `release-and-publish` skills. Read `../SKILL.md` first for the universal rules and sub-agent strategy.
|
|
5
|
+
metadata:
|
|
6
|
+
author: cyanheads
|
|
7
|
+
version: "1.0"
|
|
8
|
+
audience: internal
|
|
9
|
+
type: workflow
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
# Fix + Wrap-up + Release Workflow
|
|
13
|
+
|
|
14
|
+
Use after reading `../SKILL.md`. Use this workflow when there's a clear list of known fixes to apply and ship — sourced from a handoff document, tracked GH issues, observed gaps you've already validated, or any combination.
|
|
15
|
+
|
|
16
|
+
## Trigger contexts
|
|
17
|
+
|
|
18
|
+
The input varies but the workflow is the same. Read the inputs into a common shape before kicking off:
|
|
19
|
+
|
|
20
|
+
| Source | Shape it as |
|
|
21
|
+
|:---|:---|
|
|
22
|
+
| Handoff document (numbered findings, repro steps, acceptance criteria) | Validate each finding live in Phase 1a; file each valid one as a GH issue via `report-issue-local`; skip invalidated findings |
|
|
23
|
+
| GH issues already filed | Use as-is. Read each with `gh issue view N --comments` to capture the full thread (the body alone misses clarifications and decision updates) |
|
|
24
|
+
| Observed gap or casual report ("I noticed this", "fix the description on tool X") | If material enough to ship in a release, file a GH issue first to capture rationale and create an audit trail. Trivial typo-fix-and-ship can skip the issue step. |
|
|
25
|
+
|
|
26
|
+
The validation/filing step is the difference between "input is a hypothesis" (handoff) and "input is verified" (tracked GH issues). The rest of the workflow is identical.
|
|
27
|
+
|
|
28
|
+
## When applicable
|
|
29
|
+
|
|
30
|
+
- One or more existing servers have known work to land — issues, handoff findings, or specific verified bugs
|
|
31
|
+
- The work is the deliverable; the workflow ends in a commit + tag and (optionally) a release
|
|
32
|
+
- N = 1 (single-server handoff) and N > 1 (multi-server fix batch) both apply
|
|
33
|
+
|
|
34
|
+
For unsourced QA — where the bugs are unknown until you test — use `field-test-fix.md` instead; that workflow includes the field-test discovery phase first.
|
|
35
|
+
|
|
36
|
+
## Tier 1 skills referenced
|
|
37
|
+
|
|
38
|
+
| Phase | Tier 1 skill(s) |
|
|
39
|
+
|:---|:---|
|
|
40
|
+
| Validate (handoff input only) | `skills/field-test/SKILL.md` + `skills/report-issue-local/SKILL.md` + `.github/ISSUE_TEMPLATE/` |
|
|
41
|
+
| Fix | (No single skill — sub-agent reads issues, validates, fixes) |
|
|
42
|
+
| Verify | `skills/field-test/SKILL.md` (live verification) + `skills/code-simplifier/SKILL.md` (optional) |
|
|
43
|
+
| Wrap-up | `skills/git-wrapup/SKILL.md` |
|
|
44
|
+
| Release | `skills/release-and-publish/SKILL.md` |
|
|
45
|
+
|
|
46
|
+
## Pre-flight
|
|
47
|
+
|
|
48
|
+
Per target:
|
|
49
|
+
|
|
50
|
+
1. **Identify issues** — collect GH issue numbers to fix, the handoff document, or the explicit gap description. Read each issue with `gh issue view N --comments` to capture the full thread.
|
|
51
|
+
2. **Clean working tree** — `git status --short` must be empty
|
|
52
|
+
3. **Current version** — `git describe --tags --abbrev=0`, `grep '"version"' package.json`
|
|
53
|
+
4. **Repo visibility** — `gh repo view --json visibility -q '.visibility'`. Determines wrap-up scope.
|
|
54
|
+
5. **Build** — `bun run rebuild` per target. All must pass before Phase 1.
|
|
55
|
+
|
|
56
|
+
## Phases
|
|
57
|
+
|
|
58
|
+
Each phase's Objective column is the goal state per target — the verifiable end state the phase must produce.
|
|
59
|
+
|
|
60
|
+
| # | Phase | Objective | Sub-agent mode |
|
|
61
|
+
|:--|:---|:---|:---|
|
|
62
|
+
| 1a | Validate (conditional) | Each handoff finding field-tested live; valid ones filed as GH issues; invalidated ones reported back with reason. If zero validate, workflow stops | one sub-agent per target |
|
|
63
|
+
| 1b | Fix | Per target: targeted issues fixed in source, tests updated/added, `devcheck` + `rebuild` + `test` green, each fixed issue commented with fix details, working tree dirty for review | parallel fanout (one sub-agent per target — hard constraint) |
|
|
64
|
+
| 2 | Verify | Per target: full diff cold-reviewed; simplified if warranted; each fix re-exercised against the running server with actual tool output in the summary | parallel fanout |
|
|
65
|
+
| 3 | Wrap-up + release | Per target: fixes split into per-file commits with a release commit on top; annotated tag; published per repo visibility; tag annotation is structured markdown with issue backlinks | parallel fanout (Bash git only) |
|
|
66
|
+
| 4 | Issue cleanup | Every GH issue that shipped a fix closed with "Fixed in v\<version\>" comment | orchestrator (serial) |
|
|
67
|
+
|
|
68
|
+
Phase 1a is conditional — only runs when the input is a handoff document or otherwise unvalidated. When the input is already tracked GH issues, skip directly to Phase 1b. The release portion of Phase 3 is conditional on user authorization to ship.
|
|
69
|
+
|
|
70
|
+
## Phase notes
|
|
71
|
+
|
|
72
|
+
### Phase 1a: Validate (handoff input)
|
|
73
|
+
One sub-agent per target. The sub-agent:
|
|
74
|
+
1. Field-tests each handoff claim against the running server (project-specific helpers per the `field-test` skill)
|
|
75
|
+
2. For validated findings, traces the relevant source to confirm shape of fix
|
|
76
|
+
3. Reads `.github/ISSUE_TEMPLATE/` first to understand the repo's issue conventions
|
|
77
|
+
4. Files one GH issue per validated finding using `report-issue-local` patterns
|
|
78
|
+
5. Reports back: validated (with GH issue links and one-line reason), invalidated (with why), and observations not in the original handoff
|
|
79
|
+
|
|
80
|
+
**Noise filter:** every filed issue must pass "Would a maintainer coming to this cold say 'yes, this needs fixing'?"
|
|
81
|
+
|
|
82
|
+
**Do not file against `@cyanheads/mcp-ts-core`** unless the bug is clearly in the framework — file against the server's own repo.
|
|
83
|
+
|
|
84
|
+
**Unique field-test ID** in helper file path: `/tmp/<project>-handoff-<5CHAR>.sh`.
|
|
85
|
+
|
|
86
|
+
If zero findings validate, report to the user and stop the workflow.
|
|
87
|
+
|
|
88
|
+
### Phase 1b: Fix
|
|
89
|
+
**One sub-agent per target — hard constraint** (no file-locking; concurrent edits to the same `src/` conflict).
|
|
90
|
+
|
|
91
|
+
Each sub-agent:
|
|
92
|
+
1. Reads all open issues for its target via `gh issue view N --comments` (full thread — body alone misses clarifications)
|
|
93
|
+
2. **Validates each issue against source code** — the issue's analysis or proposed approach may be wrong; sub-agent applies judgment about the right fix and notes any deviation in its GH comment
|
|
94
|
+
3. Prioritizes: security → crashes → bugs → enhancements → docs/chore
|
|
95
|
+
4. Implements fixes using the best modern approach (the GH issue is input, not a spec)
|
|
96
|
+
5. Updates or adds tests as needed
|
|
97
|
+
6. Exit gate: `bun run devcheck` + `bun run rebuild` + `bun run test` all pass before reporting completion
|
|
98
|
+
7. Comments on each fixed GH issue with a concise fix summary (cite file paths)
|
|
99
|
+
8. Leaves everything uncommitted
|
|
100
|
+
|
|
101
|
+
**Constraints to restate:**
|
|
102
|
+
- Surgical fixes only — don't refactor surrounding code unless the fix requires it
|
|
103
|
+
- If a fix is disproportionate (major architecture change), note it on the issue and skip
|
|
104
|
+
- The exit gate is non-negotiable — do not report completion if any of devcheck/rebuild/test is red
|
|
105
|
+
|
|
106
|
+
### Phase 2: Verify
|
|
107
|
+
Fresh sub-agent per target, reads the full `git diff` cold. Two passes:
|
|
108
|
+
|
|
109
|
+
1. **Code-simplify** — read `code-simplifier`, review the diff through that lens (over-engineering, unnecessary abstractions, redundant guards, style mismatches with surrounding code). Apply cleanup if warranted; skip if changes are minimal — don't run as ceremony.
|
|
110
|
+
2. **Re-field-test** — spin up the server, run the repro steps from each fixed issue, include actual tool call output in the summary. A fix that compiles but wasn't verified against a running server is not done.
|
|
111
|
+
|
|
112
|
+
Exit gate: `bun run devcheck && bun run rebuild && bun run test`.
|
|
113
|
+
|
|
114
|
+
### Phase 3: Wrap-up + release
|
|
115
|
+
Each sub-agent reads BOTH `skills/git-wrapup/SKILL.md` AND `skills/release-and-publish/SKILL.md`.
|
|
116
|
+
|
|
117
|
+
**Orchestrator responsibility:** before spawning Phase 3 sub-agents, collect all open GH issue numbers per target (`gh issue list -R <owner>/<repo> --state open --json number,title`) and include them in each sub-agent's prompt. Phase 3 sub-agents have no context from prior phases — they need the explicit issue list to know what to close.
|
|
118
|
+
|
|
119
|
+
**Commit structure.** Fixes are NOT collapsed into a single commit:
|
|
120
|
+
1. Analyze the diff — understand which fixes touch which files
|
|
121
|
+
2. Group by file boundaries — fixes sharing a file ship in the same commit
|
|
122
|
+
3. Commit each group: `fix(scope): description` (Conventional Commits)
|
|
123
|
+
4. Release commit on top: `chore(release): v<version>` — version bump + changelog + regenerated artifacts
|
|
124
|
+
5. Tag the release commit
|
|
125
|
+
|
|
126
|
+
The tag annotation and changelog cover ALL fixes — the commit split is about git history, not release notes.
|
|
127
|
+
|
|
128
|
+
**Version bump.** Default **patch** for bug-fix releases. **Minor** when enhancements are included.
|
|
129
|
+
|
|
130
|
+
**Wrap-up scope.** Determined by repo visibility:
|
|
131
|
+
|
|
132
|
+
| Status | Scope |
|
|
133
|
+
|:---|:---|
|
|
134
|
+
| Private / in-development | Version bump → changelog → commit → tag → mcpb bundle → push → `gh release create`. Skip `bun publish`, Docker, MCP Registry. |
|
|
135
|
+
| Public / launched | Full `release-and-publish`: push + `bun publish` + `publish-mcp` + bundle + GH release + Docker (if Dockerfile). |
|
|
136
|
+
|
|
137
|
+
**Tag annotations** are for end users — internal dev cleanup (lockfile refreshes, linter fixes, build config) belongs in commit bodies, not the tag annotation.
|
|
138
|
+
|
|
139
|
+
### Phase 4: Issue cleanup
|
|
140
|
+
Close issues that shipped fixes — only those. Skipped issues stay open.
|
|
141
|
+
|
|
142
|
+
```bash
|
|
143
|
+
for n in <fixed-issue-numbers>; do
|
|
144
|
+
gh issue close "$n" -R "<owner>/<repo>" --reason completed --comment "Fixed in v<version>."
|
|
145
|
+
done
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
## Workflow-specific gotchas
|
|
149
|
+
|
|
150
|
+
| # | Gotcha | Mitigation |
|
|
151
|
+
|:--|:-------|:-----------|
|
|
152
|
+
| 1 | Multiple fix sub-agents editing the same server's `src/` | Hard constraint: 1 sub-agent per server in Phase 1b |
|
|
153
|
+
| 2 | Fix sub-agent "fixed" an issue but the change is a band-aid | Orchestrator gate after Phase 1b reviews approach, not just "does it compile" |
|
|
154
|
+
| 3 | Fix sub-agent doesn't update tests for schema changes | Exit gate requires tests pass; sub-agent must update/add tests before finishing |
|
|
155
|
+
| 4 | Field-test in Phase 2 fails but sub-agent reports success | Sub-agent must include actual tool call output in summary; orchestrator spot-checks |
|
|
156
|
+
| 5 | Code-simplify removes intentional complexity | Orchestrator gate after Phase 2 reviews the full diff |
|
|
157
|
+
| 6 | Wrap-up sub-agent collapses multi-fix diff into one commit | Phase 3 prompt enumerates the commit structure |
|
|
158
|
+
| 7 | Wrap-up sub-agent makes unplanned intermediate commits outside the planned structure | Prompt defines exact commit shape; agents must not invent extras |
|
|
159
|
+
| 8 | Reading `gh issue view N` alone misses thread context where decisions were updated | Always include `--comments` |
|
|
160
|
+
| 9 | MCP Registry returns 502 transiently during publish | Retry up to 2x with backoff |
|
|
161
|
+
| 10 | Phase 1a sub-agent validates an issue that's actually a misunderstanding | Sub-agent must field-test, not just read the claim — live verification catches false positives |
|
|
162
|
+
|
|
163
|
+
## Checklist
|
|
164
|
+
|
|
165
|
+
- [ ] Pre-flight: issues identified per target (or handoff captured), working trees clean, builds pass
|
|
166
|
+
- [ ] Phase 1a (if handoff): findings validated live, GH issues filed for valid findings, invalidated reported back
|
|
167
|
+
- [ ] Phase 1b: fix sub-agents complete — fixes implemented, tests updated, GH issues commented, exit gate green
|
|
168
|
+
- [ ] Orchestrator gate after Phase 1b: diffs reviewed, devcheck + tests green
|
|
169
|
+
- [ ] Phase 2: verify sub-agents complete — code-simplify (if applicable), re-field-test with actual outputs in summary
|
|
170
|
+
- [ ] Orchestrator gate after Phase 2: simplified diff reviewed, field-test claims verified
|
|
171
|
+
- [ ] Phase 3: version bumped, fix commits + release commit, annotated tag per target — scope matches private/public status
|
|
172
|
+
- [ ] Phase 3: published per scope (push, npm if public, MCP Registry if applicable, GH release, Docker if applicable)
|
|
173
|
+
- [ ] Phase 4: fixed issues closed; skipped issues remain open
|
|
174
|
+
- [ ] Post-workflow verification: `git ls-remote --tags origin`, `npm view <pkg>@<version>` if public, GH release artifacts attached
|
|
175
|
+
- [ ] Tag/release quality review: tag subject omits version number, structured markdown, no marketing adjectives, issue backlinks present
|
|
@@ -0,0 +1,143 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: greenfield-build
|
|
3
|
+
description: >
|
|
4
|
+
Workflow: scaffold one or more new MCP server projects from `bunx @cyanheads/mcp-ts-core init` through design → build → polish → first public release. Each phase invokes a foundational skill end-to-end; this file is the sequencing and gates, not the procedural detail. Read `../SKILL.md` first for the universal rules and sub-agent strategy.
|
|
5
|
+
metadata:
|
|
6
|
+
author: cyanheads
|
|
7
|
+
version: "1.0"
|
|
8
|
+
audience: internal
|
|
9
|
+
type: workflow
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
# Greenfield Build Workflow
|
|
13
|
+
|
|
14
|
+
Use after reading `../SKILL.md`. Drives one or more freshly-scaffolded MCP servers from idea to first public release by sequencing foundational skills with gates and verification.
|
|
15
|
+
|
|
16
|
+
## When applicable
|
|
17
|
+
|
|
18
|
+
- One or more new servers from `bunx @cyanheads/mcp-ts-core init <name>` need to be driven through design → build → ship
|
|
19
|
+
- Each target is a freshly-scaffolded project with no implementation yet (echo definitions still present)
|
|
20
|
+
- N = 1 and N > 1 both apply — parallelism is the optimization; the phase structure is the value
|
|
21
|
+
|
|
22
|
+
## Pre-flight
|
|
23
|
+
|
|
24
|
+
1. **Target list** — absolute paths and intended GitHub owner/org per target
|
|
25
|
+
2. **`gh auth status`** — Phase 1 creates GH repos
|
|
26
|
+
3. **`npm whoami`** — required if Phase 18 publishes publicly
|
|
27
|
+
4. **API key inventory** per target — Phase 11 (field-test loop) skips targets without keys
|
|
28
|
+
5. **Gold-standard reference(s)** — repo(s) the `polish-docs-meta` phase anchors on for README/metadata style. Skip the phase if no anchor exists in the ecosystem.
|
|
29
|
+
|
|
30
|
+
## Versioning strategy
|
|
31
|
+
|
|
32
|
+
Everything stays at **v0.1.0** through the build. Intermediate commits don't bump versions. The launch version (typically v0.1.1) is set in Phase 17.
|
|
33
|
+
|
|
34
|
+
## Tier 1 skills referenced
|
|
35
|
+
|
|
36
|
+
| Phase | Tier 1 skill(s) |
|
|
37
|
+
|:---|:---|
|
|
38
|
+
| Scaffold (1) | `skills/setup/SKILL.md` |
|
|
39
|
+
| Initial commit, design commit, build commit, pre-launch commit (2, 5, 10, 16) | `skills/git-wrapup/SKILL.md` (commit + tag, no push) |
|
|
40
|
+
| Design + validation (3, 4) | `skills/design-mcp-server/SKILL.md` |
|
|
41
|
+
| Build (6) | `skills/add-tool/SKILL.md`, `skills/add-app-tool/SKILL.md`, `skills/add-resource/SKILL.md`, `skills/add-prompt/SKILL.md`, `skills/add-service/SKILL.md` |
|
|
42
|
+
| Tool-def audit (7) | `skills/tool-defs-analysis/SKILL.md` |
|
|
43
|
+
| Test coverage (8) | `skills/add-test/SKILL.md` |
|
|
44
|
+
| Field-test loop (11) | → `workflows/field-test-fix.md` as a sub-loop (see Phase 11 note) |
|
|
45
|
+
| Simplify (12) | `skills/code-simplifier/SKILL.md` |
|
|
46
|
+
| Polish docs/meta (13) | `skills/polish-docs-meta/SKILL.md` |
|
|
47
|
+
| Security pass (14) | `skills/security-pass/SKILL.md` |
|
|
48
|
+
| Final wrap-up (17) | `skills/git-wrapup/SKILL.md` |
|
|
49
|
+
| Release (18) | `skills/release-and-publish/SKILL.md` |
|
|
50
|
+
|
|
51
|
+
## Phases
|
|
52
|
+
|
|
53
|
+
Each phase's Objective column is the goal state per target — the verifiable end state the phase must produce. Phase notes only appear for orchestration overrides; phases without notes run the foundational skill end-to-end.
|
|
54
|
+
|
|
55
|
+
| # | Phase | Objective | Sub-agent mode |
|
|
56
|
+
|:--|:---|:---|:---|
|
|
57
|
+
| 1 | Scaffold + repo | `bunx init` scaffold complete; `--private` GH repo created; LICENSE in place; working tree dirty (no commit) | parallel fanout |
|
|
58
|
+
| 2 | Initial commit | v0.1.0 commit + annotated tag + push to private GH repo | parallel fanout |
|
|
59
|
+
| 3 | Design | `docs/design.md` authored with Decisions Log | parallel fanout |
|
|
60
|
+
| 4 | Design validation | `docs/design.md` hardened by review pass; gate sub-agent returned PASS | two sub-agents per target |
|
|
61
|
+
| 5 | Design commit | Design changes committed and pushed | parallel fanout |
|
|
62
|
+
| 6 | Build | All designed tools/resources/prompts implemented; no echo definitions; `devcheck` + `test` green | parallel fanout |
|
|
63
|
+
| 7 | Tool-def audit | `tool-defs-analysis` findings reviewed and applied | parallel fanout |
|
|
64
|
+
| 8 | Test coverage | Tests extended beyond happy path; `devcheck` + `test` green | parallel fanout |
|
|
65
|
+
| 9 | Design ↔ implementation check | Every surface element in `docs/design.md` has a definition (or `docs/design.md` updated to reflect what shipped) | parallel fanout or orchestrator-direct |
|
|
66
|
+
| 10 | Build commit | Build work committed and pushed | parallel fanout |
|
|
67
|
+
| 11 | Field-test loop (optional) | Live API surface exercised; valid findings filed and fixed (or skipped with note) | conditional |
|
|
68
|
+
| 12 | Simplify | `code-simplifier` applied; `devcheck` + `test` green — last source-code modification | parallel fanout |
|
|
69
|
+
| 13 | Polish docs/meta | README, metadata, and agent protocol aligned to gold-standard reference | parallel fanout |
|
|
70
|
+
| 14 | Security pass | `security-pass` findings addressed; no open security gaps | parallel fanout |
|
|
71
|
+
| 15 | Final-state check | `rebuild` + `devcheck` + `test:all` + `lint:packaging` green; LICENSE present; no unfinished TODO/FIXME | orchestrator-direct |
|
|
72
|
+
| 16 | Pre-launch commit | Final polish + security work committed and pushed | parallel fanout |
|
|
73
|
+
| 17 | Final wrap-up | Launch version (typically v0.1.1) commit + annotated tag in place; **not pushed** | parallel fanout (Bash git only) |
|
|
74
|
+
| 18 | Release | Pushed and published per scope; tag annotation renders as structured markdown on GitHub Release; artifacts reachable | parallel fanout or serial (per npm 2FA mode) |
|
|
75
|
+
|
|
76
|
+
Phase 11 is optional. Phase 12 is the last phase that modifies source code — everything after is docs/metadata/verification.
|
|
77
|
+
|
|
78
|
+
## Phase notes
|
|
79
|
+
|
|
80
|
+
Only phases with orchestration overrides or non-obvious instructions appear below. Other phases run their foundational skill end-to-end.
|
|
81
|
+
|
|
82
|
+
### Phase 1: Scaffold + repo
|
|
83
|
+
Sub-agent runs `bunx @cyanheads/mcp-ts-core init <name>`, follows the `setup` skill, then creates a **private** GitHub repo (`gh repo create --private`). Override the `setup` skill's commit step — **do NOT commit**; Phase 2 is the commit. Copy `LICENSE` from `node_modules/@cyanheads/mcp-ts-core/LICENSE` if not already present.
|
|
84
|
+
|
|
85
|
+
### Phase 2: Initial commit
|
|
86
|
+
Sub-agent verifies `gh repo view --json visibility` returns `PRIVATE` (or has explicit user authorization for public) before push. Tag is `v0.1.0`.
|
|
87
|
+
|
|
88
|
+
### Phase 4: Design validation
|
|
89
|
+
Two sub-agents per target, sequential:
|
|
90
|
+
|
|
91
|
+
1. **Review** — fresh sub-agent re-runs `design-mcp-server` against the existing `docs/design.md` cold (no `docs/idea.md`, no prior context). Goal: spot what the original author justified away. Output: hardened `docs/design.md`.
|
|
92
|
+
2. **Gate** — sub-agent reads ONLY the hardened design and returns **PASS** or **FAIL**. PASS means "ready to build as-is." FAIL flags structural issues that would cause wasted build effort: missing tool the API clearly supports and users would expect; wrong endpoint or data model that would fail at runtime; contradictory constraints; missing error handling strategy for common failures. **Filter style preferences and marginal scope suggestions** — those are not gate failures.
|
|
93
|
+
|
|
94
|
+
If gate fails, spawn a focused fix sub-agent for that target, then re-gate.
|
|
95
|
+
|
|
96
|
+
### Phase 6: Build
|
|
97
|
+
Sub-agents will exhaust context on targets with 4+ tools — work persists to disk but the sub-agent can't continue. Plan a follow-up "finish" iteration as a normal backstop, not a fallback for failure. After Phase 6 lands, the orchestrator inspects each target (`bun run devcheck`, `bun run test`, `ls src/mcp-server/tools/definitions/`) and spawns a narrow-scope finish sub-agent per incomplete target with a concrete punch list: "X TS errors here, tools A/B/C missing tests, echo definitions still present in `<file>`." Narrow scope is the antidote to context exhaustion.
|
|
98
|
+
|
|
99
|
+
### Phase 9: Design ↔ implementation check
|
|
100
|
+
For each tool / resource / prompt named in `docs/design.md`, verify a definition file exists in `src/mcp-server/{tools,resources,prompts}/definitions/`. For missing surface, decide: implement it (spawn a narrow-scope sub-agent), drop it from the design (update `docs/design.md`), or defer to a follow-up (record in the Decisions Log). This is orchestration glue — small enough that the orchestrator can run it directly for N ≤ 3, fan out for larger N.
|
|
101
|
+
|
|
102
|
+
### Phase 11: Field-test loop (optional)
|
|
103
|
+
When the upstream API supports live testing and an API key is available, run the phases of `field-test-fix.md` as a sub-loop here, ending at its field-test commit. Skip with a note if blocked.
|
|
104
|
+
|
|
105
|
+
### Phase 12: Simplify
|
|
106
|
+
Last phase that modifies source code. Everything after is docs/metadata/verification.
|
|
107
|
+
|
|
108
|
+
### Phase 15: Final-state check
|
|
109
|
+
Orchestrator-direct mechanical verification per target: `bun run rebuild`, `bun run devcheck`, `bun run test:all` (or `test`), `bun run lint:packaging`. `LICENSE` present. No `TODO`/`FIXME` indicating unfinished work. `CHANGELOG.md` current. `docs/tree.md` reflects current structure. Fix anything red before Phase 16; this is verification, not a sub-agent task.
|
|
110
|
+
|
|
111
|
+
### Phase 17: Final wrap-up
|
|
112
|
+
Version bump intent is typically **patch** — v0.1.0 was the scaffold tag; the launch is the first real release at v0.1.1. Bash git only; **do not push** — Phase 18 owns the push.
|
|
113
|
+
|
|
114
|
+
## Workflow-specific gotchas
|
|
115
|
+
|
|
116
|
+
| # | Gotcha | Mitigation |
|
|
117
|
+
|:--|:-------|:-----------|
|
|
118
|
+
| 1 | `gh repo create` defaults to public if `--private` is omitted | Phase 1 prompt restates the rule; Phase 2 sub-agent re-verifies `gh repo view --json visibility` before push |
|
|
119
|
+
| 2 | Build sub-agents exhaust context on targets with 4+ tools | Expected — plan a finish iteration with a concrete punch list, narrow scope |
|
|
120
|
+
| 3 | Design gate sub-agents flag style preferences as failures | Gate prompt: "Do NOT flag style preferences or marginal scope suggestions — only structural issues that would cause wasted build effort" |
|
|
121
|
+
| 4 | Sub-agent commits during Phase 1 despite the orchestration override | Phase 1 prompt restates: "Do NOT commit — leave working tree dirty for Phase 2" verbatim |
|
|
122
|
+
|
|
123
|
+
## Checklist
|
|
124
|
+
|
|
125
|
+
- [ ] Pre-flight: targets confirmed, `gh` + `npm` auth verified, gold-standard reference(s) named, API key inventory complete
|
|
126
|
+
- [ ] Phase 1: scaffold + setup run, private repo created, LICENSE present, working tree dirty (no commits)
|
|
127
|
+
- [ ] Phase 2: v0.1.0 commit + annotated tag + push verified per target
|
|
128
|
+
- [ ] Phase 3: `docs/design.md` authored per target with Decisions Log
|
|
129
|
+
- [ ] Phase 4: design hardened by review pass; gate returns PASS per target
|
|
130
|
+
- [ ] Phase 5: design committed per target
|
|
131
|
+
- [ ] Phase 6: build complete — all designed surface implemented, green devcheck + test
|
|
132
|
+
- [ ] Phase 7: `tool-defs-analysis` audit + fixes applied
|
|
133
|
+
- [ ] Phase 8: dedicated test coverage pass — beyond happy path
|
|
134
|
+
- [ ] Phase 9: every designed surface element has a definition (or `docs/design.md` updated to reflect what shipped)
|
|
135
|
+
- [ ] Phase 10: build committed per target
|
|
136
|
+
- [ ] Phase 11 (optional): field-test loop completed or skipped with note
|
|
137
|
+
- [ ] Phase 12: code-simplifier — final source-code cleanup, green devcheck + test
|
|
138
|
+
- [ ] Phase 13: polish-docs-meta against named gold-standard
|
|
139
|
+
- [ ] Phase 14: security-pass complete, findings addressed
|
|
140
|
+
- [ ] Phase 15: final-state check — rebuild + devcheck + test:all + lint:packaging green; LICENSE; no TODO/FIXME
|
|
141
|
+
- [ ] Phase 16: pre-launch commit per target
|
|
142
|
+
- [ ] Phase 17: final wrap-up — version bumped, changelog authored, commit + annotated tag per target
|
|
143
|
+
- [ ] Phase 18: release — published per scope, artifacts verified reachable
|
|
@@ -0,0 +1,173 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: maintenance-release
|
|
3
|
+
description: >
|
|
4
|
+
Workflow: run the `maintenance` skill against one or more existing MCP server projects (dependency updates, framework adoption, skill sync), verify adoption gaps in a double-check pass, then wrap up and release via `git-wrapup` and `release-and-publish`. Read `../SKILL.md` first for the universal rules and sub-agent strategy.
|
|
5
|
+
metadata:
|
|
6
|
+
author: cyanheads
|
|
7
|
+
version: "1.1"
|
|
8
|
+
audience: internal
|
|
9
|
+
type: workflow
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
# Maintenance + Release Workflow
|
|
13
|
+
|
|
14
|
+
Use after reading `../SKILL.md`. Drives maintenance, adoption verification, wrap-up, and release across N existing MCP server projects.
|
|
15
|
+
|
|
16
|
+
## When applicable
|
|
17
|
+
|
|
18
|
+
- One or more existing servers built on `@cyanheads/mcp-ts-core` need updates from `bun outdated` landed and shipped
|
|
19
|
+
- N = 1 still benefits — fresh-context sub-agents per phase keep each focused and within context budget
|
|
20
|
+
- Each target should have a clean working tree before the workflow starts — uncommitted work blocks the `maintenance` skill's verification gate
|
|
21
|
+
|
|
22
|
+
**Scope boundary.** This workflow ships dependency, framework-adoption, and skill-sync upkeep — it does not consult, fix, or close issues in the tracker. Issue-driven work belongs to `fix-wrapup-release.md`. If a maintenance pass incidentally surfaces a genuine bug, file it (don't fix it here) and let a later `fix-wrapup-release` run address it.
|
|
23
|
+
|
|
24
|
+
## Tier 1 skills referenced
|
|
25
|
+
|
|
26
|
+
| Phase | Tier 1 skill(s) |
|
|
27
|
+
|:---|:---|
|
|
28
|
+
| Maintenance | `skills/maintenance/SKILL.md` |
|
|
29
|
+
| Double-check | `skills/polish-docs-meta/SKILL.md` (the cross-file consistency reference is the most commonly missed surface) |
|
|
30
|
+
| Wrap-up | `skills/git-wrapup/SKILL.md` |
|
|
31
|
+
| Release | `skills/release-and-publish/SKILL.md` |
|
|
32
|
+
|
|
33
|
+
## Pre-flight
|
|
34
|
+
|
|
35
|
+
Per target:
|
|
36
|
+
|
|
37
|
+
1. **Clean working tree** — `git status --short` must be empty. Halt if dirty; user fixes locally before re-invoking.
|
|
38
|
+
2. **Latest tag and version** — `git describe --tags --abbrev=0`, `grep '"version"' package.json`
|
|
39
|
+
3. **`list-skills` script presence** — `test -f scripts/list-skills.ts && grep -q '"list-skills"' package.json`. If missing, note it — the `maintenance` skill's Phase C will install it.
|
|
40
|
+
4. **`publish-mcp` script** — when `server.json` exists, check `grep -q '"publish-mcp"' package.json`. If missing, flag it — the maintenance sub-agent adds it.
|
|
41
|
+
5. **Publish destinations** — note which exist: `server.json` (MCP Registry), `manifest.json` (MCPB / GH Release), `Dockerfile` (GHCR). If `server.json` exists but `manifest.json` doesn't, flag — maintenance scaffolds it.
|
|
42
|
+
6. **`npm whoami`** — required if releasing publicly.
|
|
43
|
+
7. **Framework version delta** — `grep '"version"' node_modules/@cyanheads/mcp-ts-core/package.json` vs `npm view @cyanheads/mcp-ts-core version` to preview adoption scope.
|
|
44
|
+
|
|
45
|
+
## Phases
|
|
46
|
+
|
|
47
|
+
Each phase's Objective column is the goal state per target — the verifiable end state the phase must produce.
|
|
48
|
+
|
|
49
|
+
| # | Phase | Objective | Sub-agent mode |
|
|
50
|
+
|:--|:---|:---|:---|
|
|
51
|
+
| 1 | Maintenance | Per target: deps updated, framework adoption applied, project skills synced, `rebuild` + `devcheck` + `test` green, Step 8 numbered summary returned | parallel fanout |
|
|
52
|
+
| 2 | Double-check | Adoption gaps from Phase 1 fixed; `manifest.json`/`server.json` content validated; audience compliance verified; `rebuild` + `devcheck` + `test` green | parallel fanout |
|
|
53
|
+
| 3 | Roll-up | Per-target headlines + cross-target patterns surfaced to user; version-bump intent confirmed (patch/minor/major) | orchestrator (serial) |
|
|
54
|
+
| 4 | Wrap-up + release | Per target: version-bumped commit + annotated tag + push + publish per scope; tag annotation renders as structured markdown on GitHub Release | parallel fanout (Bash git only) |
|
|
55
|
+
|
|
56
|
+
Phase 4 combines wrap-up and release in one sub-agent because the work is sequential and shares context (version, changelog, tag annotation). The sub-agent reads both Tier 1 skills.
|
|
57
|
+
|
|
58
|
+
## Phase notes
|
|
59
|
+
|
|
60
|
+
### Phase 1: Maintenance
|
|
61
|
+
Each sub-agent runs `skills/maintenance/SKILL.md` Mode A — the full flow from `bun outdated` through verification.
|
|
62
|
+
|
|
63
|
+
**Prompt phrasing matters.** Generic "run the maintenance skill" prompts cause sub-agents to stop at changelog analysis without executing. Include explicit steps in the prompt body:
|
|
64
|
+
1. `bun outdated` — capture the list
|
|
65
|
+
2. `bun update --latest` — apply, capturing the `↑ package old → new` lines for Step 3
|
|
66
|
+
3. Invoke the `changelog` skill for each updated package (or read `node_modules/<pkg>/CHANGELOG.md` directly if the skill isn't synced yet)
|
|
67
|
+
4. If `@cyanheads/mcp-ts-core` updated, do the deeper framework review per the maintenance skill's Step 4
|
|
68
|
+
5. Run Step 5 skill/script sync — Phase A (package → project `skills/`), Phase B (project `skills/` → agent dirs), Phase C (package scripts + pristine references → project)
|
|
69
|
+
6. Adopt changes per Step 6 — framework changes are auto-adopt at every applicable site in this pass; third-party libs are cost/benefit
|
|
70
|
+
7. `bun run rebuild` → `bun run devcheck` → `bun run test`
|
|
71
|
+
8. Produce the Step 8 numbered summary
|
|
72
|
+
|
|
73
|
+
**Skill-version paradox.** If `node_modules/@cyanheads/mcp-ts-core/skills/maintenance/SKILL.md` version is newer than the synced project copy, feature-adoption rows added in the new version don't surface. Sub-agent prompt instructs: after Phase A sync completes, re-read the synced `maintenance` SKILL.md and continue from Step 5 with the new version.
|
|
74
|
+
|
|
75
|
+
**Skill audience compliance.** Only sync skills with `metadata.audience: external` into project `skills/`. Sub-agents miss this under context pressure — restate explicitly.
|
|
76
|
+
|
|
77
|
+
**Constraints to restate verbatim:**
|
|
78
|
+
- No commits, tags, pushes — leave working tree dirty for orchestrator review
|
|
79
|
+
- Read-only git allowed and expected — `git diff skills/` after Phase A surfaces adoption signal
|
|
80
|
+
- Halt and report verbatim if `bun run devcheck` can't be made green; `bun audit` failures from a transitive dep with no patch are note-not-halt
|
|
81
|
+
- Output the Step 8 numbered summary at the end — the orchestrator parses it
|
|
82
|
+
|
|
83
|
+
### Phase 2: Double-check
|
|
84
|
+
Independent maintenance sub-agents diverge on incidental choices and miss adoption sites under context pressure. The double-check pass catches gaps before wrap-up.
|
|
85
|
+
|
|
86
|
+
**Critical: these sub-agents audit AND fix, then re-verify.** Not analysis-only.
|
|
87
|
+
|
|
88
|
+
Audit categories (sub-agent prompt enumerates):
|
|
89
|
+
|
|
90
|
+
- **Adoption gaps** — features the updated skills say to do that weren't applied (error code semantic audit, missing scaffolding files like `manifest.json`/`.mcpbignore`, `publish-mcp` script)
|
|
91
|
+
- **Audience compliance** — only skills with `metadata.audience: external` belong in project `skills/`; agents sometimes sync `internal`-audience skills
|
|
92
|
+
- **Content accuracy** — `isRequired` flags in `server.json` match the upstream API's reality (does the API work without the key?); `manifest.json` `name` doesn't include the npm scope prefix; `user_config` entries have required `title` and `type` fields
|
|
93
|
+
- **Cross-target consistency** — if a feature shows up in 3 of 5 Phase 1 summaries, the other 2 likely missed it
|
|
94
|
+
- **Error code semantics** — `InvalidParams` only for malformed JSON-RPC params shape; `ValidationError` for domain validation; `NotFound` for missing entities
|
|
95
|
+
- **Description alignment** — `package.json`, `manifest.json`, `server.json` (≤100 char), README header, GH repo description should be consistent
|
|
96
|
+
- **README install badges** — Claude Desktop `.mcpb`, Cursor deeplink, VS Code deeplink — present when `manifest.json` exists
|
|
97
|
+
|
|
98
|
+
Exit gate: `bun run rebuild && bun run devcheck && bun run test` after fixes.
|
|
99
|
+
|
|
100
|
+
A lighter model (e.g. Sonnet-class) is appropriate here — verification + targeted fixes, not deep adoption work.
|
|
101
|
+
|
|
102
|
+
### Phase 3: Roll-up
|
|
103
|
+
The orchestrator collects Phase 1 + Phase 2 reports and produces:
|
|
104
|
+
1. **Per-target headlines** — short table: target → packages updated → mcp-ts-core delta → devcheck/test status → gaps fixed
|
|
105
|
+
2. **Cross-target patterns** — features adopted across multiple targets, breaking changes that hit a subset
|
|
106
|
+
3. **Open decisions** — per-target ambiguities; group by decision so the user can rule once across multiple targets when the choice is the same
|
|
107
|
+
4. **Outliers** — targets with unusually large diffs or where adoption couldn't complete cleanly
|
|
108
|
+
|
|
109
|
+
**Version bump intent.** Default is **patch** unless the change shape indicates otherwise:
|
|
110
|
+
|
|
111
|
+
| Bump | When |
|
|
112
|
+
|:---|:---|
|
|
113
|
+
| **patch** (default) | Dependency updates, framework adoption, doc polish, bug fixes — ~95% of maintenance runs |
|
|
114
|
+
| **minor** | New tools/resources/prompts added, new user-facing features, new env vars that change behavior |
|
|
115
|
+
| **major** | Breaking changes to the server's MCP surface (removed tools, renamed fields, changed semantics) |
|
|
116
|
+
|
|
117
|
+
If a target's diff suggests minor-or-above, **pause that target and surface to the user during roll-up** — unaffected targets proceed to Phase 4 at patch.
|
|
118
|
+
|
|
119
|
+
### Phase 4: Wrap-up + release
|
|
120
|
+
Each sub-agent reads BOTH `skills/git-wrapup/SKILL.md` AND `skills/release-and-publish/SKILL.md`. Runs wrap-up (version bump, changelog authoring, commit, annotated tag), then release (push, npm publish, MCP Registry, GH release, Docker).
|
|
121
|
+
|
|
122
|
+
**Framework changelog reading.** When `mcp-ts-core` was updated, the sub-agent must read the framework's changelog files for the version delta (e.g. `node_modules/@cyanheads/mcp-ts-core/changelog/0.9.x/0.9.2.md` through `0.9.6.md`) and distill user-facing changes relevant to this server into the changelog entry and tag annotation. "Picks up upstream fixes" is not acceptable — name what changed.
|
|
123
|
+
|
|
124
|
+
**Wrap-up scope.** Determined by repo visibility (`gh repo view --json visibility`):
|
|
125
|
+
|
|
126
|
+
| Status | Scope |
|
|
127
|
+
|:---|:---|
|
|
128
|
+
| Private / in-development | Version bump → changelog → commit → tag → mcpb bundle → push → `gh release create`. Skip `bun publish`, Docker, MCP Registry. |
|
|
129
|
+
| Public / launched | Full `release-and-publish`: push + `bun publish` + `publish-mcp` + bundle + GH release + Docker (if Dockerfile). |
|
|
130
|
+
|
|
131
|
+
**npm 2FA mode.** Parallel `bun publish` doesn't play nicely with interactive 2FA — OTP prompts from multiple sub-agents interleave. Either:
|
|
132
|
+
- Bypass token configured (granular access token with "Bypass 2FA for publish") → Phase 4 runs as parallel fanout
|
|
133
|
+
- No bypass → Phase 4 runs serially, orchestrator-driven, one target at a time
|
|
134
|
+
- No npm publish involved (private only) → non-issue
|
|
135
|
+
|
|
136
|
+
**Commit structure.** Version bump rides with the change that warrants it. For a maintenance pass with a single cohesive change shape (e.g. just dep updates, or just one framework adoption), that's **one commit** — subject can lead with the version (e.g. `feat: 0.5.2 — adopt new error factories, framework ^0.9.6`). For a maintenance pass containing multiple distinct concerns, split into per-concern commits with the version bump folded into the headline-change commit, not a separate ceremonial release commit.
|
|
137
|
+
|
|
138
|
+
**Tag annotations are for end users.** Internal dev cleanup (lockfile refreshes, linter fixes, build config) belongs in the commit body, not the tag annotation.
|
|
139
|
+
|
|
140
|
+
**Tag-moving protocol.** If post-version doc changes land after the version commit, move the tag to HEAD: delete remote release, delete remote + local tag, recreate tag at new HEAD with same annotation, re-push, recreate release with `.mcpb`. Authorized within the workflow — same-day forward move.
|
|
141
|
+
|
|
142
|
+
### Watchtower-style container refresh (if applicable)
|
|
143
|
+
For targets with hosted instances behind an auto-pull tool, trigger the refresh after GHCR images are verified reachable. This is operational, not part of the release-and-publish skill — handle in the orchestrator's post-Phase-4 step if the deployment infrastructure has it.
|
|
144
|
+
|
|
145
|
+
## Workflow-specific gotchas
|
|
146
|
+
|
|
147
|
+
| # | Gotcha | Mitigation |
|
|
148
|
+
|:--|:-------|:-----------|
|
|
149
|
+
| 1 | Generic "run the maintenance skill" prompts cause ~50% of sub-agents to halt at changelog analysis without executing | Include explicit execution steps in Phase 1 prompt body; respawn with directive if Step 8 summary missing |
|
|
150
|
+
| 2 | Skill-version paradox — feature rows added in newer maintenance skill don't surface in the synced older copy | Sub-agent prompt: after Phase A sync, re-read synced `maintenance` SKILL.md and continue from Step 5 |
|
|
151
|
+
| 3 | Per-target adoption divergence is expected — projects on different starting framework versions adopt different things | Don't try to normalize. Surface divergence as informational in Phase 3 roll-up. |
|
|
152
|
+
| 4 | The `changelog` skill may not exist in a target's skill directory yet | Sub-agent falls back to direct `node_modules/<pkg>/CHANGELOG.md` reading |
|
|
153
|
+
| 5 | Sub-agent runs write git commands despite instruction | Restate the no-write-git list + no-`stash` rule in prompt body; verify via `git log --oneline -1` per target after Phase 1 — should show no new commits |
|
|
154
|
+
| 6 | Sub-agent syncs `internal`-audience skills into project `skills/` | Restate "Only sync skills with `metadata.audience: external`" — sub-agents miss this under context pressure |
|
|
155
|
+
| 7 | `manifest.json` scaffolded with scoped name from `package.json` (e.g. `@scope/server-name`) — renders in mcpb install dialog | Phase 2 verifies `manifest.json` `name` doesn't contain `/` |
|
|
156
|
+
| 8 | `manifest.json` `user_config` entries missing required `title`/`type` — `mcpb pack` fails at release time | Phase 2 verifies required fields |
|
|
157
|
+
| 9 | `server.json` `isRequired` doesn't match upstream API reality | Phase 2 verifies against actual API behavior |
|
|
158
|
+
| 10 | Framework version arrow in tag/changelog says nothing useful ("picks up upstream fixes") | Phase 4 prompt requires reading mcp-ts-core changelog files and distilling relevant changes |
|
|
159
|
+
| 11 | Tag annotations render as flat comma-separated strings or balloon into full CHANGELOG copies | Phase 4 prompt: structured markdown with sections (Fixed, Dependencies, etc.), dep arrows (`pkg ^old → ^new`), test footer; length is earned |
|
|
160
|
+
| 12 | Post-version doc changes land after the tag — release points at stale content | Tag-moving protocol; authorized within the workflow as a same-day forward move |
|
|
161
|
+
| 13 | Background sub-agent bails early on context | Orchestrator checks for Step 8 summary; respawns continuation sub-agent if missing |
|
|
162
|
+
| 14 | Big monorepo or many adoptions cause context exhaustion in a sub-agent | Narrow the prompt: if a target has many breaking framework changes, split the work into "update deps + verify" and "adopt features" against that target |
|
|
163
|
+
|
|
164
|
+
## Checklist
|
|
165
|
+
|
|
166
|
+
- [ ] Pre-flight: target list confirmed, clean working trees, `list-skills`/`publish-mcp`/`manifest.json` presence noted, framework version delta noted, npm 2FA mode confirmed if releasing publicly
|
|
167
|
+
- [ ] Phase 1: maintenance sub-agents complete — Step 8 summary present per target, devcheck + test green
|
|
168
|
+
- [ ] Phase 1 integrity: `git log --oneline -1` per target confirms no new commits written by sub-agents
|
|
169
|
+
- [ ] Phase 2: double-check sub-agents complete — adoption gaps fixed, audience compliance verified, `manifest.json` and `server.json` validated; devcheck + test green after fixes
|
|
170
|
+
- [ ] Phase 3: roll-up surfaced to user; version bump intent confirmed (patch default; minor/major surfaces if applicable)
|
|
171
|
+
- [ ] Phase 4: wrap-up + release sub-agents complete — commit + annotated tag + push + publish per target, scope matches private/public status
|
|
172
|
+
- [ ] Post-Phase-4 verification: `git ls-remote --tags origin` shows new tag; `npm view <pkg>@<version>` resolves (public); GH release artifacts attached; Docker image exists (if Dockerfile)
|
|
173
|
+
- [ ] Tag/release quality review: tag subject omits version number, structured markdown, no marketing adjectives, dep arrows present, issue backlinks where applicable
|
|
@@ -4,7 +4,7 @@ description: >
|
|
|
4
4
|
Finalize documentation and project metadata for a ship-ready MCP server. Use after implementation is complete, tests pass, and devcheck is clean. Safe to run at any stage — each step checks current state and only acts on what still needs work.
|
|
5
5
|
metadata:
|
|
6
6
|
author: cyanheads
|
|
7
|
-
version: "2.
|
|
7
|
+
version: "2.3"
|
|
8
8
|
audience: external
|
|
9
9
|
type: workflow
|
|
10
10
|
---
|
|
@@ -202,6 +202,7 @@ If the project ships as an `.mcpb` bundle for Claude Desktop (check for `manifes
|
|
|
202
202
|
- Env var names in `manifest.json` (`mcp_config.env` + `user_config`) match `server.json` `environmentVariables` — `lint:packaging` enforces this, but verify the set is complete
|
|
203
203
|
- `manifest.json` `name` matches `package.json` name **without the npm scope prefix** (e.g. `bls-mcp-server`, not `@cyanheads/bls-mcp-server`); `description` matches `package.json`
|
|
204
204
|
- `manifest.json` `user_config` entries must include `title` and `type` fields — `mcpb pack` validates these
|
|
205
|
+
- For each `user_config` entry referenced as `${user_config.X}` in `mcp_config.env`: if it's not `required: true`, set `"default": ""`. MCPB hosts (Claude Desktop included) pass the literal placeholder string through to the process when an optional field is left blank without a default — strict consumer validators (`z.email()`, `z.url()`, `.regex()`) then crash at lazy config load, exiting silently after `initialize`. Server-side: pair every optional env-backed strict-validator field with a `z.preprocess` that strips `${...}` placeholders to `undefined`.
|
|
205
206
|
- `server.json` env var `isRequired` must match the upstream API's actual requirement — if the API works without the value (rate-limited, DEMO_KEY fallback, polite pool), mark `isRequired: false` and describe the tradeoff in the description
|
|
206
207
|
- Server description aligned across all surfaces: `package.json`, `manifest.json`, `server.json` (condensed, hard 100-char limit), README header `<p><b>`, and GitHub repo description (`gh repo edit --description`)
|
|
207
208
|
- `package.json` `keywords` include baseline terms: `mcp`, `mcp-server`, `model-context-protocol`, `typescript`, `bun`, `stdio`, `streamable-http`, plus data-domain terms. GitHub repo topics (`gh repo edit --add-topic`) should match.
|
|
@@ -4,7 +4,7 @@ description: >
|
|
|
4
4
|
File a bug or feature request against @cyanheads/mcp-ts-core when you hit a framework issue. Use when a builder, utility, context method, or config behaves contrary to the documented API — not for server-specific application bugs.
|
|
5
5
|
metadata:
|
|
6
6
|
author: cyanheads
|
|
7
|
-
version: "1.
|
|
7
|
+
version: "1.7"
|
|
8
8
|
audience: external
|
|
9
9
|
type: workflow
|
|
10
10
|
---
|
|
@@ -33,6 +33,8 @@ For general `gh` CLI workflows outside issue filing (PRs, workflows, API access)
|
|
|
33
33
|
gh issue list -R cyanheads/mcp-ts-core --search "your error message or keyword"
|
|
34
34
|
```
|
|
35
35
|
|
|
36
|
+
5. **For documentation- or contract-shaped requests, audit all three doc layers first** — proposals to add reference docs, public-API conventions, attribute/event catalogs, or stability commitments often duplicate surface that already exists. Check `src/` for behavior, `docs/` for human-facing reference, and `skills/` for agent-facing reference. Skill files marked `audience: external` are the framework's public contract — treat them as authoritative when evaluating whether a documentation gap exists. Also verify the constants or types you'd reference aren't already exported from `@cyanheads/mcp-ts-core` or one of its subpaths.
|
|
37
|
+
|
|
36
38
|
## Writing Well-Structured Issues
|
|
37
39
|
|
|
38
40
|
Good issues are scannable, concrete, and self-contained — terse and fact-dense. Default to one or two sentences per bullet; if a bullet runs long, split it or cut it. These patterns apply to both bugs and features — the guidance targets any prose block (Description, Additional context, feature proposals).
|
|
@@ -286,6 +288,7 @@ gh issue list -R cyanheads/mcp-ts-core --author @me
|
|
|
286
288
|
- [ ] Confirmed bug is in `@cyanheads/mcp-ts-core`, not server code
|
|
287
289
|
- [ ] Running latest (or documented) framework version
|
|
288
290
|
- [ ] Searched existing issues — no duplicate found
|
|
291
|
+
- [ ] If documentation or contract enhancement: confirmed `src/`, `docs/`, `skills/`, and public exports don't already cover the surface
|
|
289
292
|
- [ ] All secrets, credentials, and tokens redacted
|
|
290
293
|
- [ ] Primary label assigned (`bug` / `enhancement` / `documentation`)
|
|
291
294
|
- [ ] If bug: version, runtime, repro code, actual vs expected behavior included
|
package/templates/AGENTS.md
CHANGED
|
@@ -264,9 +264,14 @@ Available skills:
|
|
|
264
264
|
| `add-service` | Scaffold a new service integration |
|
|
265
265
|
| `add-test` | Scaffold test file for a tool, resource, or service |
|
|
266
266
|
| `field-test` | Exercise tools/resources/prompts with real inputs, verify behavior, report issues |
|
|
267
|
+
| `tool-defs-analysis` | Read-only audit of MCP definition language across the surface — voice, leaks, defaults, recovery hints, output descriptions |
|
|
267
268
|
| `security-pass` | Audit server for MCP-flavored security gaps: output injection, scope blast radius, input sinks, tenant isolation |
|
|
269
|
+
| `code-simplifier` | Post-session cleanup against `git diff` — modernize syntax, consolidate duplication, align with the codebase |
|
|
268
270
|
| `devcheck` | Lint, format, typecheck, audit |
|
|
269
271
|
| `polish-docs-meta` | Finalize docs, README, metadata, and agent protocol for shipping |
|
|
272
|
+
| `git-wrapup` | Land working-tree changes as a versioned commit + annotated tag — version bump, changelog, verify, tag. Local only. |
|
|
273
|
+
| `release-and-publish` | Push + npm + MCP Registry + GH Release + Docker. Picks up from `git-wrapup` |
|
|
274
|
+
| `migrate-mcp-ts-template` | One-time migration of an existing project to the current framework template |
|
|
270
275
|
| `maintenance` | Investigate changelogs, adopt upstream changes, sync skills to agent dirs |
|
|
271
276
|
| `report-issue-framework` | File a bug or feature request against `@cyanheads/mcp-ts-core` via `gh` CLI |
|
|
272
277
|
| `report-issue-local` | File a bug or feature request against this server's own repo via `gh` CLI |
|
|
@@ -275,6 +280,7 @@ Available skills:
|
|
|
275
280
|
| `api-config` | AppConfig, parseConfig, env vars |
|
|
276
281
|
| `api-context` | Context interface, logger, state, progress |
|
|
277
282
|
| `api-errors` | McpError, JsonRpcErrorCode, error patterns |
|
|
283
|
+
| `api-linter` | Definition linter rule catalog — invoked by `bun run lint:mcp` and `devcheck` |
|
|
278
284
|
| `api-services` | LLM, Speech, Graph services |
|
|
279
285
|
| `api-testing` | createMockContext, test patterns |
|
|
280
286
|
| `api-utils` | Formatting, parsing, security, pagination, scheduling, telemetry helpers |
|
package/templates/CLAUDE.md
CHANGED
|
@@ -265,9 +265,14 @@ Available skills:
|
|
|
265
265
|
| `add-service` | Scaffold a new service integration |
|
|
266
266
|
| `add-test` | Scaffold test file for a tool, resource, or service |
|
|
267
267
|
| `field-test` | Exercise tools/resources/prompts with real inputs, verify behavior, report issues |
|
|
268
|
+
| `tool-defs-analysis` | Read-only audit of MCP definition language across the surface — voice, leaks, defaults, recovery hints, output descriptions |
|
|
268
269
|
| `security-pass` | Audit server for MCP-flavored security gaps: output injection, scope blast radius, input sinks, tenant isolation |
|
|
270
|
+
| `code-simplifier` | Post-session cleanup against `git diff` — modernize syntax, consolidate duplication, align with the codebase |
|
|
269
271
|
| `devcheck` | Lint, format, typecheck, audit |
|
|
270
272
|
| `polish-docs-meta` | Finalize docs, README, metadata, and agent protocol for shipping |
|
|
273
|
+
| `git-wrapup` | Land working-tree changes as a versioned commit + annotated tag — version bump, changelog, verify, tag. Local only. |
|
|
274
|
+
| `release-and-publish` | Push + npm + MCP Registry + GH Release + Docker. Picks up from `git-wrapup` |
|
|
275
|
+
| `migrate-mcp-ts-template` | One-time migration of an existing project to the current framework template |
|
|
271
276
|
| `maintenance` | Investigate changelogs, adopt upstream changes, sync skills to agent dirs |
|
|
272
277
|
| `report-issue-framework` | File a bug or feature request against `@cyanheads/mcp-ts-core` via `gh` CLI |
|
|
273
278
|
| `report-issue-local` | File a bug or feature request against this server's own repo via `gh` CLI |
|
|
@@ -276,6 +281,7 @@ Available skills:
|
|
|
276
281
|
| `api-config` | AppConfig, parseConfig, env vars |
|
|
277
282
|
| `api-context` | Context interface, logger, state, progress |
|
|
278
283
|
| `api-errors` | McpError, JsonRpcErrorCode, error patterns |
|
|
284
|
+
| `api-linter` | Definition linter rule catalog — invoked by `bun run lint:mcp` and `devcheck` |
|
|
279
285
|
| `api-services` | LLM, Speech, Graph services |
|
|
280
286
|
| `api-testing` | createMockContext, test patterns |
|
|
281
287
|
| `api-utils` | Formatting, parsing, security, pagination, scheduling, telemetry helpers |
|
package/dist/logs/combined.log
DELETED
|
@@ -1,4 +0,0 @@
|
|
|
1
|
-
{"level":40,"time":1779856368095,"env":"testing","version":"0.9.10","pid":42668,"transport":"http","requestId":"K0H0F-OGJCX","timestamp":"2026-05-27T04:32:48.095Z","operation":"TransportManager.start","component":"HttpTransportSetup","msg":"MCP_ALLOWED_ORIGINS is not set — CORS is wildcard for CLI clients; browser Origin headers are restricted to loopback. Set MCP_ALLOWED_ORIGINS for production deployments accepting remote browser origins."}
|
|
2
|
-
{"level":40,"time":1779856369836,"env":"testing","version":"0.9.10","pid":42668,"transport":"http","requestId":"K0H0F-OGJCX","timestamp":"2026-05-27T04:32:48.095Z","operation":"TransportManager.start","component":"HttpTransportSetup","sessionId":"not-a-real-session-1779856369835","msg":"Session validation failed - invalid or hijacked session"}
|
|
3
|
-
{"level":50,"time":1779856373661,"env":"testing","version":"0.0.0-test","pid":42886,"requestId":"S73IT-N51J4","timestamp":"2026-05-27T04:32:53.660Z","operation":"HandleToolRequest","critical":false,"errorCode":-32005,"originalErrorType":"McpError","finalErrorType":"McpError","sessionId":"d403b6f5b5a1acd6bef09780d848eb07995f35133a797a95095b91d16ad63d5f","toolName":"scoped_echo","tenantId":"authz-tenant","auth":{"sub":"authz-user","scopes":["tool:other:read"],"clientId":"authz-client","tenantId":"authz-tenant","token":"[REDACTED]"},"errorData":{"sessionId":"d403b6f5b5a1acd6bef09780d848eb07995f35133a797a95095b91d16ad63d5f","toolName":"scoped_echo","requestId":"S73IT-N51J4","timestamp":"2026-05-27T04:32:53.660Z","tenantId":"authz-tenant","operation":"HandleToolRequest","auth":{"sub":"authz-user","scopes":["tool:other:read"],"clientId":"authz-client","tenantId":"authz-tenant","token":"[REDACTED]"},"originalErrorName":"McpError","originalMessage":"Insufficient permissions.","originalStack":"McpError: Insufficient permissions.\n at forbidden (/Users/casey/Developer/github/mcp-ts-core/dist/types-global/errors.js:84:58)\n at withRequiredScopes (/Users/casey/Developer/github/mcp-ts-core/dist/mcp-server/transports/auth/lib/authUtils.js:68:15)\n at <anonymous> (/Users/casey/Developer/github/mcp-ts-core/dist/mcp-server/tools/utils/toolHandlerFactory.js:146:17)\n at executeToolHandler (/Users/casey/Developer/github/mcp-ts-core/node_modules/@modelcontextprotocol/sdk/dist/esm/server/mcp.js:231:34)\n at <anonymous> (/Users/casey/Developer/github/mcp-ts-core/node_modules/@modelcontextprotocol/sdk/dist/esm/server/mcp.js:126:43)\n at processTicksAndRejections (native:7:39)"},"stack":"McpError: Insufficient permissions.\n at handleError (/Users/casey/Developer/github/mcp-ts-core/dist/utils/internal/error-handler/errorHandler.js:170:23)\n at <anonymous> (/Users/casey/Developer/github/mcp-ts-core/dist/mcp-server/tools/utils/toolHandlerFactory.js:184:26)\n at executeToolHandler (/Users/casey/Developer/github/mcp-ts-core/node_modules/@modelcontextprotocol/sdk/dist/esm/server/mcp.js:231:34)\n at <anonymous> (/Users/casey/Developer/github/mcp-ts-core/node_modules/@modelcontextprotocol/sdk/dist/esm/server/mcp.js:126:43)\n at processTicksAndRejections (native:7:39)","msg":"Error in tool:scoped_echo: Insufficient permissions."}
|
|
4
|
-
{"level":50,"time":1779856373668,"env":"testing","version":"0.0.0-test","pid":42886,"requestId":"2Z3AI-0NEMI","timestamp":"2026-05-27T04:32:53.668Z","operation":"HandleToolRequest","critical":false,"errorCode":-32005,"originalErrorType":"McpError","finalErrorType":"McpError","sessionId":"f6f091b254ded43dfd3db766e8ea167db6d7ba526bad1931f50f0ffc40f5a2e4","toolName":"scoped_echo","tenantId":"authz-tenant","auth":{"sub":"authz-user","scopes":["openid","email","profile","offline_access"],"clientId":"authz-client","tenantId":"authz-tenant","token":"[REDACTED]"},"errorData":{"sessionId":"f6f091b254ded43dfd3db766e8ea167db6d7ba526bad1931f50f0ffc40f5a2e4","toolName":"scoped_echo","requestId":"2Z3AI-0NEMI","timestamp":"2026-05-27T04:32:53.668Z","tenantId":"authz-tenant","operation":"HandleToolRequest","auth":{"sub":"authz-user","scopes":["openid","email","profile","offline_access"],"clientId":"authz-client","tenantId":"authz-tenant","token":"[REDACTED]"},"originalErrorName":"McpError","originalMessage":"Insufficient permissions.","originalStack":"McpError: Insufficient permissions.\n at forbidden (/Users/casey/Developer/github/mcp-ts-core/dist/types-global/errors.js:84:58)\n at withRequiredScopes (/Users/casey/Developer/github/mcp-ts-core/dist/mcp-server/transports/auth/lib/authUtils.js:68:15)\n at <anonymous> (/Users/casey/Developer/github/mcp-ts-core/dist/mcp-server/tools/utils/toolHandlerFactory.js:146:17)\n at executeToolHandler (/Users/casey/Developer/github/mcp-ts-core/node_modules/@modelcontextprotocol/sdk/dist/esm/server/mcp.js:231:34)\n at <anonymous> (/Users/casey/Developer/github/mcp-ts-core/node_modules/@modelcontextprotocol/sdk/dist/esm/server/mcp.js:126:43)\n at processTicksAndRejections (native:7:39)"},"stack":"McpError: Insufficient permissions.\n at handleError (/Users/casey/Developer/github/mcp-ts-core/dist/utils/internal/error-handler/errorHandler.js:170:23)\n at <anonymous> (/Users/casey/Developer/github/mcp-ts-core/dist/mcp-server/tools/utils/toolHandlerFactory.js:184:26)\n at executeToolHandler (/Users/casey/Developer/github/mcp-ts-core/node_modules/@modelcontextprotocol/sdk/dist/esm/server/mcp.js:231:34)\n at <anonymous> (/Users/casey/Developer/github/mcp-ts-core/node_modules/@modelcontextprotocol/sdk/dist/esm/server/mcp.js:126:43)\n at processTicksAndRejections (native:7:39)","msg":"Error in tool:scoped_echo: Insufficient permissions."}
|