mcp-server-todotxt

guifelix/mcp-server-todotxt

3.3

If you are the rightful owner of mcp-server-todotxt and would like to certify it and/or have it hosted online, please leave a comment on the right or send an email to henry@mcphub.com.

The MCP Todo.txt Integration is a server implementation of the Model Context Protocol (MCP) that enables interaction with Todo.txt files.


MCP Todo.txt Integration

Overview

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.

Features

Core Features

  • Resources

    • Expose the list of tasks as a resource.
    • Filter tasks by context, project, or priority.
  • Tools

    1. Add Task: Add a new task with optional metadata.
    2. Mark Task as Completed: Mark a task as completed.
    3. Delete Task: Remove a task.
    4. List Tasks: Retrieve all tasks with filtering options.
    5. Search Tasks: Search for tasks based on keywords or metadata.
    6. Sort Tasks: Sort tasks by priority, creation date, or completion date.
    7. Filter Tasks: Filter tasks by specific criteria.
    8. Add Metadata: Add custom metadata to tasks.
    9. Remove Metadata: Remove specific metadata from tasks.
    10. Batch Operations: Perform batch updates or deletions.
  • Prompts

    • Summarize tasks.
    • Generate a new task description.

Advanced Features

  • Dynamic Task Management: Update tasks dynamically based on input or triggers.
  • Session Management: Manage tasks across multiple requests.

Installation

  1. Clone the repository:

    git clone <repository-url>
    cd todomcp
    
  2. Install dependencies:

    npm install
    
  3. Build the project:

    npm run build
    

Usage

  1. Start the MCP server:

    npm start
    
  2. Interact with the server using MCP-compliant clients or tools.

Configuration

  • The path to the Todo.txt file can be configured using the TODO_FILE_PATH environment variable. If not set, the default path is todo.txt in the project root.

Development

  • To run the project in development mode:

    npm run dev
    
  • To run tests:

    npm test
    

Dependencies

  • @modelcontextprotocol/sdk
  • jsTodoTxt
  • zod

Documentation

Contributing

Contributions are welcome! Please open an issue or submit a pull request for any improvements or bug fixes.

License

This project is licensed under the MIT License.