to-do-list-mcp-server

🚀 待办事项列表 MCP 服务器

这是一个基于 Model Context Protocol (MCP) 实现的简单待办事项管理器，借助 MCP 工具可进行基本的 CRUD 操作，为用户提供便捷的待办事项管理体验。

🚀 快速开始

本待办事项列表 MCP 服务器能让你轻松管理待办事项。下面为你介绍如何快速开启使用。

✨ 主要特性

• 待办事项操作：支持添加新的待办事项、查看所有待办事项以及根据 ID 删除待办事项。
• 类型安全：使用 Zod 验证实现类型安全操作。
• 存储方式：采用简单的内存存储。
• 传输方式：具备便于集成的 Stdio 传输。

📦 安装指南

在项目中安装所需依赖，执行以下命令：

npm install @modelcontextprotocol/sdk zod

💻 使用示例

基础用法

运行服务器：

npm run start

高级用法

可用工具及其使用说明：

1. add-todo：添加一个新的待办事项。

   • 参数：{text: string}
   • 返回成功消息及分配的 ID

2. get-todos：获取所有待办事项。

   • 返回格式化的待办事项列表或空状态消息

3. remove-todo：删除一个待办事项。

   • 参数：{id: number}
   • 返回删除成功的消息，如果未找到 ID 则返回错误

以下是代码示例：

// 添加一个新的待办事项
await client.callTool({
    name: "add-todo",
    arguments: { text: "购买杂货" }
});

// 获取所有待办事项
await client.callTool({ name: "get-todos" });

// 删除一个待办事项
await client.callTool({
    name: "remove-todo",
    arguments: { id: 1 }
});

🔧 技术细节

• 协议合规：使用 MCP 服务器 SDK 确保协议合规。
• 操作模式：实现工具模式进行操作。
• 通信方式：使用 Stdio 传输进行通信。
• 状态维护：在内存中维护状态以确保简单性。

📚 详细文档

使用 MCP 客户端（如 claude）测试服务器的步骤如下：

1. 运行服务器。
2. 使用 MCP 检查器连接。
3. 分别测试每个工具。
4. 验证响应和错误处理。