bfi-cli 0.1.72 → 0.1.73
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/dist/mcp-db/main.mjs +19 -14
- package/package.json +1 -1
package/dist/mcp-db/main.mjs
CHANGED
|
@@ -164,6 +164,10 @@ var RestError = class extends Error {
|
|
|
164
164
|
this.errorKind = errorKind;
|
|
165
165
|
}
|
|
166
166
|
};
|
|
167
|
+
function requireParam(name, value) {
|
|
168
|
+
if (!value || !value.trim()) throw new RestError("invalid_params", `${name} 不能为空:请从 db_list_envs 返回结果中原样复制(如 env_code=core1_3)`);
|
|
169
|
+
return value;
|
|
170
|
+
}
|
|
167
171
|
async function post(path, payload, fetchImpl = fetch) {
|
|
168
172
|
const token = resolveToken();
|
|
169
173
|
if (!token) throw new RestError("unauthorized", "未找到 bfi token:请先执行 `bfi auth login --token <sk-token>`(token 获取地址 https://bfi.yyuap.com/user/profile),或设置 BFI_TOKEN 环境变量");
|
|
@@ -185,24 +189,24 @@ async function post(path, payload, fetchImpl = fetch) {
|
|
|
185
189
|
if (body.code === 0) return body.data;
|
|
186
190
|
throw new RestError(body.data?.error_kind || "upstream_error", body.msg || "bfi-api 返回错误");
|
|
187
191
|
}
|
|
188
|
-
function listEnvs(keyword, envType, fetchImpl) {
|
|
192
|
+
async function listEnvs(keyword, envType, fetchImpl) {
|
|
189
193
|
return post("/bficli/api/v2/db/envs", {
|
|
190
194
|
keyword,
|
|
191
195
|
env_type: envType,
|
|
192
196
|
enabled_only: true
|
|
193
197
|
}, fetchImpl);
|
|
194
198
|
}
|
|
195
|
-
function execSql(envCode, sql, maxRows, fetchImpl) {
|
|
199
|
+
async function execSql(envCode, sql, maxRows, fetchImpl) {
|
|
196
200
|
return post("/bficli/api/v2/db/exec", {
|
|
197
|
-
env_code: envCode,
|
|
198
|
-
sql,
|
|
201
|
+
env_code: requireParam("env_code", envCode),
|
|
202
|
+
sql: requireParam("sql", sql),
|
|
199
203
|
max_rows: maxRows
|
|
200
204
|
}, fetchImpl);
|
|
201
205
|
}
|
|
202
|
-
function explainSql(envCode, sql, fetchImpl) {
|
|
206
|
+
async function explainSql(envCode, sql, fetchImpl) {
|
|
203
207
|
return post("/bficli/api/v2/db/explain", {
|
|
204
|
-
env_code: envCode,
|
|
205
|
-
sql
|
|
208
|
+
env_code: requireParam("env_code", envCode),
|
|
209
|
+
sql: requireParam("sql", sql)
|
|
206
210
|
}, fetchImpl);
|
|
207
211
|
}
|
|
208
212
|
function textResult(payload, isError = false) {
|
|
@@ -234,7 +238,8 @@ function buildServer() {
|
|
|
234
238
|
}, { instructions: [
|
|
235
239
|
"数据库取证通道(只读):查询环境列表 → EXPLAIN 执行计划(优先)→ 必要时小行数 SELECT 采样。",
|
|
236
240
|
"DDL/DML 默认被环境权限位拒绝;db_direct 为用户自备连接的本地直连,词法级闸门仅放行 SELECT/WITH/EXPLAIN,结果无审计,写报告须标注\"本地直连取证\"。",
|
|
237
|
-
"执行前先用 db_list_envs 锁定 env_code(对应诊断的 appCode 先行铁律)。"
|
|
241
|
+
"执行前先用 db_list_envs 锁定 env_code(对应诊断的 appCode 先行铁律)。",
|
|
242
|
+
"降级链:环境清单匹配不到目标环境(env_not_found),或选中环境连接不可达(connection_failed)时,向用户说明并**提示附上数据库连接串**(mysql://user:pwd@host:3306/db),改走 db_direct 本地直连兜底。"
|
|
238
243
|
].join("\n") });
|
|
239
244
|
server.registerTool("db_list_envs", {
|
|
240
245
|
description: "获取可查询的数据库环境列表(env_code/env_name/db_type/datacenter/权限位 allow_ddl·dml·query·explain)。不含密码。执行任何 SQL 前必须先用本工具锁定 env_code。",
|
|
@@ -250,23 +255,23 @@ function buildServer() {
|
|
|
250
255
|
server.registerTool("db_execute", {
|
|
251
256
|
description: "在指定环境执行单条 SQL(只读取证)。仅 SELECT/WITH/SHOW/DESC/EXPLAIN;DML/DDL 需环境显式授权位否则 permission_denied。行数上限默认 200。非 mysql 库自动翻译(mysql 语法输入即可)。诊断场景优先 db_explain。",
|
|
252
257
|
inputSchema: {
|
|
253
|
-
env_code: z.string().describe("环境编码,来自 db_list_envs"),
|
|
254
|
-
sql: z.string().describe("单条 SQL(mysql 语法)"),
|
|
258
|
+
env_code: z.string().min(1, "env_code 不能为空:请从 db_list_envs 返回的 env_code 字段原样复制(如 core1_3)").describe("环境编码,来自 db_list_envs 返回的 env_code 字段(如 core1_3)原样传入"),
|
|
259
|
+
sql: z.string().min(1, "sql 不能为空").describe("单条 SQL(mysql 语法)"),
|
|
255
260
|
max_rows: z.number().int().min(1).max(2e3).optional().describe("行数上限,默认 200")
|
|
256
261
|
}
|
|
257
262
|
}, wrap((args) => execSql(args.env_code, args.sql, args.max_rows)));
|
|
258
263
|
server.registerTool("db_explain", {
|
|
259
264
|
description: "获取执行计划(慢 SQL 实证首选)。目标语句必须为 SELECT/WITH;gscm 按 db_type 组装 EXPLAIN(oracle 两步 EXPLAIN PLAN + DBMS_XPLAN)。结果为计划行,EXPLAIN 结果进报告须附原始计划行。",
|
|
260
265
|
inputSchema: {
|
|
261
|
-
env_code: z.string().describe("环境编码,来自 db_list_envs"),
|
|
262
|
-
sql: z.string().describe("目标 SELECT/WITH 语句(mysql 语法)")
|
|
266
|
+
env_code: z.string().min(1, "env_code 不能为空:请从 db_list_envs 返回的 env_code 字段原样复制(如 core1_3)").describe("环境编码,来自 db_list_envs 返回的 env_code 字段(如 core1_3)原样传入"),
|
|
267
|
+
sql: z.string().min(1, "sql 不能为空").describe("目标 SELECT/WITH 语句(mysql 语法)")
|
|
263
268
|
}
|
|
264
269
|
}, wrap((args) => explainSql(args.env_code, args.sql)));
|
|
265
270
|
server.registerTool("db_direct", {
|
|
266
271
|
description: "用户自备连接串的本地直连(不经服务端,无审计)。词法级闸门仅放行单条 SELECT/WITH/EXPLAIN(EXPLAIN ANALYZE 拒绝),执行前连接预检。仅当用户明确提供连接串且环境通道不可达时使用;报告引用本工具结果必须标注\"本地直连取证\"。",
|
|
267
272
|
inputSchema: {
|
|
268
|
-
dsn: z.string().describe("连接串 mysql://user:pwd@host:3306/db(密码仅内存持有)"),
|
|
269
|
-
sql: z.string().describe("单条 SELECT/WITH/EXPLAIN"),
|
|
273
|
+
dsn: z.string().min(1, "dsn 不能为空").describe("连接串 mysql://user:pwd@host:3306/db(密码仅内存持有)"),
|
|
274
|
+
sql: z.string().min(1, "sql 不能为空").describe("单条 SELECT/WITH/EXPLAIN"),
|
|
270
275
|
max_rows: z.number().int().min(1).max(2e3).optional().describe("行数上限,默认 200")
|
|
271
276
|
}
|
|
272
277
|
}, wrap((args) => directExecute(args.dsn, args.sql, args.max_rows)));
|