@doist/todoist-ai 0.1.0 → 0.1.2

package/dist/types/index.d.ts

@@ -0,0 +1,476 @@
+import { getMcpServer } from "./mcp-server.js";
+import { projectsAddOne } from "./tools/projects-add-one.js";
+import { projectsDeleteOne } from "./tools/projects-delete-one.js";
+import { projectsList } from "./tools/projects-list.js";
+import { projectsSearch } from "./tools/projects-search.js";
+import { projectsUpdateOne } from "./tools/projects-update-one.js";
+import { sectionsAddOne } from "./tools/sections-add-one.js";
+import { sectionsDeleteOne } from "./tools/sections-delete-one.js";
+import { sectionsSearch } from "./tools/sections-search.js";
+import { sectionsUpdateOne } from "./tools/sections-update-one.js";
+import { tasksAddMultiple } from "./tools/tasks-add-multiple.js";
+import { tasksListByDate } from "./tools/tasks-by-date-range.js";
+import { tasksListForProject } from "./tools/tasks-by-project.js";
+import { tasksCompleteMultiple } from "./tools/tasks-complete-multiple.js";
+import { tasksDeleteOne } from "./tools/tasks-delete-one.js";
+import { tasksListForSection } from "./tools/tasks-list-for-section.js";
+import { tasksListOverdue } from "./tools/tasks-list-overdue.js";
+import { tasksOrganizeMultiple } from "./tools/tasks-organize-multiple.js";
+import { tasksSearch } from "./tools/tasks-search.js";
+import { tasksUpdateOne } from "./tools/tasks-update-one.js";
+import { subtasksListForParentTask } from "./tools/subtasks-list-for-parent-task.js";
+import { accountOverview } from "./tools/account-overview.js";
+import { projectOverview } from "./tools/project-overview.js";
+declare const tools: {
+    projectsList: {
+        name: string;
+        description: string;
+        parameters: {
+            limit: import("zod").ZodDefault<import("zod").ZodNumber>;
+            cursor: import("zod").ZodOptional<import("zod").ZodString>;
+        };
+        execute(args: {
+            limit: number;
+            cursor?: string | undefined;
+        }, client: import("@doist/todoist-api-typescript").TodoistApi): Promise<{
+            projects: import("@doist/todoist-api-typescript").Project[];
+            nextCursor: string | null;
+        }>;
+    };
+    projectsSearch: {
+        name: string;
+        description: string;
+        parameters: {
+            search: import("zod").ZodOptional<import("zod").ZodString>;
+            limit: import("zod").ZodDefault<import("zod").ZodNumber>;
+            cursor: import("zod").ZodOptional<import("zod").ZodString>;
+        };
+        execute(args: {
+            limit: number;
+            cursor?: string | undefined;
+            search?: string | undefined;
+        }, client: import("@doist/todoist-api-typescript").TodoistApi): Promise<{
+            projects: {
+                id: string;
+                name: string;
+                color: string;
+                isFavorite: boolean;
+                isShared: boolean;
+                parentId: string | null;
+                inboxProject: boolean;
+                viewStyle: string;
+            }[];
+            nextCursor: string | null;
+        }>;
+    };
+    projectsAddOne: {
+        name: string;
+        description: string;
+        parameters: {
+            name: import("zod").ZodString;
+        };
+        execute(args: {
+            name: string;
+        }, client: import("@doist/todoist-api-typescript").TodoistApi): Promise<{
+            id: string;
+            name: string;
+            color: string;
+            isFavorite: boolean;
+            isShared: boolean;
+            parentId: string | null;
+            inboxProject: boolean;
+            viewStyle: string;
+        }>;
+    };
+    projectsUpdateOne: {
+        name: string;
+        description: string;
+        parameters: {
+            id: import("zod").ZodString;
+            name: import("zod").ZodString;
+        };
+        execute(args: {
+            name: string;
+            id: string;
+        }, client: import("@doist/todoist-api-typescript").TodoistApi): Promise<import("@doist/todoist-api-typescript").Project>;
+    };
+    projectsDeleteOne: {
+        name: string;
+        description: string;
+        parameters: {
+            id: import("zod").ZodString;
+        };
+        execute(args: {
+            id: string;
+        }, client: import("@doist/todoist-api-typescript").TodoistApi): Promise<{
+            success: boolean;
+        }>;
+    };
+    sectionsSearch: {
+        name: string;
+        description: string;
+        parameters: {
+            projectId: import("zod").ZodString;
+            search: import("zod").ZodOptional<import("zod").ZodString>;
+        };
+        execute(args: {
+            projectId: string;
+            search?: string | undefined;
+        }, client: import("@doist/todoist-api-typescript").TodoistApi): Promise<{
+            id: string;
+            name: string;
+        }[]>;
+    };
+    sectionsAddOne: {
+        name: string;
+        description: string;
+        parameters: {
+            name: import("zod").ZodString;
+            projectId: import("zod").ZodString;
+        };
+        execute(args: {
+            name: string;
+            projectId: string;
+        }, client: import("@doist/todoist-api-typescript").TodoistApi): Promise<import("@doist/todoist-api-typescript").Section>;
+    };
+    sectionsUpdateOne: {
+        name: string;
+        description: string;
+        parameters: {
+            id: import("zod").ZodString;
+            name: import("zod").ZodString;
+        };
+        execute(args: {
+            name: string;
+            id: string;
+        }, client: import("@doist/todoist-api-typescript").TodoistApi): Promise<import("@doist/todoist-api-typescript").Section>;
+    };
+    sectionsDeleteOne: {
+        name: string;
+        description: string;
+        parameters: {
+            id: import("zod").ZodString;
+        };
+        execute(args: {
+            id: string;
+        }, client: import("@doist/todoist-api-typescript").TodoistApi): Promise<{
+            success: boolean;
+        }>;
+    };
+    tasksListByDate: {
+        name: string;
+        description: string;
+        parameters: {
+            startDate: import("zod").ZodString;
+            daysCount: import("zod").ZodDefault<import("zod").ZodNumber>;
+            limit: import("zod").ZodDefault<import("zod").ZodNumber>;
+            cursor: import("zod").ZodOptional<import("zod").ZodString>;
+        };
+        execute(args: {
+            limit: number;
+            startDate: string;
+            daysCount: number;
+            cursor?: string | undefined;
+        }, client: import("@doist/todoist-api-typescript").TodoistApi): Promise<{
+            tasks: {
+                id: string;
+                content: string;
+                description: string;
+                dueDate: string | undefined;
+                recurring: string | boolean;
+                priority: number;
+                projectId: string;
+                sectionId: string | null;
+                parentId: string | null;
+                labels: string[];
+            }[];
+            nextCursor: string | null;
+        }>;
+    };
+    tasksDeleteOne: {
+        name: string;
+        description: string;
+        parameters: {
+            id: import("zod").ZodString;
+        };
+        execute(args: {
+            id: string;
+        }, client: import("@doist/todoist-api-typescript").TodoistApi): Promise<{
+            success: boolean;
+        }>;
+    };
+    tasksCompleteMultiple: {
+        name: string;
+        description: string;
+        parameters: {
+            ids: import("zod").ZodArray<import("zod").ZodString, "many">;
+        };
+        execute(args: {
+            ids: string[];
+        }, client: import("@doist/todoist-api-typescript").TodoistApi): Promise<{
+            success: boolean;
+            completed: string[];
+        }>;
+    };
+    tasksListForProject: {
+        name: string;
+        description: string;
+        parameters: {
+            projectId: import("zod").ZodString;
+            limit: import("zod").ZodDefault<import("zod").ZodNumber>;
+            cursor: import("zod").ZodOptional<import("zod").ZodString>;
+        };
+        execute(args: {
+            limit: number;
+            projectId: string;
+            cursor?: string | undefined;
+        }, client: import("@doist/todoist-api-typescript").TodoistApi): Promise<{
+            tasks: {
+                id: string;
+                content: string;
+                description: string;
+                dueDate: string | undefined;
+                recurring: string | boolean;
+                priority: number;
+                projectId: string;
+                sectionId: string | null;
+                parentId: string | null;
+                labels: string[];
+            }[];
+            nextCursor: string | null;
+        }>;
+    };
+    tasksListOverdue: {
+        name: string;
+        description: string;
+        parameters: {
+            limit: import("zod").ZodDefault<import("zod").ZodNumber>;
+            cursor: import("zod").ZodOptional<import("zod").ZodString>;
+        };
+        execute(args: {
+            limit: number;
+            cursor?: string | undefined;
+        }, client: import("@doist/todoist-api-typescript").TodoistApi): Promise<{
+            tasks: {
+                id: string;
+                content: string;
+                description: string;
+                dueDate: string | undefined;
+                recurring: string | boolean;
+                priority: number;
+                projectId: string;
+                sectionId: string | null;
+                parentId: string | null;
+                labels: string[];
+            }[];
+            nextCursor: string | null;
+        }>;
+    };
+    tasksSearch: {
+        name: string;
+        description: string;
+        parameters: {
+            searchText: import("zod").ZodString;
+            limit: import("zod").ZodDefault<import("zod").ZodNumber>;
+            cursor: import("zod").ZodOptional<import("zod").ZodString>;
+        };
+        execute(args: {
+            limit: number;
+            searchText: string;
+            cursor?: string | undefined;
+        }, client: import("@doist/todoist-api-typescript").TodoistApi): Promise<{
+            tasks: {
+                id: string;
+                content: string;
+                description: string;
+                dueDate: string | undefined;
+                recurring: string | boolean;
+                priority: number;
+                projectId: string;
+                sectionId: string | null;
+                parentId: string | null;
+                labels: string[];
+            }[];
+            nextCursor: string | null;
+        }>;
+    };
+    tasksAddMultiple: {
+        name: string;
+        description: string;
+        parameters: {
+            projectId: import("zod").ZodOptional<import("zod").ZodString>;
+            sectionId: import("zod").ZodOptional<import("zod").ZodString>;
+            parentId: import("zod").ZodOptional<import("zod").ZodString>;
+            tasks: import("zod").ZodArray<import("zod").ZodObject<{
+                content: import("zod").ZodString;
+                description: import("zod").ZodOptional<import("zod").ZodString>;
+                priority: import("zod").ZodOptional<import("zod").ZodNumber>;
+                dueString: import("zod").ZodOptional<import("zod").ZodString>;
+            }, "strip", import("zod").ZodTypeAny, {
+                content: string;
+                description?: string | undefined;
+                priority?: number | undefined;
+                dueString?: string | undefined;
+            }, {
+                content: string;
+                description?: string | undefined;
+                priority?: number | undefined;
+                dueString?: string | undefined;
+            }>, "many">;
+        };
+        execute(args: {
+            tasks: {
+                content: string;
+                description?: string | undefined;
+                priority?: number | undefined;
+                dueString?: string | undefined;
+            }[];
+            projectId?: string | undefined;
+            parentId?: string | undefined;
+            sectionId?: string | undefined;
+        }, client: import("@doist/todoist-api-typescript").TodoistApi): Promise<{
+            id: string;
+            content: string;
+            description: string;
+            dueDate: string | undefined;
+            recurring: string | boolean;
+            priority: number;
+            projectId: string;
+            sectionId: string | null;
+            parentId: string | null;
+            labels: string[];
+        }[]>;
+    };
+    tasksUpdateOne: {
+        name: string;
+        description: string;
+        parameters: {
+            id: import("zod").ZodString;
+            content: import("zod").ZodOptional<import("zod").ZodString>;
+            description: import("zod").ZodOptional<import("zod").ZodString>;
+            projectId: import("zod").ZodOptional<import("zod").ZodString>;
+            sectionId: import("zod").ZodOptional<import("zod").ZodString>;
+            parentId: import("zod").ZodOptional<import("zod").ZodString>;
+            priority: import("zod").ZodOptional<import("zod").ZodNumber>;
+            dueString: import("zod").ZodOptional<import("zod").ZodString>;
+        };
+        execute(args: {
+            id: string;
+            content?: string | undefined;
+            projectId?: string | undefined;
+            parentId?: string | undefined;
+            description?: string | undefined;
+            priority?: number | undefined;
+            dueString?: string | undefined;
+            sectionId?: string | undefined;
+        }, client: import("@doist/todoist-api-typescript").TodoistApi): Promise<import("@doist/todoist-api-typescript").Task>;
+    };
+    tasksOrganizeMultiple: {
+        name: string;
+        description: string;
+        parameters: {
+            tasks: import("zod").ZodArray<import("zod").ZodObject<{
+                id: import("zod").ZodString;
+                projectId: import("zod").ZodOptional<import("zod").ZodString>;
+                sectionId: import("zod").ZodOptional<import("zod").ZodString>;
+                parentId: import("zod").ZodOptional<import("zod").ZodString>;
+                order: import("zod").ZodOptional<import("zod").ZodNumber>;
+            }, "strip", import("zod").ZodTypeAny, {
+                id: string;
+                projectId?: string | undefined;
+                parentId?: string | undefined;
+                sectionId?: string | undefined;
+                order?: number | undefined;
+            }, {
+                id: string;
+                projectId?: string | undefined;
+                parentId?: string | undefined;
+                sectionId?: string | undefined;
+                order?: number | undefined;
+            }>, "many">;
+        };
+        execute(args: {
+            tasks: {
+                id: string;
+                projectId?: string | undefined;
+                parentId?: string | undefined;
+                sectionId?: string | undefined;
+                order?: number | undefined;
+            }[];
+        }, client: import("@doist/todoist-api-typescript").TodoistApi): Promise<import("@doist/todoist-api-typescript").Task[]>;
+    };
+    tasksListForSection: {
+        name: string;
+        description: string;
+        parameters: {
+            sectionId: import("zod").ZodString;
+            limit: import("zod").ZodDefault<import("zod").ZodNumber>;
+            cursor: import("zod").ZodOptional<import("zod").ZodString>;
+        };
+        execute(args: {
+            limit: number;
+            sectionId: string;
+            cursor?: string | undefined;
+        }, client: import("@doist/todoist-api-typescript").TodoistApi): Promise<{
+            tasks: {
+                id: string;
+                content: string;
+                description: string;
+                dueDate: string | undefined;
+                recurring: string | boolean;
+                priority: number;
+                projectId: string;
+                sectionId: string | null;
+                parentId: string | null;
+                labels: string[];
+            }[];
+            nextCursor: string | null;
+        }>;
+    };
+    subtasksListForParentTask: {
+        name: string;
+        description: string;
+        parameters: {
+            parentId: import("zod").ZodString;
+            limit: import("zod").ZodDefault<import("zod").ZodNumber>;
+            cursor: import("zod").ZodOptional<import("zod").ZodString>;
+        };
+        execute(args: {
+            limit: number;
+            parentId: string;
+            cursor?: string | undefined;
+        }, client: import("@doist/todoist-api-typescript").TodoistApi): Promise<{
+            tasks: {
+                id: string;
+                content: string;
+                description: string;
+                dueDate: string | undefined;
+                recurring: string | boolean;
+                priority: number;
+                projectId: string;
+                sectionId: string | null;
+                parentId: string | null;
+                labels: string[];
+            }[];
+            nextCursor: string | null;
+        }>;
+    };
+    accountOverview: {
+        name: string;
+        description: string;
+        parameters: {};
+        execute(_args: {}, client: import("@doist/todoist-api-typescript").TodoistApi): Promise<string>;
+    };
+    projectOverview: {
+        name: string;
+        description: string;
+        parameters: {
+            projectId: import("zod").ZodString;
+        };
+        execute(args: {
+            projectId: string;
+        }, client: import("@doist/todoist-api-typescript").TodoistApi): Promise<string>;
+    };
+};
+export { tools, getMcpServer };
+export { projectsList, projectsSearch, projectsAddOne, projectsUpdateOne, projectsDeleteOne, sectionsSearch, sectionsAddOne, sectionsUpdateOne, sectionsDeleteOne, tasksListByDate, tasksDeleteOne, tasksCompleteMultiple, tasksListForProject, tasksListOverdue, tasksSearch, tasksAddMultiple, tasksUpdateOne, tasksOrganizeMultiple, tasksListForSection, subtasksListForParentTask, accountOverview, projectOverview, };

