Tiny TODO MCP Server 使用说明

项目简介

Tiny TODO MCP Server 是一个基于 Model Context Protocol (MCP) 实现的服务器,专为 AI 助手设计,提供持久化的 TODO 任务管理功能。它允许 AI 模型超越自身上下文限制,长期跟踪和管理用户的待办事项。

主要功能点

  • TODO 任务管理: 支持创建、更新、查询和搜索 TODO 任务。
  • 持久化存储: 使用 SQLite 数据库存储 TODO 任务,数据持久可靠。
  • MCP 协议标准: 遵循 MCP 协议,易于与各种 MCP 客户端集成,特别是 AI 助手类应用。
  • 工具化接口: 提供明确定义的工具接口(如 'update_todo', 'get_latest_todo', 'search_todo'),方便 AI 助手调用。
  • Prompt 模板: 内置简单的 Prompt 模板,辅助 AI 助手更好地理解和格式化 TODO 内容。
  • 易于部署: 使用 Bun 运行时,启动简单快捷。

安装步骤

  1. 克隆仓库
    git clone https://github.com/tkc/tinyt-todo-mcp.git
    cd tinyt-todo-mcp
  2. 安装依赖 确保你已经安装了 Bun 运行时环境。然后运行:
    bun install

服务器配置

MCP 客户端需要配置以下 JSON 信息以连接到 Tiny TODO MCP Server。

{
  "serverName": "tiny-todo-mcp-server",
  "command": "bun",
  "args": ["run", "src/index.ts"]
}

配置参数说明:

  • 'serverName': 服务器名称,必须设置为 '"tiny-todo-mcp-server"'。
  • 'command': 启动服务器的命令,这里使用 'bun' 运行时。
  • 'args': 传递给 'bun' 命令的参数,'["run", "src/index.ts"]' 表示运行 'src/index.ts' 文件,即启动 Tiny TODO MCP Server。

可选配置:

  • 自定义数据库路径: 默认情况下,数据库文件 'tiny-todo.db' 将在项目根目录下创建。如果需要指定数据库文件路径,可以在 'args' 中添加数据库路径作为参数。例如,将数据库文件存储在 '/data/todo.db',则 'args' 配置应修改为:
    "args": ["run", "src/index.ts", "/data/todo.db"]

基本使用方法

  1. 启动服务器: 在项目根目录下,使用 MCP 客户端配置中指定的命令启动服务器。通常 MCP 客户端会自动完成此步骤。

  2. 通过 MCP 客户端与服务器交互: 使用支持 MCP 协议的 AI 助手客户端,配置上述服务器连接信息后,即可通过自然语言指令调用 Tiny TODO MCP Server 提供的工具,例如:

    • AI 助手发送请求调用 'update_todo' 工具,可以创建一个新的 TODO 任务或更新最近的任务。
    • AI 助手发送请求调用 'get_latest_todo' 工具,可以获取最新的 TODO 任务。
    • AI 助手发送请求调用 'search_todo' 工具,可以根据关键词搜索相关的 TODO 任务。

    具体的工具调用和参数传递方式,请参考 MCP 协议文档和 AI 助手客户端的使用说明。服务器返回的结果将包含 TODO 内容以及用于格式化 TODO 内容的 Prompt 提示,AI 助手可以利用这些信息更好地呈现和处理 TODO 任务。

信息

分类

生产力应用