MCP Ts Simple Template

🚀 MCP TypeScript 簡單模板

本模板用於構建模型上下文協議（MCP）服務器，為創建可與AI系統集成的自定義MCP工具提供基礎，能幫助開發者快速搭建相關項目。

🚀 快速開始

此模板實現了一個基本的MCP服務器，並附帶一個示例BMI計算器工具，展示瞭如何使用TypeScript設置MCP服務器、使用Zod定義和實現MCP工具及其輸入驗證，以及將服務器連接到標準I/O以進行通信。

✨ 主要特性

• 使用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許可證。

👥 貢獻

歡迎貢獻！請隨意提交拉取請求。