package/dist/types/main.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/mcp-helpers.d.ts

@@ -0,0 +1,12 @@
+import type { TodoistApi } from "@doist/todoist-api-typescript";
+import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import type { z } from "zod";
+import type { TodoistTool } from "./todoist-tool.js";
+/**
+ * Register a Todoist tool in an MCP server.
+ * @param tool - The tool to register.
+ * @param server - The server to register the tool on.
+ * @param client - The Todoist API client to use to execute the tool.
+ */
+declare function registerTool<Params extends z.ZodRawShape>(tool: TodoistTool<Params>, server: McpServer, client: TodoistApi): void;
+export { registerTool };

package/dist/types/mcp-server.d.ts

@@ -0,0 +1,10 @@
+import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+/**
+ * Create the MCP server.
+ * @param todoistApiKey - The API key for the todoist account.
+ * @returns the MCP server.
+ */
+declare function getMcpServer({ todoistApiKey }: {
+    todoistApiKey: string;
+}): McpServer;
+export { getMcpServer };

package/dist/types/todoist-tool.d.ts

@@ -0,0 +1,34 @@
+import type { TodoistApi } from "@doist/todoist-api-typescript";
+import type { z } from "zod";
+/**
+ * A Todoist tool that can be used in an MCP server or other conversational AI interfaces.
+ */
+type TodoistTool<Params extends z.ZodRawShape> = {
+    /**
+     * The name of the tool.
+     */
+    name: string;
+    /**
+     * The description of the tool. This is important for the LLM to understand what the tool does,
+     * and how to use it.
+     */
+    description: string;
+    /**
+     * The schema of the parameters of the tool.
+     *
+     * This is used to validate the parameters of the tool, as well as to let the LLM know what the
+     * parameters are.
+     */
+    parameters: Params;
+    /**
+     * The function that executes the tool.
+     *
+     * This is the main function that will be called when the tool is used.
+     *
+     * @param args - The arguments of the tool.
+     * @param client - The Todoist API client used to make requests to the Todoist API.
+     * @returns The result of the tool.
+     */
+    execute: (args: z.infer<z.ZodObject<Params>>, client: TodoistApi) => Promise<unknown>;
+};
+export type { TodoistTool };

