github/dbx
4
0
Fork 0
mirror of https://github.com/t8y2/dbx.git synced 2026-10-20 00:17:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix(mcp): resolve Dameng metadata schema

Browse Source
This commit is contained in:
t8y2
2026-07-11 00:49:43 +08:00
parent 3a5ef776b1
commit 47ba8a2f3b
2 changed files with 73 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/mcp-server/src/index.ts
+20 -6
View File
@@ -40,6 +40,18 @@ function withDatabase(config: ConnectionConfig, database?: string): ConnectionCo
return database === undefined ? config : { ...config, database };
}
function metadataScope(config: ConnectionConfig, database?: string, schema?: string): { config: ConnectionConfig; schema?: string } {
if (config.db_type !== "dameng") {
return { config: withDatabase(config, database), schema };
}
// Dameng exposes tables under user-owned schemas rather than separate
// databases. Accept the legacy database argument as a schema, and default to
// the login user when neither argument is provided.
const resolvedSchema = schema?.trim() || database?.trim() || config.username?.trim() || undefined;
return { config, schema: resolvedSchema };
}
function connectionIdentity(config: ConnectionConfig): string {
return `${config.name} (${config.id}) [${config.db_type} @ ${config.host}:${config.port}]`;
}
@@ -177,14 +189,15 @@ export function createDbxMcpServer(backend: Backend, options: { isWebMode?: bool
{
connection_id: z.string().optional().describe("Unique ID of the DBX connection (use this to disambiguate when multiple connections share the same name)"),
connection_name: z.string().optional().describe("Name of the DBX connection"),
database: z.string().optional().describe("Database name"),
schema: z.string().optional().describe("Schema name (default: public for PostgreSQL)"),
database: z.string().optional().describe("Database name; for Dameng this is also accepted as a schema alias"),
schema: z.string().optional().describe("Schema name (default: public for PostgreSQL, login user for Dameng)"),
},
async ({ connection_id, connection_name, database, schema }) => {
const { config, error } = await resolveConnection(backend, scope, connection_id, connection_name);
if (error) return error;
const resolvedConfig = config!;
const tables = await backend.listTables(withDatabase(resolvedConfig, database ?? scope.database), schema);
const scopeValue = metadataScope(resolvedConfig, database ?? scope.database, schema);
const tables = await backend.listTables(scopeValue.config, scopeValue.schema);
if (tables.length === 0) return text("No tables found.");
const rows = tables.map((t) => [t.name, t.type]);
return labeledText(resolvedConfig, mdTable(["Table", "Type"], rows));
@@ -198,14 +211,15 @@ export function createDbxMcpServer(backend: Backend, options: { isWebMode?: bool
connection_id: z.string().optional().describe("Unique ID of the DBX connection (use this to disambiguate when multiple connections share the same name)"),
connection_name: z.string().optional().describe("Name of the DBX connection"),
table: z.string().describe("Table name"),
database: z.string().optional().describe("Database name"),
schema: z.string().optional().describe("Schema name (default: public for PostgreSQL)"),
database: z.string().optional().describe("Database name; for Dameng this is also accepted as a schema alias"),
schema: z.string().optional().describe("Schema name (default: public for PostgreSQL, login user for Dameng)"),
},
async ({ connection_id, connection_name, table, database, schema }) => {
const { config, error } = await resolveConnection(backend, scope, connection_id, connection_name);
if (error) return error;
const resolvedConfig = config!;
const columns = await backend.describeTable(withDatabase(resolvedConfig, database ?? scope.database), table, schema);
const scopeValue = metadataScope(resolvedConfig, database ?? scope.database, schema);
const columns = await backend.describeTable(scopeValue.config, table, scopeValue.schema);
if (columns.length === 0) return text("No columns found.");
const rows = columns.map((c) => [c.is_primary_key ? `${c.name} (PK)` : c.name, c.data_type, c.is_nullable ? "YES" : "NO", c.column_default ?? "", c.comment ?? ""]);
return labeledText(resolvedConfig, mdTable(["Column", "Type", "Nullable", "Default", "Comment"], rows));
packages/mcp-server/tests/server.test.ts
+53
View File
@@ -355,6 +355,59 @@ test("mongodb describe table returns inferred document fields", async () => {
assert.match(result.content[0].text, /name/);
});
test("dameng metadata tools default to the login user schema", async () => {
const damengConnection: ConnectionConfig = {
...connection,
db_type: "dameng",
username: "SYSDBA",
database: "DAMENG",
};
const usedScopes: Array<{ database?: string; schema?: string }> = [];
const scopedBackend: Backend = {
...backend,
loadConnections: async () => [damengConnection],
listTables: async (config, schema) => {
usedScopes.push({ database: config.database, schema });
return [{ name: "ORDERS", type: "TABLE" }];
},
describeTable: async (config, _table, schema) => {
usedScopes.push({ database: config.database, schema });
return [{ name: "ID", data_type: "BIGINT", is_nullable: false, column_default: null, is_primary_key: true, comment: null }];
},
};
const server = createDbxMcpServer(scopedBackend, { isWebMode: true });
await (server as any)._registeredTools.dbx_list_tables.handler({ connection_name: "local" });
await (server as any)._registeredTools.dbx_describe_table.handler({ connection_name: "local", table: "ORDERS" });
assert.deepEqual(usedScopes, [
{ database: "DAMENG", schema: "SYSDBA" },
{ database: "DAMENG", schema: "SYSDBA" },
]);
});
test("dameng metadata tools treat database as a schema alias while preferring explicit schema", async () => {
const damengConnection: ConnectionConfig = { ...connection, db_type: "dameng", username: "SYSDBA", database: "DAMENG" };
let usedSchema = "";
const scopedBackend: Backend = {
...backend,
loadConnections: async () => [damengConnection],
listTables: async (_config, schema) => {
usedSchema = schema || "";
return [{ name: "ORDERS", type: "TABLE" }];
},
};
const server = createDbxMcpServer(scopedBackend, { isWebMode: true });
await (server as any)._registeredTools.dbx_list_tables.handler({ connection_name: "local", database: "XC" });
assert.equal(usedSchema, "XC");
await (server as any)._registeredTools.dbx_list_tables.handler({ connection_name: "local", database: "XC", schema: "REPORTING" });
assert.equal(usedSchema, "REPORTING");
});
test("mongodb execute query formats shell-style find results", async () => {
const mongoConnection: ConnectionConfig = { ...connection, db_type: "mongodb" };
const scopedBackend: Backend = {