MCP Ts Simple Template

🚀 MCP TypeScript 简单模板

本模板专为构建模型上下文协议（MCP）服务器而设计，提供了一个简洁的TypeScript基础框架，助力开发者创建可与AI系统集成的自定义MCP工具。

🚀 快速开始

本模板实现了一个基础的MCP服务器，还附带了一个示例BMI计算器工具，展示了以下核心操作：

• 运用TypeScript搭建MCP服务器。
• 借助Zod定义并实现MCP工具，同时完成输入验证。
• 将服务器连接到标准I/O以实现通信。

✨ 主要特性

• 提供了搭建MCP服务器的基础框架，便于快速上手。
• 集成示例工具，直观展示工具的创建和使用方式。
• 利用Zod进行输入验证，保障数据的准确性。

📦 安装指南

先决条件

• Node.js（建议版本20或更高）
• npm 或 yarn

安装步骤

1. 克隆此仓库。
2. 安装依赖：

npm install

💻 使用示例

基础用法

构建和运行

构建并启动服务器：

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: "您的工具响应"
    }]
  })
);

📚 详细文档

项目结构

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

依赖项

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

📄 许可证

本项目采用 ISC 许可证。

🔧 贡献

欢迎贡献！请随意提交拉取请求。