@ibm/ibmi-mcp-server 0.3.2 → 0.4.0

package/dist/ibmi-mcp-server/tools/listSchemas.tool.js

@@ -0,0 +1,195 @@
+/**
+ * List Schemas Tool
+ *
+ * Lists available schemas/libraries on the IBM i system.
+ * Part of the default text-to-SQL toolset.
+ *
+ * @module listSchemas.tool
+ */
+import { z } from "zod";
+import { JsonRpcErrorCode, McpError } from "../../types-global/errors.js";
+import { logger } from "../../utils/internal/logger.js";
+import { IBMiConnectionPool } from "../services/connectionPool.js";
+import { defineTool } from "../../mcp-server/tools/utils/tool-factory.js";
+// =============================================================================
+// Schemas
+// =============================================================================
+const ListSchemasInputSchema = z.object({
+    filter: z
+        .string()
+        .max(128, "Filter pattern cannot exceed 128 characters.")
+        .optional()
+        .describe("Optional schema name pattern to filter results (e.g., 'MY%', 'LIB%'). Uses SQL LIKE syntax."),
+    include_system: z
+        .boolean()
+        .default(false)
+        .describe("Include system schemas (Q* and SYS* prefixed). Default: false."),
+    limit: z
+        .number()
+        .int()
+        .min(1)
+        .max(500)
+        .default(50)
+        .describe("Maximum number of rows to return per page (1-500, default 50)."),
+    offset: z
+        .number()
+        .int()
+        .min(0)
+        .default(0)
+        .describe("Number of rows to skip for pagination (default 0)."),
+});
+const ListSchemasOutputSchema = z.object({
+    success: z.boolean().describe("Whether the query executed successfully."),
+    data: z
+        .array(z.record(z.unknown()))
+        .optional()
+        .describe("Array of schema records. Each record contains: SCHEMA_NAME, SCHEMA_TEXT, SYSTEM_SCHEMA_NAME, SCHEMA_SIZE."),
+    rowCount: z.number().optional().describe("Number of schemas returned."),
+    hasMore: z
+        .boolean()
+        .optional()
+        .describe("Whether more results exist beyond this page."),
+    limit: z.number().optional().describe("Page size used for this request."),
+    offset: z.number().optional().describe("Offset used for this request."),
+    executionTime: z
+        .number()
+        .optional()
+        .describe("Query execution time in milliseconds."),
+    error: z
+        .object({
+        code: z.string().describe("Error code"),
+        message: z.string().describe("Error message"),
+        details: z.record(z.unknown()).optional().describe("Error details"),
+    })
+        .optional()
+        .describe("Error information if the query failed."),
+});
+// =============================================================================
+// Business Logic
+// =============================================================================
+export async function listSchemasLogic(params, appContext, _sdkContext) {
+    logger.debug({ ...appContext, toolInput: params }, "Processing list schemas logic.");
+    const startTime = Date.now();
+    // Build WHERE conditions dynamically
+    const conditions = [];
+    const bindParams = [];
+    if (!params.include_system) {
+        conditions.push("SCHEMA_NAME NOT LIKE 'Q%' AND SCHEMA_NAME NOT LIKE 'SYS%'");
+    }
+    if (params.filter) {
+        conditions.push("SCHEMA_NAME LIKE UPPER(?)");
+        bindParams.push(params.filter);
+    }
+    const whereClause = conditions.length > 0 ? `WHERE ${conditions.join(" AND ")}` : "";
+    const sql = `
+    SELECT SCHEMA_NAME,
+           SCHEMA_TEXT,
+           SYSTEM_SCHEMA_NAME,
+           SCHEMA_SIZE
+    FROM QSYS2.SYSSCHEMAS
+    ${whereClause}
+    ORDER BY SCHEMA_NAME
+    OFFSET ? ROWS FETCH FIRST ? ROWS ONLY
+  `.trim();
+    // Fetch limit+1 to detect if more rows exist beyond this page
+    const fetchLimit = params.limit + 1;
+    bindParams.push(params.offset, fetchLimit);
+    try {
+        const result = await IBMiConnectionPool.executeQuery(sql, bindParams, appContext);
+        const executionTime = Date.now() - startTime;
+        if (!result.data) {
+            return {
+                success: true,
+                data: [],
+                rowCount: 0,
+                hasMore: false,
+                limit: params.limit,
+                offset: params.offset,
+                executionTime,
+            };
+        }
+        const typedData = result.data;
+        // Detect if more rows exist beyond this page
+        const hasMore = (typedData?.length ?? 0) > params.limit;
+        if (hasMore && typedData) {
+            typedData.pop(); // Remove the extra detection row
+        }
+        return {
+            success: true,
+            data: typedData,
+            rowCount: typedData?.length ?? 0,
+            hasMore,
+            limit: params.limit,
+            offset: params.offset,
+            executionTime,
+        };
+    }
+    catch (error) {
+        const executionTime = Date.now() - startTime;
+        logger.error({
+            ...appContext,
+            error: error instanceof Error ? error.message : String(error),
+            executionTime,
+        }, "List schemas query failed.");
+        if (error instanceof McpError) {
+            return {
+                success: false,
+                executionTime,
+                error: {
+                    code: String(error.code),
+                    message: error.message,
+                    details: error.details,
+                },
+            };
+        }
+        return {
+            success: false,
+            executionTime,
+            error: {
+                code: String(JsonRpcErrorCode.DatabaseError),
+                message: `Failed to list schemas: ${error instanceof Error ? error.message : String(error)}`,
+            },
+        };
+    }
+}
+// =============================================================================
+// Response Formatter
+// =============================================================================
+const listSchemasResponseFormatter = (result) => {
+    if (!result.success) {
+        const errorMessage = result.error?.message || "Failed to list schemas";
+        const errorDetails = result.error?.details
+            ? `\n\nDetails:\n${JSON.stringify(result.error.details, null, 2)}`
+            : "";
+        return [{ type: "text", text: `Error: ${errorMessage}${errorDetails}` }];
+    }
+    let paginationInfo = "";
+    if (result.hasMore !== undefined) {
+        paginationInfo = ` (offset ${result.offset}, limit ${result.limit}, hasMore: ${result.hasMore})`;
+    }
+    const resultJson = JSON.stringify(result.data, null, 2);
+    return [
+        {
+            type: "text",
+            text: `Found ${result.rowCount} schemas${paginationInfo}.\nExecution time: ${result.executionTime}ms\n\nSchemas:\n${resultJson}`,
+        },
+    ];
+};
+// =============================================================================
+// Tool Definition
+// =============================================================================
+export const listSchemasTool = defineTool({
+    name: "list_schemas",
+    title: "List Schemas",
+    description: "List available schemas/libraries on the IBM i system. Use this as the first step in schema discovery to find which schemas contain relevant tables.",
+    inputSchema: ListSchemasInputSchema,
+    outputSchema: ListSchemasOutputSchema,
+    logic: listSchemasLogic,
+    responseFormatter: listSchemasResponseFormatter,
+    annotations: {
+        readOnlyHint: true,
+        destructiveHint: false,
+        openWorldHint: false,
+    },
+});
+//# sourceMappingURL=listSchemas.tool.js.map

