Skip to content

feat: 发布 MCP Server 到 npm(oh-my-sage-mcp),新增 CI 与自动发版 - #37

Merged
lazyalex616 merged 1 commit into
allocnode:mainfrom
lazyalex616:feat/npm-publish
Nov 2, 2026
Merged

lazyalex616 merged 1 commit into
allocnode:mainfrom
lazyalex616:feat/npm-publish

Conversation

@lazyalex616

Copy link
Copy Markdown
Collaborator

内容

把 MCP Server 发布到 npm,包名 oh-my-sage-mcp,用户不用再克隆仓库,MCP 配置里写 npx -y oh-my-sage-mcp 就能用。同时加上 CI 和自动发版。

npm 包

  • 根 package.json 是网页版,标为 private,不会被误发布
  • scripts/build-npm-package.mjs 在 dist/npm/ 组装一个只含 MCP 的独立包:
    • 依赖只有编译产物实际用到的 5 个(@modelcontextprotocol/sdk、bn.js、elliptic、ws、zod),和 Docker 镜像共用同一份扫描脚本
    • 带上本机常驻安装脚本,全局安装后可以直接运行,不需要源码
    • README 里的图片改成 GitHub 绝对地址,npm 页面上也能显示
    • 打包后 79 个文件,约 125 KB,安装后 node_modules 约 15 MB
  • MCP Server 的版本号改为读取 package.json(之前写死 1.0.0),新增 --version、--help
  • 版本号从 0.0.2 升到 0.1.0
  • Node.js 最低版本改为 20:MCP SDK 的 HTTP 传输依赖 @hono/node-server,它要求 Node 20

工作流

CI(ci.yml,每个 PR 和 main 推送)

任务 内容
lint · typecheck · test ESLint、网页版和 MCP 两套类型检查、单元测试
npm package Ubuntu / Windows / macOS × Node 20 / 22 / 24:打包、装进空项目、真实启动,stdio 握手要列出 32 个工具,HTTP 模式 /healthz 和 initialize 要通过。不连接网关
docker build 确认 Dockerfile 能构建

Release(release.yml,推送 v* 标签):跑完检查和打包冒烟测试后发布到 npm,并创建 GitHub Release。标签必须和 package.json 版本一致;该版本已在 npm 上时跳过发布。

发布用 npm 的可信发布(OIDC),仓库里不保存任何 npm 令牌,发布的包会自动带上来源证明。首个版本先手动发布,再在 npm 包设置里登记本仓库的 release.yml,之后发版只需要改版本号、合并、推标签。

文档

  • README「方式一」改为 npx 配置,Skill 改用 npx skills add allocnode/oh-my-sage --skill mijia-automation 安装
  • 本机常驻改为全局安装后运行包里的脚本,安装截图同步更新
  • deploy/README.md、AGENTS.md 同步

本地验证

  • lint、两套类型检查、单元测试(180 通过,1 跳过)
  • 打出的 tarball 装进空目录:--version、stdio 32 个工具、HTTP healthz 与 initialize 全部通过
  • 包里的 Windows 安装脚本实际注册计划任务、healthz 通过、卸载干净
  • Docker 本机没有,由 CI 验证

- scripts/build-npm-package.mjs 组装只含 MCP 的独立包:5 个运行时依赖,附带本机常驻安装脚本
- scripts/smoke-npm-package.mjs 安装打包产物后实际运行:stdio 握手 32 个工具、HTTP healthz 与 initialize
- MCP Server 版本号读取 package.json,新增 --version 与 --help
- CI:lint、两套类型检查、单元测试,三个系统 × Node 20/22/24 的打包冒烟测试,Docker 构建
- Release:推送 v* 标签后用 npm 可信发布(OIDC)发版并创建 GitHub Release
- README 与部署文档改为 npx 安装,Skill 改用 npx skills add 安装
@lazyalex616
lazyalex616 marked this pull request as ready for review November 2, 2026 05:30
@lazyalex616
lazyalex616 merged commit 928bc32 into allocnode:main Nov 2, 2026
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant