Agent-Rules项目中的MCP服务器发布指南

前言

在Agent-Rules项目中，Model Context Protocol（MCP）服务器是核心组件之一。本文将详细介绍如何将MCP服务器作为NPM包进行发布的全流程，包括自动化检查、手动准备步骤以及发布后的操作。

自动化发布准备

Agent-Rules项目提供了强大的自动化发布准备脚本，这是确保发布质量的第一道防线：

npm run prepare-release

这个脚本执行以下关键检查：

1. 版本控制检查：确保当前处于主分支且没有未提交的更改
2. 包完整性验证：检查package.json中所有必填字段
3. 依赖关系审计：检查缺失或过期的依赖项
4. 安全扫描：运行npm audit检测已知漏洞
5. 版本可用性：确认目标版本尚未发布
6. 构建产物验证：确保TypeScript声明文件(.d.ts)已生成
7. 本地化测试：对于包含原生代码(如Swift)的项目，运行格式化和lint检查
8. 包体积监控：防止意外包含大文件导致安装问题

手动发布准备步骤

1. 版本号管理

遵循语义化版本控制(SemVer)原则：

• 主版本号(Major)：不兼容的API修改
• 次版本号(Minor)：向下兼容的功能新增
• 修订号(Patch)：向下兼容的问题修正
• 预发布标签：如beta、rc等

2. 文档更新要点

• README.md：必须包含最新功能说明和安装指南
• API文档：详细记录所有工具模式和服务器行为变更
• 变更日志：采用标准格式记录每个版本的改动

3. 本地测试注意事项

由于MCP服务器通常需要系统级权限，CI环境无法完全模拟，因此必须：

1. 在本地运行全套测试
2. 首次运行时注意系统权限提示
3. 特别关注需要文件系统访问或Apple Events的测试用例

NPM发布流程

1. 预发布验证

npm publish --access public --tag beta --dry-run

关键检查点：

• 确认包含所有必要文件(dist/, package.json等)
• 排除无关文件(node_modules/, 测试文件等)
• 验证包结构是否符合预期

2. 正式发布

根据版本类型选择适当标签：

• 稳定版：npm publish --access public
• 预发布版：npm publish --access public --tag beta

发布后操作

1. 创建Git标签：git tag v1.0.0
2. 推送标签：git push origin v1.0.0
3. 编写发布说明：从CHANGELOG.md提取关键变更

最佳实践建议

1. 自动化优先：尽可能使用prepare-release脚本
2. 权限管理：为测试账户预先配置必要权限
3. 版本策略：预发布版本使用明确标签(beta/rc)
4. 文档同步：确保文档与代码变更保持同步
5. 回滚计划：准备版本回滚方案应对紧急情况

通过遵循这些指南，可以确保Agent-Rules项目中的MCP服务器发布过程规范、可靠，同时保持高质量的交付标准。