JinDaGe - mcp-template-node MCP Details

article

README

🚀 MCP 模板节点

这是一个用于创建 Model Context Protocol (MCP) 服务器的 Node.js/TypeScript 模板。它通过一个简单的笔记管理系统，为你展示了 MCP 协议的具体应用，能帮助你快速上手 MCP 服务器的开发。

🚀 快速开始

克隆仓库

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

安装依赖

yarn install

构建并运行服务器

yarn build
yarn start

✨ 主要特性

使用严格类型检查的 TypeScript 实现，提升代码的可靠性和可维护性。
拥有简单的笔记管理系统，支持基本的 CRUD 操作。
提供 MCP 概念的完整示例，涵盖工具、资源、提示等方面。
采用内存存储笔记，方便开发和测试。
具备全面的错误处理和验证机制，确保系统的稳定性。
带有 Vitest 的单元测试，保证代码质量。
提供 VS Code 调试配置，便于开发调试。
拥有 GitHub Actions CI 工作流，用于测试和构建，实现自动化部署。

📦 安装指南

先决条件

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

💻 使用示例

基础用法

项目提供了一个简单的笔记管理系统作为 MCP 协议的使用示例，你可以按照以下步骤进行操作：

克隆仓库并安装依赖。
构建并运行服务器。
通过 API 进行笔记的创建、读取、更新和删除操作。

高级用法

如果你想扩展此模板，可以按照以下步骤进行：

在项目根目录创建 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'
};

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

📚 详细文档

项目结构

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             # 项目文档

开发

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

测试

运行测试

运行所有测试：yarn test
以观察模式运行测试（文件更改时重新运行）：yarn test:watch
以覆盖率运行测试：yarn test:coverage

测试结构

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

扩展模板

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

在项目根目录创建 config.ts 文件，定义配置信息。
在 src/tools 文件夹中创建自定义工具。

贡献指南

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

叉击仓库。
创建功能分支。
提交更改。
推送到个人仓库。
提交拉取请求。

📄 许可证

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

联系方式

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

🔍 什么是 MCP？

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

mcp-template-node