MCP TypeScript Simple Template

MCP TypeScript 简易模板

一个用于构建 Model Context Protocol（MCP）服务的简易 TypeScript 模板。本项目为创建可集成到 AI 系统中的自定义 MCP 工具提供基础框架。

概述

此模板实现了一个基础 MCP 服务，并包含一个示例 BMI 计算器工具。它演示了如何：

• 在 TypeScript 中搭建 MCP 服务
• 使用 Zod 定义并实现带输入验证的 MCP 工具
• 将服务连接到标准输入/输出以进行通信

前置条件

• 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",
  {
    // Define input schema using Zod
    paramName: z.string(),
    // Add more parameters as needed
  },
  async ({ paramName }) => ({
    content: [{
      type: "text",
      text: "Your tool's response"
    }]
  })
);

依赖项

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

许可证

ISC

贡献

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