Todo管理MCP服务

一个教育项目,用于探索模型上下文协议(MCP)的能力,通过RESTful API桥接LLMs与Todo管理系统,实现自然语言交互。

  • by michalMalujdy
  • TypeScript
  • 本地部署
  • 更新于
在 GitHub 查看 michalMalujdy/todo-mcp

使用说明

所有MCP

一个探索模型上下文协议(MCP)能力的教育项目。

描述

这个项目是一个学习练习,用于理解和实验模型上下文协议(MCP)。它演示了如何构建一个MCP服务器,将LLM与RESTful API桥接起来,从而实现与Todo管理系统的自然语言交互。

该项目包括:

  • 后端:用于Todo管理的NestJS REST API
  • MCP服务器:向LLM公开后端功能的MCP服务器
  • MCP检查员:用于测试和调试MCP服务器的工具

先决条件

  • Node.js 18+和npm
  • 对TypeScript和REST API的基本理解

安装

  1. 安装后端依赖项:

    cd backend
    npm install
    
  2. 安装MCP服务器依赖项:

    cd ../mcp-server
    npm install
    
  3. (可选)为数据库添加样本数据种子:

    cd ../backend
    npm run seed
    

运行它

要启动所有服务(后端、MCP服务器和检查器),请使用提供的启动脚本:

./start.sh

此脚本将:

  1. 在上启动后端API http://localhost:3000
  2. 启动MCP服务器 http://localhost:3001
  3. 启动MCP检查器

MCP检查器配置

当检查器打开时,使用以下设置对其进行配置:

  • 传输类型:流式HTTP
  • 统一资源定位符: http://localhost:3001/mcp
  • 连接类型:通过代理

配置后,您可以通过检查器的web界面测试MCP工具、资源和提示。

项目结构

todo-mcp/
├── backend/          # NestJS REST API
├── mcp-server/       # MCP Server implementation
├── data/             # SQLite database
└── start.sh          # Start script for all services

停止服务

按 Ctrl+C 在运行启动脚本的终端中停止所有服务。

许可证

麻省理工学院