返回市场
麦克普-ts简单模板

麦克普-ts简单模板

作者:ChenReuven4 星标更新:2025-03-23

项目介绍

MCP TypeScript 简易模板

这是一个用于构建模型上下文协议(MCP)服务器的简单TypeScript模板。该项目提供了一个基础框架,用于创建可以与AI系统集成的自定义MCP工具。

概览

此模板实现了一个基本的MCP服务器,并包含一个示例BMI计算器工具。它展示了如何:

  • 在TypeScript中设置MCP服务器
  • 使用Zod进行输入验证来定义和实现MCP工具
  • 将服务器连接到标准I/O以进行通信

预备条件

  • Node.js(推荐版本20或更高)
  • npm 或 yarn

安装

  1. 克隆此仓库
  2. 安装依赖项:
npm install

项目结构

  • index.ts - 主服务器实现,带有示例工具
  • package.json - 项目依赖项和脚本
  • tsconfig.json - TypeScript配置

使用方法

构建和运行

编译并启动服务器:

npm start

这将编译TypeScript代码并启动MCP服务器。

开发

在开发过程中,你可以:

  1. 修改index.ts以添加自己的工具
  2. 运行构建命令以编译:
npm run build

创建自定义工具

要创建新的工具,请按照index.ts中的这个模式操作:

server.tool(
  "your-tool-name",
  {
    // 使用Zod定义输入模式
    paramName: z.string(),
    // 根据需要添加更多参数
  },
  async ({ paramName }) => ({
    content: [{
      type: "text",
      text: "您的工具响应"
    }]
  })
);

依赖项

  • @modelcontextprotocol/sdk - 核心MCP SDK
  • zod - 模式验证
  • dotenv - 环境变量管理
  • typescript - TypeScript编译器

许可证

ISC

贡献

欢迎贡献!请随时提交Pull Request。