@omnicoreos/planka-mcp 0.2.0 → 0.3.0

package/dist/tools/queries.d.ts

@@ -1,47 +1,95 @@
 /**
- * Tool: planka_list_cards
+ * Arguments shared by planka_find_cards and its planka_list_cards alias.
+ *
+ * `labelFilter` and `withDescription` are still accepted — a caller written
+ * against the old names keeps working — but they are no longer announced in
+ * `inputSchema`: both are aliases of a parameter that is (`labelName`,
+ * `descriptionChars`), and every announced property is paid for once per
+ * session by every client.
  */
-export declare const listCardsTool: {
+export interface FindCardsParams {
+    boardId?: string;
+    listId?: string;
+    listName?: string;
+    query?: string;
+    labelName?: string;
+    labelFilter?: string;
+    labelIds?: string[];
+    userIds?: string[];
+    withLabels?: boolean;
+    detail?: "digest" | "full";
+    withDescription?: boolean;
+    descriptionChars?: number;
+    limit?: number;
+    offset?: number;
+}
+/**
+ * Tool: planka_find_cards — the one read over a board's cards.
+ */
+export declare const findCardsTool: {
     name: string;
     description: string;
     inputSchema: {
         type: "object";
         properties: {
-            listId: {
-                type: string;
-                description: string;
+            readonly boardId: {
+                readonly type: "string";
+                readonly description: "Board ID. Optional with PLANKA_DEFAULT_BOARD_ID; ignored when listId is given.";
+            };
+            readonly listId: {
+                readonly type: "string";
+                readonly description: "Read exactly this column. THE CHEAP PATH: one request, no pagination, so total is the real size of the column and truncated is false by construction.";
+            };
+            readonly listName: {
+                readonly type: "string";
+                readonly description: "Column name fragment (case- and accent-insensitive) instead of an ID. Costs a board read; listId is cheaper.";
+            };
+            readonly query: {
+                readonly type: "string";
+                readonly description: "Free text matched against card name AND description. Several words are ANDed — all must appear — ignoring case and accents. A leading '/' makes the rest a case-insensitive regular expression.";
+            };
+            readonly labelName: {
+                readonly type: "string";
+                readonly description: "Only cards carrying this label name (exact name, case- and accent-insensitive). If the board has no such label, the response says so and lists the ones it does have.";
+            };
+            readonly labelIds: {
+                readonly type: "array";
+                readonly items: {
+                    readonly type: "string";
+                };
+                readonly description: "Only cards carrying at least one of these label IDs (OR).";
             };
-            withLabels: {
-                type: string;
-                description: string;
+            readonly userIds: {
+                readonly type: "array";
+                readonly items: {
+                    readonly type: "string";
+                };
+                readonly description: "Only cards where one of these users is a member or a task assignee (OR).";
             };
-            withDescription: {
-                type: string;
-                description: string;
+            readonly withLabels: {
+                readonly type: "boolean";
+                readonly description: "Resolve label names. Default true; false skips one board read on the listId path.";
             };
-            labelFilter: {
-                type: string;
-                description: string;
+            readonly detail: {
+                readonly type: "string";
+                readonly enum: readonly ["digest", "full"];
+                readonly description: "digest (default): id, name, labels, members, tasks, dueDate, commentsTotal, updatedAt. full: every field of the card, description included.";
             };
-            limit: {
-                type: string;
-                description: string;
+            readonly descriptionChars: {
+                readonly type: "number";
+                readonly description: "Per-match description preview, in characters. 0 (the default) leaves descriptions out.";
             };
-            offset: {
-                type: string;
-                description: string;
+            readonly limit: {
+                readonly type: "number";
+                readonly description: "Max matches to return. Default 25, max 200.";
+            };
+            readonly offset: {
+                readonly type: "number";
+                readonly description: "Skip this many matches. Use nextOffset from the previous response.";
             };
         };
-        required: string[];
     };
-    handler: (params: {
-        listId: string;
-        withLabels?: boolean;
-        withDescription?: boolean;
-        labelFilter?: string;
-        limit?: number;
-        offset?: number;
-    }) => Promise<{
+    handler: (params: FindCardsParams) => Promise<{
         content: {
             type: "text";
             text: string;
@@ -55,24 +103,73 @@ export declare const listCardsTool: {
     }>;
 };
 /**
- * Tool: planka_list_lists
+ * Tool: planka_list_cards — alias of planka_find_cards with listId.
  */
-export declare const listListsTool: {
+export declare const listCardsTool: {
     name: string;
     description: string;
     inputSchema: {
         type: "object";
         properties: {
-            boardId: {
-                type: string;
-                description: string;
+            readonly boardId: {
+                readonly type: "string";
+                readonly description: "Board ID. Optional with PLANKA_DEFAULT_BOARD_ID; ignored when listId is given.";
+            };
+            readonly listId: {
+                readonly type: "string";
+                readonly description: "Read exactly this column. THE CHEAP PATH: one request, no pagination, so total is the real size of the column and truncated is false by construction.";
+            };
+            readonly listName: {
+                readonly type: "string";
+                readonly description: "Column name fragment (case- and accent-insensitive) instead of an ID. Costs a board read; listId is cheaper.";
+            };
+            readonly query: {
+                readonly type: "string";
+                readonly description: "Free text matched against card name AND description. Several words are ANDed — all must appear — ignoring case and accents. A leading '/' makes the rest a case-insensitive regular expression.";
+            };
+            readonly labelName: {
+                readonly type: "string";
+                readonly description: "Only cards carrying this label name (exact name, case- and accent-insensitive). If the board has no such label, the response says so and lists the ones it does have.";
+            };
+            readonly labelIds: {
+                readonly type: "array";
+                readonly items: {
+                    readonly type: "string";
+                };
+                readonly description: "Only cards carrying at least one of these label IDs (OR).";
+            };
+            readonly userIds: {
+                readonly type: "array";
+                readonly items: {
+                    readonly type: "string";
+                };
+                readonly description: "Only cards where one of these users is a member or a task assignee (OR).";
+            };
+            readonly withLabels: {
+                readonly type: "boolean";
+                readonly description: "Resolve label names. Default true; false skips one board read on the listId path.";
+            };
+            readonly detail: {
+                readonly type: "string";
+                readonly enum: readonly ["digest", "full"];
+                readonly description: "digest (default): id, name, labels, members, tasks, dueDate, commentsTotal, updatedAt. full: every field of the card, description included.";
+            };
+            readonly descriptionChars: {
+                readonly type: "number";
+                readonly description: "Per-match description preview, in characters. 0 (the default) leaves descriptions out.";
+            };
+            readonly limit: {
+                readonly type: "number";
+                readonly description: "Max matches to return. Default 25, max 200.";
+            };
+            readonly offset: {
+                readonly type: "number";
+                readonly description: "Skip this many matches. Use nextOffset from the previous response.";
             };
         };
         required: string[];
     };
-    handler: (params: {
-        boardId: string;
-    }) => Promise<{
+    handler: (params: FindCardsParams) => Promise<{
         content: {
             type: "text";
             text: string;
@@ -85,6 +182,13 @@ export declare const listListsTool: {
         isError: boolean;
     }>;
 };
+/** Arguments shared by planka_board_summary and its planka_list_lists alias. */
+export interface BoardSummaryParams {
+    boardId?: string;
+    cardsFrom?: string[];
+    highlightLabel?: string;
+    limit?: number;
+}
 /**
  * Tool: planka_board_summary
  */
@@ -116,12 +220,7 @@ export declare const boardSummaryTool: {
         };
         required: string[];
     };
-    handler: (params: {
-        boardId: string;
-        cardsFrom?: string[];
-        highlightLabel?: string;
-        limit?: number;
-    }) => Promise<{
+    handler: (params: BoardSummaryParams) => Promise<{
         content: {
             type: "text";
             text: string;
@@ -135,9 +234,9 @@ export declare const boardSummaryTool: {
     }>;
 };
 /**
- * Tool: planka_find_cards
+ * Tool: planka_list_lists — alias of planka_board_summary with cardsFrom: [].
  */
-export declare const findCardsTool: {
+export declare const listListsTool: {
     name: string;
     description: string;
     inputSchema: {
@@ -147,41 +246,11 @@ export declare const findCardsTool: {
                 type: string;
                 description: string;
             };
-            labelName: {
-                type: string;
-                description: string;
-            };
-            query: {
-                type: string;
-                description: string;
-            };
-            listId: {
-                type: string;
-                description: string;
-            };
-            withDescription: {
-                type: string;
-                description: string;
-            };
-            limit: {
-                type: string;
-                description: string;
-            };
-            offset: {
-                type: string;
-                description: string;
-            };
         };
         required: string[];
     };
     handler: (params: {
-        boardId: string;
-        labelName?: string;
-        query?: string;
-        listId?: string;
-        withDescription?: boolean;
-        limit?: number;
-        offset?: number;
+        boardId?: string;
     }) => Promise<{
         content: {
             type: "text";
@@ -201,68 +270,64 @@ export declare const queryTools: ({
     inputSchema: {
         type: "object";
         properties: {
-            listId: {
-                type: string;
-                description: string;
+            readonly boardId: {
+                readonly type: "string";
+                readonly description: "Board ID. Optional with PLANKA_DEFAULT_BOARD_ID; ignored when listId is given.";
+            };
+            readonly listId: {
+                readonly type: "string";
+                readonly description: "Read exactly this column. THE CHEAP PATH: one request, no pagination, so total is the real size of the column and truncated is false by construction.";
+            };
+            readonly listName: {
+                readonly type: "string";
+                readonly description: "Column name fragment (case- and accent-insensitive) instead of an ID. Costs a board read; listId is cheaper.";
+            };
+            readonly query: {
+                readonly type: "string";
+                readonly description: "Free text matched against card name AND description. Several words are ANDed — all must appear — ignoring case and accents. A leading '/' makes the rest a case-insensitive regular expression.";
+            };
+            readonly labelName: {
+                readonly type: "string";
+                readonly description: "Only cards carrying this label name (exact name, case- and accent-insensitive). If the board has no such label, the response says so and lists the ones it does have.";
+            };
+            readonly labelIds: {
+                readonly type: "array";
+                readonly items: {
+                    readonly type: "string";
+                };
+                readonly description: "Only cards carrying at least one of these label IDs (OR).";
             };
-            withLabels: {
-                type: string;
-                description: string;
+            readonly userIds: {
+                readonly type: "array";
+                readonly items: {
+                    readonly type: "string";
+                };
+                readonly description: "Only cards where one of these users is a member or a task assignee (OR).";
             };
-            withDescription: {
-                type: string;
-                description: string;
+            readonly withLabels: {
+                readonly type: "boolean";
+                readonly description: "Resolve label names. Default true; false skips one board read on the listId path.";
             };
-            labelFilter: {
-                type: string;
-                description: string;
+            readonly detail: {
+                readonly type: "string";
+                readonly enum: readonly ["digest", "full"];
+                readonly description: "digest (default): id, name, labels, members, tasks, dueDate, commentsTotal, updatedAt. full: every field of the card, description included.";
             };
-            limit: {
-                type: string;
-                description: string;
+            readonly descriptionChars: {
+                readonly type: "number";
+                readonly description: "Per-match description preview, in characters. 0 (the default) leaves descriptions out.";
             };
-            offset: {
-                type: string;
-                description: string;
+            readonly limit: {
+                readonly type: "number";
+                readonly description: "Max matches to return. Default 25, max 200.";
             };
-        };
-        required: string[];
-    };
-    handler: (params: {
-        listId: string;
-        withLabels?: boolean;
-        withDescription?: boolean;
-        labelFilter?: string;
-        limit?: number;
-        offset?: number;
-    }) => Promise<{
-        content: {
-            type: "text";
-            text: string;
-        }[];
-    } | {
-        content: {
-            type: "text";
-            text: string;
-        }[];
-        isError: boolean;
-    }>;
-} | {
-    name: string;
-    description: string;
-    inputSchema: {
-        type: "object";
-        properties: {
-            boardId: {
-                type: string;
-                description: string;
+            readonly offset: {
+                readonly type: "number";
+                readonly description: "Skip this many matches. Use nextOffset from the previous response.";
             };
         };
-        required: string[];
     };
-    handler: (params: {
-        boardId: string;
-    }) => Promise<{
+    handler: (params: FindCardsParams) => Promise<{
         content: {
             type: "text";
             text: string;
@@ -302,12 +367,7 @@ export declare const queryTools: ({
         };
         required: string[];
     };
-    handler: (params: {
-        boardId: string;
-        cardsFrom?: string[];
-        highlightLabel?: string;
-        limit?: number;
-    }) => Promise<{
+    handler: (params: BoardSummaryParams) => Promise<{
         content: {
             type: "text";
             text: string;
@@ -329,41 +389,11 @@ export declare const queryTools: ({
                 type: string;
                 description: string;
             };
-            labelName: {
-                type: string;
-                description: string;
-            };
-            query: {
-                type: string;
-                description: string;
-            };
-            listId: {
-                type: string;
-                description: string;
-            };
-            withDescription: {
-                type: string;
-                description: string;
-            };
-            limit: {
-                type: string;
-                description: string;
-            };
-            offset: {
-                type: string;
-                description: string;
-            };
         };
         required: string[];
     };
     handler: (params: {
-        boardId: string;
-        labelName?: string;
-        query?: string;
-        listId?: string;
-        withDescription?: boolean;
-        limit?: number;
-        offset?: number;
+        boardId?: string;
     }) => Promise<{
         content: {
             type: "text";

package/dist/tools/queries.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../src/tools/queries.ts"],"names":[],"mappings":"AAgDA;;GAEG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;gBAyCZ,MAAM;qBACD,OAAO;0BACF,OAAO;sBACX,MAAM;gBACZ,MAAM;iBACL,MAAM;;;;;;;;;;;;;CA6CpB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;iBAa4B,MAAM;;;;;;;;;;;;;CAQ3D,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA+Bd,MAAM;oBACH,MAAM,EAAE;yBACH,MAAM;gBACf,MAAM;;;;;;;;;;;;;CAuBnB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA4CX,MAAM;oBACH,MAAM;gBACV,MAAM;iBACL,MAAM;0BACG,OAAO;gBACjB,MAAM;iBACL,MAAM;;;;;;;;;;;;;CAkBpB,CAAC;AAEF,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;gBArNT,MAAM;qBACD,OAAO;0BACF,OAAO;sBACX,MAAM;gBACZ,MAAM;iBACL,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA+DiC,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA4C7C,MAAM;oBACH,MAAM,EAAE;yBACH,MAAM;gBACf,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAwEL,MAAM;oBACH,MAAM;gBACV,MAAM;iBACL,MAAM;0BACG,OAAO;gBACjB,MAAM;iBACL,MAAM;;;;;;;;;;;;;IAyBpB,CAAC"}
+{"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../src/tools/queries.ts"],"names":[],"mappings":"AA2CA;;;;;;;;GAQG;AACH,MAAM,WAAW,eAAe;IAC9B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,MAAM,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;IAC3B,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAkED;;GAEG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAiCzB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAUzB,CAAC;AAEF,gFAAgF;AAChF,MAAM,WAAW,kBAAkB;IACjC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AA6BD;;GAEG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAoC5B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;kBAe6B,MAAM;;;;;;;;;;;;;CAG5D,CAAC;AAEF,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBALgC,MAAM;;;;;;;;;;;;;IAU5D,CAAC"}