sino-bc-cli 1.3.2 → 1.3.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 +15 -3
- package/dist/SKILL.md +2 -1
- package/dist/api-doc/README.md +14 -0
- package/dist/api-doc/biz-line-query.md +2 -0
- package/dist/api-doc/biz-line-strategy.md +2 -0
- package/dist/api-doc/icenter-mcp-strategy-dimension-facebook-ad-list.md +4 -2
- package/dist/api-doc/icenter-mcp-strategy-metrics-facebook-ad-list.md +4 -2
- package/dist/api-doc/icenter-mcp-version-query.md +5 -3
- package/dist/constants/gateway.d.ts +2 -1
- package/dist/constants/gateway.js +13 -7
- package/dist/constants/gateway.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -282,7 +282,7 @@ sino-bc-cli /init
|
|
|
282
282
|
| :---------- | :-------------------------------------------------------------------------------------------- |
|
|
283
283
|
| `/init` | 将本包 `SKILL.md` 复制到用户主目录下的 Agent 技能目录，供飞书豆包工作 / Cursor / Claude / Codex 自动识别 |
|
|
284
284
|
| `/api-list` | 列出全部可调用接口；Cursor / VS Code 终端中 Ctrl+单击接口名或文档路径打开本地文档，也可输入序号或传入 name |
|
|
285
|
-
| `/ic-api` |
|
|
285
|
+
| `/ic-api` | 交互选择并经网关调用 iCenter 接口（路径统一带 `/sino-icenter` 前缀）；`ENV` 默认 `prod`，`API_KEY` 默认使用网关常量 |
|
|
286
286
|
| `/bc-api` | 交互选择并调用业务线查询 / 业务线策略接口（共 22 个，路径统一带 `/sino-opti-hive` 前缀） |
|
|
287
287
|
|
|
288
288
|
### 全局选项
|
|
@@ -293,6 +293,18 @@ sino-bc-cli /init
|
|
|
293
293
|
| `--help` | `-h` | 显示帮助信息 |
|
|
294
294
|
| `--debug` | `-d` | 启用 Debug 日志模式，输出更详细的运行信息 |
|
|
295
295
|
|
|
296
|
+
### 环境与请求网关
|
|
297
|
+
|
|
298
|
+
`/ic-api`、`/bc-api` 的请求地址一律由 [`src/constants/gateway.ts`](./src/constants/gateway.ts) 的 `GATEWAY_CONFIG` 决定，命令内部统一走 `joinGatewayUrl(env, path)` 拼接，不在任何命令或文档里硬编码请求地址。
|
|
299
|
+
|
|
300
|
+
| `ENV` | 说明 | 网关地址 |
|
|
301
|
+
| :----- | :------- | :----------------------------------- |
|
|
302
|
+
| `test` | 测试环境 | `https://test-agent.beyondclick.com` |
|
|
303
|
+
| `pre` | 预发环境 | `https://test-agent.beyondclick.com` |
|
|
304
|
+
| `prod` | 生产环境 | `https://test-agent.beyondclick.com` |
|
|
305
|
+
|
|
306
|
+
> 当前三环境同一地址。换地址只需改 `GATEWAY_CONFIG`，同时同步 [`SKILL.md`](./SKILL.md) 与 [`src/api-doc/`](./src/api-doc/README.md) 中的示例地址。
|
|
307
|
+
|
|
296
308
|
### 使用示例
|
|
297
309
|
|
|
298
310
|
#### ① 查看版本和帮助
|
|
@@ -317,14 +329,14 @@ sino-bc-cli /api-list biz-line-open-list
|
|
|
317
329
|
|
|
318
330
|
执行效果：按「iCenter MCP / 业务线查询 / 业务线策略」分组列出全部接口。接口名是终端超链接，文档路径可 Ctrl+单击打开对应 markdown；交互终端也可输入序号。传入序号或接口 `name` 则直接打开该文档。
|
|
319
331
|
|
|
320
|
-
#### ③
|
|
332
|
+
#### ③ 经网关调用 iCenter 接口
|
|
321
333
|
|
|
322
334
|
```bash
|
|
323
335
|
sino-bc-cli /ic-api
|
|
324
336
|
sino-bc-cli /ic-api test
|
|
325
337
|
```
|
|
326
338
|
|
|
327
|
-
|
|
339
|
+
执行效果：交互选择接口后，向对应环境的网关地址发起请求。所有路径带 `/sino-icenter` 前缀。
|
|
328
340
|
|
|
329
341
|
#### ④ 调用业务线查询 / 业务线策略接口
|
|
330
342
|
|
package/dist/SKILL.md
CHANGED
|
@@ -28,7 +28,7 @@ BeyondClick 投放数据与业务线策略的 Agent 调用入口。用本 CLI
|
|
|
28
28
|
| 项 | 规则 |
|
|
29
29
|
| --- | --- |
|
|
30
30
|
| 环境 | `test` / `pre` / `prod`，未指明默认 `prod` |
|
|
31
|
-
| 网关 | `https://test-agent.beyondclick.com
|
|
31
|
+
| 网关 | `https://test-agent.beyondclick.com`（当前三环境同一地址；所有请求只走网关，不直连服务地址） |
|
|
32
32
|
| iCenter 前缀 | `/sino-icenter` |
|
|
33
33
|
| 业务线前缀 | `/sino-opti-hive` |
|
|
34
34
|
| 鉴权 | `Authorization: Bearer <API_KEY>`；用户未给 Key 时用 CLI 内置默认值 |
|
|
@@ -110,5 +110,6 @@ sino-bc-cli /init
|
|
|
110
110
|
| 用文档里的 `act_…` / `bizLineId: 1251` | 换成用户给出的账户或业务线 |
|
|
111
111
|
| 成效接口一次查超过 21 天 | 拆段或改查维度接口 |
|
|
112
112
|
| 漏 `X-GATEWAY-TYPE` 或路径前缀 | 带 `A2C-CLI`；iCenter / 业务线分别加对应前缀 |
|
|
113
|
+
| 直连 `o-test-tc-sino-icenter` / `o-test-sino-opti-hive` 等服务地址 | 一律请求网关 `https://test-agent.beyondclick.com` + 路由前缀 |
|
|
113
114
|
| 未确认就调 save/update/del | 先确认环境与写操作 |
|
|
114
115
|
| 把 `exprot-all` 改成 `export-all` | 按服务端拼写调用 |
|
package/dist/api-doc/README.md
CHANGED
|
@@ -10,6 +10,20 @@
|
|
|
10
10
|
|
|
11
11
|
---
|
|
12
12
|
|
|
13
|
+
## 请求网关
|
|
14
|
+
|
|
15
|
+
所有接口一律经网关调用，网关地址的唯一来源是 `src/constants/gateway.ts` 的 `GATEWAY_CONFIG`；各文档中出现的上游服务地址（`o-test-tc-sino-icenter`、`o-test-sino-opti-hive` 等）仅作接口文档出处，不作为请求地址。
|
|
16
|
+
|
|
17
|
+
| 环境 | 网关地址 |
|
|
18
|
+
| --- | --- |
|
|
19
|
+
| `test` 测试环境 | `https://test-agent.beyondclick.com` |
|
|
20
|
+
| `pre` 预发环境 | `https://test-agent.beyondclick.com` |
|
|
21
|
+
| `prod` 生产环境 | `https://test-agent.beyondclick.com` |
|
|
22
|
+
|
|
23
|
+
> 当前三环境同一地址；改地址只改 `GATEWAY_CONFIG`，代码通过 `joinGatewayUrl(env, path)` 取值，不要在别处硬编码。
|
|
24
|
+
|
|
25
|
+
---
|
|
26
|
+
|
|
13
27
|
## iCenter MCP 接口
|
|
14
28
|
|
|
15
29
|
数据来源：[ContextForge MCP Gateway Admin - Tools](https://o-test-sino-mcp-gateway.meetsocial.cn/admin/?tools_page=2&tools_size=10&tools_inactive=false#tools)
|
|
@@ -4,6 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
对外开放的只读查询接口，共 **5** 个，均不涉及数据变更。
|
|
6
6
|
|
|
7
|
+
> **网关地址**：`https://test-agent.beyondclick.com`（三环境同一地址，唯一来源 `src/constants/gateway.ts` 的 `GATEWAY_CONFIG`），不要直连 sino-opti-hive 服务地址。
|
|
8
|
+
>
|
|
7
9
|
> **路由前缀**：经网关调用时所有路径需带 `/sino-opti-hive`，例如 `/sino-opti-hive/biz-line-open/channels`。
|
|
8
10
|
|
|
9
11
|
| # | name | 展示名 | 方法 | 路径（含前缀） |
|
|
@@ -4,6 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
业务线主数据与周策略的增删改查，共 **17** 个接口。
|
|
6
6
|
|
|
7
|
+
> **网关地址**：`https://test-agent.beyondclick.com`（三环境同一地址，唯一来源 `src/constants/gateway.ts` 的 `GATEWAY_CONFIG`），不要直连 sino-opti-hive 服务地址。
|
|
8
|
+
>
|
|
7
9
|
> **路由前缀**：经网关调用时所有路径需带 `/sino-opti-hive`，例如 `/sino-opti-hive/biz-line/list`。
|
|
8
10
|
>
|
|
9
11
|
> ⚠️ 标记为「写操作」的接口会变更线上数据，`/bc-api` 会按文档示例请求体直接发起调用，调用前请确认环境。
|
|
@@ -11,12 +11,14 @@
|
|
|
11
11
|
## 接口地址
|
|
12
12
|
|
|
13
13
|
```
|
|
14
|
-
https://
|
|
14
|
+
https://test-agent.beyondclick.com/sino-icenter/mcp/strategy/dimension/facebook/ad/list
|
|
15
15
|
```
|
|
16
16
|
|
|
17
|
-
- **baseUrl**：`https://
|
|
17
|
+
- **baseUrl**：`https://test-agent.beyondclick.com`（网关地址，三环境同一地址，唯一来源 `src/constants/gateway.ts` 的 `GATEWAY_CONFIG`）
|
|
18
18
|
- **path**：`/sino-icenter/mcp/strategy/dimension/facebook/ad/list`
|
|
19
19
|
|
|
20
|
+
> 一律经网关调用，不要直连 iCenter 服务地址。
|
|
21
|
+
|
|
20
22
|
## 说明
|
|
21
23
|
|
|
22
24
|
查询 Facebook（Meta）渠道的广告策略配置数据。按指定广告账户和日期范围，返回广告的策略设置明细（广告目标、成效目标、出价方式、调整出价、受众类型、兴趣词包、年龄、性别等），用于分析某批账户在某段时间内各广告的策略配置分布。
|
|
@@ -11,12 +11,14 @@
|
|
|
11
11
|
## 接口地址
|
|
12
12
|
|
|
13
13
|
```
|
|
14
|
-
https://
|
|
14
|
+
https://test-agent.beyondclick.com/sino-icenter/mcp/strategy/metrics/facebook/ad/list
|
|
15
15
|
```
|
|
16
16
|
|
|
17
|
-
- **baseUrl**：`https://
|
|
17
|
+
- **baseUrl**：`https://test-agent.beyondclick.com`（网关地址，三环境同一地址，唯一来源 `src/constants/gateway.ts` 的 `GATEWAY_CONFIG`）
|
|
18
18
|
- **path**：`/sino-icenter/mcp/strategy/metrics/facebook/ad/list`
|
|
19
19
|
|
|
20
|
+
> 一律经网关调用，不要直连 iCenter 服务地址。
|
|
21
|
+
|
|
20
22
|
## 说明
|
|
21
23
|
|
|
22
24
|
查询 Facebook（Meta）渠道广告的策略维度加成效指标数据。在广告策略配置（广告目标、成效目标、出价方式、受众定向等）的分组下，返回消耗、曝光、点击、购买、安装等成效指标，用于分析哪种策略配置带来更好的投放效果。
|
|
@@ -11,12 +11,14 @@
|
|
|
11
11
|
## 接口地址
|
|
12
12
|
|
|
13
13
|
```
|
|
14
|
-
https://
|
|
14
|
+
https://test-agent.beyondclick.com/sino-icenter/version
|
|
15
15
|
```
|
|
16
16
|
|
|
17
|
-
- **baseUrl**：`https://
|
|
17
|
+
- **baseUrl**：`https://test-agent.beyondclick.com`（网关地址，三环境同一地址，唯一来源 `src/constants/gateway.ts` 的 `GATEWAY_CONFIG`）
|
|
18
18
|
- **path**：`/sino-icenter/version`
|
|
19
19
|
|
|
20
|
+
> 一律经网关调用，不要直连 iCenter 服务地址。
|
|
21
|
+
|
|
20
22
|
## 说明
|
|
21
23
|
|
|
22
24
|
查询 iCenter 服务 git 最新提交版本。无请求参数、无请求体。
|
|
@@ -33,7 +35,7 @@ https://o-test-tc-sino-icenter.meetsocial.com/sino-icenter/version
|
|
|
33
35
|
|
|
34
36
|
```http
|
|
35
37
|
GET /sino-icenter/version HTTP/1.1
|
|
36
|
-
Host:
|
|
38
|
+
Host: test-agent.beyondclick.com
|
|
37
39
|
```
|
|
38
40
|
|
|
39
41
|
## 响应说明
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { EnvName, IGatewayConfig } from '../types';
|
|
2
2
|
/**
|
|
3
|
-
*
|
|
3
|
+
* 调用网关接口时的默认 API Key
|
|
4
4
|
* 请求头：Authorization: Bearer ${API_KEY}
|
|
5
5
|
*/
|
|
6
6
|
export declare const DEFAULT_API_KEY = "eyJraWQiOiIyMDI2MDkwNyIsImFsZyI6IlJTMjU2IiwidHlwIjoiSldUIn0.eyJzdWIiOiI4ODg4IiwiaWF0IjoxNzg4NzY3ODc1LCJleHAiOjE3OTEzNTk4NzV9.I4ZB2b__CYtnzUX2ThKPX3eUPnPdlDzvtZoXZlu-D0BiqsAw7vSsj8GpO-X4CpqwxTpfAKrSZnaIqT9JXVVQcRwmnUdMdbyV6Gm1bTiFoXYD_m2jEuKSpqLYzXVCMFuGfQrYg-FZJFhKcw2vb4i-Mm_Qmtp9AkaSzR6caWlbix9hPrU1JKTLWwFeXpRBu9AxA1rxcya8-aI8PRkTk4rhOzfcQ7Q91CnWmuq4Kfs2e-8t1dTp7TubXfG82wi8CLTkTMa1UrugSdogDqk2g6hiOWsoR6EtFQ3GcECVN1eU8YfiUSfoasXh8LANtuW3bDIJkn6Hn1ltt2d4vP3jOvAHTQ";
|
|
@@ -10,6 +10,7 @@ export declare const GATEWAY_TYPE_HEADER = "X-GATEWAY-TYPE";
|
|
|
10
10
|
export declare const GATEWAY_TYPE_VALUE = "A2C-CLI";
|
|
11
11
|
/**
|
|
12
12
|
* 三环境网关配置
|
|
13
|
+
* 全部请求地址的唯一来源：命令层只经 joinGatewayUrl 取值，不得在别处硬编码
|
|
13
14
|
*/
|
|
14
15
|
export declare const GATEWAY_CONFIG: Record<EnvName, IGatewayConfig>;
|
|
15
16
|
/**
|
|
@@ -51,7 +51,7 @@ const types_1 = require("../types");
|
|
|
51
51
|
/** 合法环境标识列表 */
|
|
52
52
|
const VALID_ENV_NAMES = [types_1.EnvName.TEST, types_1.EnvName.PRE, types_1.EnvName.PROD];
|
|
53
53
|
/**
|
|
54
|
-
*
|
|
54
|
+
* 调用网关接口时的默认 API Key
|
|
55
55
|
* 请求头：Authorization: Bearer ${API_KEY}
|
|
56
56
|
*/
|
|
57
57
|
exports.DEFAULT_API_KEY = "eyJraWQiOiIyMDI2MDkwNyIsImFsZyI6IlJTMjU2IiwidHlwIjoiSldUIn0.eyJzdWIiOiI4ODg4IiwiaWF0IjoxNzg4NzY3ODc1LCJleHAiOjE3OTEzNTk4NzV9.I4ZB2b__CYtnzUX2ThKPX3eUPnPdlDzvtZoXZlu-D0BiqsAw7vSsj8GpO-X4CpqwxTpfAKrSZnaIqT9JXVVQcRwmnUdMdbyV6Gm1bTiFoXYD_m2jEuKSpqLYzXVCMFuGfQrYg-FZJFhKcw2vb4i-Mm_Qmtp9AkaSzR6caWlbix9hPrU1JKTLWwFeXpRBu9AxA1rxcya8-aI8PRkTk4rhOzfcQ7Q91CnWmuq4Kfs2e-8t1dTp7TubXfG82wi8CLTkTMa1UrugSdogDqk2g6hiOWsoR6EtFQ3GcECVN1eU8YfiUSfoasXh8LANtuW3bDIJkn6Hn1ltt2d4vP3jOvAHTQ";
|
|
@@ -59,24 +59,30 @@ exports.DEFAULT_API_KEY = "eyJraWQiOiIyMDI2MDkwNyIsImFsZyI6IlJTMjU2IiwidHlwIjoiS
|
|
|
59
59
|
exports.GATEWAY_TYPE_HEADER = 'X-GATEWAY-TYPE';
|
|
60
60
|
/** 网关固定请求头取值 */
|
|
61
61
|
exports.GATEWAY_TYPE_VALUE = 'A2C-CLI';
|
|
62
|
+
/**
|
|
63
|
+
* 网关地址，当前三环境同一地址
|
|
64
|
+
* 各环境地址拆开后，改为在 GATEWAY_CONFIG 中按环境分别配置
|
|
65
|
+
*/
|
|
66
|
+
const DEFAULT_GATEWAY_BASE_URL = 'https://test-agent.beyondclick.com/';
|
|
62
67
|
/**
|
|
63
68
|
* 三环境网关配置
|
|
69
|
+
* 全部请求地址的唯一来源：命令层只经 joinGatewayUrl 取值，不得在别处硬编码
|
|
64
70
|
*/
|
|
65
71
|
exports.GATEWAY_CONFIG = {
|
|
66
72
|
[types_1.EnvName.TEST]: {
|
|
67
73
|
env: types_1.EnvName.TEST,
|
|
68
|
-
label:
|
|
69
|
-
baseUrl:
|
|
74
|
+
label: '测试环境',
|
|
75
|
+
baseUrl: DEFAULT_GATEWAY_BASE_URL,
|
|
70
76
|
},
|
|
71
77
|
[types_1.EnvName.PRE]: {
|
|
72
78
|
env: types_1.EnvName.PRE,
|
|
73
|
-
label:
|
|
74
|
-
baseUrl:
|
|
79
|
+
label: '预发环境',
|
|
80
|
+
baseUrl: DEFAULT_GATEWAY_BASE_URL,
|
|
75
81
|
},
|
|
76
82
|
[types_1.EnvName.PROD]: {
|
|
77
83
|
env: types_1.EnvName.PROD,
|
|
78
|
-
label:
|
|
79
|
-
baseUrl:
|
|
84
|
+
label: '生产环境',
|
|
85
|
+
baseUrl: DEFAULT_GATEWAY_BASE_URL,
|
|
80
86
|
},
|
|
81
87
|
};
|
|
82
88
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"gateway.js","sourceRoot":"","sources":["../../src/constants/gateway.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
|
1
|
+
{"version":3,"file":"gateway.js","sourceRoot":"","sources":["../../src/constants/gateway.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2DA,4CAEC;AAMD,8CAEC;AAMD,8BAEC;AAOD,wCAIC;AAxFD;;;;;;;GAOG;AACH,0CAA4B;AAC5B,oCAAmD;AAEnD,eAAe;AACf,MAAM,eAAe,GAAc,CAAC,eAAO,CAAC,IAAI,EAAE,eAAO,CAAC,GAAG,EAAE,eAAO,CAAC,IAAI,CAAC,CAAC;AAE7E;;;GAGG;AACU,QAAA,eAAe,GAC1B,qdAAqd,CAAC;AAExd,8BAA8B;AACjB,QAAA,mBAAmB,GAAG,gBAAgB,CAAC;AAEpD,gBAAgB;AACH,QAAA,kBAAkB,GAAG,SAAS,CAAC;AAE5C;;;GAGG;AACH,MAAM,wBAAwB,GAAG,qCAAqC,CAAC;AAEvE;;;GAGG;AACU,QAAA,cAAc,GAAoC;IAC7D,CAAC,eAAO,CAAC,IAAI,CAAC,EAAE;QACd,GAAG,EAAE,eAAO,CAAC,IAAI;QACjB,KAAK,EAAE,MAAM;QACb,OAAO,EAAE,wBAAwB;KAClC;IACD,CAAC,eAAO,CAAC,GAAG,CAAC,EAAE;QACb,GAAG,EAAE,eAAO,CAAC,GAAG;QAChB,KAAK,EAAE,MAAM;QACb,OAAO,EAAE,wBAAwB;KAClC;IACD,CAAC,eAAO,CAAC,IAAI,CAAC,EAAE;QACd,GAAG,EAAE,eAAO,CAAC,IAAI;QACjB,KAAK,EAAE,MAAM;QACb,OAAO,EAAE,wBAAwB;KAClC;CACF,CAAC;AAEF;;;GAGG;AACH,SAAgB,gBAAgB,CAAC,GAAY;IAC3C,OAAO,sBAAc,CAAC,GAAG,CAAC,CAAC;AAC7B,CAAC;AAED;;;GAGG;AACH,SAAgB,iBAAiB,CAAC,GAAY;IAC5C,OAAO,sBAAc,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC;AACrC,CAAC;AAED;;;GAGG;AACH,SAAgB,SAAS,CAAC,KAAc;IACtC,OAAO,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC;AACjE,CAAC;AAED;;;;GAIG;AACH,SAAgB,cAAc,CAAC,GAAY,EAAE,IAAY;IACvD,MAAM,OAAO,GAAG,CAAC,CAAC,OAAO,CAAC,iBAAiB,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC;IACvD,MAAM,cAAc,GAAG,CAAC,CAAC,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC;IACnE,OAAO,GAAG,OAAO,GAAG,cAAc,EAAE,CAAC;AACvC,CAAC"}
|