package/dist/ibmi-mcp-server/tools/listSchemas.tool.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"listSchemas.tool.js","sourceRoot":"","sources":["../../../src/ibmi-mcp-server/tools/listSchemas.tool.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,gBAAgB,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AAE1E,OAAO,EAAE,MAAM,EAAE,MAAM,gCAAgC,CAAC;AAExD,OAAO,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,EAAE,UAAU,EAAE,MAAM,8CAA8C,CAAC;AAG1E,gFAAgF;AAChF,UAAU;AACV,gFAAgF;AAEhF,MAAM,sBAAsB,GAAG,CAAC,CAAC,MAAM,CAAC;IACtC,MAAM,EAAE,CAAC;SACN,MAAM,EAAE;SACR,GAAG,CAAC,GAAG,EAAE,8CAA8C,CAAC;SACxD,QAAQ,EAAE;SACV,QAAQ,CACP,6FAA6F,CAC9F;IACH,cAAc,EAAE,CAAC;SACd,OAAO,EAAE;SACT,OAAO,CAAC,KAAK,CAAC;SACd,QAAQ,CAAC,gEAAgE,CAAC;IAC7E,KAAK,EAAE,CAAC;SACL,MAAM,EAAE;SACR,GAAG,EAAE;SACL,GAAG,CAAC,CAAC,CAAC;SACN,GAAG,CAAC,GAAG,CAAC;SACR,OAAO,CAAC,EAAE,CAAC;SACX,QAAQ,CAAC,gEAAgE,CAAC;IAC7E,MAAM,EAAE,CAAC;SACN,MAAM,EAAE;SACR,GAAG,EAAE;SACL,GAAG,CAAC,CAAC,CAAC;SACN,OAAO,CAAC,CAAC,CAAC;SACV,QAAQ,CAAC,oDAAoD,CAAC;CAClE,CAAC,CAAC;AAEH,MAAM,uBAAuB,GAAG,CAAC,CAAC,MAAM,CAAC;IACvC,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,CAAC,0CAA0C,CAAC;IACzE,IAAI,EAAE,CAAC;SACJ,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;SAC5B,QAAQ,EAAE;SACV,QAAQ,CACP,2GAA2G,CAC5G;IACH,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,6BAA6B,CAAC;IACvE,OAAO,EAAE,CAAC;SACP,OAAO,EAAE;SACT,QAAQ,EAAE;SACV,QAAQ,CAAC,8CAA8C,CAAC;IAC3D,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,kCAAkC,CAAC;IACzE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,+BAA+B,CAAC;IACvE,aAAa,EAAE,CAAC;SACb,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,uCAAuC,CAAC;IACpD,KAAK,EAAE,CAAC;SACL,MAAM,CAAC;QACN,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC;QACvC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,eAAe,CAAC;QAC7C,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,eAAe,CAAC;KACpE,CAAC;SACD,QAAQ,EAAE;SACV,QAAQ,CAAC,wCAAwC,CAAC;CACtD,CAAC,CAAC;AAKH,gFAAgF;AAChF,iBAAiB;AACjB,gFAAgF;AAEhF,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACpC,MAAwB,EACxB,UAA0B,EAC1B,WAAuB;IAEvB,MAAM,CAAC,KAAK,CACV,EAAE,GAAG,UAAU,EAAE,SAAS,EAAE,MAAM,EAAE,EACpC,gCAAgC,CACjC,CAAC;IAEF,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IAE7B,qCAAqC;IACrC,MAAM,UAAU,GAAa,EAAE,CAAC;IAChC,MAAM,UAAU,GAAmB,EAAE,CAAC;IAEtC,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC;QAC3B,UAAU,CAAC,IAAI,CACb,2DAA2D,CAC5D,CAAC;IACJ,CAAC;IAED,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;QAClB,UAAU,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC;QAC7C,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACjC,CAAC;IAED,MAAM,WAAW,GACf,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IAEnE,MAAM,GAAG,GAAG;;;;;;MAMR,WAAW;;;GAGd,CAAC,IAAI,EAAE,CAAC;IAET,8DAA8D;IAC9D,MAAM,UAAU,GAAG,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC;IACpC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IAE3C,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,kBAAkB,CAAC,YAAY,CAClD,GAAG,EACH,UAAU,EACV,UAAU,CACX,CAAC;QAEF,MAAM,aAAa,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC;QAE7C,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;YACjB,OAAO;gBACL,OAAO,EAAE,IAAI;gBACb,IAAI,EAAE,EAAE;gBACR,QAAQ,EAAE,CAAC;gBACX,OAAO,EAAE,KAAK;gBACd,KAAK,EAAE,MAAM,CAAC,KAAK;gBACnB,MAAM,EAAE,MAAM,CAAC,MAAM;gBACrB,aAAa;aACd,CAAC;QACJ,CAAC;QAED,MAAM,SAAS,GAAG,MAAM,CAAC,IAAiC,CAAC;QAE3D,6CAA6C;QAC7C,MAAM,OAAO,GAAG,CAAC,SAAS,EAAE,MAAM,IAAI,CAAC,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC;QACxD,IAAI,OAAO,IAAI,SAAS,EAAE,CAAC;YACzB,SAAS,CAAC,GAAG,EAAE,CAAC,CAAC,iCAAiC;QACpD,CAAC;QAED,OAAO;YACL,OAAO,EAAE,IAAI;YACb,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,SAAS,EAAE,MAAM,IAAI,CAAC;YAChC,OAAO;YACP,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,MAAM,EAAE,MAAM,CAAC,MAAM;YACrB,aAAa;SACd,CAAC;IACJ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,aAAa,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC;QAE7C,MAAM,CAAC,KAAK,CACV;YACE,GAAG,UAAU;YACb,KAAK,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC;YAC7D,aAAa;SACd,EACD,4BAA4B,CAC7B,CAAC;QAEF,IAAI,KAAK,YAAY,QAAQ,EAAE,CAAC;YAC9B,OAAO;gBACL,OAAO,EAAE,KAAK;gBACd,aAAa;gBACb,KAAK,EAAE;oBACL,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC;oBACxB,OAAO,EAAE,KAAK,CAAC,OAAO;oBACtB,OAAO,EAAE,KAAK,CAAC,OAAO;iBACvB;aACF,CAAC;QACJ,CAAC;QAED,OAAO;YACL,OAAO,EAAE,KAAK;YACd,aAAa;YACb,KAAK,EAAE;gBACL,IAAI,EAAE,MAAM,CAAC,gBAAgB,CAAC,aAAa,CAAC;gBAC5C,OAAO,EAAE,2BAA2B,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE;aAC7F;SACF,CAAC;IACJ,CAAC;AACH,CAAC;AAED,gFAAgF;AAChF,qBAAqB;AACrB,gFAAgF;AAEhF,MAAM,4BAA4B,GAAG,CACnC,MAAyB,EACT,EAAE;IAClB,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACpB,MAAM,YAAY,GAAG,MAAM,CAAC,KAAK,EAAE,OAAO,IAAI,wBAAwB,CAAC;QACvE,MAAM,YAAY,GAAG,MAAM,CAAC,KAAK,EAAE,OAAO;YACxC,CAAC,CAAC,iBAAiB,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE;YAClE,CAAC,CAAC,EAAE,CAAC;QACP,OAAO,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,YAAY,GAAG,YAAY,EAAE,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED,IAAI,cAAc,GAAG,EAAE,CAAC;IACxB,IAAI,MAAM,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;QACjC,cAAc,GAAG,YAAY,MAAM,CAAC,MAAM,WAAW,MAAM,CAAC,KAAK,cAAc,MAAM,CAAC,OAAO,GAAG,CAAC;IACnG,CAAC;IAED,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IACxD,OAAO;QACL;YACE,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,SAAS,MAAM,CAAC,QAAQ,WAAW,cAAc,sBAAsB,MAAM,CAAC,aAAa,mBAAmB,UAAU,EAAE;SACjI;KACF,CAAC;AACJ,CAAC,CAAC;AAEF,gFAAgF;AAChF,kBAAkB;AAClB,gFAAgF;AAEhF,MAAM,CAAC,MAAM,eAAe,GAAG,UAAU,CAAC;IACxC,IAAI,EAAE,cAAc;IACpB,KAAK,EAAE,cAAc;IACrB,WAAW,EACT,qJAAqJ;IACvJ,WAAW,EAAE,sBAAsB;IACnC,YAAY,EAAE,uBAAuB;IACrC,KAAK,EAAE,gBAAgB;IACvB,iBAAiB,EAAE,4BAA4B;IAC/C,WAAW,EAAE;QACX,YAAY,EAAE,IAAI;QAClB,eAAe,EAAE,KAAK;QACtB,aAAa,EAAE,KAAK;KACrB;CACF,CAAC,CAAC"}

