mp-publish-mcp 0.1.4

package/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2023 novlan1
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,102 @@
+# 小程序发布工具
+
+`mp-publish-mcp` - 小程序发布 MCP 工具
+
+## 功能特性
+
+- ✅ **触发发布流水线**: 通过 MCP 工具触发小程序发布流水线
+- ✅ **自动获取 Git 信息**: 自动从当前目录获取仓库地址和分支名称
+- ✅ **发布原因记录**: 支持记录发布原因，方便追溯历史
+- ✅ **参数校验**: 自动校验必填参数，确保发布信息完整
+
+## 安装
+
+```bash
+npm install mp-publish-mcp
+# or
+pnpm add mp-publish-mcp
+```
+
+## MCP 工具调用规则
+
+### 小程序发布工具 (`mp-publish`)
+
+**🔴【强制调用规则】**：
+
+- 当用户需要发布小程序时，AI 助手必须调用此 MCP 工具
+- 会自动从当前 Git 目录获取仓库地址和分支信息
+- 返回流水线触发结果
+
+**参数说明：**
+
+| 参数 | 类型 | 必填 | 说明 |
+|------|------|------|------|
+| `subProjectName` | string | ✅ | 子工程名，用于多工程仓库场景 |
+| `publishReason` | string | release分支必填 | 发布原因，用于记录本次发布的目的 |
+| `repo` | string | ❌ | Git 仓库地址，不传则自动获取 |
+| `branch` | string | ❌ | Git 分支名称，不传则自动获取 |
+| `cwd` | string | ❌ | 工作目录路径，用于执行 git 命令获取 repo 和 branch |
+
+**🔴【校验规则】**：
+
+1. `subProjectName` 为必填参数，必须提供子工程名
+2. 当 `branch` 为 `release` 时，`publishReason` 为必填参数
+
+## 使用示例
+
+### 基本发布（自动获取 Git 信息）
+
+```json
+{
+  "subProjectName": "weapp-main"
+}
+```
+
+### 带发布原因（非 release 分支）
+
+```json
+{
+  "subProjectName": "weapp-main",
+  "publishReason": "修复首页加载问题"
+}
+```
+
+### release 分支发布（必须带发布原因）
+
+```json
+{
+  "subProjectName": "weapp-main",
+  "publishReason": "v1.2.0 正式版发布",
+  "branch": "release"
+}
+```
+
+### 指定仓库和分支
+
+```json
+{
+  "subProjectName": "weapp-main",
+  "repo": "git@git.aow.com:example/miniprogram.git",
+  "branch": "feature/new-feature"
+}
+```
+
+### 指定工作目录
+
+```json
+{
+  "subProjectName": "weapp-main",
+  "cwd": "/path/to/project"
+}
+```
+
+## 开发
+
+```bash
+# 构建
+pnpm --filter "mp-publish-mcp" build
+```
+
+## 许可证
+
+MIT