MCP 模板节点

一个用于创建 Model Context Protocol (MCP) 服务器的 Node.js/TypeScript 模板。此模板演示了一个简单的笔记管理系统，使用 MCP 协议。

什么是 MCP？

Model Context Protocol (MCP) 是应用程序向大型语言模型（LLMs）提供上下文的一种标准化方式。了解更多信息，请访问 MCP 协议官方网站。

功能特性

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

先决条件

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

项目结构

mcp-template-node/
├── build/                # 编译后的 JavaScript 文件
├── src/
│   ├── __tests__/        # 集成测试和测试工具
│   ├── errors/           # 自定义错误类
│   ├── tools/            # MCP 工具实现
│   │   └── __tests__/    # 工具单元测试
│   ├── types/            # TypeScript 类型定义
│   │   └── __tests__/    # 类型测试
│   └── index.ts          # 服务器主入口文件，带 MCP 示例
├── package.json          # 项目配置
├── tsconfig.json         # TypeScript 配置
├── eslint.config.mjs     # ESLint 平面配置
└── README.md             # 项目文档

快速开始

1. 克隆仓库：

   git clone https://github.com/Rethunk-Tech/mcp-template-node.git
   cd mcp-template-node
   

2. 安装依赖：

   yarn install
   

3. 构建并运行服务器：

   yarn build
   yarn start
   

开发

• 启动 TypeScript 编译器的实时模式：yarn dev
• 检查代码格式：yarn lint
• 修复格式问题：yarn lint:fix
• 运行测试：yarn test

测试

该项目包含全面的测试，用于验证 MCP 服务器及其工具的功能。

运行测试

运行所有测试：

yarn test

以观察模式运行测试（文件更改时重新运行）：

yarn test:watch

以覆盖率运行测试：

yarn test:coverage

测试结构

• 单元测试：位于 __tests__ 文件夹中，带注释的示例
• 集成测试：位于 src/__tests__/integration 文件夹中
• 覆盖率报告：生成在 coverage 文件夹中

扩展模板

要扩展此模板，请执行以下步骤：

1. 在项目根目录创建 config.ts 文件，定义以下内容：

   export interface Config {
     environment: 'development' | 'production';
     port: number;
     apiPrefix: string;
   }
   
   export const config: Config = {
     environment: process.env.NODE_ENV || 'development',
     port: parseInt(process.env.PORT) || 3000,
     apiPrefix: '/api'
   };
   

2. 在 src/tools 文件夹中创建自定义工具。

贡献指南

要为项目做贡献，请遵循以下步骤：

1. 叉击仓库
2. 创建功能分支
3. 提交更改
4. 推送到个人仓库
5. 提交拉取请求

许可证

[在此处添加许可证信息]

联系方式

• 邮箱：[在此处添加邮箱地址]
• GitHub：[在此处添加 GitHub 用户名或链接]