package/dist/types/tools/account-overview.d.ts

@@ -0,0 +1,8 @@
+import type { TodoistApi } from "@doist/todoist-api-typescript";
+declare const accountOverview: {
+    name: string;
+    description: string;
+    parameters: {};
+    execute(_args: {}, client: TodoistApi): Promise<string>;
+};
+export { accountOverview };

package/dist/types/tools/project-overview.d.ts

@@ -0,0 +1,13 @@
+import type { TodoistApi } from "@doist/todoist-api-typescript";
+import { z } from "zod";
+declare const projectOverview: {
+    name: string;
+    description: string;
+    parameters: {
+        projectId: z.ZodString;
+    };
+    execute(args: {
+        projectId: string;
+    }, client: TodoistApi): Promise<string>;
+};
+export { projectOverview };

package/dist/types/tools/projects-add-one.d.ts

@@ -0,0 +1,21 @@
+import { z } from "zod";
+declare const projectsAddOne: {
+    name: string;
+    description: string;
+    parameters: {
+        name: z.ZodString;
+    };
+    execute(args: {
+        name: string;
+    }, client: import("@doist/todoist-api-typescript").TodoistApi): Promise<{
+        id: string;
+        name: string;
+        color: string;
+        isFavorite: boolean;
+        isShared: boolean;
+        parentId: string | null;
+        inboxProject: boolean;
+        viewStyle: string;
+    }>;
+};
+export { projectsAddOne };

