@cplace/test-mcp-server 1.0.0 → 1.1.0

package/dist/tools/board-widget.d.ts

@@ -0,0 +1,432 @@
+import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import { z } from "zod";
+import { CplaceApiClient } from '../api.js';
+declare const BOARD_TOOL_DEFINITIONS: {
+    readonly cplace_board_get_configuration: {
+        readonly description: "Get current board widget configuration in a structured format suitable for modification.\n\nReturns the current state of:\n- cards: Card sources (searches) with display attribute mappings\n- columns: Column structure (static or dynamic mode)\n- swimlanes: Swimlane structure (if enabled)\n- visualComponents: UI settings and toggles\n\nWORKFLOW: Use this tool first, then modify the relevant section and pass to the corresponding configure tool.";
+        readonly inputSchema: {
+            readonly context: z.ZodUnion<[z.ZodObject<{
+                type: z.ZodLiteral<"page">;
+                pageUID: z.ZodString;
+            }, "strip", z.ZodTypeAny, {
+                type: "page";
+                pageUID: string;
+            }, {
+                type: "page";
+                pageUID: string;
+            }>, z.ZodObject<{
+                type: z.ZodLiteral<"type">;
+                workspaceId: z.ZodString;
+                typeInternalName: z.ZodString;
+                alternativeLayoutName: z.ZodOptional<z.ZodString>;
+            }, "strip", z.ZodTypeAny, {
+                type: "type";
+                workspaceId: string;
+                typeInternalName: string;
+                alternativeLayoutName?: string | undefined;
+            }, {
+                type: "type";
+                workspaceId: string;
+                typeInternalName: string;
+                alternativeLayoutName?: string | undefined;
+            }>]>;
+            readonly widgetId: z.ZodString;
+        };
+        readonly annotations: {
+            readonly title: "Get Board Configuration";
+        };
+    };
+    readonly cplace_board_configure_cards: {
+        readonly description: "Configure card sources for a board widget. Declares the complete set of card sources - existing sources not in the array will be removed.\n\nIMPORTANT: Configure cards BEFORE columns/swimlanes, as they reference cards via searchId.\n\nEach card source defines:\n- searchId: Unique identifier used by columns/swimlanes to reference this source\n- search: cplaceJson from cplace_search_pages (defines which pages become cards)\n- displayAttributes: How card data is displayed (description, date, tags, icons)\n\n**WARNING**: Do not manually construct search JSON! The search parameter requires a specific format with a \"filters\" array.\n\n**Correct Usage**: Use the cplaceJson field from cplace_search_pages response\n\n**Search JSON Workflow**:\n1. Call cplace_search_pages with your desired filter (e.g., types, workspace)\n2. Take the cplaceJson field from the response\n3. Use that value for the search parameter\n\nExample of CORRECT format: {\"filters\":[{\"relativeSpace\":\"true\"},{\"types\":[\"cf.myApp.myType\"]}]}\nExample of WRONG format: {\"types\":[\"cf.myApp.myType\"]} (missing filters array - will cause \"No value for filters\" error)\n\nWORKFLOW:\n1. Get current config: cplace_board_get_configuration\n2. Modify the cards array\n3. Call this tool with the complete desired cards array";
+        readonly inputSchema: {
+            readonly context: z.ZodUnion<[z.ZodObject<{
+                type: z.ZodLiteral<"page">;
+                pageUID: z.ZodString;
+            }, "strip", z.ZodTypeAny, {
+                type: "page";
+                pageUID: string;
+            }, {
+                type: "page";
+                pageUID: string;
+            }>, z.ZodObject<{
+                type: z.ZodLiteral<"type">;
+                workspaceId: z.ZodString;
+                typeInternalName: z.ZodString;
+                alternativeLayoutName: z.ZodOptional<z.ZodString>;
+            }, "strip", z.ZodTypeAny, {
+                type: "type";
+                workspaceId: string;
+                typeInternalName: string;
+                alternativeLayoutName?: string | undefined;
+            }, {
+                type: "type";
+                workspaceId: string;
+                typeInternalName: string;
+                alternativeLayoutName?: string | undefined;
+            }>]>;
+            readonly widgetId: z.ZodString;
+            readonly cards: z.ZodArray<z.ZodObject<{
+                searchId: z.ZodString;
+                search: z.ZodString;
+                typeId: z.ZodOptional<z.ZodString>;
+                displayAttributes: z.ZodOptional<z.ZodObject<{
+                    description: z.ZodOptional<z.ZodString>;
+                    date: z.ZodOptional<z.ZodString>;
+                    tags: z.ZodOptional<z.ZodString>;
+                    customIcons: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+                    additional: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+                }, "strip", z.ZodTypeAny, {
+                    date?: string | undefined;
+                    description?: string | undefined;
+                    tags?: string | undefined;
+                    customIcons?: string[] | undefined;
+                    additional?: string[] | undefined;
+                }, {
+                    date?: string | undefined;
+                    description?: string | undefined;
+                    tags?: string | undefined;
+                    customIcons?: string[] | undefined;
+                    additional?: string[] | undefined;
+                }>>;
+            }, "strip", z.ZodTypeAny, {
+                search: string;
+                searchId: string;
+                typeId?: string | undefined;
+                displayAttributes?: {
+                    date?: string | undefined;
+                    description?: string | undefined;
+                    tags?: string | undefined;
+                    customIcons?: string[] | undefined;
+                    additional?: string[] | undefined;
+                } | undefined;
+            }, {
+                search: string;
+                searchId: string;
+                typeId?: string | undefined;
+                displayAttributes?: {
+                    date?: string | undefined;
+                    description?: string | undefined;
+                    tags?: string | undefined;
+                    customIcons?: string[] | undefined;
+                    additional?: string[] | undefined;
+                } | undefined;
+            }>, "many">;
+        };
+        readonly annotations: {
+            readonly title: "Configure Board Cards";
+        };
+    };
+    readonly cplace_board_configure_columns: {
+        readonly description: "Configure column structure for a board widget. Declares the complete column configuration.\n\nMODES:\n- static: Explicitly define columns with value mappings (most common)\n- dynamic: Auto-generate columns from attribute values\n\nIMPORTANT: All searchId references must exist in the board's card configurations.\nConfigure cards first if adding new card sources.\n\nSTATIC MODE: Array order = column order (left to right)\nDYNAMIC MODE: Columns auto-generated; use for date-based or value-based grouping\n\nWORKFLOW:\n1. Ensure cards are configured with desired searchIds\n2. Get current config: cplace_board_get_configuration\n3. Modify or replace columns configuration\n4. Call this tool with complete desired state";
+        readonly inputSchema: {
+            readonly context: z.ZodUnion<[z.ZodObject<{
+                type: z.ZodLiteral<"page">;
+                pageUID: z.ZodString;
+            }, "strip", z.ZodTypeAny, {
+                type: "page";
+                pageUID: string;
+            }, {
+                type: "page";
+                pageUID: string;
+            }>, z.ZodObject<{
+                type: z.ZodLiteral<"type">;
+                workspaceId: z.ZodString;
+                typeInternalName: z.ZodString;
+                alternativeLayoutName: z.ZodOptional<z.ZodString>;
+            }, "strip", z.ZodTypeAny, {
+                type: "type";
+                workspaceId: string;
+                typeInternalName: string;
+                alternativeLayoutName?: string | undefined;
+            }, {
+                type: "type";
+                workspaceId: string;
+                typeInternalName: string;
+                alternativeLayoutName?: string | undefined;
+            }>]>;
+            readonly widgetId: z.ZodString;
+            readonly mode: z.ZodEnum<["static", "dynamic"]>;
+            readonly columns: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                columnId: z.ZodString;
+                names: z.ZodObject<{
+                    en: z.ZodString;
+                    de: z.ZodOptional<z.ZodString>;
+                }, "strip", z.ZodTypeAny, {
+                    en: string;
+                    de?: string | undefined;
+                }, {
+                    en: string;
+                    de?: string | undefined;
+                }>;
+                mappings: z.ZodArray<z.ZodObject<{
+                    searchId: z.ZodString;
+                    attribute: z.ZodString;
+                    values: z.ZodArray<z.ZodString, "many">;
+                }, "strip", z.ZodTypeAny, {
+                    values: string[];
+                    attribute: string;
+                    searchId: string;
+                }, {
+                    values: string[];
+                    attribute: string;
+                    searchId: string;
+                }>, "many">;
+            }, "strip", z.ZodTypeAny, {
+                columnId: string;
+                names: {
+                    en: string;
+                    de?: string | undefined;
+                };
+                mappings: {
+                    values: string[];
+                    attribute: string;
+                    searchId: string;
+                }[];
+            }, {
+                columnId: string;
+                names: {
+                    en: string;
+                    de?: string | undefined;
+                };
+                mappings: {
+                    values: string[];
+                    attribute: string;
+                    searchId: string;
+                }[];
+            }>, "many">>;
+            readonly dynamicConfig: z.ZodOptional<z.ZodObject<{
+                mappedAttributes: z.ZodArray<z.ZodObject<{
+                    searchId: z.ZodString;
+                    attribute: z.ZodString;
+                }, "strip", z.ZodTypeAny, {
+                    attribute: string;
+                    searchId: string;
+                }, {
+                    attribute: string;
+                    searchId: string;
+                }>, "many">;
+                timeGranularity: z.ZodOptional<z.ZodEnum<["day", "week", "month", "quarter", "year"]>>;
+                dateRange: z.ZodOptional<z.ZodObject<{
+                    start: z.ZodString;
+                    end: z.ZodString;
+                }, "strip", z.ZodTypeAny, {
+                    start: string;
+                    end: string;
+                }, {
+                    start: string;
+                    end: string;
+                }>>;
+                dateFormatId: z.ZodOptional<z.ZodString>;
+            }, "strip", z.ZodTypeAny, {
+                mappedAttributes: {
+                    attribute: string;
+                    searchId: string;
+                }[];
+                timeGranularity?: "day" | "week" | "month" | "quarter" | "year" | undefined;
+                dateRange?: {
+                    start: string;
+                    end: string;
+                } | undefined;
+                dateFormatId?: string | undefined;
+            }, {
+                mappedAttributes: {
+                    attribute: string;
+                    searchId: string;
+                }[];
+                timeGranularity?: "day" | "week" | "month" | "quarter" | "year" | undefined;
+                dateRange?: {
+                    start: string;
+                    end: string;
+                } | undefined;
+                dateFormatId?: string | undefined;
+            }>>;
+        };
+        readonly annotations: {
+            readonly title: "Configure Board Columns";
+        };
+    };
+    readonly cplace_board_configure_swimlanes: {
+        readonly description: "Configure swimlane structure for a board widget. Swimlanes create horizontal groupings within columns.\n\nSET enabled: false to remove all swimlanes (flat board).\n\nMODES (when enabled):\n- static: Explicitly define swimlanes with value mappings\n- dynamic: Auto-generate swimlanes from attribute values\n\nIMPORTANT: All searchId references must exist in the board's card configurations.\n\nWORKFLOW:\n1. Ensure cards are configured with desired searchIds\n2. Get current config: cplace_board_get_configuration\n3. Modify or replace swimlanes configuration\n4. Call this tool with complete desired state";
+        readonly inputSchema: {
+            readonly context: z.ZodUnion<[z.ZodObject<{
+                type: z.ZodLiteral<"page">;
+                pageUID: z.ZodString;
+            }, "strip", z.ZodTypeAny, {
+                type: "page";
+                pageUID: string;
+            }, {
+                type: "page";
+                pageUID: string;
+            }>, z.ZodObject<{
+                type: z.ZodLiteral<"type">;
+                workspaceId: z.ZodString;
+                typeInternalName: z.ZodString;
+                alternativeLayoutName: z.ZodOptional<z.ZodString>;
+            }, "strip", z.ZodTypeAny, {
+                type: "type";
+                workspaceId: string;
+                typeInternalName: string;
+                alternativeLayoutName?: string | undefined;
+            }, {
+                type: "type";
+                workspaceId: string;
+                typeInternalName: string;
+                alternativeLayoutName?: string | undefined;
+            }>]>;
+            readonly widgetId: z.ZodString;
+            readonly enabled: z.ZodBoolean;
+            readonly mode: z.ZodOptional<z.ZodEnum<["static", "dynamic"]>>;
+            readonly swimlanes: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                swimlaneId: z.ZodString;
+                names: z.ZodObject<{
+                    en: z.ZodString;
+                    de: z.ZodOptional<z.ZodString>;
+                }, "strip", z.ZodTypeAny, {
+                    en: string;
+                    de?: string | undefined;
+                }, {
+                    en: string;
+                    de?: string | undefined;
+                }>;
+                mappings: z.ZodArray<z.ZodObject<{
+                    searchId: z.ZodString;
+                    attribute: z.ZodString;
+                    values: z.ZodArray<z.ZodString, "many">;
+                }, "strip", z.ZodTypeAny, {
+                    values: string[];
+                    attribute: string;
+                    searchId: string;
+                }, {
+                    values: string[];
+                    attribute: string;
+                    searchId: string;
+                }>, "many">;
+            }, "strip", z.ZodTypeAny, {
+                names: {
+                    en: string;
+                    de?: string | undefined;
+                };
+                mappings: {
+                    values: string[];
+                    attribute: string;
+                    searchId: string;
+                }[];
+                swimlaneId: string;
+            }, {
+                names: {
+                    en: string;
+                    de?: string | undefined;
+                };
+                mappings: {
+                    values: string[];
+                    attribute: string;
+                    searchId: string;
+                }[];
+                swimlaneId: string;
+            }>, "many">>;
+            readonly dynamicConfig: z.ZodOptional<z.ZodObject<{
+                mappedAttributes: z.ZodArray<z.ZodObject<{
+                    searchId: z.ZodString;
+                    attribute: z.ZodString;
+                }, "strip", z.ZodTypeAny, {
+                    attribute: string;
+                    searchId: string;
+                }, {
+                    attribute: string;
+                    searchId: string;
+                }>, "many">;
+                timeGranularity: z.ZodOptional<z.ZodEnum<["day", "week", "month", "quarter", "year"]>>;
+                dateRange: z.ZodOptional<z.ZodObject<{
+                    start: z.ZodString;
+                    end: z.ZodString;
+                }, "strip", z.ZodTypeAny, {
+                    start: string;
+                    end: string;
+                }, {
+                    start: string;
+                    end: string;
+                }>>;
+                dateFormatId: z.ZodOptional<z.ZodString>;
+            }, "strip", z.ZodTypeAny, {
+                mappedAttributes: {
+                    attribute: string;
+                    searchId: string;
+                }[];
+                timeGranularity?: "day" | "week" | "month" | "quarter" | "year" | undefined;
+                dateRange?: {
+                    start: string;
+                    end: string;
+                } | undefined;
+                dateFormatId?: string | undefined;
+            }, {
+                mappedAttributes: {
+                    attribute: string;
+                    searchId: string;
+                }[];
+                timeGranularity?: "day" | "week" | "month" | "quarter" | "year" | undefined;
+                dateRange?: {
+                    start: string;
+                    end: string;
+                } | undefined;
+                dateFormatId?: string | undefined;
+            }>>;
+        };
+        readonly annotations: {
+            readonly title: "Configure Board Swimlanes";
+        };
+    };
+    readonly cplace_board_configure_visual: {
+        readonly description: "Configure visual settings for a board widget. Controls UI features and display options.\n\nAvailable settings:\n- showCardCount: Show card count in column headers\n- enableQuickAdd: Show \"+\" button to create new cards\n- showUnmappedContainer: Show container for cards without valid column mapping\n- enableCardDetailsView: Show card details inline instead of navigation\n- showSpaceAfterLastColumn: Add visual spacing after last column\n- enableRecentHistory: Show button to highlight recently changed cards\n- recentHistoryWeeks: Time range for \"recent\" cards (default: 2)\n\nOmitted settings retain their current values (this tool does partial updates for visual settings).";
+        readonly inputSchema: {
+            readonly context: z.ZodUnion<[z.ZodObject<{
+                type: z.ZodLiteral<"page">;
+                pageUID: z.ZodString;
+            }, "strip", z.ZodTypeAny, {
+                type: "page";
+                pageUID: string;
+            }, {
+                type: "page";
+                pageUID: string;
+            }>, z.ZodObject<{
+                type: z.ZodLiteral<"type">;
+                workspaceId: z.ZodString;
+                typeInternalName: z.ZodString;
+                alternativeLayoutName: z.ZodOptional<z.ZodString>;
+            }, "strip", z.ZodTypeAny, {
+                type: "type";
+                workspaceId: string;
+                typeInternalName: string;
+                alternativeLayoutName?: string | undefined;
+            }, {
+                type: "type";
+                workspaceId: string;
+                typeInternalName: string;
+                alternativeLayoutName?: string | undefined;
+            }>]>;
+            readonly widgetId: z.ZodString;
+            readonly showCardCount: z.ZodOptional<z.ZodBoolean>;
+            readonly enableQuickAdd: z.ZodOptional<z.ZodBoolean>;
+            readonly showUnmappedContainer: z.ZodOptional<z.ZodBoolean>;
+            readonly unmappedContainerNames: z.ZodOptional<z.ZodObject<{
+                en: z.ZodString;
+                de: z.ZodOptional<z.ZodString>;
+            }, "strip", z.ZodTypeAny, {
+                en: string;
+                de?: string | undefined;
+            }, {
+                en: string;
+                de?: string | undefined;
+            }>>;
+            readonly enableCardDetailsView: z.ZodOptional<z.ZodBoolean>;
+            readonly showSpaceAfterLastColumn: z.ZodOptional<z.ZodBoolean>;
+            readonly enableRecentHistory: z.ZodOptional<z.ZodBoolean>;
+            readonly recentHistoryWeeks: z.ZodOptional<z.ZodNumber>;
+        };
+        readonly annotations: {
+            readonly title: "Configure Board Visual Settings";
+        };
+    };
+};
+export declare function registerBoardWidgetTools(server: McpServer, client: CplaceApiClient): void;
+export { BOARD_TOOL_DEFINITIONS };
+//# sourceMappingURL=board-widget.d.ts.map

package/dist/tools/board-widget.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"board-widget.d.ts","sourceRoot":"","sources":["../../src/tools/board-widget.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AACpE,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAgH5C,QAAA,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAkIlB,CAAC;AA2bX,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,eAAe,QA2YlF;AAGD,OAAO,EAAE,sBAAsB,EAAE,CAAC"}