Todo List

🚀 Todo List MCP Server

A Model Context Protocol (MCP) server that provides comprehensive APIs for managing to-do lists. It offers a convenient way to handle to - do tasks and can be integrated into various applications.

💡 Usage Tip

This project serves as an educational example for MCP implementation. For detailed explanations, refer to GUIDE.md to understand why it's implemented this way and how it works.

✨ Features

• Create To - do: Add new tasks with a title and Markdown description.
• Update To - do: Modify existing tasks.
• Complete To - do: Mark tasks as completed.
• Delete To - do: Remove tasks from the list.
• Search To - do: Find tasks by title or creation date.
• Summarize To - do: Get a quick overview of all incomplete tasks.

📦 Installation

# Clone the repository
git clone https://github.com/RegiByte/todo-list-mcp.git
cd todo-list-mcp

# Install dependencies
npm install

# Build the project
npm run build

📚 Documentation

🚀 Quick Start

Start the Server

npm start

Configuration in Claude for Desktop

Claude Desktop

Add the following to claude_desktop_config.json:

{
  "mcpServers": {
    "todo": {
      "command": "node",
      "args": ["/absolute/path/to/todo-list-mcp/dist/index.js"]
    }
  }
}

Cursor

• Go to "Cursor Settings" -> MCP.
• Add a new MCP server of type "command".
• Add the absolute path of the server and run it with node.
• Example: node /absolute/path/to/todo-list-mcp/dist/index.js

💻 Usage Examples

When used with Claude for Desktop or Cursor, you can try the following commands:

• "Create a to - do to learn MCP with a description explaining why MCP is useful."
• "List all my active to - dos."
• "Create a to - do for tomorrow's meeting with agenda details (in Markdown)."
• "Mark my learn - MCP to - do as completed."
• "Summarize all my active to - dos."

🔧 Technical Details

Tools

This MCP server exposes the following tools:

1. create-todo: Create a new to - do.
2. list-todos: List all to - dos.
3. get-todo: Get a specific to - do by ID.
4. update-todo: Update the title or description of a to - do.
5. complete-todo: Mark a to - do as completed.
6. delete-todo: Delete a to - do.
7. search-todos-by-title: Search to - dos by title (case - insensitive partial match).
8. search-todos-by-date: Search to - dos by creation date (format: YYYY - MM - DD).
9. list-active-todos: List all incomplete to - dos.
10. summarize-active-todos: Generate a summary of all incomplete to - dos.

Project Structure

This project follows a clear layered structure for easy understanding and maintenance:

src/
├── models/       # Data structures and validation schemas
├── services/     # Business logic and service operations
├── utils/        # Helper functions and formatting tools
├── config.ts     # Configuration settings
├── client.ts     # Client for local testing
└── index.ts      # Entry file, containing MCP tool definitions

Development Steps

# Clone the repository locally
git clone https://github.com/RegiByte/todo-list-mcp.git

# Enter the project directory
cd todo-list-mcp

# Install dependencies
npm install

# Start the development server
npm run dev

📄 License

The code of this project is licensed under the MIT License. Please check LICENSE for detailed information.

# View the license content
cat LICENSE

Through this MCP project, you can conveniently manage to - do lists and integrate them into various applications. We hope this example helps you understand how MCP works!