package/dist/types/tools/projects-delete-one.d.ts

@@ -0,0 +1,14 @@
+import { z } from "zod";
+declare const projectsDeleteOne: {
+    name: string;
+    description: string;
+    parameters: {
+        id: z.ZodString;
+    };
+    execute(args: {
+        id: string;
+    }, client: import("@doist/todoist-api-typescript").TodoistApi): Promise<{
+        success: boolean;
+    }>;
+};
+export { projectsDeleteOne };

package/dist/types/tools/projects-list.d.ts

@@ -0,0 +1,17 @@
+import { z } from "zod";
+declare const projectsList: {
+    name: string;
+    description: string;
+    parameters: {
+        limit: z.ZodDefault<z.ZodNumber>;
+        cursor: z.ZodOptional<z.ZodString>;
+    };
+    execute(args: {
+        limit: number;
+        cursor?: string | undefined;
+    }, client: import("@doist/todoist-api-typescript").TodoistApi): Promise<{
+        projects: import("@doist/todoist-api-typescript").Project[];
+        nextCursor: string | null;
+    }>;
+};
+export { projectsList };

package/dist/types/tools/projects-search.d.ts

@@ -0,0 +1,28 @@
+import { z } from "zod";
+declare const projectsSearch: {
+    name: string;
+    description: string;
+    parameters: {
+        search: z.ZodOptional<z.ZodString>;
+        limit: z.ZodDefault<z.ZodNumber>;
+        cursor: z.ZodOptional<z.ZodString>;
+    };
+    execute(args: {
+        limit: number;
+        cursor?: string | undefined;
+        search?: string | undefined;
+    }, client: import("@doist/todoist-api-typescript").TodoistApi): Promise<{
+        projects: {
+            id: string;
+            name: string;
+            color: string;
+            isFavorite: boolean;
+            isShared: boolean;
+            parentId: string | null;
+            inboxProject: boolean;
+            viewStyle: string;
+        }[];
+        nextCursor: string | null;
+    }>;
+};
+export { projectsSearch };

package/dist/types/tools/projects-update-one.d.ts

@@ -0,0 +1,14 @@
+import { z } from "zod";
+declare const projectsUpdateOne: {
+    name: string;
+    description: string;
+    parameters: {
+        id: z.ZodString;
+        name: z.ZodString;
+    };
+    execute(args: {
+        name: string;
+        id: string;
+    }, client: import("@doist/todoist-api-typescript").TodoistApi): Promise<import("@doist/todoist-api-typescript").Project>;
+};
+export { projectsUpdateOne };

package/dist/types/tools/sections-add-one.d.ts

@@ -0,0 +1,14 @@
+import { z } from "zod";
+declare const sectionsAddOne: {
+    name: string;
+    description: string;
+    parameters: {
+        name: z.ZodString;
+        projectId: z.ZodString;
+    };
+    execute(args: {
+        name: string;
+        projectId: string;
+    }, client: import("@doist/todoist-api-typescript").TodoistApi): Promise<import("@doist/todoist-api-typescript").Section>;
+};
+export { sectionsAddOne };