这是一个用于创建 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
项目提供了一个简单的笔记管理系统作为 MCP 协议的使用示例,你可以按照以下步骤进行操作:
如果你想扩展此模板,可以按照以下步骤进行:
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 # 项目文档
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
文件夹中创建自定义工具。要为项目做贡献,请遵循以下步骤:
[在此处添加许可证信息]
Model Context Protocol (MCP) 是应用程序向大型语言模型(LLMs)提供上下文的一种标准化方式。了解更多信息,请访问 MCP 协议官方网站。