MCP Server Template

MCP 服务模板

使用 Express.js 和 TypeScript 构建的轻量且可扩展的 MCP（Model Context Protocol）服务实现。此模板为构建 AI 驱动的应用提供了坚实的基础，这些应用可通过服务器发送事件（SSE）与兼容 MCP 的客户端通信。

功能

• 支持 TypeScript 的 Express.js 服务
• 使用服务器发送事件（SSE）进行实时通信
• MCP 协议实现
• 笔记管理系统
• 支持 Docker
• 使用 Zod 进行输入验证

前提条件

• Node.js 22 或更高版本
• npm（Node.js 包管理器）
• Docker（可选）

安装

1. 克隆仓库：

git clone https://github.com/yourusername/mcp-template.git
cd mcp-template

2. 安装依赖：

npm install

3. 构建项目：

npm run build

运行服务

本地开发

npm start

服务默认会在端口 3123 上启动。

使用 Docker

构建 Docker 镜像：

docker build -t mcp-template .

运行容器：

docker run -p 3123:3123 mcp-template

API 端点

MCP 端点

• GET /mcp/sse - 建立用于 MCP 通信的 SSE 连接

可用工具

• add-note - 向笔记存储中添加新笔记

  • 参数：
    • noteTitle：string - 笔记标题
    • noteContent：string - 笔记内容
    • noteTags：string[]（可选）- 笔记标签

• update-note - 更新现有笔记

  • 参数：
    • noteId：string - 要更新的笔记 ID
    • noteTitle：string - 新笔记标题
    • noteContent：string - 新笔记内容
    • noteTags：string[]（可选）- 笔记的新标签

• get-note - 获取指定笔记

  • 参数：
    • noteId：string - 要获取的笔记 ID

• get-all-notes - 获取存储中的所有笔记

  • 参数：无

• delete-note - 从存储中删除笔记

  • 参数：
    • noteId：string - 要删除的笔记 ID

输入验证

服务使用 Zod 进行运行时类型检查和输入验证。处理前，会根据预定义的架构验证所有传入请求。这可确保整个应用的类型安全和数据完整性。

环境变量

• PORT - 服务端口（默认值：3123）
• LOG_LEVEL - 日志级别（默认值："info"）
• DOCKER - 在 Docker 中运行时设为 "true"
• DEV - 开发模式下设为 "true"

开发

项目结构

src/
├── config.ts         # Configuration settings
├── index.ts         # Application entry point
├── logger.ts        # Logging configuration
├── note-store.ts    # Note management system
└── server/
    └── routers/
        └── mcp.ts   # MCP router implementation

构建

npm run build

代码检查

npm run lint

许可证

MIT

作者

Antonio De Vivo