任务管理协议服务器

Todo.txt-MCP

Todo.txt-MCP是一个模型上下文协议（MCP）服务器，旨在管理您的 todo.txt文件。它使AI代理能够与您的任务进行交互——列出、添加、， 编辑并标记为已完成。它支持通过本地存储 todo.txt 通过WebDAV进行文件或同步。

🚀 Docker快速入门

运行TodoTui最简单的方法是使用Docker Compose。

您可以使用以下内容 docker-compose.yml 配置：

version: "3.8"

services:
  todo-txt-mcp:
    build: https://github.com/ArnoNuyts/Todo.txt-MCP.git

    ports:
      - "5000:5000"

    volumes:
      # Mount only the data file for persistence
      - ./todo.txt:/app/todo.txt

    environment:
      # Configuration
      - TODOTXT_MCP_BACKEND=local
      - TODOTXT_MCP_LOCAL_FILENAME=todo.txt
      # - TODOTXT_MCP_BACKEND=webdav
      # - TODOTXT_MCP_WEBDAV_URL=https://dav.example.com
      # - TODOTXT_MCP_WEBDAV_USERNAME=user
      # - TODOTXT_MCP_WEBDAV_PASSWORD=pass

1. 跑:
   复制

   docker-compose up -d
   

2. 访问：服务器将在以下时间运行 http://localhost:5000.

💻 在本地运行

如果你安装了Deno，你可以直接运行服务器。

1. 安装Deno: https://deno.com/runtime
2. 跑:
   复制

   deno run --allow-net --allow-read --allow-write --allow-env server.ts
   

   默认情况下，它在端口上运行 3000。您可以通过设置 PORT 环境变量。

⚙️ 配置

您可以使用环境变量配置后端。这尤其 在使用Docker运行时非常有用。

本地文件后端（默认）

将待办事项存储在本地文本文件中。

• TODOTUI_BACKEND：设置为 local.
• TODOTUI_LOCAL_FILENAME：todo文件的路径（默认： todo.txt).

WebDAV后端

与WebDAV服务器（例如Nextcloud）同步。

• TODOTUI_BACKEND：设置为 webdav.
• TODOTUI_WEBDAV_URL：WebDAV资源的完整URL（例如。， https://cloud.example.com/remote.php/dav/files/user/todo.txt).
• TODOTUI_WEBDAV_USERNAME：WebDAV用户名。
• TODOTUI_WEBDAV_PASSWORD：WebDAV密码。

🛠️ MCP检验员测试

您可以使用MCP检查器验证服务器是否正常工作。

1. 启动服务器 （Docker或本地）。
2. 运行检查器:
   复制

   npx @modelcontextprotocol/inspector http://localhost:5000/mcp
   

   （更换端口 5000 和 3000 如果不使用Docker在本地运行）

这将打开一个web界面，您可以在其中列出可用的工具(list_todos, add_todo等等）并执行它们以测试功能。