@todoist/mcp 0.0.0-stage → 15.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Doist
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,233 @@
-# Temporary Holding Version
+# Todoist MCP Server
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Library for connecting AI agents to Todoist. Includes tools that can be integrated into LLMs,
+enabling them to access and modify a Todoist account on the user's behalf.
+
+These tools can be used both through an MCP server, or imported directly in other projects to
+integrate them to your own AI conversational interfaces.
+
+## Using tools
+
+### 1. Add this repository as a dependency
+
+```sh
+npm install @todoist/mcp
+```
+
+This package was previously published as `@doist/todoist-mcp`.
+
+### 2. Import the tools and plug them to an AI
+
+Here's an example using [Vercel's AI SDK](https://ai-sdk.dev/docs/ai-sdk-core/generating-text#streamtext).
+
+```js
+import { findTasksByDate, addTasks } from '@todoist/mcp'
+import { TodoistApi } from '@doist/todoist-sdk'
+import { streamText } from 'ai'
+
+// Create Todoist API client
+const client = new TodoistApi(process.env.TODOIST_API_KEY)
+
+// Helper to wrap tools with the client
+function wrapTool(tool, todoistClient) {
+    return {
+        ...tool,
+        execute(args) {
+            return tool.execute(args, todoistClient)
+        },
+    }
+}
+
+const result = streamText({
+    model: yourModel,
+    system: 'You are a helpful Todoist assistant',
+    tools: {
+        findTasksByDate: wrapTool(findTasksByDate, client),
+        addTasks: wrapTool(addTasks, client),
+    },
+})
+```
+
+## Using as an MCP server
+
+### Quick Start
+
+You can run the MCP server directly with npx:
+
+```bash
+npx -p @todoist/mcp todoist-mcp
+```
+
+### Setup Guide
+
+The Todoist MCP server is available as a streamable HTTP service for easy integration with various AI clients:
+
+**Primary URL (Streamable HTTP):** `https://ai.todoist.net/mcp`
+
+#### Claude Desktop
+
+1. Open Settings → Connectors → Add custom connector
+2. Enter `https://ai.todoist.net/mcp` and complete OAuth authentication
+
+#### Cursor
+
+Create a configuration file:
+
+- **Global:** `~/.cursor/mcp.json`
+- **Project-specific:** `.cursor/mcp.json`
+
+```json
+{
+    "mcpServers": {
+        "todoist": {
+            "command": "npx",
+            "args": ["-y", "mcp-remote", "https://ai.todoist.net/mcp"]
+        }
+    }
+}
+```
+
+Then enable the server in Cursor settings if prompted.
+
+#### Claude Code (CLI)
+
+The fastest setup is the official Todoist plugin, which wires up the MCP server for you:
+
+```bash
+/plugin marketplace add todoist/todoist-mcp
+/plugin install todoist@doist
+```
+
+OAuth runs in your browser the first time you use a Todoist tool. See [Anthropic's plugin docs](https://code.claude.com/docs/en/plugins-reference) for more.
+
+If you'd rather configure the MCP server manually, run:
+
+```bash
+claude mcp add --transport http todoist https://ai.todoist.net/mcp
+```
+
+Then launch `claude`, execute `/mcp`, and select the `todoist` MCP server to authenticate.
+
+#### Gemini CLI
+
+Install the official Todoist extension with [Gemini CLI](https://geminicli.com/docs/get-started/installation/) 0.67.0 or later:
+
+```bash
+gemini extensions install https://github.com/todoist/todoist-mcp
+```
+
+Start or restart Gemini CLI, then run `/mcp auth todoist` and sign in with your Todoist account. Todoist hosts the server; no API key or local server is needed.
+
+The assistant can read and change your Todoist tasks and projects. Revoke access at any time in Todoist under Settings → Integrations.
+
+#### Visual Studio Code
+
+1. Open Command Palette → MCP: Add Server
+2. Select HTTP transport and use:
+
+```json
+{
+    "servers": {
+        "todoist": {
+            "type": "http",
+            "url": "https://ai.todoist.net/mcp"
+        }
+    }
+}
+```
+
+#### Other MCP Clients
+
+```bash
+npx -y mcp-remote https://ai.todoist.net/mcp
+```
+
+For more details on setting up and using the MCP server, including creating custom servers, see [docs/mcp-server.md](docs/mcp-server.md).
+
+## Features
+
+A key feature of this project is that tools can be reused, and are not written specifically for use in an MCP server. They can be hooked up as tools to other conversational AI interfaces (e.g. Vercel's AI SDK).
+
+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.
+
+For our design philosophy, guidelines, 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.
+
+#### OpenAI MCP Compatibility
+
+This server includes `search` and `fetch` tools that follow the [OpenAI MCP specification](https://platform.openai.com/docs/mcp), enabling seamless integration with OpenAI's MCP protocol. These tools return JSON-encoded results optimized for OpenAI's requirements while maintaining compatibility with the broader MCP ecosystem.
+
+## Dependencies
+
+- MCP server using the official [@modelcontextprotocol/server](https://github.com/modelcontextprotocol/typescript-sdk)
+- Todoist Typescript API client [@doist/todoist-sdk](https://github.com/Doist/todoist-sdk)
+
+## MCP Server Setup
+
+See [docs/mcp-server.md](docs/mcp-server.md) for full instructions on setting up the MCP server.
+
+## Local Development Setup
+
+See [docs/dev-setup.md](docs/dev-setup.md) for full setup instructions and [CONTRIBUTING.md](CONTRIBUTING.md) for contributor workflows and quality checks.
+
+### MCP Apps
+
+This project includes support for **MCP Apps** – interactive UI widgets rendered inline in AI chat interfaces. Widgets provide rich visual representations of tool outputs (e.g., task lists) instead of plain text.
+
+See [docs/mcp-apps.md](docs/mcp-apps.md) for the widget architecture, build pipeline, and development workflow.
+
+### Quick Start
+
+After cloning and setting up the repository:
+
+- `npm start` - Build and run the MCP inspector for testing
+- `npm run dev` - Development mode with auto-rebuild and restart
+- `npm run tool:list` - List available tools for direct execution
+- `npm run tool -- <tool-name> '<json-args>'` - Run a tool directly without MCP
+
+When using `npm run tool`, include `--` before tool arguments so npm forwards them to `scripts/run-tool.ts`.
+
+Example check before write operations:
+`npm run tool -- user-info '{}'`
+This confirms which Todoist account the current `TODOIST_API_KEY` is connected to.
+
+`run-tool` uses `TODOIST_API_KEY` from your `.env` file (created from `.env.example` by `npm run setup`). Use a test account or a temporary project when running write operations to avoid modifying real data.
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for:
+
+- Development workflow
+- Running tools directly with `scripts/run-tool.ts`
+- Testing and quality checks
+- Commit conventions
+
+## Releasing
+
+This project uses [release-please](https://github.com/googleapis/release-please) to automate version management and package publishing.
+
+### How it works
+
+1. Make your changes using [Conventional Commits](https://www.conventionalcommits.org/):
+    - `feat:` for new features (minor version bump)
+    - `fix:` for bug fixes (patch version bump)
+    - `feat!:` or `fix!:` for breaking changes (major version bump)
+    - `docs:` for documentation changes
+    - `chore:` for maintenance tasks
+    - `ci:` for CI changes
+
+2. When commits are pushed to `main`:
+    - Release-please automatically creates/updates a release PR
+    - The PR includes version bump and changelog updates
+    - Review the PR and merge when ready
+
+3. After merging the release PR:
+    - A new GitHub release is automatically created
+    - A new tag is created
+    - The `publish` workflow is triggered
+    - The package is published to npm

package/dist/filter-helpers.d.ts

@@ -0,0 +1,53 @@
+import { TodoistApi } from '@doist/todoist-sdk';
+export declare const RESPONSIBLE_USER_FILTERING: readonly ["assigned", "unassignedOrMe", "all"];
+export type ResponsibleUserFiltering = (typeof RESPONSIBLE_USER_FILTERING)[number];
+/**
+ * Resolves a responsible user name/email to user ID and email.
+ * @param client - Todoist API client
+ * @param responsibleUser - User identifier (can be user ID, name, or email)
+ * @returns Object with userId and email, or undefined if not provided
+ * @throws Error if user cannot be found
+ */
+export declare function resolveResponsibleUser(client: TodoistApi, responsibleUser: string | undefined): Promise<{
+    userId: string;
+    email: string;
+} | undefined>;
+/**
+ * Appends a filter component to a query string with proper ' & ' separator.
+ * @param query - The existing query string
+ * @param filterComponent - The filter component to append
+ * @returns The updated query string
+ */
+export declare function appendToQuery(query: string, filterComponent: string): string;
+/**
+ * Builds a query filter string for responsible user filtering that can be appended to a Todoist filter query.
+ * @param resolvedAssigneeId - The resolved assignee ID (if provided)
+ * @param assigneeEmail - The assignee email (if provided)
+ * @param currentUserId - The current authenticated user's ID
+ * @param responsibleUserFiltering - The filtering mode ('assigned', 'unassignedOrMe', 'all')
+ * @returns Query filter string (e.g., "assigned to: email@example.com" or "!assigned to: others")
+ */
+export declare function buildResponsibleUserQueryFilter({ resolvedAssigneeId, assigneeEmail, currentUserId, responsibleUserFiltering, }: {
+    resolvedAssigneeId: string | undefined;
+    assigneeEmail: string | undefined;
+    currentUserId?: string;
+    responsibleUserFiltering?: ResponsibleUserFiltering;
+}): string;
+/**
+ * Filters tasks based on responsible user logic:
+ * - If resolvedAssigneeId is another user: returns only tasks assigned to that user
+ * - Otherwise: returns only unassigned tasks or tasks assigned to current user
+ * @param tasks - Array of tasks to filter (must have responsibleUid property)
+ * @param resolvedAssigneeId - The resolved assignee ID to filter by (optional)
+ * @param currentUserId - The current authenticated user's ID
+ * @returns Filtered array of tasks
+ */
+export declare function filterTasksByResponsibleUser<T extends {
+    responsibleUid?: string;
+}>({ tasks, resolvedAssigneeId, currentUserId, responsibleUserFiltering, }: {
+    tasks: T[];
+    resolvedAssigneeId: string | undefined;
+    currentUserId: string;
+    responsibleUserFiltering?: ResponsibleUserFiltering;
+}): T[];
+//# sourceMappingURL=filter-helpers.d.ts.map

package/dist/filter-helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"filter-helpers.d.ts","sourceRoot":"","sources":["../src/filter-helpers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA;AAGpD,eAAO,MAAM,0BAA0B,gDAAiD,CAAA;AACxF,MAAM,MAAM,wBAAwB,GAAG,CAAC,OAAO,0BAA0B,CAAC,CAAC,MAAM,CAAC,CAAA;AAElF;;;;;;GAMG;AACH,wBAAsB,sBAAsB,CACxC,MAAM,EAAE,UAAU,EAClB,eAAe,EAAE,MAAM,GAAG,SAAS,GACpC,OAAO,CAAC;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG,SAAS,CAAC,CAaxD;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,GAAG,MAAM,CAQ5E;AAED;;;;;;;GAOG;AACH,wBAAgB,+BAA+B,CAAC,EAC5C,kBAAkB,EAClB,aAAa,EACb,aAAa,EACb,wBAA2C,GAC9C,EAAE;IACC,kBAAkB,EAAE,MAAM,GAAG,SAAS,CAAA;IACtC,aAAa,EAAE,MAAM,GAAG,SAAS,CAAA;IACjC,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,wBAAwB,CAAC,EAAE,wBAAwB,CAAA;CACtD,GAAG,MAAM,CAmBT;AAED;;;;;;;;GAQG;AACH,wBAAgB,4BAA4B,CAAC,CAAC,SAAS;IAAE,cAAc,CAAC,EAAE,MAAM,CAAA;CAAE,EAAE,EAChF,KAAK,EACL,kBAAkB,EAClB,aAAa,EACb,wBAA2C,GAC9C,EAAE;IACC,KAAK,EAAE,CAAC,EAAE,CAAA;IACV,kBAAkB,EAAE,MAAM,GAAG,SAAS,CAAA;IACtC,aAAa,EAAE,MAAM,CAAA;IACrB,wBAAwB,CAAC,EAAE,wBAAwB,CAAA;CACtD,GAAG,CAAC,EAAE,CAgBN"}

package/dist/http-app.d.ts

@@ -0,0 +1,28 @@
+import { Express } from 'express';
+type CreateHttpAppOptions = {
+    todoistApiKey: string;
+    baseUrl?: string;
+    /** Hostnames trusted in the Host/Origin headers (DNS-rebinding protection). */
+    allowedHosts: string[];
+};
+type HttpApp = {
+    app: Express;
+    /**
+     * Ends the open `subscriptions/listen` streams and aborts in-flight MCP
+     * exchanges. Call it before closing the HTTP server, otherwise
+     * `server.close()` waits for those streams to end on their own.
+     */
+    close: () => Promise<void>;
+};
+/**
+ * Build the Express app for the MCP HTTP server.
+ *
+ * The DNS-rebinding guard (`requireTrustedHost`) is scoped to the sensitive
+ * `/mcp` routes and runs ahead of body parsing and token auth there. `/health`
+ * is intentionally unguarded so deployment health probes — which send the
+ * target's private IP in the Host header — keep working; it exposes no account
+ * data.
+ */
+declare function createHttpApp({ todoistApiKey, baseUrl, allowedHosts }: CreateHttpAppOptions): HttpApp;
+export { createHttpApp, type CreateHttpAppOptions, type HttpApp };
+//# sourceMappingURL=http-app.d.ts.map

package/dist/http-app.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"http-app.d.ts","sourceRoot":"","sources":["../src/http-app.ts"],"names":[],"mappings":"AAEA,OAAgB,EAAE,KAAK,OAAO,EAA+B,MAAM,SAAS,CAAA;AAK5E,KAAK,oBAAoB,GAAG;IACxB,aAAa,EAAE,MAAM,CAAA;IACrB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,+EAA+E;IAC/E,YAAY,EAAE,MAAM,EAAE,CAAA;CACzB,CAAA;AAED,KAAK,OAAO,GAAG;IACX,GAAG,EAAE,OAAO,CAAA;IACZ;;;;OAIG;IACH,KAAK,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;CAC7B,CAAA;AAED;;;;;;;;GAQG;AACH,iBAAS,aAAa,CAAC,EAAE,aAAa,EAAE,OAAO,EAAE,YAAY,EAAE,EAAE,oBAAoB,GAAG,OAAO,CAoD9F;AAED,OAAO,EAAE,aAAa,EAAE,KAAK,oBAAoB,EAAE,KAAK,OAAO,EAAE,CAAA"}