Skip to main content
Glama
README.md
# Todoist for VoiceOS

> Voice-control [Todoist](https://todoist.com) from [VoiceOS](https://voiceos.com) β€” and optionally keep Apple Reminders in sync with it.

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](./LICENSE)
[![Platform: macOS](https://img.shields.io/badge/platform-macOS-black.svg)](#requirements)
[![Todoist API v1](https://img.shields.io/badge/Todoist-API%20v1-e44332.svg)](https://developer.todoist.com/)

A local [Model Context Protocol](https://modelcontextprotocol.io) server that adds
Todoist to VoiceOS, plus a one-way **Apple Reminders β†’ Todoist** sync. Your API
token stays on your Mac β€” nothing is sent anywhere except Todoist's own API.

```
πŸŽ™οΈ  "Add buy milk to Todoist tomorrow at 9am"
πŸŽ™οΈ  "What's on my Todoist for today?"
πŸŽ™οΈ  "Mark the expenses task done"
```

---

## ✨ Features

- **Add / list / complete / update tasks by voice**
- **Natural-language due dates** β€” "tomorrow at 9am", "every friday"
- **Priorities** (p1–p4), **projects**, and **filters** ("today", "overdue")
- **Fuzzy completion** β€” "mark the *milk* task done" matches `Buy milk`
- **Optional Reminders sync** β€” anything you drop in Apple Reminders lands in Todoist
- **One-command installer** with guided token setup
- **No keys in code** β€” token lives at `~/.config/todoist/token` (chmod 600)

---

## πŸš€ Quick start

```bash
git clone https://github.com/gabeperez/voiceos-todoist.git
cd voiceos-todoist
./setup.sh
```

The installer will:

1. **Walk you through getting your Todoist API token** and validate + save it securely.
2. Install dependencies.
3. **Register the integration in VoiceOS automatically.**
4. Optionally set up the Reminders β†’ Todoist sync (with a dry-run preview first).

Then **restart VoiceOS** (or toggle the Todoist integration) and start talking.

> Prefer not to clone? Grab `todoist-voiceos.zip` from the
> [latest release](https://github.com/gabeperez/voiceos-todoist/releases/latest),
> unzip, and run `./setup.sh`.

---

## πŸ“‹ Requirements

| | |
|---|---|
| **OS** | macOS with [VoiceOS](https://voiceos.com) installed |
| **Runtime** | [Node.js](https://nodejs.org) 18+ (setup checks for it) |
| **Account** | A [Todoist](https://todoist.com) account |

### Getting your API token

Todoist β†’ **Settings β†’ Integrations β†’ Developer β†’ API token**
(<https://app.todoist.com/app/settings/integrations/developer>). The setup script
links you straight there and validates the token before saving.

---

## πŸ› οΈ Tools

| Tool | What it does |
|---|---|
| `add_task` | Create a task β€” NL due date, priority p1–p4, project, description. |
| `list_tasks` | List active tasks; filter by project or query (`today`, `overdue`). |
| `complete_task` | Close a task by id or content substring (`milk` β†’ `Buy milk`). |
| `update_task` | Change text / due date / priority / description. |
| `list_projects` | List your projects and their ids. |

Priority is UI-style: **p1 = highest**, p4 = none.

---

## πŸ” Apple Reminders β†’ Todoist sync (optional)

Mirrors **incomplete** reminders into Todoist on a 5-minute timer:

- Due dates + notes are copied; each Reminders list maps to a Todoist project (auto-created).
- Dedupe + completion state in `~/.config/todoist/sync-state.json`.
- When a synced reminder is **completed or removed**, its Todoist task is closed.
- **One-way only** β€” Todoist changes never flow back to Reminders.

```bash
npm run sync:dry            # preview what would sync β€” writes nothing
sync/install-launchd.sh     # enable the 5-minute background timer
sync/uninstall-launchd.sh   # stop it
```

The first run triggers a macOS **Automation β†’ Reminders** permission prompt β€” approve it.

### Sync options

Set these in `sync/run-sync.sh`:

| Env | Effect |
|---|---|
| `SYNC_LISTS="Inbox,Work"` | Only sync these Reminders lists (default: all). |
| `TODOIST_PROJECT="Inbox"` | Force everything into one project (default: list→project). |
| `SYNC_COMPLETIONS="false"` | Don't close Todoist tasks on completion/removal. |
| `SYNC_DUE="false"` | Don't copy due dates. |
| `DRY_RUN="true"` | Report what would sync; write nothing. |

---

## 🧹 Uninstall

```bash
./uninstall.sh
```

Unregisters from VoiceOS, stops the sync timer, and offers to delete your saved token + state.

---

## πŸ” How it works

```
                 β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
   VoiceOS ──────►  mcp-server.ts (stdio)     β”œβ”€β”€β–Ί Todoist API v1
   (voice)        β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
                 β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
 Apple Reminders─►  sync (launchd, every 5m)  β”œβ”€β”€β–Ί Todoist API v1
                 β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
```

- `mcp-server.ts` β€” the MCP server VoiceOS launches over stdio (via `start.sh`).
- `sync/sync-reminders-to-todoist.mjs` β€” reads Reminders via JXA, pushes to Todoist.
- `register-voiceos.mjs` β€” adds/removes the entry in VoiceOS's `config.json`.
- Uses the **Todoist unified API v1** (`/api/v1`); the old `/rest/v2` is deprecated.

---

## πŸ”’ Privacy

Your token is stored locally at `~/.config/todoist/token` (chmod 600) and used only
to call Todoist's API directly from your Mac. Nothing is proxied through any third
party. The Reminders sync reads your local Reminders via macOS scripting and writes
only to your Todoist.

---

## License

[MIT](./LICENSE) Β© Gabe Perez

TDQS

A4.3/5.0

Scored across 5 tools

Disambiguation5/5

Each tool has a distinct purpose: adding, completing, updating tasks, and listing projects or tasks. No overlapping functionality.

Naming Consistency5/5

All tool names follow a consistent verb_noun pattern in snake_case (e.g., add_task, list_projects), making it predictable.

Tool Count5/5

With 5 tools, the set is well-scoped for a task management integration, covering core operations without being too sparse or bloated.

Completeness4/5

Covers add, complete, update, and list tasks/projects. Missing delete/archive task, but the core workflow is fully supported.

Maintenance

ActivityInactive
ResponsivenessNo issues