@leeguoo/yapi-mcp 0.3.0 → 0.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +23 -4
- package/dist/cli.js +24 -9
- package/dist/cli.js.map +1 -1
- package/dist/skill/install.d.ts +1 -0
- package/dist/skill/install.js +724 -0
- package/dist/skill/install.js.map +1 -0
- package/dist/yapi-cli.d.ts +2 -0
- package/dist/yapi-cli.js +592 -0
- package/dist/yapi-cli.js.map +1 -0
- package/package.json +4 -3
package/README.md
CHANGED
|
@@ -54,10 +54,29 @@ Yapi Auto MCP Server 是一个基于 [Model Context Protocol](https://modelconte
|
|
|
54
54
|
|
|
55
55
|
### 推荐方式:用 Cross Request Master 一键生成 MCP 配置(免手动找 Token)
|
|
56
56
|
|
|
57
|
-
如果你日常就在浏览器里使用 YApi,推荐安装 Chrome 扩展 [cross-request-master](https://github.com/leeguooooo/cross-request-master)。它会在 YApi 接口详情页(基本信息区域右上角)提供
|
|
57
|
+
如果你日常就在浏览器里使用 YApi,推荐安装 Chrome 扩展 [cross-request-master](https://github.com/leeguooooo/cross-request-master)。它会在 YApi 接口详情页(基本信息区域右上角)提供 **「MCP 配置(所有项目)」** / **「Skill 一键安装」** 按钮,可一键生成并复制配置:
|
|
58
58
|
|
|
59
|
-
-
|
|
60
|
-
-
|
|
59
|
+
- MCP 配置(所有项目):使用 `--yapi-auth-mode=global`(账号密码),启动后调用一次 `yapi_update_token` 刷新登录态 Cookie(并可选刷新项目缓存)
|
|
60
|
+
- Skill 一键安装:生成 Codex/Claude Skill,并写入全局配置 `~/.yapi/config.toml`
|
|
61
|
+
|
|
62
|
+
### Skill 一键安装与 CLI
|
|
63
|
+
|
|
64
|
+
一条命令把 Skill 安装到 Codex / Claude Code,并写入 `~/.yapi/config.toml`(缺省会提示输入):
|
|
65
|
+
|
|
66
|
+
```bash
|
|
67
|
+
npx -y @leeguoo/yapi-mcp install-skill \
|
|
68
|
+
--yapi-base-url=https://your-yapi-domain.com \
|
|
69
|
+
--yapi-email=your_email@example.com \
|
|
70
|
+
--yapi-password=your_password
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
CLI 使用示例(走同一份 `~/.yapi/config.toml`):
|
|
74
|
+
|
|
75
|
+
```bash
|
|
76
|
+
npx -y @leeguoo/yapi-mcp yapi -V
|
|
77
|
+
npx -y @leeguoo/yapi-mcp yapi -h
|
|
78
|
+
npx -y @leeguoo/yapi-mcp yapi --path /api/interface/get --query id=123
|
|
79
|
+
```
|
|
61
80
|
|
|
62
81
|
### 手动方式:使用 npx(无需安装)
|
|
63
82
|
|
|
@@ -245,7 +264,7 @@ node dist/cli.js --stdio
|
|
|
245
264
|
2. 进入项目设置页面
|
|
246
265
|
3. 在 Token 配置中生成或查看 Token
|
|
247
266
|
|
|
248
|
-
不想手动找 Token 的话,可以用 [cross-request-master](https://github.com/leeguooooo/cross-request-master) 在接口详情页一键生成 MCP
|
|
267
|
+
不想手动找 Token 的话,可以用 [cross-request-master](https://github.com/leeguooooo/cross-request-master) 在接口详情页一键生成 **MCP 配置(所有项目)** 或 **Skill 一键安装**。
|
|
249
268
|
|
|
250
269
|

|
|
251
270
|
|
package/dist/cli.js
CHANGED
|
@@ -4,14 +4,29 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
4
4
|
const path_1 = require("path");
|
|
5
5
|
const dotenv_1 = require("dotenv");
|
|
6
6
|
const index_1 = require("./index");
|
|
7
|
+
const install_1 = require("./skill/install");
|
|
7
8
|
(0, dotenv_1.config)({ path: (0, path_1.resolve)(process.cwd(), ".env") });
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
}
|
|
9
|
+
const [command, ...restArgs] = process.argv.slice(2);
|
|
10
|
+
if (command === "install-skill") {
|
|
11
|
+
(0, install_1.runInstallSkill)(restArgs).catch((error) => {
|
|
12
|
+
if (error instanceof Error) {
|
|
13
|
+
console.error("Skill install failed:", error.message);
|
|
14
|
+
}
|
|
15
|
+
else {
|
|
16
|
+
console.error("Skill install failed with unknown error:", error);
|
|
17
|
+
}
|
|
18
|
+
process.exit(1);
|
|
19
|
+
});
|
|
20
|
+
}
|
|
21
|
+
else {
|
|
22
|
+
(0, index_1.startServer)().catch((error) => {
|
|
23
|
+
if (error instanceof Error) {
|
|
24
|
+
console.error("Failed to start server:", error.message);
|
|
25
|
+
}
|
|
26
|
+
else {
|
|
27
|
+
console.error("Failed to start server with unknown error:", error);
|
|
28
|
+
}
|
|
29
|
+
process.exit(1);
|
|
30
|
+
});
|
|
31
|
+
}
|
|
17
32
|
//# sourceMappingURL=cli.js.map
|
package/dist/cli.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";;;AAEA,+BAA+B;AAC/B,mCAAgC;AAChC,mCAAsC;
|
|
1
|
+
{"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"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare function runInstallSkill(rawArgs: string[]): Promise<void>;
|