execute-query.ts•5.55 kB
/**
* execute_query tool - Execute a SQL query against a database
*/
import { Tool } from "@modelcontextprotocol/sdk/types.js";
import { ExecuteQueryInput, RawOutput } from "../types/index.js";
import { createLogger } from "../utils/logger.js";
import { createUsqlError, formatMcpError, sanitizeConnectionString } from "../utils/error-handler.js";
import { validateConnectionString } from "../usql/connection.js";
import { executeUsqlQuery } from "../usql/process-executor.js";
import { parseUsqlError } from "../usql/parser.js";
import { getQueryTimeout, resolveConnectionStringOrDefault } from "../usql/config.js";
const logger = createLogger("usql-mcp:tools:execute-query");
export const executeQuerySchema: Tool = {
name: "execute_query",
description: "Execute a SQL query against a database and return results",
inputSchema: {
type: "object",
properties: {
connection_string: {
type: "string",
description:
'Database connection URL or configured connection name. Can be a full URL (e.g., "postgres://user:pass@localhost/db") or a connection name from env vars (e.g., "oracle" for USQL_ORACLE, "postgres" for USQL_POSTGRES)',
},
query: {
type: "string",
description: "SQL query to execute (SELECT, INSERT, UPDATE, DELETE, etc.)",
},
parameters: {
type: "array",
description: "Optional query parameters for prepared statements",
items: {
type: ["string", "number", "boolean", "null"],
},
},
output_format: {
type: "string",
enum: ["json", "csv"],
description: "Output format for query results (default: json)",
},
timeout_ms: {
type: ["number", "null"],
description: "Optional timeout in milliseconds for this call (overrides defaults). Use null for unlimited.",
minimum: 1,
},
},
required: ["query"],
},
};
export async function handleExecuteQuery(input: ExecuteQueryInput): Promise<RawOutput> {
const outputFormat = input.output_format || "json";
logger.debug("[execute-query] Handling request", {
connectionStringInput: input.connection_string,
queryLength: input.query?.length || 0,
parameterCount: input.parameters?.length || 0,
outputFormat,
});
let resolvedConnectionString: string | undefined;
try {
if (!input.query || typeof input.query !== "string") {
throw createUsqlError("InvalidInput", "query is required and must be a string");
}
// Resolve connection string (could be a name like "oracle" or a full URI)
try {
resolvedConnectionString = resolveConnectionStringOrDefault(input.connection_string);
} catch (error) {
throw createUsqlError("InvalidConnection", `Failed to resolve connection: ${String(error)}`);
}
logger.debug("[execute-query] Resolved connection", {
connectionString: sanitizeConnectionString(resolvedConnectionString),
});
if (!validateConnectionString(resolvedConnectionString)) {
throw createUsqlError(
"InvalidConnection",
`Invalid connection string format: ${resolvedConnectionString}`
);
}
// Process parameters if provided
const processedQuery = input.query;
if (input.parameters && input.parameters.length > 0) {
logger.debug("[execute-query] Processing parameterized query", {
parameterCount: input.parameters.length,
});
// Parameters will be passed via usql's prepared statement handling
// For now, we support basic parameter substitution
}
// Execute query
const timeoutOverride =
input.timeout_ms === null
? undefined
: typeof input.timeout_ms === "number" && Number.isFinite(input.timeout_ms)
? input.timeout_ms
: undefined;
const timeout = timeoutOverride ?? getQueryTimeout();
logger.debug("[execute-query] Executing query with timeout", { timeout });
const result = await executeUsqlQuery(resolvedConnectionString, processedQuery, {
timeout,
format: outputFormat,
});
logger.debug("[execute-query] Query executed", {
exitCode: result.exitCode,
stdoutLength: result.stdout.length,
stderrLength: result.stderr.length,
});
// Check for errors
if (result.exitCode !== 0 && result.stderr) {
const errorMessage = parseUsqlError(result.stderr);
throw createUsqlError("QueryExecutionError", errorMessage, {
exitCode: result.exitCode,
query: input.query.substring(0, 200),
});
}
// Return raw output
logger.debug("[execute-query] Query successful", {
outputFormat,
contentLength: result.stdout.length,
});
return {
format: outputFormat as "json" | "csv",
content: result.stdout,
};
} catch (error) {
// Use user-provided connection string for error details (before resolution)
// This ensures we sanitize what the user actually provided
const connectionForError = input.connection_string || resolvedConnectionString;
const queryForError = typeof input.query === "string" ? input.query.substring(0, 200) : undefined;
const mcpError = formatMcpError(
error,
connectionForError || queryForError
? {
connectionString: connectionForError ? sanitizeConnectionString(connectionForError) : undefined,
query: queryForError,
}
: undefined
);
logger.error("[execute-query] Error executing query", error);
throw mcpError;
}
}