MCP Template Node

MCP Template Node

site icon
2025.04.14 0
TypeScript开发模板笔记管理开发效率
mcp-template-node 是一个基于 Node.js/TypeScript 的模板仓库,用于创建符合 Model Context Protocol (MCP) 标准的服务器。该模板展示了一个简单的笔记管理系统,通过 MCP 协议为大型语言模型 (LLMs) 提供上下文。
View on GitHub

Overview

基本能力

产品定位

mcp-template-node 是一个开发模板,旨在帮助开发者快速构建符合 MCP 标准的服务器,特别适用于需要为 LLMs 提供上下文的应用程序开发。

核心功能

  • TypeScript 实现,支持严格的类型检查
  • 简单的笔记管理系统,支持基本的 CRUD 操作
  • 完整的 MCP 概念示例(工具、资源、提示)
  • 内存存储笔记
  • 全面的错误处理和验证
  • 使用 Vitest 进行单元测试
  • VS Code 调试配置
  • GitHub Actions CI 工作流,用于测试和构建

适用场景

  • 开发需要与 LLMs 交互的应用程序
  • 快速构建符合 MCP 标准的服务器
  • 学习和理解 MCP 协议的实际应用

工具列表

  • Create Note: 创建带有标题和内容的新笔记
  • List Notes: 列出所有可用笔记及其 ID 和标题
  • Get Note: 通过 ID 检索特定笔记
  • Update Note: 更新现有笔记的标题、内容或标签
  • Delete Note: 通过 ID 删除笔记

常见问题解答

无明确常见问题解答部分。

使用教程

使用依赖

  • Node.js 18 或更高版本
  • npm 或 yarn

安装教程

  1. 克隆仓库: bash git clone https://github.com/Rethunk-Tech/mcp-template-node.git cd mcp-template-node

  2. 安装依赖: bash yarn install

  3. 构建并运行服务器: bash yarn build yarn start

调试方式

  • 启动 TypeScript 编译器监视模式:yarn dev
  • 检查代码:yarn lint
  • 修复代码问题:yarn lint:fix
  • 运行测试:yarn test
  • 运行测试监视模式:yarn test:watch
  • 运行测试覆盖率:yarn test:coverage
  • 使用 MCP Inspector 进行独立测试:yarn inspector

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。