Skip to content

Commit a0b455f

Browse files
docs(release): update runbook with bump script, server.json, and registry submissions (#57)
1 parent e52eb8c commit a0b455f

File tree

2 files changed

+19
-8
lines changed

2 files changed

+19
-8
lines changed

docs/release-runbook.md

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,11 @@ chore(release): bump workspace versions to 0.2.0
3232

3333
### 1. Bump versions
3434

35-
Update the version in all four package manifests and the MCPB `manifest.json`:
35+
```bash
36+
node scripts/bump_version.mjs <version>
37+
```
3638

37-
- `packages/docx-core/package.json`
38-
- `packages/docx-mcp/package.json`
39-
- `packages/safe-docx/package.json`
40-
- `packages/safe-docx-mcpb/package.json`
41-
- `packages/safe-docx-mcpb/manifest.json`
39+
This script is the source of truth for which files are managed (package manifests, MCPB manifest, cross-workspace dependency ranges, and `package-lock.json`). Do not bump versions manually.
4240

4341
Commit: `chore(release): bump workspace versions to X.Y.Z`
4442

@@ -65,14 +63,27 @@ preflight → publish-suite → ensure-release → publish-mcpb-asset → update
6563

6664
### 4. Verify
6765

66+
- [ ] `node scripts/bump_version.mjs --check` confirms all managed files are in sync
6867
- [ ] npm packages are published with provenance
6968
- [ ] GitHub Release exists with categorized notes
7069
- [ ] MCPB asset is attached to the release
7170
- [ ] Changelog data PR is opened (merge it to update the trust site)
7271

72+
### 5. MCP Registry Submissions
73+
74+
After npm publish, submit the package to each registry target:
75+
76+
1. **Official MCP Registry** (`registry.modelcontextprotocol.io`) — Requires `packages/safe-docx/server.json` (already managed by the bump script). Submit via the [registry quickstart](https://modelcontextprotocol.io/registry/quickstart).
77+
2. **Anthropic Connectors Directory** — Separate from the official registry. Submit local MCP servers via the [Google Form](https://support.claude.com/en/articles/12922832-local-mcp-server-submission-guide).
78+
3. **mcpservers.org** — Manual web form at https://mcpservers.org/submit.
79+
4. **Smithery.ai** — Publish via https://smithery.ai/docs/build/publish or https://smithery.ai/new.
80+
5. **Glama.ai** — Auto-discovers from GitHub/registry. Verify listing after registry publish + sync window (not tied to npm timing).
81+
82+
> **Note:** These URLs were verified as of 2026-03-17. Confirm they are still current at submission time.
83+
7384
## Monorepo Version Coupling
7485

75-
All publishable packages share the same version. The preflight job verifies that the tag version matches every `package.json` and the MCPB `manifest.json`. If any mismatch exists, the release fails before publishing.
86+
All publishable packages share the same version. The preflight job verifies that the tag version matches all files managed by `bump_version.mjs`. If any mismatch exists, the release fails before publishing.
7687

7788
## Fixing Bad Release Notes
7889

docs/safe-docx/mcp-docs-checklist.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,6 @@ Before adding more docs, trim anything that matches one of these:
4747
- [x] Keep tool schemas in one source of truth (`src/tool_catalog.ts` with Zod 4).
4848
- [x] Generate tool docs from schema source (`docs/tool-reference.generated.md`).
4949
- [x] Add three golden prompts.
50-
- [ ] Publish `.mcpb` artifact in CI release flow.
50+
- [x] Publish `.mcpb` artifact in CI release flow.
5151
- [x] List public package in MCP Registry when open-source launch is ready.
5252
- [ ] Add concise troubleshooting section in package README after first support feedback cycle.

0 commit comments

Comments
 (0)