MCP TypeScript 简易模板

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

概述

此模板实现了一个基本的 MCP 服务器，带有一个示例 BMI 计算器工具。它演示了如何：

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

前提条件

• Node.js (推荐 v20 或更高版本)
• 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 - Schema 验证
• dotenv - 环境变量管理
• typescript - TypeScript 编译器

许可证

ISC

贡献

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