Sbb MCP Server

🚀 MCP TypeScript 項目指南

MCP TypeScript 是一個用於構建高效服務器端應用的框架，支持工具、資源和提示模板等多種功能模塊。以下將詳細介紹該框架的使用方法、配置方式以及最佳實踐。

🚀 快速開始

✨ 主要特性

MCP TypeScript 框架包含以下核心組件：

1. 工具（Tools）：用於執行特定任務，例如數據處理或 API 調用。
2. 資源（Resources）：提供可按 URI 訪問的資源接口。
3. 提示模板（Prompt Templates）：定義如何將用戶輸入轉化為對話消息。

💻 使用示例

🔍 基礎用法

以下是各個核心組件的基礎使用示例：

工具示例：Echo Tool

server.tool("echo", { message: z.string() }, async ({ message }) => ({
  content: [{ type: "text", text: `Tool echo: ${message}` }],
}));

資源示例：Echo Resource

server.resource(
  "echo",
  new ResourceTemplate("echo://{message}", { list: undefined }),
  async (uri, { message }) => ({
    contents: [
      {
        uri: uri.href,
        text: `Resource echo: ${message}`,
      },
    ],
  })
);

提示模板示例：Echo Prompt

server.prompt("echo", { message: z.string() }, ({ message }) => ({
  messages: [
    {
      role: "user",
      content: {
        type: "text",
        text: `Please process this message: ${message}`,
      },
    },
  ],
}));

📦 安裝指南

此部分文檔未提及具體安裝步驟，故跳過。

📚 詳細文檔

🏗️ 項目結構

• src/index.ts：主服務器實現文件。
• src/low - level - index.ts：使用低級 API 的替代實現。
• dist/：編譯輸出目錄。

⚙️ 配置與部署

🌐 環境變量配置

1. 使用 Docker Compose

# docker-compose.yaml
services:
  mmcp-server:
    environment:
      - API_KEY=${API_KEY}
      - DATABASE_URL=${DATABASE_URL}

2. 在代碼中訪問環境變量

const apiKey = process.env.API_KEY;
const dbUrl = process.env.DATABASE_URL;

3. 本地開發配置
   • 創建 .env 文件：

API_KEY=sk - 123

• 將 .env 添加到 .gitignore 中。

4. 生產部署
   • 在部署平臺設置環境變量。
   • 避免將敏感信息提交到版本控制系統。

🚀 項目部署

🐳 Docker 部署示例

docker build -t mcp - typescript .
docker run -p 3000:3000 --env API_KEY=your_key mcp - typescript

🧪 監聽端點測試

可以使用 curl 或 Postman 測試服務端點：

curl http://localhost:3000/echo?message=test

💡 最佳實踐

1. 錯誤處理
   • 實現全面的錯誤處理機制。
   • 提供有意義的錯誤消息。
2. 類型安全
   • 使用 TypeScript 定義環境變量類型。
   • 採用 zod 進行運行時驗證。
3. 日誌記錄 使用 server.server.sendLoggingMessage 發送調試信息：

server.server.sendLoggingMessage({
  level: "info",
  data: "Starting server...",
});

📄 許可證

• 許可證：MIT License
• 維護者：MCP 開發團隊

🌟 貢獻指南

歡迎社區貢獻！請參考 CONTRIBUTING.md。

❓ 問題反饋

如遇問題，請提交至 GitHub Issues。

以上是 MCP TypeScript 框架的詳細指南，涵蓋了從配置到部署的完整流程，希望對您構建高效服務器端應用有所幫助！