sx-platform-mcp 0.0.3 → 0.0.5
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/.env.example +1 -0
- package/dist/index.js +66 -11
- package/package.json +1 -1
package/.env.example
CHANGED
|
@@ -26,6 +26,7 @@ SX_BASE_URL=http://127.0.0.1:8000
|
|
|
26
26
|
|
|
27
27
|
# 其它可选配置(一般不用动):
|
|
28
28
|
# SX_TENANT_ID=000000 兜底租户,调用方没带 sx-tenant-id 时使用
|
|
29
|
+
# SX_API_SECRET= 平台 API Secret;登录换令牌时作为 apiSecret 参数
|
|
29
30
|
# SX_TOOL_GROUPS=all 只注册指定分组,逗号分隔;all 表示不限制
|
|
30
31
|
# SX_TOOL_GROUPS_EXCLUDE= 屏蔽指定分组(优先级高于白名单)
|
|
31
32
|
# SX_ALLOW_WRITES=true 是否允许写操作
|
package/dist/index.js
CHANGED
|
@@ -19776,6 +19776,7 @@ function loadConfig() {
|
|
|
19776
19776
|
account: readSecret("SX_ACCOUNT"),
|
|
19777
19777
|
password: readSecret("SX_PASSWORD"),
|
|
19778
19778
|
passwordMode: readPasswordMode(),
|
|
19779
|
+
apiSecret: readSecret("SX_API_SECRET"),
|
|
19779
19780
|
timeoutMs: envInt(3e4, "SX_TIMEOUT_MS"),
|
|
19780
19781
|
maxResponseChars: envInt(6e4, "SX_MAX_RESPONSE_CHARS"),
|
|
19781
19782
|
allowWrites: envBool(true, "SX_ALLOW_WRITES"),
|
|
@@ -20055,7 +20056,8 @@ var SxClient = class {
|
|
|
20055
20056
|
username: cred.account,
|
|
20056
20057
|
password: toSubmitPassword(cred.password, cred.passwordMode ?? "md5"),
|
|
20057
20058
|
scope: "all",
|
|
20058
|
-
tenantId: tenantId ?? ""
|
|
20059
|
+
tenantId: tenantId ?? "",
|
|
20060
|
+
...this.config.apiSecret === void 0 ? {} : { apiSecret: this.config.apiSecret }
|
|
20059
20061
|
}
|
|
20060
20062
|
});
|
|
20061
20063
|
/**
|
|
@@ -20736,6 +20738,23 @@ function registerTools(server, ctx, tools, options = {}) {
|
|
|
20736
20738
|
const SERVER_INSTRUCTIONS = [
|
|
20737
20739
|
"━━━━ sx-platform 低代码平台 · 通用操作规则 ━━━━",
|
|
20738
20740
|
"",
|
|
20741
|
+
"【做看板/数据分析先找全数据源】不要只查模型设计。",
|
|
20742
|
+
"",
|
|
20743
|
+
" 1. 先用 sx_model 找模型;",
|
|
20744
|
+
" 2. 再用 sx_sql { action:\"list\" } 查 SQL 设计,看有没有现成的 SQL 数据源;",
|
|
20745
|
+
" 3. 选 SQL 时用 sx_sql { action:\"get\" } 读 SQL_EXPR 和 SQL_OTHER;",
|
|
20746
|
+
" 4. SQL_OTHER 含 sqlFileList / orderList / fieldList 三个键;",
|
|
20747
|
+
" fieldList 是字段说明表,做报表/看板前先读,确认字段中文名和类型。",
|
|
20748
|
+
"",
|
|
20749
|
+
"【查询接口选择】默认分页,不要用 list 拉全量。",
|
|
20750
|
+
"",
|
|
20751
|
+
" · 模型数据:优先 sx_dynamic { action:\"page\", current:1, size:20 };",
|
|
20752
|
+
" 需要总数、翻页、大表查询,一律用 page。",
|
|
20753
|
+
" · SQL 数据:优先平台的 sqlPage(分页)接口;不要用 sqlList 拉全量。",
|
|
20754
|
+
" · sx_dynamic { action:\"list\" } 只适合确定很小的数据(字典/配置/少量候选);",
|
|
20755
|
+
" 它不分页、没有 total,maxRows 也不生效;没有过滤条件时平台会返回全部行。",
|
|
20756
|
+
" · 用户说“全部/所有”时,先确认数据量;大表要用 page 分页循环,不要一次 list。",
|
|
20757
|
+
"",
|
|
20739
20758
|
"【工具选择顺序】先用已有工具,不够再查路由。",
|
|
20740
20759
|
"",
|
|
20741
20760
|
" 1. 先根据对话内容和当前上下文判断:常驻工具能不能直接满足?",
|
|
@@ -21360,7 +21379,7 @@ const queryConditionShape = {
|
|
|
21360
21379
|
const dynamicQueryTools = [defineTool({
|
|
21361
21380
|
name: "sx_dynamic",
|
|
21362
21381
|
title: "数据查询(分页/列表/单条/搜索/取数/变更记录/公式)",
|
|
21363
|
-
description: "低代码数据层的**唯一查询入口**。用 `action` 选择查什么:\n\n· **`page`**(最常用)—— 分页查询模型数据,带 total。`current` / `size` **必填且为正整数**。\n 适合「列出/统计满足条件的 X 记录」。「最近 N 条」用 `orderList` + 小 size,不要拉全量再截断。\n· **`list`** ——
|
|
21382
|
+
description: "低代码数据层的**唯一查询入口**。用 `action` 选择查什么:\n\n· **`page`**(最常用)—— 分页查询模型数据,带 total。`current` / `size` **必填且为正整数**。\n 适合「列出/统计满足条件的 X 记录」。「最近 N 条」用 `orderList` + 小 size,不要拉全量再截断。\n· **`list`** —— **仅限确定数据量很小的表**(字典/配置/少量候选);不分页、无 total、`maxRows` 不生效。\n 大表、行数不确定、没有过滤条件时**禁止用 list**,否则平台会全量扫描并可能超时;一律改用 page。\n· **`get`** —— 查单条(按 `sxKey` 或 `queryValue`)。**编辑前先调它**拿全部字段、当前值与 SX_KEY。\n `actionType:\"ADD\"` 返回**带新增默认值**的记录(当前登录人/时间/STATUS 都已填好),不需要定位;\n `EDIT` / `VIEW` / `COPY_ADD` / `CHANGE` 需要定位。\n· **`search`** —— 下拉/自动补全。给定模型与值列/标签列,把编码翻译成文本。\n `fieldDictTable` 传 SX_DICT / SX_DICT_BIZ 表示查平台字典。\n· **`datasource`** —— **通用查数入口**,支持列表、分组汇总、SQL 数据源:\n `dataSourceType:\"model\"`(按模型名)/ `\"sql\"`(按 SQL 编码,多表关联用这个);\n `queryMode:\"2\"`(列表)/ `\"1\"`(分组汇总,需 `groupSumFieldList`);\n `maxRows` **必填**,返回全部传 `-1`,限制行数传正整数。\n `dataAuth`:model 默认 `\"1\"`、sql 默认 `\"2\"`;管理员做看板可显式传 `\"99\"`(不控制权限)。\n `queryColumns` 只对 model 列表生效;`extQueryColumnList` 可加 CASE WHEN 等扩展列。\n `formData` 只对 SQL 模式生效;`sqlAllField:\"1\"` 只对 SQL 列表模式生效。\n ⚠️ groupSum:`\"1\"`=分组字段、`\"3\"`=COUNT、其它=SUM。**不支持 AVG**(自己 SUM÷COUNT)。\n **不要自己写 `sqlField:\"COUNT(1)\"` 配 `groupSum:\"2\"`** —— 会生成 SUM(COUNT(1)) 报 ORA-00937。\n· **`change_log`** —— 单条记录的字段级审计轨迹(旧值/新值/操作人)。需 `sxKey`。\n· **`formula`** —— 服务端公式解析,用于落库前先验证公式写法。\n\n**字段范围**:传 `formCode` 只返回表单字段;传 `modelName` 返回模型全部字段;两者都传时**表单优先**。`allField:\"1\"` 优先于表单。\n不确定列名时:先 `allField:\"1\"` 查一条看真实物理列名。\n`subData:\"2\"` 连带返回子模型数据 —— **这是发现模型关系的正确方式**(子记录 PID = 主记录 ID)。\n\n⚠️ 写操作(保存/批量/删除/锁定等)全部在 `sx_dynamic_save`,本工具只读。",
|
|
21364
21383
|
group: "dynamic",
|
|
21365
21384
|
inputSchema: {
|
|
21366
21385
|
action: enumType(ACTIONS$10).describe("查什么:page / list / get / search / datasource / change_log / formula"),
|
|
@@ -21396,6 +21415,16 @@ const dynamicQueryTools = [defineTool({
|
|
|
21396
21415
|
dicData: stringType().optional().describe("action=search:内联字典的 JSON 字符串,如 [{\"dictKey\":\"1\",\"dictValue\":\"启用\"}]"),
|
|
21397
21416
|
dataSourceType: enumType(["model", "sql"]).optional().describe("action=datasource 必填:model=按模型名取数;sql=按 SQL 编码(多表关联用这个)"),
|
|
21398
21417
|
queryMode: enumType(["1", "2"]).optional().describe("action=datasource 必填:1=分组汇总(需 groupSumFieldList);2=列表明细"),
|
|
21418
|
+
dataAuth: enumType([
|
|
21419
|
+
"1",
|
|
21420
|
+
"2",
|
|
21421
|
+
"99"
|
|
21422
|
+
]).optional().describe("权限控制:model 默认 1、sql 默认 2;管理员做看板可传 99(不控权限)"),
|
|
21423
|
+
extQueryColumnList: arrayType(objectType({
|
|
21424
|
+
fieldName: stringType().describe("结果列名"),
|
|
21425
|
+
fieldRemark: stringType().optional().describe("中文名"),
|
|
21426
|
+
sqlField: stringType().optional().describe("CASE WHEN / 表达式;原样拼 SQL")
|
|
21427
|
+
})).optional().describe("action=datasource + queryMode=2:额外扩展列(如 CASE WHEN)"),
|
|
21399
21428
|
sqlCode: stringType().optional().describe("action=datasource + dataSourceType=sql 必填:SQL 编码"),
|
|
21400
21429
|
groupSumFieldList: arrayType(objectType({
|
|
21401
21430
|
fieldName: stringType().describe("结果列名(分组字段用真实列名,统计列可自定义如 CNT)"),
|
|
@@ -21411,7 +21440,7 @@ const dynamicQueryTools = [defineTool({
|
|
|
21411
21440
|
rowData: recordType(unknownType()).optional().describe("action=formula:行数据,公式中通过 $rowData 访问"),
|
|
21412
21441
|
mainData: recordType(unknownType()).optional().describe("action=formula:主表数据,作为公式变量顶层作用域")
|
|
21413
21442
|
},
|
|
21414
|
-
handler: async (args, { client }) => {
|
|
21443
|
+
handler: async (args, { client, role }) => {
|
|
21415
21444
|
const action = args.action;
|
|
21416
21445
|
let target;
|
|
21417
21446
|
if (NEEDS_TARGET$1.has(action)) {
|
|
@@ -21463,10 +21492,12 @@ const dynamicQueryTools = [defineTool({
|
|
|
21463
21492
|
const rows = Array.isArray(res.data) ? res.data : [];
|
|
21464
21493
|
const hint = emptyResultHint(rows.length === 0 ? 0 : void 0, args.modelName);
|
|
21465
21494
|
const scope = fieldScopeNote(args);
|
|
21495
|
+
const hasFilter = args.queryValue !== void 0 || args.queryParam !== void 0 || args.queryList !== void 0 || args.compoundQuery !== void 0 || args.search !== void 0;
|
|
21466
21496
|
return ok({
|
|
21467
21497
|
returned: rows.length,
|
|
21468
21498
|
...scope ? { fieldScope: scope } : {},
|
|
21469
21499
|
...hint ? { hint } : {},
|
|
21500
|
+
...hasFilter ? {} : { warning: "list 未带过滤条件,平台会返回全部匹配行;大表请改用 action:\"page\" 并带 current/size。" },
|
|
21470
21501
|
data: res.data
|
|
21471
21502
|
});
|
|
21472
21503
|
}
|
|
@@ -21545,6 +21576,10 @@ const dynamicQueryTools = [defineTool({
|
|
|
21545
21576
|
if (args.dataSourceType === "model" && !args.modelName) return fail("dataSourceType=model 时必须传 modelName。可用 sx_model {action:\"list\", scope:\"all\"} 查模型名。");
|
|
21546
21577
|
if (args.dataSourceType === "sql" && !args.sqlCode) return fail("dataSourceType=sql 时必须传 sqlCode(来自 SX_SQL.SQL_CODE,可用 sx_dynamic 查 SX_SQL 获取)。");
|
|
21547
21578
|
if (!args.queryMode) return fail("action=\"datasource\" 必须传 queryMode:1=分组汇总;2=列表明细。示例:queryMode:\"2\"。");
|
|
21579
|
+
if (args.maxRows === void 0) return fail("action=\"datasource\" 必须传 maxRows:返回全部传 -1,限制行数传正整数。");
|
|
21580
|
+
if (args.maxRows < -1) return fail("maxRows 只能是 -1(全部)或 >=0 的整数。");
|
|
21581
|
+
const actualRole = typeof role === "function" ? role() : role;
|
|
21582
|
+
if (args.dataAuth === "99" && actualRole !== "administrator") return fail("dataAuth=99(不控制权限)仅管理员可用。");
|
|
21548
21583
|
if (args.queryMode === "1" && (!args.groupSumFieldList || args.groupSumFieldList.length === 0)) return fail("queryMode=1(分组汇总)必须传 groupSumFieldList。例如:[{fieldName:\"STATUS\",groupSum:\"1\"},{fieldName:\"CNT\",groupSum:\"3\",sqlField:\"ID\"}]");
|
|
21549
21584
|
/**
|
|
21550
21585
|
* ⚠️ **dataAuth 必须按数据源类型传,否则数据权限完全不生效。**
|
|
@@ -21565,7 +21600,7 @@ const dynamicQueryTools = [defineTool({
|
|
|
21565
21600
|
*
|
|
21566
21601
|
* 所以这里一律按类型带上,不做角色判断 —— 少一个分支,也少一处出错机会。
|
|
21567
21602
|
*/
|
|
21568
|
-
const dataAuth = args.dataSourceType === "sql" ? "2" : "1";
|
|
21603
|
+
const dataAuth = args.dataAuth ?? (args.dataSourceType === "sql" ? "2" : "1");
|
|
21569
21604
|
const body = {
|
|
21570
21605
|
dataSourceType: args.dataSourceType,
|
|
21571
21606
|
queryMode: args.queryMode,
|
|
@@ -21575,6 +21610,7 @@ const dynamicQueryTools = [defineTool({
|
|
|
21575
21610
|
maxRows: args.maxRows,
|
|
21576
21611
|
groupSumFieldList: args.groupSumFieldList,
|
|
21577
21612
|
queryColumns: args.queryColumns,
|
|
21613
|
+
extQueryColumnList: args.extQueryColumnList,
|
|
21578
21614
|
orderList: args.orderList,
|
|
21579
21615
|
compoundQuery: args.compoundQuery,
|
|
21580
21616
|
compoundExpr: args.compoundExpr,
|
|
@@ -24399,6 +24435,17 @@ const STANDALONE_PAGE_NOTICE = ["【权限说明】当前身份为普通用户
|
|
|
24399
24435
|
*/
|
|
24400
24436
|
const SECTIONS$4 = {
|
|
24401
24437
|
overview: [
|
|
24438
|
+
"━━ 数据源选择:模型设计 + SQL 设计都要看 ━━",
|
|
24439
|
+
"",
|
|
24440
|
+
"做看板/数据分析时,不要只从模型设计里找数据:",
|
|
24441
|
+
" 1. 先用 sx_model { action:\"list\", scope:\"all\" } 找模型;",
|
|
24442
|
+
" 2. 再用 sx_sql { action:\"list\" } 找现成 SQL 数据源;",
|
|
24443
|
+
" 3. 选 SQL 时用 sx_sql { action:\"get\" } 看 SQL_EXPR 与 SQL_OTHER;",
|
|
24444
|
+
" 4. SQL_OTHER.fieldList 是字段说明表,先读它确认字段中文名/类型;",
|
|
24445
|
+
" 5. 找不到现成 SQL 时,才考虑新建 SQL 或直接查模型。",
|
|
24446
|
+
"",
|
|
24447
|
+
"SQL 设计也是报表/看板/集成流/API 的正式数据源,不要漏掉。",
|
|
24448
|
+
"",
|
|
24402
24449
|
"━━━━ 零、先读 iframe 平台规范(写 HTML 前的硬门槛)━━━━",
|
|
24403
24450
|
"",
|
|
24404
24451
|
"平台自带一份 iframe 动态 HTML 规范,位于:",
|
|
@@ -27854,7 +27901,7 @@ async function findSql(client, sqlCode) {
|
|
|
27854
27901
|
const sqlTools = [{
|
|
27855
27902
|
name: "sx_sql",
|
|
27856
27903
|
title: "SQL 设计(查询 / 详情 / 保存 / 预览 / 删除)",
|
|
27857
|
-
description: "SQL 设计的独立入口。SQL 存在 `SX_SQL`,作为**报表 / 集成流 / API 的数据源**。\n\n· **`list`** —— 列出本租户的 SQL 设计(编码 / 名称 / 归属应用 / 同步状态)。\n· **`get`** ——
|
|
27904
|
+
description: "SQL 设计的独立入口。SQL 存在 `SX_SQL`,作为**报表 / 看板 / 数据分析 / 集成流 / API 的数据源**。\n做数据分析或看板时,除了模型设计,也要先用 `list/get` 查 SQL 设计,确认有没有现成的 SQL 数据源。\n\n· **`list`** —— 列出本租户的 SQL 设计(编码 / 名称 / 归属应用 / 同步状态)。\n· **`get`** —— 取一条的完整配置(`SQL_EXPR` + `SQL_OTHER.sqlFileList/orderList/fieldList`)。\n· **`save`** —— 新建或更新(按 `sqlCode` 判断是否存在)。**更新时先读全量再合并**,不会把 `SQL_OTHER` 里的排序/附件/字段说明配置抹掉。\n· **`preview`** —— 执行一次取数,用来验证语句是否可跑、字段名对不对。\n· **`delete`**(需 `confirm`)—— 逻辑删除。\n\n━━ 关键约束 ━━\n① **`sqlCode` 是唯一业务键**,租户内唯一。建议大写+下划线,如 `RPT_ORDER_LIST`。\n② 预览与查询**必须带 `formCode`**(平台要据此查表单配置)。按平台约定它等于 `sqlCode`,所以省略时工具自动用 `sqlCode` 兜底。\n③ 报表用 `sx_report_create` 生成时,**表单编码就是 sqlCode**,两者天然一致。\n④ 表名请写 `T${SYS.TENANT_ID}_模型名` 而不是写死租户,否则跨租户复制会失效。\n\n━━ SQL 里的可用变量 ━━\n`${SYS.TENANT_ID}` / `${SYS.USER_ID}` / `${SYS.USER_NAME}` / `${SYS.DEPT_ID}` 等,由平台在执行时注入。传 `params` 可额外注入自定义参数。",
|
|
27858
27905
|
group: "form",
|
|
27859
27906
|
mutating: true,
|
|
27860
27907
|
/** 只有 save / delete 改数据;list / get / preview 是纯读。 */
|
|
@@ -27874,6 +27921,7 @@ const sqlTools = [{
|
|
|
27874
27921
|
order: stringType().describe("\"1\"=倒序,其它=正序")
|
|
27875
27922
|
})).optional().describe("save:默认排序,写入 SQL_OTHER.orderList"),
|
|
27876
27923
|
sqlFileList: arrayType(recordType(unknownType())).optional().describe("save:关联附件,写入 SQL_OTHER.sqlFileList。形如 [{fieldName:\"FILE1\", dataIdSource:\"ID\", modelField:\"MES_AFRU.AFRU_IMAGE\"}]"),
|
|
27924
|
+
fieldList: arrayType(recordType(unknownType())).optional().describe("save:字段说明表格,写入 SQL_OTHER.fieldList;常见 {fieldName, fieldRemark, fieldType, fieldLength},结构按平台字段说明表。"),
|
|
27877
27925
|
extra: recordType(unknownType()).optional().describe("save:其它要一并写入 SX_SQL 的字段(UPPER 列名),原样带上"),
|
|
27878
27926
|
keyword: stringType().optional().describe("list:按 SQL_CODE / SQL_NAME 模糊过滤"),
|
|
27879
27927
|
current: numberType().int().positive().optional().describe("list:页码,默认 1"),
|
|
@@ -27949,15 +27997,16 @@ const sqlTools = [{
|
|
|
27949
27997
|
const base = existing ? { ...existing } : {};
|
|
27950
27998
|
delete base.SX_KEY;
|
|
27951
27999
|
let other = base.SQL_OTHER;
|
|
27952
|
-
|
|
28000
|
+
{
|
|
27953
28001
|
let parsed = {};
|
|
27954
28002
|
if (typeof other === "string" && other.trim().startsWith("{")) try {
|
|
27955
28003
|
parsed = JSON.parse(other);
|
|
27956
28004
|
} catch {
|
|
27957
28005
|
parsed = {};
|
|
27958
28006
|
}
|
|
27959
|
-
|
|
27960
|
-
|
|
28007
|
+
parsed.sqlFileList = args.sqlFileList ?? (Array.isArray(parsed.sqlFileList) ? parsed.sqlFileList : []);
|
|
28008
|
+
parsed.orderList = args.orderList ?? (Array.isArray(parsed.orderList) ? parsed.orderList : []);
|
|
28009
|
+
parsed.fieldList = args.fieldList ?? (Array.isArray(parsed.fieldList) ? parsed.fieldList : []);
|
|
27961
28010
|
other = JSON.stringify(parsed);
|
|
27962
28011
|
}
|
|
27963
28012
|
const formValue = {
|
|
@@ -30046,16 +30095,22 @@ const SECTIONS$2 = {
|
|
|
30046
30095
|
" SQL_DATABASE 数据源 ID,一般 null(用默认数据源)",
|
|
30047
30096
|
" APP_ID 所属应用(可空)",
|
|
30048
30097
|
"",
|
|
30049
|
-
"SQL_OTHER
|
|
30098
|
+
"SQL_OTHER 的结构(当前平台维护三个键):",
|
|
30050
30099
|
"```json",
|
|
30051
30100
|
"{",
|
|
30052
30101
|
" \"sqlFileList\": [],",
|
|
30053
30102
|
" \"orderList\": [",
|
|
30054
30103
|
" { \"prop\": \"BARCODE\", \"order\": \"0\" }",
|
|
30055
|
-
" ]",
|
|
30104
|
+
" ],",
|
|
30105
|
+
" \"fieldList\": []",
|
|
30056
30106
|
"}",
|
|
30057
30107
|
"```",
|
|
30058
|
-
"
|
|
30108
|
+
" 三个键即使为空也要保留 —— 平台的列配置/字段说明界面依赖它们存在。",
|
|
30109
|
+
"",
|
|
30110
|
+
"── 字段说明 fieldList ──",
|
|
30111
|
+
" `[{ fieldName, fieldRemark, fieldType, ... }]`",
|
|
30112
|
+
" 保存 SQL 时写入 SQL_OTHER.fieldList;做报表/看板/数据分析时先读它,",
|
|
30113
|
+
" 确认字段中文名和类型,不要只靠 SQL 结果列猜。",
|
|
30059
30114
|
"",
|
|
30060
30115
|
"── 默认排序 orderList(⚠️ 易错)──",
|
|
30061
30116
|
" `[{ prop: \"字段名\", order: \"0\" | \"1\" }]`",
|