@leeguoo/yapi-mcp 0.3.0 → 0.3.2

package/README.md

@@ -54,10 +54,54 @@ Yapi Auto MCP Server 是一个基于 [Model Context Protocol](https://modelconte
 
 ### 推荐方式：用 Cross Request Master 一键生成 MCP 配置（免手动找 Token）
 
-如果你日常就在浏览器里使用 YApi，推荐安装 Chrome 扩展 [cross-request-master](https://github.com/leeguooooo/cross-request-master)。它会在 YApi 接口详情页（基本信息区域右上角）提供 **「当前项目 MCP 配置」** / **「所有项目 MCP 配置」** 按钮，可一键生成并复制配置：
+如果你日常就在浏览器里使用 YApi，推荐安装 Chrome 扩展 [cross-request-master](https://github.com/leeguooooo/cross-request-master)。它会在 YApi 接口详情页（基本信息区域右上角）提供 **「YApi 工具箱」** 按钮，包含 MCP 配置/Skill 一键安装/CLI docs-sync 说明；另外保留 **「复制给 AI」** 一键复制接口 Markdown：
 
-- 当前项目：使用 `--yapi-token=projectId:token`
-- 所有项目（全局模式）：使用 `--yapi-auth-mode=global`（账号密码），启动后调用一次 `yapi_update_token` 刷新登录态 Cookie（并可选刷新项目缓存）
+- MCP 配置（所有项目）：使用 `--yapi-auth-mode=global`（账号密码），启动后调用一次 `yapi_update_token` 刷新登录态 Cookie（并可选刷新项目缓存）
+- Skill 一键安装：生成 Codex/Claude Skill，并写入全局配置 `~/.yapi/config.toml`
+- CLI 使用与 docs-sync：提供本地 CLI 安装命令和文档同步示例
+
+### Skill 一键安装与 CLI
+
+一条命令把 Skill 安装到 Codex / Claude Code，并写入 `~/.yapi/config.toml`（缺省会提示输入）：
+
+```bash
+npx -y @leeguoo/yapi-mcp install-skill \
+  --yapi-base-url=https://your-yapi-domain.com \
+  --yapi-email=your_email@example.com \
+  --yapi-password=your_password
+```
+
+CLI 使用示例（走同一份 `~/.yapi/config.toml`）：
+
+```bash
+npx -y @leeguoo/yapi-mcp yapi -V
+npx -y @leeguoo/yapi-mcp yapi -h
+npx -y @leeguoo/yapi-mcp yapi login
+npx -y @leeguoo/yapi-mcp yapi --path /api/interface/get --query id=123
+```
+
+全局模式下可先执行 `yapi login` 缓存登录态（`~/.yapi-mcp/auth-*.json`），权限失效会自动重新登录。
+
+Markdown 同步到 YApi（支持 Mermaid 预渲染，需 `pandoc` + `mmdc`）：
+
+```bash
+npx -y @leeguoo/yapi-mcp yapi docs-sync bind add \
+  --name projectA \
+  --dir docs/release-notes \
+  --project-id 267 \
+  --catid 3667
+
+npx -y @leeguoo/yapi-mcp yapi docs-sync --binding projectA
+# 或同步 .yapi/docs-sync.json 内的所有绑定
+npx -y @leeguoo/yapi-mcp yapi docs-sync
+```
+
+说明：
+- 绑定配置保存在 `.yapi/docs-sync.json`（自动维护 `files`：文件名 → API id）
+- 兼容旧方式：`--dir` 读取目录内 `.yapi.json` 的 `project_id/catid` 与 `source_files`
+- 管理绑定：`yapi docs-sync bind list|get|add|update|remove`
+- 可用 `--dry-run` 只做转换不更新
+- 如需跳过 Mermaid 渲染，使用 `--no-mermaid`
 
 ### 手动方式：使用 npx（无需安装）
 
@@ -245,7 +289,7 @@ node dist/cli.js --stdio
 2. 进入项目设置页面
 3. 在 Token 配置中生成或查看 Token
 
-不想手动找 Token 的话，可以用 [cross-request-master](https://github.com/leeguooooo/cross-request-master) 在接口详情页一键生成 MCP 配置（会自动带上 `projectId:token`）。
+不想手动找 Token 的话，可以用 [cross-request-master](https://github.com/leeguooooo/cross-request-master) 在接口详情页一键生成 **MCP 配置（所有项目）** 或 **Skill 一键安装**。
 
 ![Token 获取示例](./images/token.png)
 

package/dist/cli.js

@@ -4,14 +4,29 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const path_1 = require("path");
 const dotenv_1 = require("dotenv");
 const index_1 = require("./index");
+const install_1 = require("./skill/install");
 (0, dotenv_1.config)({ path: (0, path_1.resolve)(process.cwd(), ".env") });
-(0, index_1.startServer)().catch((error) => {
-    if (error instanceof Error) {
-        console.error("Failed to start server:", error.message);
-    }
-    else {
-        console.error("Failed to start server with unknown error:", error);
-    }
-    process.exit(1);
-});
+const [command, ...restArgs] = process.argv.slice(2);
+if (command === "install-skill") {
+    (0, install_1.runInstallSkill)(restArgs).catch((error) => {
+        if (error instanceof Error) {
+            console.error("Skill install failed:", error.message);
+        }
+        else {
+            console.error("Skill install failed with unknown error:", error);
+        }
+        process.exit(1);
+    });
+}
+else {
+    (0, index_1.startServer)().catch((error) => {
+        if (error instanceof Error) {
+            console.error("Failed to start server:", error.message);
+        }
+        else {
+            console.error("Failed to start server with unknown error:", error);
+        }
+        process.exit(1);
+    });
+}
 //# sourceMappingURL=cli.js.map

package/dist/cli.js.map

@@ -1 +1 @@
-{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";;;AAEA,+BAA+B;AAC/B,mCAAgC;AAChC,mCAAsC;AAGtC,IAAA,eAAM,EAAC,EAAE,IAAI,EAAE,IAAA,cAAO,EAAC,OAAO,CAAC,GAAG,EAAE,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC;AAEjD,IAAA,mBAAW,GAAE,CAAC,KAAK,CAAC,CAAC,KAAc,EAAE,EAAE;IACrC,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;QAC3B,OAAO,CAAC,KAAK,CAAC,yBAAyB,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAC1D,CAAC;SAAM,CAAC;QACN,OAAO,CAAC,KAAK,CAAC,4CAA4C,EAAE,KAAK,CAAC,CAAC;IACrE,CAAC;IACD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,CAAC,CAAC"}
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";;;AAEA,+BAA+B;AAC/B,mCAAgC;AAChC,mCAAsC;AACtC,6CAAkD;AAGlD,IAAA,eAAM,EAAC,EAAE,IAAI,EAAE,IAAA,cAAO,EAAC,OAAO,CAAC,GAAG,EAAE,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC;AAEjD,MAAM,CAAC,OAAO,EAAE,GAAG,QAAQ,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAErD,IAAI,OAAO,KAAK,eAAe,EAAE,CAAC;IAChC,IAAA,yBAAe,EAAC,QAAQ,CAAC,CAAC,KAAK,CAAC,CAAC,KAAc,EAAE,EAAE;QACjD,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;YAC3B,OAAO,CAAC,KAAK,CAAC,uBAAuB,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;QACxD,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,KAAK,CAAC,0CAA0C,EAAE,KAAK,CAAC,CAAC;QACnE,CAAC;QACD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC,CAAC,CAAC;AACL,CAAC;KAAM,CAAC;IACN,IAAA,mBAAW,GAAE,CAAC,KAAK,CAAC,CAAC,KAAc,EAAE,EAAE;QACrC,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;YAC3B,OAAO,CAAC,KAAK,CAAC,yBAAyB,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;QAC1D,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,KAAK,CAAC,4CAA4C,EAAE,KAAK,CAAC,CAAC;QACrE,CAAC;QACD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/skill/install.d.ts

@@ -0,0 +1 @@
+export declare function runInstallSkill(rawArgs: string[]): Promise<void>;