MCP Sse Sample

🚀 MCP SSE 示例

本項目是使用SSE（Server-Sent Events）實現的MCP服務器示例，清晰展示了MCP協議中SSE的具體實現方法。

✨ 主要特性

• 提供多種實用工具，涵蓋消息回顯、數字相加、長操作進度通知、LLM採樣、圖像獲取、環境變量打印以及註釋消息展示等功能。
• 服務器會定期發送隨機級別的日誌消息，方便調試與監控。

📦 安裝指南

本地運行

# 安裝依賴
npm install

# 構建項目
npm run build

# 以STDIO模式運行
npm run start

# 以SSE模式運行
npm run start:sse

在Claude Desktop中使用

在claude_desktop_config.json文件中添加以下配置：

{
  "mcpServers": {
    "sse-sample": {
      "command": "npx",
      "args": [
        "-y",
        "mcp_sse_sample"
      ]
    }
  }
}

📚 詳細文檔

組件

工具

1. echo

   • 功能：簡單的回顯工具，可將輸入的消息原樣返回。
   • 輸入參數：
     • message (字符串)：需要回顯的消息內容。
   • 返回結果：包含回顯消息的文本內容。

2. add

   • 功能：實現兩個數字的相加操作。
   • 輸入參數：
     • a (數字)：第一個相加的數字。
     • b (數字)：第二個相加的數字。
   • 返回結果：相加結果的文本。

3. longRunningOperation

   • 功能：模擬長操作，並在執行過程中發送進度通知。
   • 輸入參數：
     • duration (數字, 默認值為10)：操作的持續時間（單位：秒）。
     • steps (數字, 默認值為5)：進度步驟的數量。
   • 返回結果：完成消息，包含操作的持續時間和步驟數。
   • 執行過程：在操作執行過程中會發送進度通知。

4. sampleLLM

   • 功能：利用MCP採樣功能演示LLM的採樣能力。
   • 輸入參數：
     • prompt (字符串)：發送給LLM的提示信息。
     • maxTokens (數字, 默認值為100)：最大生成的令牌數。
   • 返回結果：LLM生成的響應內容。

5. getTinyImage

   • 功能：返回一個小測試圖像。
   • 輸入參數：無。
   • 返回結果：Base64編碼的PNG圖像數據。

6. printEnv

   • 功能：打印所有環境變量，用於調試MCP服務器配置。
   • 輸入參數：無。
   • 返回結果：所有環境變量的JSON字符串。

7. annotatedMessage

   • 功能：展示如何使用註釋為內容提供元數據。
   • 輸入參數：
     • messageType (枚舉: "error" | "success" | "debug")：要展示的不同消息類型。
     • includeImage (布爾值, 默認值為false)：是否包含示例圖像。
   • 返回結果：具有不同註釋的內容：
     • 錯誤消息：高優先級（1.0），用戶和助理都可見。
     • 成功消息：中等優先級（0.7），面向用戶。
     • 調試消息：低優先級（0.3），面向助理。
     • 可選圖像：中等優先級（0.5），面向用戶。
   • 示例註釋：

{
  "priority": 1.0,
  "audience": ["user", "assistant"]
}

日誌

服務器每隔15秒會發送隨機級別的日誌消息，示例如下：

{
  "method": "notifications/message",
  "params": {
    "level": "info",
    "data": "Info-level message"
  }
}