sino-bc-cli 1.6.0 → 1.8.0
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 +47 -33
- package/dist/SKILL.md +26 -36
- package/dist/api-doc/README.md +17 -42
- package/dist/index.js +1 -1
- package/package.json +1 -1
- package/dist/api-doc/icenter-mcp-strategy-dimension-facebook-ad-list.md +0 -170
- package/dist/api-doc/icenter-mcp-strategy-dimension-google-ad-list.md +0 -170
- package/dist/api-doc/icenter-mcp-strategy-dimension-tiktok-ad-list.md +0 -172
- package/dist/api-doc/icenter-mcp-strategy-metrics-facebook-ad-list.md +0 -202
- package/dist/api-doc/icenter-mcp-strategy-metrics-google-ad-list.md +0 -201
- package/dist/api-doc/icenter-mcp-strategy-metrics-tiktok-ad-list.md +0 -204
- package/dist/api-doc/icenter-mcp-version-query.md +0 -71
package/README.md
CHANGED
|
@@ -140,13 +140,13 @@ sino-bc-cli/
|
|
|
140
140
|
│ │
|
|
141
141
|
│ ├── commands/ # 📦 命令实现层(每命令一个文件,可独立扩展)
|
|
142
142
|
│ │ ├── index.ts # 命令批量注册入口
|
|
143
|
-
│ │ ├── init.command.ts # /init 命令实现(注册 Agent 技能 +
|
|
143
|
+
│ │ ├── init.command.ts # /init 命令实现(注册 Agent 技能 + 初始化变量配置 + 拉取启动 MCP)
|
|
144
144
|
│ │ ├── api-list.command.ts # /api-list 命令实现(列出接口并打开文档)
|
|
145
|
-
│ │ ├── api-endpoint.command.ts #
|
|
146
|
-
│ │ ├── ic-api.command.ts # /ic-api 命令实现(调用 iCenter 接口地址)
|
|
145
|
+
│ │ ├── api-endpoint.command.ts # 接口调用类命令基类(经网关 HTTP 调用)
|
|
147
146
|
│ │ ├── bc-api.command.ts # /bc-api 命令实现(调用业务线查询 / 业务线策略接口)
|
|
148
|
-
│ │ ├── get-config.command.ts # /get-config
|
|
147
|
+
│ │ ├── get-config.command.ts # /get-config 命令实现(查看变量配置与 MCP 配置)
|
|
149
148
|
│ │ ├── set-config.command.ts # /set-config 命令实现(修改变量配置)
|
|
149
|
+
│ │ ├── mcp-reload.command.ts # /mcp-reload 命令实现(按 mcp.json 重启 MCP)
|
|
150
150
|
│ │ └── uninstall.command.ts # /uninstall 命令实现(关闭 MCP、清理技能目录与配置并卸载)
|
|
151
151
|
│ │
|
|
152
152
|
│ ├── utils/ # 🛠 工具类层(高内聚的可复用工具)
|
|
@@ -159,7 +159,8 @@ sino-bc-cli/
|
|
|
159
159
|
│ │ ├── prompt.ts # 终端交互(复用单一 readline 会话:提问、选择、确认)
|
|
160
160
|
│ │ ├── config-store.ts # 变量配置读写(字段元信息 + 读 / 写 / 删)
|
|
161
161
|
│ │ ├── config-prompt.ts # 变量配置交互采集(/init 与 /set-config 共用)
|
|
162
|
-
│ │ ├── mcp-
|
|
162
|
+
│ │ ├── mcp-store.ts # ~/.sino-bc-cli/mcp.json 读写
|
|
163
|
+
│ │ ├── mcp-service.ts # MCP 同步到 Cursor / Codex / Claude / VS Code 并握手
|
|
163
164
|
│ │ └── skill-install.ts # Agent 技能目录的写入与清理
|
|
164
165
|
│ │
|
|
165
166
|
│ ├── types/ # 📝 类型定义层
|
|
@@ -245,8 +246,8 @@ npm run dev -- [参数]
|
|
|
245
246
|
# 示例:查看帮助
|
|
246
247
|
npm run dev -- --help
|
|
247
248
|
|
|
248
|
-
# 示例:执行 /
|
|
249
|
-
npm run dev -- /
|
|
249
|
+
# 示例:执行 /bc-api 命令
|
|
250
|
+
npm run dev -- /bc-api
|
|
250
251
|
```
|
|
251
252
|
|
|
252
253
|
### 5. 全局安装(推荐)
|
|
@@ -269,7 +270,7 @@ npm i sino-bc-cli -g
|
|
|
269
270
|
sino-bc-cli --help
|
|
270
271
|
sino-bc-cli /init
|
|
271
272
|
sino-bc-cli /api-list
|
|
272
|
-
sino-bc-cli /
|
|
273
|
+
sino-bc-cli /bc-api
|
|
273
274
|
```
|
|
274
275
|
|
|
275
276
|
`npm i sino-bc-cli -g` 完成后会自动执行 `/init`,把 `SKILL.md` 写到用户主目录的 Agent 技能目录(`~/.agents/skills/sino-bc-cli` 等)。飞书豆包工作:技能·连接器 → 管理 → **本地** → 刷新。若未出现,手动执行:
|
|
@@ -288,28 +289,27 @@ sino-bc-cli /init
|
|
|
288
289
|
|
|
289
290
|
| 命令 | 说明 |
|
|
290
291
|
| :---------- | :-------------------------------------------------------------------------------------------- |
|
|
291
|
-
| `/init` | 注册 `SKILL.md` 到 Agent
|
|
292
|
+
| `/init` | 注册 `SKILL.md` 到 Agent 技能目录,交互设置环境 / `API_KEY`,并拉取启动 MCP |
|
|
292
293
|
| `/api-list` | 列出全部可调用接口;Cursor / VS Code 终端中 Ctrl+单击接口名或文档路径打开本地文档,也可输入序号或传入 name |
|
|
293
|
-
| `/
|
|
294
|
-
| `/
|
|
295
|
-
| `/
|
|
296
|
-
| `/
|
|
297
|
-
| `/uninstall` |
|
|
294
|
+
| `/bc-api` | 交互选择并调用业务线查询 / 业务线策略接口(共 22 个,路径统一带 `/sino-opti-hive` 前缀);**不接收参数**。经网关 HTTP |
|
|
295
|
+
| `/get-config` | 查看变量配置与 `mcp.json`;密钥默认打码,`--show-secret` 显示明文,`--json` 输出 JSON |
|
|
296
|
+
| `/set-config` | 修改变量配置(环境 / API_KEY);不带参数时逐项交互修改 |
|
|
297
|
+
| `/mcp-reload` | 重新读取 `~/.sino-bc-cli/mcp.json`,同步到 Cursor / Codex / Claude / VS Code 并重新握手 |
|
|
298
|
+
| `/uninstall` | 关闭本 CLI 写入的 MCP,删除技能目录与变量配置文件,并从全局 npm 卸载本 CLI |
|
|
298
299
|
|
|
299
300
|
### 变量配置文件
|
|
300
301
|
|
|
301
|
-
环境、`
|
|
302
|
+
环境、`API_KEY` 存放在 `<用户主目录>/.sino-bc-cli/config.json`。`X-GATEWAY-TYPE` 固定为 `A2C-CLI`,不开放配置。
|
|
303
|
+
|
|
304
|
+
MCP Server 存放在 `<用户主目录>/.sino-bc-cli/mcp.json`,结构与 Cursor 的 `mcp.json` 一致。用户自行增删后执行 `/mcp-reload`,CLI 会同步到 Cursor、Codex、Claude Code、VS Code。
|
|
302
305
|
|
|
303
306
|
| 字段 | 命令行键名 | 默认值 | 说明 |
|
|
304
307
|
| :--- | :--------- | :----- | :--- |
|
|
305
308
|
| `env` | `env` | `prod` | 目标环境,可选 `test` / `pre` / `prod` |
|
|
306
|
-
| `
|
|
307
|
-
| `apiKey` | `api-key` | 内置默认 Key | 网关鉴权用的 API Key |
|
|
308
|
-
| `useMcp` | `use-mcp` | `no` | 是否走 MCP 服务调用接口,`yes` / `no`。为 `yes` 时,`/ic-api`、`/bc-api` 会先启动 MCP 再发请求 |
|
|
309
|
-
| `mcpToken` | `mcp-token` | 内置默认 Token | MCP 网关鉴权 Token;仅 `useMcp=yes` 时询问。过期会提示重输并写回配置文件 |
|
|
309
|
+
| `apiKey` | `api-key` | 内置默认 Key | 网关鉴权用的 API Key(`/bc-api` 使用) |
|
|
310
310
|
|
|
311
311
|
```bash
|
|
312
|
-
#
|
|
312
|
+
# 查看(密钥打码)
|
|
313
313
|
sino-bc-cli /get-config
|
|
314
314
|
|
|
315
315
|
# 三种修改写法等价
|
|
@@ -317,15 +317,29 @@ sino-bc-cli /set-config env test
|
|
|
317
317
|
sino-bc-cli /set-config env=test
|
|
318
318
|
sino-bc-cli /set-config --env=test
|
|
319
319
|
|
|
320
|
-
# 开启后会询问 MCP Token;/ic-api、/bc-api 会先启动 MCP 再发请求
|
|
321
|
-
sino-bc-cli /set-config use-mcp yes
|
|
322
|
-
sino-bc-cli /set-config mcp-token <新 token>
|
|
323
|
-
|
|
324
320
|
# 不带参数则逐项交互修改,直接回车保留当前值
|
|
325
321
|
sino-bc-cli /set-config
|
|
322
|
+
|
|
323
|
+
# 改 MCP:编辑文件后重启
|
|
324
|
+
# %USERPROFILE%\.sino-bc-cli\mcp.json
|
|
325
|
+
sino-bc-cli /mcp-reload
|
|
326
|
+
```
|
|
327
|
+
|
|
328
|
+
```json
|
|
329
|
+
{
|
|
330
|
+
"mcpServers": {
|
|
331
|
+
"example": {
|
|
332
|
+
"type": "streamable-http",
|
|
333
|
+
"url": "https://your-mcp-gateway/mcp/",
|
|
334
|
+
"headers": {
|
|
335
|
+
"Authorization": "Bearer <token>"
|
|
336
|
+
}
|
|
337
|
+
}
|
|
338
|
+
}
|
|
339
|
+
}
|
|
326
340
|
```
|
|
327
341
|
|
|
328
|
-
> `/init`
|
|
342
|
+
> `/init` 结束时自动拉取并启动 `mcp.json`(文件不存在则创建空清单,已存在不覆盖)。非交互环境(npm `postinstall`、CI、Agent 调用)下不提问。MCP 失败只警告。
|
|
329
343
|
|
|
330
344
|
### 全局选项
|
|
331
345
|
|
|
@@ -337,7 +351,7 @@ sino-bc-cli /set-config
|
|
|
337
351
|
|
|
338
352
|
### 环境与请求网关
|
|
339
353
|
|
|
340
|
-
`/
|
|
354
|
+
`/bc-api` 的请求地址由 [`src/constants/gateway.ts`](./src/constants/gateway.ts) 的 `GATEWAY_CONFIG` 决定,命令内部统一走 `joinGatewayUrl(env, path)` 拼接。业务线路径带 `/sino-opti-hive`。iCenter 请写入 `mcp.json` 后 `/mcp-reload`。
|
|
341
355
|
|
|
342
356
|
| `ENV` | 说明 | 网关地址 |
|
|
343
357
|
| :----- | :------- | :----------------------------------- |
|
|
@@ -369,16 +383,16 @@ sino-bc-cli /api-list 3
|
|
|
369
383
|
sino-bc-cli /api-list biz-line-open-list
|
|
370
384
|
```
|
|
371
385
|
|
|
372
|
-
|
|
386
|
+
执行效果:按「业务线查询 / 业务线策略」分组列出全部接口。接口名是终端超链接,文档路径可 Ctrl+单击打开对应 markdown;交互终端也可输入序号。传入序号或接口 `name` 则直接打开该文档。
|
|
373
387
|
|
|
374
|
-
#### ③
|
|
388
|
+
#### ③ 配置并重启 MCP
|
|
375
389
|
|
|
376
390
|
```bash
|
|
377
|
-
sino-bc-cli
|
|
391
|
+
# 编辑 %USERPROFILE%\.sino-bc-cli\mcp.json 后
|
|
392
|
+
sino-bc-cli /mcp-reload
|
|
378
393
|
```
|
|
379
394
|
|
|
380
|
-
|
|
381
|
-
本命令不接收参数,切换环境请先执行 `sino-bc-cli /set-config env <test|pre|prod>`。
|
|
395
|
+
执行效果:把 `mcp.json` 里的 Server 同步到 Cursor(`~/.cursor/mcp.json`)、Codex(`~/.codex/config.toml`)、Claude Code(`~/.claude.json`)、VS Code 用户级 `mcp.json`,并对带 `url` 的 Server 做 initialize 握手。
|
|
382
396
|
|
|
383
397
|
#### ④ 调用业务线查询 / 业务线策略接口
|
|
384
398
|
|
|
@@ -393,9 +407,9 @@ sino-bc-cli /bc-api
|
|
|
393
407
|
#### ⑤ 启用 Debug 模式运行
|
|
394
408
|
|
|
395
409
|
```bash
|
|
396
|
-
sino-bc-cli --debug /
|
|
410
|
+
sino-bc-cli --debug /bc-api
|
|
397
411
|
# 或使用短选项
|
|
398
|
-
sino-bc-cli -d /
|
|
412
|
+
sino-bc-cli -d /bc-api
|
|
399
413
|
```
|
|
400
414
|
|
|
401
415
|
Debug 模式会输出详细的日志,包括参数解析、命令注册、接口调用过程等信息,便于排查问题。
|
package/dist/SKILL.md
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: sino-bc-cli
|
|
3
3
|
description: >
|
|
4
|
-
Use when 查询或操作 BeyondClick
|
|
5
|
-
|
|
4
|
+
Use when 查询或操作 BeyondClick 业务线数据:投放渠道、投放品类、
|
|
5
|
+
业务线列表/详情/策略与表现、Top 业务线、周策略增删改查、
|
|
6
6
|
红绿灯、客户满意度、消耗、ROAS;或用户提到 sino-bc-cli、/init、/api-list、
|
|
7
|
-
/
|
|
7
|
+
/bc-api、/get-config、/set-config、/mcp-reload、/uninstall、
|
|
8
8
|
sino-opti-hive、A2C-CLI。
|
|
9
9
|
metadata:
|
|
10
10
|
requires:
|
|
@@ -13,14 +13,15 @@ metadata:
|
|
|
13
13
|
|
|
14
14
|
# sino-bc-cli
|
|
15
15
|
|
|
16
|
-
BeyondClick
|
|
16
|
+
BeyondClick 业务线策略的 Agent 调用入口。用本 CLI 发现接口和文档,再按用户真实参数请求网关。
|
|
17
|
+
iCenter 不走本 CLI 接口清单:用户把 MCP Server 写进 `~/.sino-bc-cli/mcp.json`,`/init` 或 `/mcp-reload` 会同步到 Cursor / Codex / Claude / VS Code。
|
|
17
18
|
|
|
18
19
|
## When to Use
|
|
19
20
|
|
|
20
|
-
- 查 Facebook / Google / TikTok 广告策略配置、消耗/点击/购买等成效
|
|
21
21
|
- 查投放渠道、投放行业/品类、业务线主数据、周策略与表现、行业 Top
|
|
22
22
|
- 新建/编辑/删除业务线或周策略(须先确认环境和写操作意图)
|
|
23
|
-
- 用户点名 `/api-list`、`/
|
|
23
|
+
- 用户点名 `/api-list`、`/bc-api`、`/mcp-reload`、sino-opti-hive
|
|
24
|
+
- 用户要给 Cursor / Codex / Claude / VS Code 增加或重启 MCP
|
|
24
25
|
|
|
25
26
|
不要用本技能处理:本仓库源码开发、扩展命令、npm 发版(见 `README.md` / `ReleaseSteps.md`)。
|
|
26
27
|
|
|
@@ -29,20 +30,21 @@ BeyondClick 投放数据与业务线策略的 Agent 调用入口。用本 CLI
|
|
|
29
30
|
| 项 | 规则 |
|
|
30
31
|
| --- | --- |
|
|
31
32
|
| 环境 | `test` / `pre` / `prod`,取自变量配置文件,默认 `prod` |
|
|
32
|
-
| 网关 | `https://test-agent.beyondclick.com
|
|
33
|
-
| iCenter 前缀 | `/sino-icenter` |
|
|
33
|
+
| 网关 | `https://test-agent.beyondclick.com`(当前三环境同一地址;`/bc-api` 走网关,不直连服务地址) |
|
|
34
34
|
| 业务线前缀 | `/sino-opti-hive` |
|
|
35
35
|
| 鉴权 | `Authorization: Bearer <API_KEY>`;取自变量配置文件,未设置时用 CLI 内置默认值 |
|
|
36
|
-
| 来源头 | 必须带 `X-GATEWAY-TYPE
|
|
37
|
-
| 请求体 |
|
|
36
|
+
| 来源头 | 必须带 `X-GATEWAY-TYPE: A2C-CLI`(CLI 固定写入,不开放配置) |
|
|
37
|
+
| 请求体 | 按用户条件组装;禁止原样提交文档示例业务线 ID |
|
|
38
|
+
| iCenter / 其他 MCP | 编辑 `~/.sino-bc-cli/mcp.json` 后执行 `sino-bc-cli /mcp-reload` |
|
|
38
39
|
|
|
39
40
|
### 变量配置文件
|
|
40
41
|
|
|
41
|
-
环境、`
|
|
42
|
-
|
|
42
|
+
环境、`API_KEY` 存放在 `<用户主目录>/.sino-bc-cli/config.json`,由 `/init` 创建、`/set-config` 修改。
|
|
43
|
+
MCP Server 存放在 `<用户主目录>/.sino-bc-cli/mcp.json`(与 Cursor 同结构),用户自行增删后执行 `/mcp-reload`。
|
|
44
|
+
需要知道当前生效取值时执行 `sino-bc-cli /get-config --json`(密钥默认打码,加 `--show-secret` 才是明文)。
|
|
43
45
|
|
|
44
|
-
`/
|
|
45
|
-
Agent 在非 TTY
|
|
46
|
+
`/bc-api` 不接收任何参数,且必须在交互式终端里选接口、只用文档默认 body。
|
|
47
|
+
Agent 在非 TTY 下跑这条会直接报错退出;需要真实查询时用 `/api-list` 发现接口后直接 HTTP。
|
|
46
48
|
|
|
47
49
|
## Agent 流程
|
|
48
50
|
|
|
@@ -51,6 +53,7 @@ Agent 在非 TTY 下跑这两条会直接报错退出;需要真实查询时用
|
|
|
51
53
|
3. 写操作(描述含 ⚠️)先向用户确认环境和意图,未确认不发。
|
|
52
54
|
4. 按约定发 GET/POST,解析 `success` / `code` / `message` / `result`。
|
|
53
55
|
5. 回复用业务语言摘要;文档路径写成 Markdown 链接。完整 Key 不要回显。
|
|
56
|
+
6. 用户要查 iCenter 广告策略时,使用已配置的 MCP 工具,不要走 `/bc-api`。
|
|
54
57
|
|
|
55
58
|
```bash
|
|
56
59
|
curl -sS -X POST "https://test-agent.beyondclick.com/sino-opti-hive/biz-line-open/list" \
|
|
@@ -64,18 +67,6 @@ CLI 未安装:`npm i sino-bc-cli@latest -g`(需 Node.js >= 24)。技能未
|
|
|
64
67
|
|
|
65
68
|
## 意图 → 接口
|
|
66
69
|
|
|
67
|
-
### iCenter MCP(`/ic-api`,文档各一份 `<name>.md`)
|
|
68
|
-
|
|
69
|
-
| 用户在问 | name | 注意 |
|
|
70
|
-
| --- | --- | --- |
|
|
71
|
-
| Facebook 广告策略配置(目标/出价/受众/创意,不含消耗) | `icenter-mcp-strategy-dimension-facebook-ad-list` | `dimensionValues` 只能有 `account_id`;账户须 `act_` 前缀;`dimensions` 非空;`country_code` 必须单独传 |
|
|
72
|
-
| Facebook 策略 + 成效(消耗、点击、购买等) | `icenter-mcp-strategy-metrics-facebook-ad-list` | 最多近 21 天;`indicators` 非空 |
|
|
73
|
-
| Google 广告策略配置(成效目标/出价/系列类型,不含消耗) | `icenter-mcp-strategy-dimension-google-ad-list` | 不支持广告目标和兴趣词包;出价用 `cpc_bid_amount` / `cpm_bid_amount` / `cpv_bid_amount`;`country_code` 必须单独传 |
|
|
74
|
-
| Google 策略 + 成效 | `icenter-mcp-strategy-metrics-google-ad-list` | 最多近 21 天;`indicators` 非空 |
|
|
75
|
-
| TikTok 广告策略配置(含转化出价/深度转化出价,不含消耗) | `icenter-mcp-strategy-dimension-tiktok-ad-list` | TikTok 独有 `conversion_bid` / `deep_cpabid`;`country_code` 必须单独传 |
|
|
76
|
-
| TikTok 策略 + 成效 | `icenter-mcp-strategy-metrics-tiktok-ad-list` | 最多近 21 天;`indicators` 非空 |
|
|
77
|
-
| iCenter git 版本 | `icenter-mcp-version-query` | GET,无 body |
|
|
78
|
-
|
|
79
70
|
### 业务线查询(只读,文档 `biz-line-query.md`)
|
|
80
71
|
|
|
81
72
|
| 用户在问 | name | 注意 |
|
|
@@ -108,12 +99,12 @@ CLI 未安装:`npm i sino-bc-cli@latest -g`(需 Node.js >= 24)。技能未
|
|
|
108
99
|
```bash
|
|
109
100
|
sino-bc-cli /api-list
|
|
110
101
|
sino-bc-cli /api-list biz-line-open-list
|
|
111
|
-
sino-bc-cli /ic-api # 交互选接口;不接收参数,用文档示例 body
|
|
112
102
|
sino-bc-cli /bc-api
|
|
113
103
|
|
|
114
|
-
sino-bc-cli /init # 注册技能 +
|
|
115
|
-
sino-bc-cli /get-config #
|
|
104
|
+
sino-bc-cli /init # 注册技能 + 设置环境 / API_KEY,并拉取启动 MCP
|
|
105
|
+
sino-bc-cli /get-config # 查看变量配置与 mcp.json(密钥打码)
|
|
116
106
|
sino-bc-cli /set-config env prod # 改单项;也支持 --env=prod、不带参数逐项交互
|
|
107
|
+
sino-bc-cli /mcp-reload # 按 ~/.sino-bc-cli/mcp.json 重启 MCP
|
|
117
108
|
sino-bc-cli /uninstall # 清理技能目录与配置文件并卸载 CLI
|
|
118
109
|
```
|
|
119
110
|
|
|
@@ -121,12 +112,11 @@ sino-bc-cli /uninstall # 清理技能目录与配置文件并
|
|
|
121
112
|
|
|
122
113
|
| 错误 | 正确做法 |
|
|
123
114
|
| --- | --- |
|
|
124
|
-
| 非 TTY 执行 `/
|
|
125
|
-
| 给 `/
|
|
126
|
-
| 用文档里的 `
|
|
127
|
-
|
|
|
128
|
-
|
|
|
129
|
-
|
|
|
130
|
-
| 直连 `o-test-tc-sino-icenter` / `o-test-sino-opti-hive` 等服务地址 | 一律请求网关 `https://test-agent.beyondclick.com` + 路由前缀 |
|
|
115
|
+
| 非 TTY 执行 `/bc-api` | 这条会报错退出;改直接 HTTP,只用 `/api-list` 发现接口 |
|
|
116
|
+
| 给 `/bc-api` 传环境或 Key | 参数已下线;用 `/set-config` 改、`/get-config` 查 |
|
|
117
|
+
| 用文档里的 `bizLineId: 1251` | 换成用户给出的业务线 |
|
|
118
|
+
| 漏 `X-GATEWAY-TYPE` 或业务线路径前缀 | 带 `A2C-CLI` 与 `/sino-opti-hive` |
|
|
119
|
+
| 直连 `o-test-sino-opti-hive` 等服务地址 | 请求网关 `https://test-agent.beyondclick.com` + `/sino-opti-hive` |
|
|
120
|
+
| 改了 mcp.json 却不重启 | 执行 `sino-bc-cli /mcp-reload` |
|
|
131
121
|
| 未确认就调 save/update/del | 先确认环境与写操作 |
|
|
132
122
|
| 把 `exprot-all` 改成 `export-all` | 按服务端拼写调用 |
|
package/dist/api-doc/README.md
CHANGED
|
@@ -1,18 +1,24 @@
|
|
|
1
1
|
# 接口文档索引
|
|
2
2
|
|
|
3
|
-
本目录汇总 CLI
|
|
3
|
+
本目录汇总 CLI 可交互调用的业务线接口。浏览清单用 `/api-list`(可点击打开本文档),发起调用用 `/bc-api`。
|
|
4
|
+
|
|
5
|
+
iCenter 不再随 CLI 提供接口文档。需要 iCenter 时,把 MCP Server 写进 `~/.sino-bc-cli/mcp.json`,再执行 `/init` 或 `/mcp-reload`,CLI 会同步到 Cursor / Codex / Claude / VS Code。
|
|
4
6
|
|
|
5
7
|
| 分组 | 命令 | 接口数 | 文档 |
|
|
6
8
|
| --- | --- | --- | --- |
|
|
7
|
-
| iCenter MCP | `/ic-api` | 7 | 见下方「iCenter MCP 接口」 |
|
|
8
9
|
| 业务线查询 | `/bc-api` | 5 | [biz-line-query.md](./biz-line-query.md) |
|
|
9
10
|
| 业务线策略 | `/bc-api` | 17 | [biz-line-strategy.md](./biz-line-strategy.md) |
|
|
10
11
|
|
|
11
12
|
---
|
|
12
13
|
|
|
13
|
-
##
|
|
14
|
+
## 调用通道
|
|
15
|
+
|
|
16
|
+
| 范围 | 通道 |
|
|
17
|
+
| --- | --- |
|
|
18
|
+
| `biz-line-query.md` / `biz-line-strategy.md` 与 `/bc-api` | 固定走网关 HTTP,路径带 `/sino-opti-hive` |
|
|
19
|
+
| iCenter 及其他 MCP | 用户编辑 `~/.sino-bc-cli/mcp.json`,由 `/init`、`/mcp-reload` 同步并启动 |
|
|
14
20
|
|
|
15
|
-
|
|
21
|
+
网关地址的唯一来源是 `src/constants/gateway.ts` 的 `GATEWAY_CONFIG`;各文档中出现的上游服务地址(`o-test-sino-opti-hive` 等)仅作接口文档出处,不作为请求地址。
|
|
16
22
|
|
|
17
23
|
| 环境 | 网关地址 |
|
|
18
24
|
| --- | --- |
|
|
@@ -24,26 +30,6 @@
|
|
|
24
30
|
|
|
25
31
|
---
|
|
26
32
|
|
|
27
|
-
## iCenter MCP 接口
|
|
28
|
-
|
|
29
|
-
数据来源:[ContextForge MCP Gateway Admin - Tools](https://o-test-sino-mcp-gateway.meetsocial.cn/admin/?team_id=61761abbe4a4476c84c7df2cd7335a52#tools)
|
|
30
|
-
|
|
31
|
-
筛选规则:`name` 以 `icenter-mcp-` 开头。当前共 **7** 个接口,每个接口一份独立文档。所有路径经网关调用时统一带 `/sino-icenter` 路由前缀,例如 `/sino-icenter/version`。
|
|
32
|
-
|
|
33
|
-
| 文档 | name | 展示名 | 方法 | 说明 |
|
|
34
|
-
| --- | --- | --- | --- | --- |
|
|
35
|
-
| [icenter-mcp-strategy-dimension-facebook-ad-list.md](./icenter-mcp-strategy-dimension-facebook-ad-list.md) | `icenter-mcp-strategy-dimension-facebook-ad-list` | Facebook广告策略维度数据 | POST | 查询 Facebook 广告策略配置(不含成效指标) |
|
|
36
|
-
| [icenter-mcp-strategy-metrics-facebook-ad-list.md](./icenter-mcp-strategy-metrics-facebook-ad-list.md) | `icenter-mcp-strategy-metrics-facebook-ad-list` | Facebook广告策略成效数据 | POST | 查询 Facebook 策略维度 + 成效指标(最多近 21 天) |
|
|
37
|
-
| [icenter-mcp-strategy-dimension-google-ad-list.md](./icenter-mcp-strategy-dimension-google-ad-list.md) | `icenter-mcp-strategy-dimension-google-ad-list` | Google广告策略维度数据 | POST | 查询 Google 广告策略配置(不含成效指标) |
|
|
38
|
-
| [icenter-mcp-strategy-metrics-google-ad-list.md](./icenter-mcp-strategy-metrics-google-ad-list.md) | `icenter-mcp-strategy-metrics-google-ad-list` | Google广告策略成效数据 | POST | 查询 Google 策略维度 + 成效指标(最多近 21 天) |
|
|
39
|
-
| [icenter-mcp-strategy-dimension-tiktok-ad-list.md](./icenter-mcp-strategy-dimension-tiktok-ad-list.md) | `icenter-mcp-strategy-dimension-tiktok-ad-list` | TikTok广告策略维度数据 | POST | 查询 TikTok 广告策略配置(不含成效指标) |
|
|
40
|
-
| [icenter-mcp-strategy-metrics-tiktok-ad-list.md](./icenter-mcp-strategy-metrics-tiktok-ad-list.md) | `icenter-mcp-strategy-metrics-tiktok-ad-list` | TikTok广告策略成效数据 | POST | 查询 TikTok 策略维度 + 成效指标(最多近 21 天) |
|
|
41
|
-
| [icenter-mcp-version-query.md](./icenter-mcp-version-query.md) | `icenter-mcp-version-query` | 查询git最新提交版本 | GET | 查询 iCenter 服务 git 最新提交版本 |
|
|
42
|
-
|
|
43
|
-
对应命令:`/ic-api`,接口清单定义在 `src/constants/api-doc.ts`。
|
|
44
|
-
|
|
45
|
-
---
|
|
46
|
-
|
|
47
33
|
## 业务线接口(sino-opti-hive)
|
|
48
34
|
|
|
49
35
|
数据来源:[sino-opti-hive 接口文档](https://o-test-sino-opti-hive.meetsocial.com/doc.html)
|
|
@@ -71,28 +57,17 @@ sino-bc-cli /api-list 1
|
|
|
71
57
|
sino-bc-cli /api-list biz-line-open-channels
|
|
72
58
|
```
|
|
73
59
|
|
|
74
|
-
`/
|
|
60
|
+
`/bc-api` 交互选接口后经网关发起调用,请求体默认使用各文档「请求示例」;`GET` 接口无请求体。环境与鉴权取自变量配置文件,命令本身不接收参数。
|
|
75
61
|
|
|
76
62
|
```bash
|
|
77
|
-
# iCenter 接口(默认生产环境 + 内置 API Key)
|
|
78
|
-
sino-bc-cli /ic-api
|
|
79
|
-
|
|
80
63
|
# 业务线接口
|
|
81
64
|
sino-bc-cli /bc-api
|
|
82
65
|
|
|
83
|
-
#
|
|
84
|
-
sino-bc-cli /
|
|
85
|
-
|
|
86
|
-
# 指定环境和 API Key
|
|
87
|
-
sino-bc-cli /bc-api pre sk-your-api-key
|
|
88
|
-
|
|
89
|
-
# 选项写法
|
|
90
|
-
sino-bc-cli /bc-api --env=test --api-key=sk-your-api-key
|
|
66
|
+
# 切换环境
|
|
67
|
+
sino-bc-cli /set-config env test
|
|
91
68
|
```
|
|
92
69
|
|
|
93
|
-
|
|
|
94
|
-
| --- | --- | --- |
|
|
95
|
-
| `
|
|
96
|
-
| `API_KEY` |
|
|
97
|
-
|
|
98
|
-
执行后会按分组列出接口,输入序号后按所选环境网关发起调用,并打印响应。
|
|
70
|
+
| 配置 | 默认值 | 说明 |
|
|
71
|
+
| --- | --- | --- |
|
|
72
|
+
| `env` | `prod` | `test` / `pre` / `prod`,用于取 `src/constants/gateway.ts` 中的网关地址 |
|
|
73
|
+
| `API_KEY` | `src/constants/gateway.ts` 的 `DEFAULT_API_KEY` | 注入请求头 `Authorization: Bearer ${API_KEY}`;同时固定注入 `X-GATEWAY-TYPE: A2C-CLI` |
|