项目简介

该项目提供了一个基于 Model Context Protocol (MCP) 的服务器实现示例,旨在展示如何将一个简单的任务管理后端 API 集成到支持 MCP 的大型语言模型 (LLM) 客户端(如 Cursor 编辑器)中。通过此项目,用户可以直接在 LLM 聊天界面中,使用自然语言与后端进行交互,创建、更新或删除任务。

主要功能点

  • 任务创建: 允许通过自然语言指令创建新的任务,包含标题、描述和状态。
  • 任务更新: 支持修改现有任务的标题、描述或状态。
  • 任务删除: 可以根据任务标识删除指定的任务。
  • 通用问候: 提供一个简单的问候功能,作为工具调用的示例。

安装步骤

  1. 克隆仓库: 将项目代码克隆到本地。
  2. 启动后端服务:
    • 进入 'backend' 目录。
    • 运行 'npm install' 安装依赖。
    • 运行 'npm start' 启动任务管理 API 服务,默认运行在端口 5000。
  3. 设置 MCP 服务器:
    • 进入 'mcp-server' 目录。
    • 运行 'npm install' 安装 MCP 服务器所需的依赖。

服务器配置(供MCP客户端参考)

MCP客户端需要配置服务器的启动命令和参数才能连接。对于此项目,您需要为您的MCP客户端(如 Cursor)配置以下信息:

  • 服务器名称 (server name): 'task-manager'
  • 启动命令 (command): 'node'
  • 启动参数 (args): '["mcp-server/index.js"]' (这是一个数组,包含要执行的脚本路径)
  • 描述 (description): 'A task management server'

通常,这些配置会保存在客户端特定的配置文件中(例如 Cursor 的 '.cursor/mcp.json'),并通过客户端界面启用。请查阅您的 MCP 客户端文档以了解具体的配置方式。配置完成后,重启客户端并确保服务器已启用。

基本使用方法

在支持MCP并已正确配置和启用此服务器的客户端(如 Cursor 聊天界面)中,您可以使用自然语言发出指令来调用服务器暴露的任务管理工具:

  • 创建任务: 输入类似 "创建一个任务,标题是 '编写项目文档',描述是 '详细说明安装和使用步骤'" 的指令。
  • 更新任务: 输入类似 "将任务 [任务ID] 的状态标记为 '已完成'" 或 "更新任务 [任务ID],将标题改为 '完成文档编写'" 的指令。(注意:您需要先通过其他方式获取到任务的实际ID)
  • 删除任务: 输入类似 "删除任务 [任务ID]" 的指令。
  • 获取问候: 输入类似 "问候 Jay" 的指令。

信息

分类

生产力应用