@doist/todoist-ai 2.2.2 → 3.0.0

package/README.md

@@ -19,15 +19,15 @@ npm install @doist/todoist-ai
 Here's an example using [Vercel's AI SDK](https://ai-sdk.dev/docs/ai-sdk-core/generating-text#streamtext).
 
 ```js
-import { tasksListByDate, tasksAddMultiple } from "@doist/todoist-ai";
+import { findTasksByDate, addTasks } from "@doist/todoist-ai";
 import { streamText } from "ai";
 
 const result = streamText({
     model: yourModel,
     system: "You are a helpful Todoist assistant",
     tools: {
-        tasksListByDate,
-        tasksAddMultiple,
+        findTasksByDate,
+        addTasks,
     },
 });
 ```
@@ -60,6 +60,14 @@ This project is in its early stages. Expect more and/or better tools soon.
 
 Nevertheless, our goal is to provide a small set of tools that enable complete workflows, rather than just atomic actions, striking a balance between flexibility and efficiency for LLMs.
 
+### Design Philosophy
+
+Our tools follow an **intelligent consolidation** approach that reduces cognitive load on LLMs by providing fewer, more powerful tools that handle complete user workflows rather than requiring multiple API calls for common tasks.
+
+Key principles include workflow-centric design, smart parameter handling, batch operations, and context-aware responses with suggested next steps.
+
+For detailed design guidelines, examples, and development patterns, see [docs/tool-design.md](docs/tool-design.md).
+
 ### Available Tools
 
 For a complete list of available tools, see the [src/tools](src/tools) directory.