使用说明

项目简介

Todo MCP Server 是一个基于 Model Context Protocol (MCP) 构建的后端服务，它提供了一套完整的待办事项管理功能，例如添加、查询、更新、删除和标记完成待办事项。此服务器旨在作为 LLM 应用的上下文服务，使 LLM 能够通过调用工具来管理用户的待办事项。数据存储使用轻量级数据库 LokiJS，并支持本地文件持久化。

主要功能点

添加待办事项 (addTodo): 允许 LLM 添加新的待办事项，包括标题、描述和截止日期。
查询待办事项 (queryTodos): 允许 LLM 查询待办事项列表，可以根据状态（未完成、已完成、全部）进行筛选。
更新待办事项 (updateTodo): 允许 LLM 修改已存在的待办事项的标题、描述和截止日期。
删除待办事项 (deleteTodo): 允许 LLM 删除指定的待办事项。
更新待办事项状态 (toggleTodoStatus): 允许 LLM 将待办事项标记为已完成或未完成。
数据持久化: 使用 LokiJS 数据库，支持将数据持久化到本地文件，默认不持久化，可通过设置环境变量 'DB' 指定数据库文件路径来实现持久化。

安装步骤

安装 Node.js 和 npm: 确保您的环境中已安装 Node.js 和 npm (Node 包管理器)。
下载仓库代码: 从 GitHub 仓库 https://github.com/coolcao/todo-mcp-server 下载代码到本地。
安装依赖: 在项目根目录下打开终端，运行命令 'npm install' 安装项目依赖。
启动服务器: 在项目根目录下，运行命令 'npm start' 启动 MCP 服务器。服务器将通过 stdio 传输协议运行。

服务器配置

对于 MCP 客户端，您需要配置连接到 Todo MCP Server 的信息。以下是一个 JSON 格式的配置示例，您需要将其添加到您的 MCP 客户端配置中：

{
  "serverName": "todo-mcp-server",
  "command": "node",
  "args": ["src/index.js"]
}

配置参数说明:

'serverName': 服务器名称，设置为 'todo-mcp-server'，与服务器代码中定义的一致。
'command': 启动服务器的命令，由于本项目是 Node.js 应用，所以设置为 'node'。
'args': 命令参数，指定服务器入口文件路径，设置为 '["src/index.js"]'。

可选配置:

数据持久化: 如果您需要持久化待办事项数据，可以设置环境变量 'DB'。例如，在启动服务器之前，在终端中执行 'export DB=/path/to/your/todos.db' (将 '/path/to/your/todos.db' 替换为您希望保存数据库文件的路径)。不设置此环境变量则数据仅在内存中保存，服务器重启后数据将丢失。

基本使用方法

Todo MCP Server 启动后，您可以使用任何 MCP 客户端与之通信。客户端可以通过 JSON-RPC 协议调用服务器提供的工具来管理待办事项。

例如，您可以使用 MCP 客户端调用 'addTodo' 工具来添加新的待办事项，调用 'queryTodos' 工具来查询待办事项列表，等等。具体的工具参数和使用方法请参考仓库 README.md 文件和工具定义代码。

注意: 本服务器通过 stdio 进行通信，MCP 客户端需要配置为使用 stdio 传输协议，并正确配置服务器的启动命令和参数。

关键词