项目简介

本项目是一个简单的待办事项(To-Do List)MCP服务器示例,它使用 Fireproof 数据库来存储待办事项数据,并允许用户通过支持 MCP 协议的 LLM 客户端(如 Claude Desktop)进行交互,实现待办事项的创建、查看、标记完成和删除等功能。

主要功能点

  • 待办事项管理: 支持创建、列出、标记为完成和删除待办事项。
  • 资源: 将待办事项列表和单个事项作为资源暴露给 LLM 客户端,使其能够理解和利用上下文信息。
  • 工具: 提供工具接口,允许 LLM 客户端调用 'create_todo', 'list_todos', 'mark_todo_as_done', 'delete_todo' 等工具来操作待办事项。
  • Prompt模板: 支持 'summarize_todos' Prompt模板,允许 LLM 客户端请求服务器生成总结待办事项的 Prompt,方便用户进行任务回顾。

安装步骤

  1. 安装 Node.js: 确保你的电脑上已安装 Node.js 运行环境。
  2. 克隆仓库: 打开终端,执行命令克隆代码仓库到本地:
    git clone https://github.com/jimpick/mcp-fireproof-todos.git
  3. 进入项目目录: 进入克隆下来的项目目录:
    cd mcp-fireproof-todos
  4. 安装依赖: 安装项目所需的依赖包:
    npm install
  5. 构建服务器: 构建服务器代码:
    npm run build

服务器配置

要将此 MCP 服务器与 MCP 客户端(例如 Claude Desktop)配合使用,你需要配置客户端以连接到此服务器。以 Claude Desktop 为例,你需要编辑其配置文件 'claude_desktop_config.json'(路径通常为 '~/Library/Application Support/Claude/' (MacOS) 或 '%APPDATA%/Claude/' (Windows))。

在 'claude_desktop_config.json' 文件中的 'mcpServers' 字段下添加一个新的服务器配置项,配置信息如下:

{
  "mcpServers": {
    "todos": {
      "command": "/path/to/mcp-fireproof-todos/build/index.js"
    }
  }
}
  • 'todos': 服务器名称,可以自定义,用于在客户端中引用此服务器。
  • 'command': MCP 服务器的启动命令。请将 '/path/to/mcp-fireproof-todos/build/index.js' 替换为 你本地仓库 'build/index.js' 文件的绝对路径。 例如,如果你的仓库路径是 '/Users/yourname/mcp-fireproof-todos',则 'command' 应配置为 '/Users/yourname/mcp-fireproof-todos/build/index.js'。

注意: 请勿添加 'args' 字段,此服务器不需要额外的启动参数。

基本使用方法

配置完成后,启动 Claude Desktop 等 MCP 客户端,客户端将自动连接到此 MCP 服务器。你可以通过自然语言指令与客户端进行交互,例如:

  • "添加 牛奶 到我的待办事项" - 创建一个新的待办事项 "牛奶"。
  • "我的待办事项有哪些?" - 列出当前所有待办事项。
  • "标记 买鸡蛋 为已完成" - 将包含 "买鸡蛋" 内容的待办事项标记为完成。
  • "删除 洗车 这个待办事项" - 删除包含 "洗车" 内容的待办事项。
  • "总结我的待办事项" - 请求 Claude 总结当前的待办事项列表。

具体指令取决于 LLM 客户端的理解能力,你可以根据需要调整指令以达到最佳效果。

信息

分类

生产力应用