sino-bc-cli 1.8.2 → 1.8.3
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 +24 -66
- package/dist/SKILL.md +4 -3
- package/dist/affordance/biz-line.md +5 -11
- package/dist/api-doc/README.md +9 -18
- package/dist/api-doc/biz-line-query.md +3 -5
- package/dist/generated/api-catalog.json +287 -0
- package/dist/index.js +1 -1
- package/dist/skills/sino-bc-biz-line/SKILL.md +6 -7
- package/dist/skills/sino-bc-biz-line/references/long-tail-api.md +18 -16
- package/dist/skills/sino-bc-shared/SKILL.md +1 -3
- package/package.json +2 -1
- package/dist/skills/sino-bc-shared/references/mcp-reload.md +0 -9
package/README.md
CHANGED
|
@@ -141,14 +141,12 @@ sino-bc-cli/
|
|
|
141
141
|
│ │
|
|
142
142
|
│ ├── commands/ # 📦 命令实现层(每命令一个文件,可独立扩展)
|
|
143
143
|
│ │ ├── index.ts # 命令批量注册入口
|
|
144
|
-
│ │ ├── init.command.ts # /init 命令实现(注册 Agent 技能 +
|
|
145
|
-
│ │ ├── api-list.command.ts # /api-list 命令实现(列出接口、给出调用命令并打开文档)
|
|
144
|
+
│ │ ├── init.command.ts # /init 命令实现(注册 Agent 技能 + 初始化变量配置)
|
|
146
145
|
│ │ ├── bc-api.command.ts # /bc-api 已下线,仅打印迁移提示并非 0 退出
|
|
147
|
-
│ │ ├── get-config.command.ts # /get-config
|
|
146
|
+
│ │ ├── get-config.command.ts # /get-config 命令实现(查看变量配置)
|
|
148
147
|
│ │ ├── set-config.command.ts # /set-config 命令实现(修改变量配置)
|
|
149
|
-
│ │ ├── mcp-reload.command.ts # /mcp-reload 命令实现(按 mcp.json 重启 MCP)
|
|
150
148
|
│ │ ├── skill.command.ts # /skill 命令实现(列出包内技能或打开 SKILL.md)
|
|
151
|
-
│ │ └── uninstall.command.ts # /uninstall
|
|
149
|
+
│ │ └── uninstall.command.ts # /uninstall 命令实现(清理技能目录与配置并卸载)
|
|
152
150
|
│ │
|
|
153
151
|
│ ├── shortcuts/ # ⚡ Shortcut 执行面(业务命令,域 + `+cmd`)
|
|
154
152
|
│ │ ├── index.ts # 注册表与执行器(flag 解析、输出格式、写确认门)
|
|
@@ -156,7 +154,7 @@ sino-bc-cli/
|
|
|
156
154
|
│ │ ├── types.ts # Shortcut 声明与执行上下文类型
|
|
157
155
|
│ │ └── biz-line/ # biz-line 域
|
|
158
156
|
│ │ ├── index.ts # 该域全部 Shortcut 登记处
|
|
159
|
-
│ │ ├── read.ts # 只读 Shortcut(+channels/+categories/+list/+strategies
|
|
157
|
+
│ │ ├── read.ts # 只读 Shortcut(+channels/+categories/+list/+strategies)
|
|
160
158
|
│ │ ├── write.ts # 写 Shortcut(+save/+update/+status/+delete/+strategy-*)
|
|
161
159
|
│ │ ├── raw-api.ts # biz-line api <name> 点名调用
|
|
162
160
|
│ │ └── helpers.ts # 按名解析业务线、字典名称映射等编排
|
|
@@ -174,8 +172,6 @@ sino-bc-cli/
|
|
|
174
172
|
│ │ ├── prompt.ts # 终端交互(复用单一 readline 会话:提问、选择、确认)
|
|
175
173
|
│ │ ├── config-store.ts # 变量配置读写(字段元信息 + 读 / 写 / 删)
|
|
176
174
|
│ │ ├── config-prompt.ts # 变量配置交互采集(/init 与 /set-config 共用)
|
|
177
|
-
│ │ ├── mcp-store.ts # ~/.sino-bc-cli/mcp.json 读写
|
|
178
|
-
│ │ ├── mcp-service.ts # MCP 同步到 Cursor / Codex / Claude / VS Code 并握手
|
|
179
175
|
│ │ └── skill-install.ts # Agent 技能目录的写入与清理
|
|
180
176
|
│ │
|
|
181
177
|
│ ├── types/ # 📝 类型定义层
|
|
@@ -304,7 +300,7 @@ npm i sino-bc-cli -g
|
|
|
304
300
|
```bash
|
|
305
301
|
sino-bc-cli --help
|
|
306
302
|
sino-bc-cli /init
|
|
307
|
-
sino-bc-cli
|
|
303
|
+
sino-bc-cli biz-line --help
|
|
308
304
|
sino-bc-cli biz-line +list --name <业务线名称>
|
|
309
305
|
```
|
|
310
306
|
|
|
@@ -326,13 +322,11 @@ sino-bc-cli /init
|
|
|
326
322
|
|
|
327
323
|
| 命令 | 说明 |
|
|
328
324
|
| :---------- | :-------------------------------------------------------------------------------------------- |
|
|
329
|
-
| `/init` | 注册 `sino-bc-shared` / `sino-bc-biz-line` 到 Agent 技能目录(并删除旧 `sino-bc-cli/`),交互设置环境 / `API_KEY
|
|
325
|
+
| `/init` | 注册 `sino-bc-shared` / `sino-bc-biz-line` 到 Agent 技能目录(并删除旧 `sino-bc-cli/`),交互设置环境 / `API_KEY` |
|
|
330
326
|
| `/skill` | 列出包内 Agent 技能;传入 name 打开对应 `SKILL.md` |
|
|
331
|
-
| `/
|
|
332
|
-
| `/get-config` | 查看变量配置与 `mcp.json`;密钥默认打码,`--show-secret` 显示明文,`--json` 输出 JSON |
|
|
327
|
+
| `/get-config` | 查看变量配置;密钥默认打码,`--show-secret` 显示明文,`--json` 输出 JSON |
|
|
333
328
|
| `/set-config` | 修改变量配置(环境 / API_KEY);不带参数时逐项交互修改 |
|
|
334
|
-
| `/
|
|
335
|
-
| `/uninstall` | 关闭本 CLI 写入的 MCP,删除技能目录与变量配置文件,并从全局 npm 卸载本 CLI |
|
|
329
|
+
| `/uninstall` | 删除技能目录与变量配置文件,并从全局 npm 卸载本 CLI |
|
|
336
330
|
| `/bc-api` | **已下线**。只打印迁移提示并非 0 退出,改用 `biz-line +<shortcut>` 或 `biz-line api <name>` |
|
|
337
331
|
|
|
338
332
|
### 业务命令(`biz-line`)
|
|
@@ -341,14 +335,13 @@ sino-bc-cli /init
|
|
|
341
335
|
| :--- | :--- |
|
|
342
336
|
| `biz-line +channels` | 查询投放渠道列表(`code` 即业务线里的 `mediaChannelId`) |
|
|
343
337
|
| `biz-line +categories` | 查询投放行业与品类字典树 |
|
|
344
|
-
| `biz-line +list` | 查询业务线;`--name` / `--id` / `--
|
|
345
|
-
| `biz-line +strategies` | 查周策略与表现;`--name` 会先解析业务线 ID
|
|
346
|
-
| `biz-line +top` | 行业 / 品类 Top 业务线;两者至少传一个,同时传则只按行业 |
|
|
338
|
+
| `biz-line +list` | 查询业务线;`--name` / `--id` / `--category`,不传即查全部(`pagination: false`) |
|
|
339
|
+
| `biz-line +strategies` | 查周策略与表现;`--name` 会先解析业务线 ID,或传单个 `--id` |
|
|
347
340
|
| `biz-line +save` / `+update` / `+status` / `+delete` | ⚠️ 业务线写操作 |
|
|
348
341
|
| `biz-line +strategy-save` / `+strategy-update` / `+strategy-delete` | ⚠️ 周策略写操作 |
|
|
349
342
|
| `biz-line api <name> --data '<json>'` | 按接口 `name` 点名调用,覆盖导出、对比、消耗等长尾接口 |
|
|
350
343
|
|
|
351
|
-
`--channel` / `--industry
|
|
344
|
+
`+list --category` 同时接受数字 ID 与名称;传名称时会先查品类字典再映射,映射不到会报错并列出可选值。`+list` 不再接受 `--channel` / `--industry`。行业 / 品类 Top 没有 Shortcut。
|
|
352
345
|
|
|
353
346
|
### Shortcut 面公共参数
|
|
354
347
|
|
|
@@ -379,8 +372,6 @@ sino-bc-cli /init
|
|
|
379
372
|
|
|
380
373
|
环境、`API_KEY` 存放在 `<用户主目录>/.sino-bc-cli/config.json`。`X-GATEWAY-TYPE` 固定为 `A2C-CLI`,不开放配置。
|
|
381
374
|
|
|
382
|
-
MCP Server 存放在 `<用户主目录>/.sino-bc-cli/mcp.json`,结构与 Cursor 的 `mcp.json` 一致。用户自行增删后执行 `/mcp-reload`,CLI 会同步到 Cursor、Codex、Claude Code、VS Code。
|
|
383
|
-
|
|
384
375
|
| 字段 | 命令行键名 | 默认值 | 说明 |
|
|
385
376
|
| :--- | :--------- | :----- | :--- |
|
|
386
377
|
| `env` | `env` | `prod` | 目标环境,可选 `test` / `pre` / `prod` |
|
|
@@ -397,27 +388,9 @@ sino-bc-cli /set-config --env=test
|
|
|
397
388
|
|
|
398
389
|
# 不带参数则逐项交互修改,直接回车保留当前值
|
|
399
390
|
sino-bc-cli /set-config
|
|
400
|
-
|
|
401
|
-
# 改 MCP:编辑文件后重启
|
|
402
|
-
# %USERPROFILE%\.sino-bc-cli\mcp.json
|
|
403
|
-
sino-bc-cli /mcp-reload
|
|
404
|
-
```
|
|
405
|
-
|
|
406
|
-
```json
|
|
407
|
-
{
|
|
408
|
-
"mcpServers": {
|
|
409
|
-
"example": {
|
|
410
|
-
"type": "streamable-http",
|
|
411
|
-
"url": "https://your-mcp-gateway/mcp/",
|
|
412
|
-
"headers": {
|
|
413
|
-
"Authorization": "Bearer <token>"
|
|
414
|
-
}
|
|
415
|
-
}
|
|
416
|
-
}
|
|
417
|
-
}
|
|
418
391
|
```
|
|
419
392
|
|
|
420
|
-
> `/init`
|
|
393
|
+
> `/init` 在非交互环境(npm `postinstall`、CI、Agent 调用)下不提问:配置文件已存在则保持不变,不存在则按默认值创建。
|
|
421
394
|
|
|
422
395
|
### 全局选项
|
|
423
396
|
|
|
@@ -429,7 +402,7 @@ sino-bc-cli /mcp-reload
|
|
|
429
402
|
|
|
430
403
|
### 环境与请求网关
|
|
431
404
|
|
|
432
|
-
业务命令的请求地址由 [`src/constants/gateway.ts`](./src/constants/gateway.ts) 的 `GATEWAY_CONFIG` 决定,统一走 `joinGatewayUrl(env, path)` 拼接,实际请求由 [`src/utils/gateway-client.ts`](./src/utils/gateway-client.ts) 这一个出口发出。业务线路径带 `/sino-opti-hive`。
|
|
405
|
+
业务命令的请求地址由 [`src/constants/gateway.ts`](./src/constants/gateway.ts) 的 `GATEWAY_CONFIG` 决定,统一走 `joinGatewayUrl(env, path)` 拼接,实际请求由 [`src/utils/gateway-client.ts`](./src/utils/gateway-client.ts) 这一个出口发出。业务线路径带 `/sino-opti-hive`。
|
|
433
406
|
|
|
434
407
|
| `ENV` | 说明 | 网关地址 |
|
|
435
408
|
| :----- | :------- | :----------------------------------- |
|
|
@@ -453,40 +426,26 @@ sino-bc-cli --help
|
|
|
453
426
|
sino-bc-cli -h
|
|
454
427
|
```
|
|
455
428
|
|
|
456
|
-
#### ②
|
|
429
|
+
#### ② 查看某域何时用哪条命令
|
|
457
430
|
|
|
458
431
|
```bash
|
|
459
|
-
sino-bc-cli
|
|
460
|
-
sino-bc-cli /api-list 3
|
|
461
|
-
sino-bc-cli /api-list biz-line-open-list
|
|
432
|
+
sino-bc-cli biz-line --help
|
|
462
433
|
```
|
|
463
434
|
|
|
464
|
-
|
|
435
|
+
接口字段口径见 [`src/api-doc/README.md`](./src/api-doc/README.md)。
|
|
465
436
|
|
|
466
|
-
#### ③
|
|
467
|
-
|
|
468
|
-
```bash
|
|
469
|
-
# 编辑 %USERPROFILE%\.sino-bc-cli\mcp.json 后
|
|
470
|
-
sino-bc-cli /mcp-reload
|
|
471
|
-
```
|
|
472
|
-
|
|
473
|
-
执行效果:把 `mcp.json` 里的 Server 同步到 Cursor(`~/.cursor/mcp.json`)、Codex(`~/.codex/config.toml`)、Claude Code(`~/.claude.json`)、VS Code 用户级 `mcp.json`,并对带 `url` 的 Server 做 initialize 握手。
|
|
474
|
-
|
|
475
|
-
#### ④ 查询业务线数据
|
|
437
|
+
#### ③ 查询业务线数据
|
|
476
438
|
|
|
477
439
|
```bash
|
|
478
440
|
# 按名称查业务线
|
|
479
441
|
sino-bc-cli biz-line +list --name <业务线名称>
|
|
480
442
|
|
|
481
|
-
#
|
|
482
|
-
sino-bc-cli biz-line +list --
|
|
443
|
+
# 按品类筛选(接受名称或 ID)
|
|
444
|
+
sino-bc-cli biz-line +list --category <品类>
|
|
483
445
|
|
|
484
446
|
# 查某条业务线的周策略与表现
|
|
485
447
|
sino-bc-cli biz-line +strategies --name <业务线名称>
|
|
486
448
|
|
|
487
|
-
# 行业 Top
|
|
488
|
-
sino-bc-cli biz-line +top --industry APP --top-n 5
|
|
489
|
-
|
|
490
449
|
# 没有 Shortcut 的长尾接口
|
|
491
450
|
sino-bc-cli biz-line api biz-line-strategy-compare \
|
|
492
451
|
--data '{"bizLineId":123,"currentId":2,"prevId":1}'
|
|
@@ -494,7 +453,7 @@ sino-bc-cli biz-line api biz-line-strategy-compare \
|
|
|
494
453
|
|
|
495
454
|
执行效果:向配置文件指定环境的网关发起请求,路径统一带 `/sino-opti-hive` 前缀,自动注入 `Authorization` 与 `X-GATEWAY-TYPE: A2C-CLI`。接口清单见 [`src/api-doc/README.md`](./src/api-doc/README.md)。
|
|
496
455
|
|
|
497
|
-
####
|
|
456
|
+
#### ④ 执行写操作(需确认)
|
|
498
457
|
|
|
499
458
|
```bash
|
|
500
459
|
# 先预览请求,不会真正发起
|
|
@@ -506,12 +465,12 @@ sino-bc-cli biz-line +status --id 123 --status 3 --yes
|
|
|
506
465
|
|
|
507
466
|
> ⚠️ 写操作会变更线上数据。不加 `--yes` 时:交互式终端会展示环境与关键参数并询问;非交互式环境以退出码 `10` 返回 `confirmation_required`,需人工确认后再重试。
|
|
508
467
|
|
|
509
|
-
####
|
|
468
|
+
#### ⑤ 启用 Debug 模式运行
|
|
510
469
|
|
|
511
470
|
```bash
|
|
512
|
-
sino-bc-cli --debug
|
|
471
|
+
sino-bc-cli --debug biz-line --help
|
|
513
472
|
# 或使用短选项
|
|
514
|
-
sino-bc-cli -d
|
|
473
|
+
sino-bc-cli -d biz-line --help
|
|
515
474
|
```
|
|
516
475
|
|
|
517
476
|
Debug 模式会输出详细的日志,包括参数解析、命令注册、接口调用过程等信息,便于排查问题。
|
|
@@ -575,7 +534,7 @@ npm run rebuild
|
|
|
575
534
|
3. **补测试**:在 `tests/` 下用 HTTP 桩断言请求与输出
|
|
576
535
|
4. **同步文档**:`skills/sino-bc-biz-line` 的意图表、`affordance/biz-line.md` 的 WHEN、`src/api-doc/` 的字段口径;根 `SKILL.md` 只做入口
|
|
577
536
|
|
|
578
|
-
参数解析、输出格式、写操作确认门、错误归类都由 `src/shortcuts/index.ts` 统一承担,声明里不要自己发 HTTP。接口 `name` 一律取自 `src/
|
|
537
|
+
参数解析、输出格式、写操作确认门、错误归类都由 `src/shortcuts/index.ts` 统一承担,声明里不要自己发 HTTP。接口 `name` 一律取自 `src/generated/api-catalog.json`,不要新造。维护者同步 Apifox:`APIFOX_TOKEN` 环境变量 + `npm run sync-api-doc`(不要把 token 写入仓库)。
|
|
579
538
|
|
|
580
539
|
> 只是想调一个已有接口,通常不需要写新 Shortcut——直接 `biz-line api <name> --data '<json>'` 即可。Shortcut 应当带来智能默认值、参数编排或更友好的输出,否则不值得新增。
|
|
581
540
|
|
|
@@ -609,7 +568,6 @@ import { ExampleCommand } from "./example.command"; // 新增导入
|
|
|
609
568
|
|
|
610
569
|
export const commands: ICommand[] = [
|
|
611
570
|
new InitCommand(),
|
|
612
|
-
new ApiListCommand(),
|
|
613
571
|
new GetConfigCommand(),
|
|
614
572
|
new ExampleCommand(), // 新增注册
|
|
615
573
|
];
|
package/dist/SKILL.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: sino-bc-cli
|
|
3
3
|
description: >
|
|
4
|
-
Use when 查询或操作 BeyondClick 业务线,或配置 sino-bc-cli
|
|
4
|
+
Use when 查询或操作 BeyondClick 业务线,或配置 sino-bc-cli。
|
|
5
5
|
完整规则在 sino-bc-shared 与 sino-bc-biz-line;本文件只做入口。
|
|
6
6
|
metadata:
|
|
7
7
|
requires:
|
|
@@ -10,10 +10,11 @@ metadata:
|
|
|
10
10
|
|
|
11
11
|
# sino-bc-cli
|
|
12
12
|
|
|
13
|
-
Agent
|
|
13
|
+
Agent 技能已拆成多份,**不要只读这一页**。
|
|
14
14
|
|
|
15
|
-
1. 配置、信封、确认门、禁止拼 HTTP
|
|
15
|
+
1. 配置、信封、确认门、禁止拼 HTTP:[`skills/sino-bc-shared/SKILL.md`](skills/sino-bc-shared/SKILL.md)
|
|
16
16
|
2. 业务线意图与 Shortcut:[`skills/sino-bc-biz-line/SKILL.md`](skills/sino-bc-biz-line/SKILL.md)
|
|
17
|
+
3. 其他域:`skills/sino-bc-<domain>/`(由 `npm run sync-api-doc` 生成)
|
|
17
18
|
|
|
18
19
|
安装与刷新(会写入上述两份并删除旧的 `sino-bc-cli/` 技能目录):
|
|
19
20
|
|
|
@@ -11,27 +11,21 @@
|
|
|
11
11
|
## +categories
|
|
12
12
|
|
|
13
13
|
- **WHEN**:用户问投放行业 / 品类树,或要把名称映射成字典 ID。
|
|
14
|
-
-
|
|
14
|
+
- **别用**:已经有品类 ID 且只要业务线(直接 `+list --category`)。
|
|
15
15
|
- **示例**:`sino-bc-cli biz-line +categories`
|
|
16
16
|
|
|
17
17
|
## +list
|
|
18
18
|
|
|
19
|
-
- **WHEN**:按名称、ID
|
|
20
|
-
- **别用**:只要某一条的周策略(用 `+strategies
|
|
19
|
+
- **WHEN**:按名称、ID、品类筛业务线;不传条件 = 全部。
|
|
20
|
+
- **别用**:只要某一条的周策略(用 `+strategies`)。渠道或行业条件请走 `biz-line api`。
|
|
21
21
|
- **示例**:`sino-bc-cli biz-line +list --name <业务线名称>`
|
|
22
22
|
|
|
23
23
|
## +strategies
|
|
24
24
|
|
|
25
25
|
- **WHEN**:查某条业务线的周策略和表现。
|
|
26
|
-
- **别用**:`--name` 可能命中多条时不要猜,先 `+list`
|
|
26
|
+
- **别用**:`--name` 可能命中多条时不要猜,先 `+list` 收窄或改单个 `--id`。
|
|
27
27
|
- **示例**:`sino-bc-cli biz-line +strategies --name <业务线名称>`
|
|
28
28
|
|
|
29
|
-
## +top
|
|
30
|
-
|
|
31
|
-
- **WHEN**:问某行业或品类里表现最好的业务线。
|
|
32
|
-
- **别用**:行业和品类都没有时不要空跑;两个都传则只按行业。
|
|
33
|
-
- **示例**:`sino-bc-cli biz-line +top --industry APP`
|
|
34
|
-
|
|
35
29
|
## +save / +update
|
|
36
30
|
|
|
37
31
|
- **WHEN**:新建或编辑业务线主数据。字段多用 `--data`。
|
|
@@ -58,6 +52,6 @@
|
|
|
58
52
|
|
|
59
53
|
## api
|
|
60
54
|
|
|
61
|
-
- **WHEN**:导出、对比、消耗、周期列表、上期摘要等没有 `+`
|
|
55
|
+
- **WHEN**:导出、对比、消耗、周期列表、上期摘要等没有 `+` 的接口。行业 / 品类 Top 目前没有 Shortcut。
|
|
62
56
|
- **别用**:已有 Shortcut 的高频查询仍应走 `+xxx`。
|
|
63
57
|
- **示例**:`sino-bc-cli biz-line api biz-line-strategy-compare --data '{"bizLineId":123,"currentId":2,"prevId":1}'`
|
package/dist/api-doc/README.md
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
# 接口文档索引
|
|
2
2
|
|
|
3
|
-
本目录汇总 CLI
|
|
3
|
+
本目录汇总 CLI 可调用的业务线接口(字段口径)。何时用哪条命令见仓库 `affordance/biz-line.md` 或 `sino-bc-cli biz-line --help`。发起调用用 `biz-line +<shortcut>`;没有 Shortcut 的接口用 `biz-line api <name> --data '<json>'`。Agent 技能树在 `skills/`,自省用 `/skill`。
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
本 CLI 只覆盖业务线网关接口,不管理 MCP。
|
|
6
6
|
|
|
7
7
|
| 分组 | 命令 | 接口数 | 文档 |
|
|
8
8
|
| --- | --- | --- | --- |
|
|
9
|
-
| 业务线查询 | `biz-line +channels` / `+categories`
|
|
10
|
-
| 业务线策略 | `biz-line +save` / `+update` / `+status` / `+delete` / `+strategy-*`,其余 `biz-line api <name>` | 17 | [biz-line-strategy.md](./biz-line-strategy.md) |
|
|
9
|
+
| 业务线查询 | `biz-line +channels` / `+categories` | 2 | [biz-line-query.md](./biz-line-query.md) |
|
|
10
|
+
| 业务线策略 | `biz-line +list` / `+strategies` / `+save` / `+update` / `+status` / `+delete` / `+strategy-*`,其余 `biz-line api <name>` | 17 | [biz-line-strategy.md](./biz-line-strategy.md) |
|
|
11
11
|
|
|
12
12
|
---
|
|
13
13
|
|
|
@@ -16,7 +16,6 @@ iCenter 不再随 CLI 提供接口文档。需要 iCenter 时,把 MCP Server
|
|
|
16
16
|
| 范围 | 通道 |
|
|
17
17
|
| --- | --- |
|
|
18
18
|
| `biz-line-query.md` / `biz-line-strategy.md` 与 `biz-line` 命令 | 固定走网关 HTTP,路径带 `/sino-opti-hive` |
|
|
19
|
-
| iCenter 及其他 MCP | 用户编辑 `~/.sino-bc-cli/mcp.json`,由 `/init`、`/mcp-reload` 同步并启动 |
|
|
20
19
|
|
|
21
20
|
网关地址的唯一来源是 `src/constants/gateway.ts` 的 `GATEWAY_CONFIG`;各文档中出现的上游服务地址(`o-test-sino-opti-hive` 等)仅作接口文档出处,不作为请求地址。
|
|
22
21
|
|
|
@@ -34,14 +33,14 @@ iCenter 不再随 CLI 提供接口文档。需要 iCenter 时,把 MCP Server
|
|
|
34
33
|
|
|
35
34
|
数据来源:[sino-opti-hive 接口文档](https://o-test-sino-opti-hive.meetsocial.com/doc.html)
|
|
36
35
|
|
|
37
|
-
共 **
|
|
36
|
+
共 **19** 个接口,分两组。所有路径经网关调用时统一带 `/sino-opti-hive` 路由前缀,例如 `/sino-opti-hive/biz-line-open/channels`。
|
|
38
37
|
|
|
39
38
|
| 文档 | 分组 | 接口数 | 说明 |
|
|
40
39
|
| --- | --- | --- | --- |
|
|
41
|
-
| [biz-line-query.md](./biz-line-query.md) | 业务线查询 |
|
|
42
|
-
| [biz-line-strategy.md](./biz-line-strategy.md) | 业务线策略 | 17 |
|
|
40
|
+
| [biz-line-query.md](./biz-line-query.md) | 业务线查询 | 2 | 对外开放的只读查询:渠道、品类字典 |
|
|
41
|
+
| [biz-line-strategy.md](./biz-line-strategy.md) | 业务线策略 | 17 | 业务线主数据与周策略的增删改查、导出;`+list` / `+strategies` 改绑此组内部接口 |
|
|
43
42
|
|
|
44
|
-
对应命令:`biz-line +<shortcut>` 与 `biz-line api <name>`,接口清单定义在 `src/
|
|
43
|
+
对应命令:`biz-line +<shortcut>` 与 `biz-line api <name>`,接口清单定义在 `src/generated/api-catalog.json`。维护者同步:`APIFOX_TOKEN` 环境变量 + `npm run sync-api-doc`。
|
|
45
44
|
|
|
46
45
|
> ⚠️ 业务线策略组含新建 / 编辑 / 删除等写操作接口。写操作必须先确认:不加 `--yes` 时交互式终端会询问,非交互式环境以退出码 `10` 返回 `confirmation_required`;执行前可用 `--dry-run` 预览请求。
|
|
47
46
|
>
|
|
@@ -51,15 +50,7 @@ iCenter 不再随 CLI 提供接口文档。需要 iCenter 时,把 MCP Server
|
|
|
51
50
|
|
|
52
51
|
## 命令调用
|
|
53
52
|
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
```bash
|
|
57
|
-
sino-bc-cli /api-list
|
|
58
|
-
sino-bc-cli /api-list 1
|
|
59
|
-
sino-bc-cli /api-list biz-line-open-channels
|
|
60
|
-
```
|
|
61
|
-
|
|
62
|
-
发起调用经网关 HTTP;环境与鉴权取自变量配置文件,无需在命令上传。
|
|
53
|
+
发起调用经网关 HTTP;环境与鉴权取自变量配置文件,无需在命令上传。字段口径以本目录 markdown 为准。
|
|
63
54
|
|
|
64
55
|
```bash
|
|
65
56
|
# 有 Shortcut 的高频查询
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
数据来源:[sino-opti-hive 接口文档](https://o-test-sino-opti-hive.meetsocial.com/doc.html#/default/%E4%B8%9A%E5%8A%A1%E7%BA%BF%E6%9F%A5%E8%AF%A2/channelsUsingGET)
|
|
4
4
|
|
|
5
|
-
对外开放的只读查询接口,共 **
|
|
5
|
+
对外开放的只读查询接口,共 **2** 个(渠道、品类字典)。业务线列表与周策略已改绑内部接口,见 [biz-line-strategy.md](./biz-line-strategy.md) 的 `biz-line-list` / `biz-line-strategy-list`。
|
|
6
6
|
|
|
7
7
|
> **网关地址**:`https://test-agent.beyondclick.com`(三环境同一地址,唯一来源 `src/constants/gateway.ts` 的 `GATEWAY_CONFIG`),不要直连 sino-opti-hive 服务地址。
|
|
8
8
|
>
|
|
@@ -12,9 +12,8 @@
|
|
|
12
12
|
| --- | --- | --- | --- | --- |
|
|
13
13
|
| 1 | `biz-line-open-channels` | 查询投放渠道列表 | GET | `/sino-opti-hive/biz-line-open/channels` |
|
|
14
14
|
| 2 | `biz-line-open-placement-categories` | 查询投放品类字典树 | GET | `/sino-opti-hive/biz-line-open/placement-categories` |
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
| 5 | `biz-line-open-strategy-top` | 查询投放表现 Top 业务线 | POST | `/sino-opti-hive/biz-line-open/strategy-top` |
|
|
15
|
+
|
|
16
|
+
> `biz-line-open-list` / `biz-line-open-strategies` / `biz-line-open-strategy-top` 已不在现行 catalog。`+list` / `+strategies` 改打 `biz-line-list` / `biz-line-strategy-list`。`+top` 已下线。
|
|
18
17
|
|
|
19
18
|
所有接口统一返回 `RestResponseVO` 包装:`success`、`code`、`message`、`result`、`traceId`。下文只描述 `result`。
|
|
20
19
|
|
|
@@ -209,7 +208,6 @@ sino-bc-cli biz-line +channels
|
|
|
209
208
|
sino-bc-cli biz-line +categories
|
|
210
209
|
sino-bc-cli biz-line +list --name <业务线名称>
|
|
211
210
|
sino-bc-cli biz-line +strategies --name <业务线名称>
|
|
212
|
-
sino-bc-cli biz-line +top --industry APP --top-n 5
|
|
213
211
|
|
|
214
212
|
# 切换环境(test / pre / prod)
|
|
215
213
|
sino-bc-cli /set-config env test
|
|
@@ -0,0 +1,287 @@
|
|
|
1
|
+
[
|
|
2
|
+
{
|
|
3
|
+
"name": "biz-line-open-channels",
|
|
4
|
+
"displayName": "查询投放渠道列表",
|
|
5
|
+
"description": "无入参,返回 ChannelEnum 全量:code = 渠道 ID,name = 渠道名称",
|
|
6
|
+
"group": "业务线查询",
|
|
7
|
+
"method": "GET",
|
|
8
|
+
"path": "/sino-opti-hive/biz-line-open/channels",
|
|
9
|
+
"timeout": 20000,
|
|
10
|
+
"tag": "业务线查询",
|
|
11
|
+
"domain": "biz-line",
|
|
12
|
+
"shortcut": "+channels",
|
|
13
|
+
"risk": "read",
|
|
14
|
+
"summary": "查询投放渠道列表",
|
|
15
|
+
"docFile": "biz-line-query.md"
|
|
16
|
+
},
|
|
17
|
+
{
|
|
18
|
+
"name": "biz-line-open-placement-categories",
|
|
19
|
+
"displayName": "查询投放品类字典树",
|
|
20
|
+
"description": "无入参,一级节点 = 投放行业,二级节点 children = 投放品类",
|
|
21
|
+
"group": "业务线查询",
|
|
22
|
+
"method": "GET",
|
|
23
|
+
"path": "/sino-opti-hive/biz-line-open/placement-categories",
|
|
24
|
+
"timeout": 20000,
|
|
25
|
+
"tag": "业务线查询",
|
|
26
|
+
"domain": "biz-line",
|
|
27
|
+
"shortcut": "+categories",
|
|
28
|
+
"risk": "read",
|
|
29
|
+
"summary": "查询投放品类字典树",
|
|
30
|
+
"docFile": "biz-line-query.md"
|
|
31
|
+
},
|
|
32
|
+
{
|
|
33
|
+
"name": "biz-line-list",
|
|
34
|
+
"displayName": "业务线分页列表",
|
|
35
|
+
"description": "result 为分页对象:total = 总条数,result = 当前页 BizLineListVO 列表",
|
|
36
|
+
"group": "业务线策略",
|
|
37
|
+
"method": "POST",
|
|
38
|
+
"path": "/sino-opti-hive/biz-line/list",
|
|
39
|
+
"timeout": 20000,
|
|
40
|
+
"tag": "业务线策略",
|
|
41
|
+
"domain": "biz-line",
|
|
42
|
+
"shortcut": "+list",
|
|
43
|
+
"risk": "read",
|
|
44
|
+
"summary": "业务线分页列表",
|
|
45
|
+
"docFile": "biz-line-strategy.md"
|
|
46
|
+
},
|
|
47
|
+
{
|
|
48
|
+
"name": "biz-line-detail",
|
|
49
|
+
"displayName": "业务线详情",
|
|
50
|
+
"description": "按业务线 ID 查详情,result 为 BizLineDetailVO",
|
|
51
|
+
"group": "业务线策略",
|
|
52
|
+
"method": "POST",
|
|
53
|
+
"path": "/sino-opti-hive/biz-line/detail",
|
|
54
|
+
"timeout": 20000,
|
|
55
|
+
"tag": "业务线策略",
|
|
56
|
+
"domain": "biz-line",
|
|
57
|
+
"shortcut": "+detail",
|
|
58
|
+
"risk": "write",
|
|
59
|
+
"summary": "业务线详情",
|
|
60
|
+
"docFile": "biz-line-strategy.md"
|
|
61
|
+
},
|
|
62
|
+
{
|
|
63
|
+
"name": "biz-line-save",
|
|
64
|
+
"displayName": "新建业务线",
|
|
65
|
+
"description": "⚠️ 写操作:新建业务线,成功时 result 为新建业务线详情",
|
|
66
|
+
"group": "业务线策略",
|
|
67
|
+
"method": "POST",
|
|
68
|
+
"path": "/sino-opti-hive/biz-line/save",
|
|
69
|
+
"timeout": 20000,
|
|
70
|
+
"tag": "业务线策略",
|
|
71
|
+
"domain": "biz-line",
|
|
72
|
+
"shortcut": "+save",
|
|
73
|
+
"risk": "write",
|
|
74
|
+
"summary": "新建业务线",
|
|
75
|
+
"docFile": "biz-line-strategy.md"
|
|
76
|
+
},
|
|
77
|
+
{
|
|
78
|
+
"name": "biz-line-update",
|
|
79
|
+
"displayName": "编辑业务线",
|
|
80
|
+
"description": "⚠️ 写操作:按 ID 编辑业务线,成功时 result 为 Boolean",
|
|
81
|
+
"group": "业务线策略",
|
|
82
|
+
"method": "POST",
|
|
83
|
+
"path": "/sino-opti-hive/biz-line/update",
|
|
84
|
+
"timeout": 20000,
|
|
85
|
+
"tag": "业务线策略",
|
|
86
|
+
"domain": "biz-line",
|
|
87
|
+
"shortcut": "+update",
|
|
88
|
+
"risk": "write",
|
|
89
|
+
"summary": "编辑业务线",
|
|
90
|
+
"docFile": "biz-line-strategy.md"
|
|
91
|
+
},
|
|
92
|
+
{
|
|
93
|
+
"name": "biz-line-status-update",
|
|
94
|
+
"displayName": "切换业务线状态",
|
|
95
|
+
"description": "⚠️ 写操作:仅更新状态与操作人,status 取 1 进行中 / 2 已完成 / 3 已暂停",
|
|
96
|
+
"group": "业务线策略",
|
|
97
|
+
"method": "POST",
|
|
98
|
+
"path": "/sino-opti-hive/biz-line/status/update",
|
|
99
|
+
"timeout": 20000,
|
|
100
|
+
"tag": "业务线策略",
|
|
101
|
+
"domain": "biz-line",
|
|
102
|
+
"shortcut": "+status",
|
|
103
|
+
"risk": "write",
|
|
104
|
+
"summary": "切换业务线状态",
|
|
105
|
+
"docFile": "biz-line-strategy.md"
|
|
106
|
+
},
|
|
107
|
+
{
|
|
108
|
+
"name": "biz-line-del",
|
|
109
|
+
"displayName": "删除业务线",
|
|
110
|
+
"description": "⚠️ 写操作:按 ID 删除业务线,成功时 result 为 Boolean",
|
|
111
|
+
"group": "业务线策略",
|
|
112
|
+
"method": "POST",
|
|
113
|
+
"path": "/sino-opti-hive/biz-line/del",
|
|
114
|
+
"timeout": 20000,
|
|
115
|
+
"tag": "业务线策略",
|
|
116
|
+
"domain": "biz-line",
|
|
117
|
+
"shortcut": "+delete",
|
|
118
|
+
"risk": "write",
|
|
119
|
+
"summary": "删除业务线",
|
|
120
|
+
"docFile": "biz-line-strategy.md"
|
|
121
|
+
},
|
|
122
|
+
{
|
|
123
|
+
"name": "biz-line-list-export",
|
|
124
|
+
"displayName": "业务线列表导出",
|
|
125
|
+
"description": "导出筛选条件下所有业务线数据,result 为 Excel 文件访问 URL",
|
|
126
|
+
"group": "业务线策略",
|
|
127
|
+
"method": "POST",
|
|
128
|
+
"path": "/sino-opti-hive/biz-line/list/export",
|
|
129
|
+
"timeout": 20000,
|
|
130
|
+
"tag": "业务线策略",
|
|
131
|
+
"domain": "biz-line",
|
|
132
|
+
"shortcut": "+export",
|
|
133
|
+
"risk": "write",
|
|
134
|
+
"summary": "业务线列表导出",
|
|
135
|
+
"docFile": "biz-line-strategy.md"
|
|
136
|
+
},
|
|
137
|
+
{
|
|
138
|
+
"name": "biz-line-strategy-list",
|
|
139
|
+
"displayName": "全部策略分页",
|
|
140
|
+
"description": "按业务线分页查周策略,result 为 BizLineStrategyDetailVO 分页对象",
|
|
141
|
+
"group": "业务线策略",
|
|
142
|
+
"method": "POST",
|
|
143
|
+
"path": "/sino-opti-hive/biz-line/strategy/list",
|
|
144
|
+
"timeout": 20000,
|
|
145
|
+
"tag": "业务线策略",
|
|
146
|
+
"domain": "biz-line",
|
|
147
|
+
"shortcut": "+strategies",
|
|
148
|
+
"risk": "read",
|
|
149
|
+
"summary": "全部策略分页",
|
|
150
|
+
"docFile": "biz-line-strategy.md"
|
|
151
|
+
},
|
|
152
|
+
{
|
|
153
|
+
"name": "biz-line-strategy-detail",
|
|
154
|
+
"displayName": "策略详情(编辑返显)",
|
|
155
|
+
"description": "result 为 BizLineStrategyDetailVO,含标签展示文案与乐观锁版本号",
|
|
156
|
+
"group": "业务线策略",
|
|
157
|
+
"method": "POST",
|
|
158
|
+
"path": "/sino-opti-hive/biz-line/strategy/detail",
|
|
159
|
+
"timeout": 20000,
|
|
160
|
+
"tag": "业务线策略",
|
|
161
|
+
"domain": "biz-line",
|
|
162
|
+
"shortcut": "+strategy-detail",
|
|
163
|
+
"risk": "write",
|
|
164
|
+
"summary": "策略详情(编辑返显)",
|
|
165
|
+
"docFile": "biz-line-strategy.md"
|
|
166
|
+
},
|
|
167
|
+
{
|
|
168
|
+
"name": "biz-line-strategy-period-list",
|
|
169
|
+
"displayName": "策略周期列表",
|
|
170
|
+
"description": "按业务线返回全部策略周期,result 含 items 与 total",
|
|
171
|
+
"group": "业务线策略",
|
|
172
|
+
"method": "POST",
|
|
173
|
+
"path": "/sino-opti-hive/biz-line/strategy/period-list",
|
|
174
|
+
"timeout": 20000,
|
|
175
|
+
"tag": "业务线策略",
|
|
176
|
+
"domain": "biz-line",
|
|
177
|
+
"shortcut": "+period-list",
|
|
178
|
+
"risk": "write",
|
|
179
|
+
"summary": "策略周期列表",
|
|
180
|
+
"docFile": "biz-line-strategy.md"
|
|
181
|
+
},
|
|
182
|
+
{
|
|
183
|
+
"name": "biz-line-strategy-preview-info",
|
|
184
|
+
"displayName": "新建策略前置-上期摘要",
|
|
185
|
+
"description": "按目标周期取上期策略摘要,periodExist 标识目标周期是否已有数据",
|
|
186
|
+
"group": "业务线策略",
|
|
187
|
+
"method": "POST",
|
|
188
|
+
"path": "/sino-opti-hive/biz-line/strategy/preview-info",
|
|
189
|
+
"timeout": 20000,
|
|
190
|
+
"tag": "业务线策略",
|
|
191
|
+
"domain": "biz-line",
|
|
192
|
+
"shortcut": "+preview-info",
|
|
193
|
+
"risk": "write",
|
|
194
|
+
"summary": "新建策略前置-上期摘要",
|
|
195
|
+
"docFile": "biz-line-strategy.md"
|
|
196
|
+
},
|
|
197
|
+
{
|
|
198
|
+
"name": "biz-line-strategy-save",
|
|
199
|
+
"displayName": "新建策略",
|
|
200
|
+
"description": "⚠️ 写操作:新建业务线周策略,成功时 result 为 Boolean",
|
|
201
|
+
"group": "业务线策略",
|
|
202
|
+
"method": "POST",
|
|
203
|
+
"path": "/sino-opti-hive/biz-line/strategy/save",
|
|
204
|
+
"timeout": 20000,
|
|
205
|
+
"tag": "业务线策略",
|
|
206
|
+
"domain": "biz-line",
|
|
207
|
+
"shortcut": "+strategy-save",
|
|
208
|
+
"risk": "write",
|
|
209
|
+
"summary": "新建策略",
|
|
210
|
+
"docFile": "biz-line-strategy.md"
|
|
211
|
+
},
|
|
212
|
+
{
|
|
213
|
+
"name": "biz-line-strategy-update",
|
|
214
|
+
"displayName": "编辑策略",
|
|
215
|
+
"description": "⚠️ 写操作:按策略 ID 编辑,version 为乐观锁,overwrite=true 强制覆盖",
|
|
216
|
+
"group": "业务线策略",
|
|
217
|
+
"method": "POST",
|
|
218
|
+
"path": "/sino-opti-hive/biz-line/strategy/update",
|
|
219
|
+
"timeout": 20000,
|
|
220
|
+
"tag": "业务线策略",
|
|
221
|
+
"domain": "biz-line",
|
|
222
|
+
"shortcut": "+strategy-update",
|
|
223
|
+
"risk": "write",
|
|
224
|
+
"summary": "编辑策略",
|
|
225
|
+
"docFile": "biz-line-strategy.md"
|
|
226
|
+
},
|
|
227
|
+
{
|
|
228
|
+
"name": "biz-line-strategy-del",
|
|
229
|
+
"displayName": "删除策略",
|
|
230
|
+
"description": "⚠️ 写操作:按策略 ID 删除,成功时 result 为 Boolean",
|
|
231
|
+
"group": "业务线策略",
|
|
232
|
+
"method": "POST",
|
|
233
|
+
"path": "/sino-opti-hive/biz-line/strategy/del",
|
|
234
|
+
"timeout": 20000,
|
|
235
|
+
"tag": "业务线策略",
|
|
236
|
+
"domain": "biz-line",
|
|
237
|
+
"shortcut": "+strategy-delete",
|
|
238
|
+
"risk": "write",
|
|
239
|
+
"summary": "删除策略",
|
|
240
|
+
"docFile": "biz-line-strategy.md"
|
|
241
|
+
},
|
|
242
|
+
{
|
|
243
|
+
"name": "biz-line-strategy-compare",
|
|
244
|
+
"displayName": "策略对比",
|
|
245
|
+
"description": "对比两期策略,diffFields 给出存在差异的字段名列表",
|
|
246
|
+
"group": "业务线策略",
|
|
247
|
+
"method": "POST",
|
|
248
|
+
"path": "/sino-opti-hive/biz-line/strategy/compare",
|
|
249
|
+
"timeout": 20000,
|
|
250
|
+
"tag": "业务线策略",
|
|
251
|
+
"domain": "biz-line",
|
|
252
|
+
"shortcut": "+compare",
|
|
253
|
+
"risk": "write",
|
|
254
|
+
"summary": "策略对比",
|
|
255
|
+
"docFile": "biz-line-strategy.md"
|
|
256
|
+
},
|
|
257
|
+
{
|
|
258
|
+
"name": "biz-line-strategy-spend",
|
|
259
|
+
"displayName": "策略周期消耗汇总",
|
|
260
|
+
"description": "按策略 ID 汇总周期内关联项目消耗,result 含 totalSpend",
|
|
261
|
+
"group": "业务线策略",
|
|
262
|
+
"method": "POST",
|
|
263
|
+
"path": "/sino-opti-hive/biz-line/strategy/spend",
|
|
264
|
+
"timeout": 20000,
|
|
265
|
+
"tag": "业务线策略",
|
|
266
|
+
"domain": "biz-line",
|
|
267
|
+
"shortcut": "+spend",
|
|
268
|
+
"risk": "write",
|
|
269
|
+
"summary": "策略周期消耗汇总",
|
|
270
|
+
"docFile": "biz-line-strategy.md"
|
|
271
|
+
},
|
|
272
|
+
{
|
|
273
|
+
"name": "biz-line-strategy-exprot-all",
|
|
274
|
+
"displayName": "导出全部策略",
|
|
275
|
+
"description": "导出该业务线全部策略,result 为文件访问 URL(服务端路径拼写为 exprot-all)",
|
|
276
|
+
"group": "业务线策略",
|
|
277
|
+
"method": "POST",
|
|
278
|
+
"path": "/sino-opti-hive/biz-line/strategy/exprot-all",
|
|
279
|
+
"timeout": 20000,
|
|
280
|
+
"tag": "业务线策略",
|
|
281
|
+
"domain": "biz-line",
|
|
282
|
+
"shortcut": "+exprot-all",
|
|
283
|
+
"risk": "write",
|
|
284
|
+
"summary": "导出全部策略",
|
|
285
|
+
"docFile": "biz-line-strategy.md"
|
|
286
|
+
}
|
|
287
|
+
]
|