The MCP Todo.txt Integration is a server implementation of the Model Context Protocol (MCP) that enables interaction with Todo.txt files. This project allows LLMs to manage tasks in a Todo.txt file programmatically using the MCP protocol.
-
Resources
- Expose the list of tasks as a resource.
- Filter tasks by context, project, or priority.
-
Tools
- Add Task: Add a new task with optional metadata.
- Mark Task as Completed: Mark a task as completed.
- Delete Task: Remove a task.
- List Tasks: Retrieve all tasks with filtering options.
- Search Tasks: Search for tasks based on keywords or metadata.
- Sort Tasks: Sort tasks by priority, creation date, or completion date.
- Filter Tasks: Filter tasks by specific criteria.
- Add Metadata: Add custom metadata to tasks.
- Remove Metadata: Remove specific metadata from tasks.
- Batch Operations: Perform batch updates or deletions.
-
Prompts
- Summarize tasks.
- Generate a new task description.
- Dynamic Task Management: Update tasks dynamically based on input or triggers.
- Session Management: Manage tasks across multiple requests.
For quick installation, use the one-click installation button below
-
Clone the repository:
git clone <repository-url> cd todomcp
-
Install dependencies:
npm install
-
Build the project:
npm run build
-
Start the MCP server:
npm start
-
Interact with the server using MCP-compliant clients or tools.
- The path to the Todo.txt file can be configured using the
TODO_FILE_PATHenvironment variable. If not set, the default path istodo.txtin the project root.
-
To run the project in development mode:
npm run dev
-
To run tests:
npm test
@modelcontextprotocol/sdkjsTodoTxtzod
Contributions are welcome! Please open an issue or submit a pull request for any improvements or bug fixes.
This project is licensed under the MIT License.