package/dist/ibmi-mcp-server/tools/listTablesInSchema.tool.d.ts

@@ -0,0 +1,107 @@
+/**
+ * List Tables in Schema Tool
+ *
+ * Lists tables, views, and physical files in a specific schema with metadata
+ * including row counts. Promoted from YAML tool definition.
+ *
+ * @module listTablesInSchema.tool
+ */
+import { z } from "zod";
+import type { RequestContext } from "../../utils/index.js";
+import type { SdkContext } from "../../mcp-server/tools/utils/types.js";
+declare const ListTablesInputSchema: z.ZodObject<{
+    schema_name: z.ZodString;
+    table_filter: z.ZodDefault<z.ZodString>;
+    limit: z.ZodDefault<z.ZodNumber>;
+    offset: z.ZodDefault<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    limit: number;
+    offset: number;
+    schema_name: string;
+    table_filter: string;
+}, {
+    schema_name: string;
+    limit?: number | undefined;
+    offset?: number | undefined;
+    table_filter?: string | undefined;
+}>;
+declare const ListTablesOutputSchema: z.ZodObject<{
+    success: z.ZodBoolean;
+    data: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>, "many">>;
+    rowCount: z.ZodOptional<z.ZodNumber>;
+    hasMore: z.ZodOptional<z.ZodBoolean>;
+    limit: z.ZodOptional<z.ZodNumber>;
+    offset: z.ZodOptional<z.ZodNumber>;
+    executionTime: z.ZodOptional<z.ZodNumber>;
+    error: z.ZodOptional<z.ZodObject<{
+        code: z.ZodString;
+        message: z.ZodString;
+        details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    }, "strip", z.ZodTypeAny, {
+        code: string;
+        message: string;
+        details?: Record<string, unknown> | undefined;
+    }, {
+        code: string;
+        message: string;
+        details?: Record<string, unknown> | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    success: boolean;
+    error?: {
+        code: string;
+        message: string;
+        details?: Record<string, unknown> | undefined;
+    } | undefined;
+    limit?: number | undefined;
+    data?: Record<string, unknown>[] | undefined;
+    executionTime?: number | undefined;
+    rowCount?: number | undefined;
+    offset?: number | undefined;
+    hasMore?: boolean | undefined;
+}, {
+    success: boolean;
+    error?: {
+        code: string;
+        message: string;
+        details?: Record<string, unknown> | undefined;
+    } | undefined;
+    limit?: number | undefined;
+    data?: Record<string, unknown>[] | undefined;
+    executionTime?: number | undefined;
+    rowCount?: number | undefined;
+    offset?: number | undefined;
+    hasMore?: boolean | undefined;
+}>;
+type ListTablesInput = z.infer<typeof ListTablesInputSchema>;
+type ListTablesOutput = z.infer<typeof ListTablesOutputSchema>;
+export declare function listTablesLogic(params: ListTablesInput, appContext: RequestContext, _sdkContext: SdkContext): Promise<ListTablesOutput>;
+export declare const listTablesInSchemaTool: import("../../mcp-server/tools/utils/types.js").ToolDefinition<{
+    schema_name: z.ZodString;
+    table_filter: z.ZodDefault<z.ZodString>;
+    limit: z.ZodDefault<z.ZodNumber>;
+    offset: z.ZodDefault<z.ZodNumber>;
+}, {
+    success: z.ZodBoolean;
+    data: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>, "many">>;
+    rowCount: z.ZodOptional<z.ZodNumber>;
+    hasMore: z.ZodOptional<z.ZodBoolean>;
+    limit: z.ZodOptional<z.ZodNumber>;
+    offset: z.ZodOptional<z.ZodNumber>;
+    executionTime: z.ZodOptional<z.ZodNumber>;
+    error: z.ZodOptional<z.ZodObject<{
+        code: z.ZodString;
+        message: z.ZodString;
+        details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    }, "strip", z.ZodTypeAny, {
+        code: string;
+        message: string;
+        details?: Record<string, unknown> | undefined;
+    }, {
+        code: string;
+        message: string;
+        details?: Record<string, unknown> | undefined;
+    }>>;
+}>;
+export {};
+//# sourceMappingURL=listTablesInSchema.tool.d.ts.map

package/dist/ibmi-mcp-server/tools/listTablesInSchema.tool.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"listTablesInSchema.tool.d.ts","sourceRoot":"","sources":["../../../src/ibmi-mcp-server/tools/listTablesInSchema.tool.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAI3D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uCAAuC,CAAC;AAMxE,QAAA,MAAM,qBAAqB;;;;;;;;;;;;;;;EA4BzB,CAAC;AAEH,QAAA,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA2B1B,CAAC;AAEH,KAAK,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAC7D,KAAK,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAM/D,wBAAsB,eAAe,CACnC,MAAM,EAAE,eAAe,EACvB,UAAU,EAAE,cAAc,EAC1B,WAAW,EAAE,UAAU,GACtB,OAAO,CAAC,gBAAgB,CAAC,CA2G3B;AAoCD,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;EAcjC,CAAC"}

package/dist/ibmi-mcp-server/tools/listTablesInSchema.tool.js

@@ -0,0 +1,198 @@
+/**
+ * List Tables in Schema Tool
+ *
+ * Lists tables, views, and physical files in a specific schema with metadata
+ * including row counts. Promoted from YAML tool definition.
+ *
+ * @module listTablesInSchema.tool
+ */
+import { z } from "zod";
+import { JsonRpcErrorCode, McpError } from "../../types-global/errors.js";
+import { logger } from "../../utils/internal/logger.js";
+import { IBMiConnectionPool } from "../services/connectionPool.js";
+import { defineTool } from "../../mcp-server/tools/utils/tool-factory.js";
+// =============================================================================
+// Schemas
+// =============================================================================
+const ListTablesInputSchema = z.object({
+    schema_name: z
+        .string()
+        .min(1, "Schema name cannot be empty.")
+        .max(128, "Schema name cannot exceed 128 characters.")
+        .describe("Schema name to list tables from (e.g., 'QIWS', 'SAMPLE', 'MYLIB')"),
+    table_filter: z
+        .string()
+        .max(128, "Table filter cannot exceed 128 characters.")
+        .default("*ALL")
+        .describe("Filter tables by name pattern (e.g., 'CUST%', 'ORD%'). Use '*ALL' for all tables."),
+    limit: z
+        .number()
+        .int()
+        .min(1)
+        .max(500)
+        .default(50)
+        .describe("Maximum number of rows to return per page (1-500, default 50)."),
+    offset: z
+        .number()
+        .int()
+        .min(0)
+        .default(0)
+        .describe("Number of rows to skip for pagination (default 0)."),
+});
+const ListTablesOutputSchema = z.object({
+    success: z.boolean().describe("Whether the query executed successfully."),
+    data: z
+        .array(z.record(z.unknown()))
+        .optional()
+        .describe("Array of table records. Each record contains: TABLE_SCHEMA, TABLE_NAME, TABLE_TYPE (T=Table, V=View, P=Physical file), TABLE_TEXT, NUMBER_ROWS, COLUMN_COUNT."),
+    rowCount: z.number().optional().describe("Number of tables returned."),
+    hasMore: z
+        .boolean()
+        .optional()
+        .describe("Whether more results exist beyond this page."),
+    limit: z.number().optional().describe("Page size used for this request."),
+    offset: z.number().optional().describe("Offset used for this request."),
+    executionTime: z
+        .number()
+        .optional()
+        .describe("Query execution time in milliseconds."),
+    error: z
+        .object({
+        code: z.string().describe("Error code"),
+        message: z.string().describe("Error message"),
+        details: z.record(z.unknown()).optional().describe("Error details"),
+    })
+        .optional()
+        .describe("Error information if the query failed."),
+});
+// =============================================================================
+// Business Logic
+// =============================================================================
+export async function listTablesLogic(params, appContext, _sdkContext) {
+    logger.debug({ ...appContext, toolInput: params }, "Processing list tables in schema logic.");
+    const startTime = Date.now();
+    const sql = `
+    SELECT T.TABLE_SCHEMA,
+           T.TABLE_NAME,
+           T.TABLE_TYPE,
+           T.TABLE_TEXT,
+           COALESCE(S.NUMBER_ROWS, 0) AS NUMBER_ROWS,
+           T.COLUMN_COUNT
+    FROM QSYS2.SYSTABLES T
+    LEFT JOIN QSYS2.SYSTABLESTAT S
+      ON T.TABLE_SCHEMA = S.TABLE_SCHEMA
+      AND T.TABLE_NAME = S.TABLE_NAME
+    WHERE T.TABLE_SCHEMA = UPPER(?)
+      AND T.TABLE_TYPE IN ('T', 'V', 'P')
+      AND (? = '*ALL' OR T.TABLE_NAME LIKE UPPER(?))
+    ORDER BY T.TABLE_TYPE, T.TABLE_NAME
+    OFFSET ? ROWS FETCH FIRST ? ROWS ONLY
+  `.trim();
+    // Fetch limit+1 to detect if more rows exist beyond this page
+    const fetchLimit = params.limit + 1;
+    try {
+        const result = await IBMiConnectionPool.executeQuery(sql, [
+            params.schema_name,
+            params.table_filter,
+            params.table_filter,
+            params.offset,
+            fetchLimit,
+        ], appContext);
+        const executionTime = Date.now() - startTime;
+        if (!result.data) {
+            return {
+                success: true,
+                data: [],
+                rowCount: 0,
+                hasMore: false,
+                limit: params.limit,
+                offset: params.offset,
+                executionTime,
+            };
+        }
+        const typedData = result.data;
+        // Detect if more rows exist beyond this page
+        const hasMore = (typedData?.length ?? 0) > params.limit;
+        if (hasMore && typedData) {
+            typedData.pop(); // Remove the extra detection row
+        }
+        return {
+            success: true,
+            data: typedData,
+            rowCount: typedData?.length ?? 0,
+            hasMore,
+            limit: params.limit,
+            offset: params.offset,
+            executionTime,
+        };
+    }
+    catch (error) {
+        const executionTime = Date.now() - startTime;
+        logger.error({
+            ...appContext,
+            error: error instanceof Error ? error.message : String(error),
+            schema: params.schema_name,
+            executionTime,
+        }, "List tables query failed.");
+        if (error instanceof McpError) {
+            return {
+                success: false,
+                executionTime,
+                error: {
+                    code: String(error.code),
+                    message: error.message,
+                    details: error.details,
+                },
+            };
+        }
+        return {
+            success: false,
+            executionTime,
+            error: {
+                code: String(JsonRpcErrorCode.DatabaseError),
+                message: `Failed to list tables: ${error instanceof Error ? error.message : String(error)}`,
+            },
+        };
+    }
+}
+// =============================================================================
+// Response Formatter
+// =============================================================================
+const listTablesResponseFormatter = (result) => {
+    if (!result.success) {
+        const errorMessage = result.error?.message || "Failed to list tables in schema";
+        const errorDetails = result.error?.details
+            ? `\n\nDetails:\n${JSON.stringify(result.error.details, null, 2)}`
+            : "";
+        return [{ type: "text", text: `Error: ${errorMessage}${errorDetails}` }];
+    }
+    let paginationInfo = "";
+    if (result.hasMore !== undefined) {
+        paginationInfo = ` (offset ${result.offset}, limit ${result.limit}, hasMore: ${result.hasMore})`;
+    }
+    const resultJson = JSON.stringify(result.data, null, 2);
+    return [
+        {
+            type: "text",
+            text: `Found ${result.rowCount} tables${paginationInfo}.\nExecution time: ${result.executionTime}ms\n\nTables:\n${resultJson}`,
+        },
+    ];
+};
+// =============================================================================
+// Tool Definition
+// =============================================================================
+export const listTablesInSchemaTool = defineTool({
+    name: "list_tables_in_schema",
+    title: "List Tables in Schema",
+    description: "List tables, views, and physical files in a specific schema with metadata including row counts. Use after list_schemas to find tables before querying column details.",
+    inputSchema: ListTablesInputSchema,
+    outputSchema: ListTablesOutputSchema,
+    logic: listTablesLogic,
+    responseFormatter: listTablesResponseFormatter,
+    annotations: {
+        readOnlyHint: true,
+        destructiveHint: false,
+        openWorldHint: false,
+    },
+});
+//# sourceMappingURL=listTablesInSchema.tool.js.map

package/dist/ibmi-mcp-server/tools/listTablesInSchema.tool.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"listTablesInSchema.tool.js","sourceRoot":"","sources":["../../../src/ibmi-mcp-server/tools/listTablesInSchema.tool.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,gBAAgB,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AAE1E,OAAO,EAAE,MAAM,EAAE,MAAM,gCAAgC,CAAC;AACxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,EAAE,UAAU,EAAE,MAAM,8CAA8C,CAAC;AAG1E,gFAAgF;AAChF,UAAU;AACV,gFAAgF;AAEhF,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAAC;IACrC,WAAW,EAAE,CAAC;SACX,MAAM,EAAE;SACR,GAAG,CAAC,CAAC,EAAE,8BAA8B,CAAC;SACtC,GAAG,CAAC,GAAG,EAAE,2CAA2C,CAAC;SACrD,QAAQ,CACP,mEAAmE,CACpE;IACH,YAAY,EAAE,CAAC;SACZ,MAAM,EAAE;SACR,GAAG,CAAC,GAAG,EAAE,4CAA4C,CAAC;SACtD,OAAO,CAAC,MAAM,CAAC;SACf,QAAQ,CACP,mFAAmF,CACpF;IACH,KAAK,EAAE,CAAC;SACL,MAAM,EAAE;SACR,GAAG,EAAE;SACL,GAAG,CAAC,CAAC,CAAC;SACN,GAAG,CAAC,GAAG,CAAC;SACR,OAAO,CAAC,EAAE,CAAC;SACX,QAAQ,CAAC,gEAAgE,CAAC;IAC7E,MAAM,EAAE,CAAC;SACN,MAAM,EAAE;SACR,GAAG,EAAE;SACL,GAAG,CAAC,CAAC,CAAC;SACN,OAAO,CAAC,CAAC,CAAC;SACV,QAAQ,CAAC,oDAAoD,CAAC;CAClE,CAAC,CAAC;AAEH,MAAM,sBAAsB,GAAG,CAAC,CAAC,MAAM,CAAC;IACtC,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,CAAC,0CAA0C,CAAC;IACzE,IAAI,EAAE,CAAC;SACJ,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;SAC5B,QAAQ,EAAE;SACV,QAAQ,CACP,+JAA+J,CAChK;IACH,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,4BAA4B,CAAC;IACtE,OAAO,EAAE,CAAC;SACP,OAAO,EAAE;SACT,QAAQ,EAAE;SACV,QAAQ,CAAC,8CAA8C,CAAC;IAC3D,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,kCAAkC,CAAC;IACzE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,+BAA+B,CAAC;IACvE,aAAa,EAAE,CAAC;SACb,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,uCAAuC,CAAC;IACpD,KAAK,EAAE,CAAC;SACL,MAAM,CAAC;QACN,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC;QACvC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,eAAe,CAAC;QAC7C,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,eAAe,CAAC;KACpE,CAAC;SACD,QAAQ,EAAE;SACV,QAAQ,CAAC,wCAAwC,CAAC;CACtD,CAAC,CAAC;AAKH,gFAAgF;AAChF,iBAAiB;AACjB,gFAAgF;AAEhF,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,MAAuB,EACvB,UAA0B,EAC1B,WAAuB;IAEvB,MAAM,CAAC,KAAK,CACV,EAAE,GAAG,UAAU,EAAE,SAAS,EAAE,MAAM,EAAE,EACpC,yCAAyC,CAC1C,CAAC;IAEF,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IAE7B,MAAM,GAAG,GAAG;;;;;;;;;;;;;;;;GAgBX,CAAC,IAAI,EAAE,CAAC;IAET,8DAA8D;IAC9D,MAAM,UAAU,GAAG,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC;IAEpC,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,kBAAkB,CAAC,YAAY,CAClD,GAAG,EACH;YACE,MAAM,CAAC,WAAW;YAClB,MAAM,CAAC,YAAY;YACnB,MAAM,CAAC,YAAY;YACnB,MAAM,CAAC,MAAM;YACb,UAAU;SACX,EACD,UAAU,CACX,CAAC;QAEF,MAAM,aAAa,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC;QAE7C,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;YACjB,OAAO;gBACL,OAAO,EAAE,IAAI;gBACb,IAAI,EAAE,EAAE;gBACR,QAAQ,EAAE,CAAC;gBACX,OAAO,EAAE,KAAK;gBACd,KAAK,EAAE,MAAM,CAAC,KAAK;gBACnB,MAAM,EAAE,MAAM,CAAC,MAAM;gBACrB,aAAa;aACd,CAAC;QACJ,CAAC;QAED,MAAM,SAAS,GAAG,MAAM,CAAC,IAAgC,CAAC;QAE1D,6CAA6C;QAC7C,MAAM,OAAO,GAAG,CAAC,SAAS,EAAE,MAAM,IAAI,CAAC,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC;QACxD,IAAI,OAAO,IAAI,SAAS,EAAE,CAAC;YACzB,SAAS,CAAC,GAAG,EAAE,CAAC,CAAC,iCAAiC;QACpD,CAAC;QAED,OAAO;YACL,OAAO,EAAE,IAAI;YACb,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,SAAS,EAAE,MAAM,IAAI,CAAC;YAChC,OAAO;YACP,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,MAAM,EAAE,MAAM,CAAC,MAAM;YACrB,aAAa;SACd,CAAC;IACJ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,aAAa,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC;QAE7C,MAAM,CAAC,KAAK,CACV;YACE,GAAG,UAAU;YACb,KAAK,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC;YAC7D,MAAM,EAAE,MAAM,CAAC,WAAW;YAC1B,aAAa;SACd,EACD,2BAA2B,CAC5B,CAAC;QAEF,IAAI,KAAK,YAAY,QAAQ,EAAE,CAAC;YAC9B,OAAO;gBACL,OAAO,EAAE,KAAK;gBACd,aAAa;gBACb,KAAK,EAAE;oBACL,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC;oBACxB,OAAO,EAAE,KAAK,CAAC,OAAO;oBACtB,OAAO,EAAE,KAAK,CAAC,OAAO;iBACvB;aACF,CAAC;QACJ,CAAC;QAED,OAAO;YACL,OAAO,EAAE,KAAK;YACd,aAAa;YACb,KAAK,EAAE;gBACL,IAAI,EAAE,MAAM,CAAC,gBAAgB,CAAC,aAAa,CAAC;gBAC5C,OAAO,EAAE,0BAA0B,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE;aAC5F;SACF,CAAC;IACJ,CAAC;AACH,CAAC;AAED,gFAAgF;AAChF,qBAAqB;AACrB,gFAAgF;AAEhF,MAAM,2BAA2B,GAAG,CAClC,MAAwB,EACR,EAAE;IAClB,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACpB,MAAM,YAAY,GAChB,MAAM,CAAC,KAAK,EAAE,OAAO,IAAI,iCAAiC,CAAC;QAC7D,MAAM,YAAY,GAAG,MAAM,CAAC,KAAK,EAAE,OAAO;YACxC,CAAC,CAAC,iBAAiB,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE;YAClE,CAAC,CAAC,EAAE,CAAC;QACP,OAAO,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,YAAY,GAAG,YAAY,EAAE,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED,IAAI,cAAc,GAAG,EAAE,CAAC;IACxB,IAAI,MAAM,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;QACjC,cAAc,GAAG,YAAY,MAAM,CAAC,MAAM,WAAW,MAAM,CAAC,KAAK,cAAc,MAAM,CAAC,OAAO,GAAG,CAAC;IACnG,CAAC;IAED,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IACxD,OAAO;QACL;YACE,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,SAAS,MAAM,CAAC,QAAQ,UAAU,cAAc,sBAAsB,MAAM,CAAC,aAAa,kBAAkB,UAAU,EAAE;SAC/H;KACF,CAAC;AACJ,CAAC,CAAC;AAEF,gFAAgF;AAChF,kBAAkB;AAClB,gFAAgF;AAEhF,MAAM,CAAC,MAAM,sBAAsB,GAAG,UAAU,CAAC;IAC/C,IAAI,EAAE,uBAAuB;IAC7B,KAAK,EAAE,uBAAuB;IAC9B,WAAW,EACT,uKAAuK;IACzK,WAAW,EAAE,qBAAqB;IAClC,YAAY,EAAE,sBAAsB;IACpC,KAAK,EAAE,eAAe;IACtB,iBAAiB,EAAE,2BAA2B;IAC9C,WAAW,EAAE;QACX,YAAY,EAAE,IAAI;QAClB,eAAe,EAAE,KAAK;QACtB,aAAa,EAAE,KAAK;KACrB;CACF,CAAC,CAAC"}