返回 MCP 目录
public公开dns本地运行

todo-mcp-server

一个基于SQLite的简单待办事项管理MCP服务器

article

README

🚀 待办事项 MCP 服务器

这是一个简单的MCP(模型上下文协议)服务器,专门用于管理待办事项。它借助SQLite数据库进行数据存储,能有效且稳定地记录待办事项信息。

✨ 主要特性

  • 可添加新的待办事项,方便用户随时记录新任务。
  • 能够列出所有待办事项,让用户对任务一目了然。
  • 支持根据ID删除待办事项,便于清理已完成或不需要的任务。

📦 安装指南

  1. 安装依赖:
npm install
  1. 配置数据库位置(可选): 打开 src/database.ts 文件,并修改 DB_LOCATION 变量为您偏好的位置:
// 示例:
// - Windows: "C:/todos"
// - macOS: join(homedir(), "todos")
// - Linux: "/home/username/todos" 或 join(homedir(), "todos")
// - 当前目录:join(process.cwd(), "data")
const DB_LOCATION = "C:/todos";
  1. 构建项目:
npm run build

📚 详细文档

数据库

该应用程序使用SQLite进行数据存储。默认情况下,数据库文件位于 C:/todos/todos.db。您可以通过修改 src/database.ts 文件中的 DB_LOCATION 变量来更改此位置。如果指定的目录和数据库文件不存在,它们会自动创建。

可用工具

add - todo

添加一个新的待办事项到列表中。 参数:

  • text (字符串):待办事项的文字内容 示例:
add-todo(text: "购买杂货")

get - todos

列出所有待办事项。 示例:

get-todos()

remove - todo

根据ID删除一个待办事项。 参数:

  • id (数字):要删除的待办事项的ID 示例:
remove-todo(id: 1)

🔧 技术细节

该项目使用以下技术构建:

  • TypeScript:提供类型检查,增强代码的健壮性和可维护性。
  • better - sqlite3 进行数据库操作:高效地与SQLite数据库进行交互。
  • MCP SDK 实现服务器:借助MCP SDK搭建服务器,实现待办事项管理的各项功能。
help

运行方式说明

cloud

托管运行

托管运行通常表示这个 MCP Server 由服务方环境承载,用户一般按页面提供的连接方式或授权流程接入,不需要在本地长期启动一个 MCP 进程

  1. 打开服务方连接页
  2. 完成授权或复制端点
  3. 在 MCP 客户端中连接
terminal

本地运行 / 其它方式

本地运行通常需要用户在自己的电脑或服务器上安装依赖,把 server_config 复制到 MCP 客户端,并按 env_schema 补齐环境变量、密钥或其它配置

  1. 复制 server_config
  2. 安装所需依赖
  3. 补齐环境变量后重启客户端