Mcp2mqtt

🚀 mcp2mqtt 服務器指南

mcp2mqtt 服務器為支持 MCP 協議的客戶端提供了高效的服務。通過本指南，你可以瞭解如何安裝、配置和運行該服務器，以及獲取相關的文檔參考。

🚀 快速開始

安裝與配置

📦 安裝指南

以下是 mcp2mqtt 服務器的安裝步驟：

1. 創建虛擬環境：

   uv venv .venv
   

2. 激活虛擬環境：
   • Windows：

     .venv\Scripts\activate
     

   • Linux/macOS：

     source .venv/bin/activate
     

3. 安裝開發依賴：

   uv pip install --editable .
   

⚙️ 配置說明

在支持 MCP 協議的客戶端（如 Claude Desktop 或 Cline）配置文件中添加以下內容：

使用默認演示參數：

{
    "mcpServers": {
        "mcp2mqtt": {
            "command": "uv",
            "args": [
                "--directory",
                "你的實際路徑/mcp2mqtt",  // 示例: "C:/Users/Administrator/Documents/develop/my-mcp-server/mcp2mqtt"
                "run",
                "mcp2mqtt"
            ]
        }
    }
}

指定參數文件名：

{
    "mcpServers": {
        "mcp2mqtt": {
            "command": "uv",
            "args": [
                "--directory",
                "你的實際路徑/mcp2mqtt",  // 示例: "C:/Users/Administrator/Documents/develop/my-mcp-server/mcp2mqtt"
                "run",
                "mcp2mqtt",
                "--config", // 可選參數，指定配置文件名
                "Pico"  // 可選參數，指定配置文件名，不需要添加_config.yaml後綴
            ]
        }
    }
}

📂 配置文件位置

程序按以下順序查找配置文件：

1. 當前工作目錄（適合開發測試）：

   • 路徑：./config.yaml
   • 示例：如果你在 C:\Projects 運行程序，它會查找 C:\Projects\config.yaml

2. 用戶主目錄（推薦個人使用）：

   # Windows系統
   C:\Users\用戶名\.mcp2mqtt\config.yaml
   
   # macOS系統
   /Users/用戶名/.mcp2mqtt/config.yaml
   
   # Linux系統
   /home/用戶名/.mcp2mqtt/config.yaml
   

3. 系統級配置（適合多用戶環境）：

   # Windows系統（需要管理員權限）
   C:\ProgramData\mcp2mqtt\config.yaml
   
   # macOS/Linux系統（需要root權限）
   /etc/mcp2mqtt/config.yaml
   

程序會按上述順序查找配置文件，使用找到的第一個有效配置文件。你可以根據需求選擇合適的位置：

• 開發測試：使用當前目錄
• 個人使用：建議使用用戶主目錄（推薦）
• 多用戶環境：使用系統級配置

▶️ 運行服務器

# 確保已激活虛擬環境
.venv\Scripts\activate

# 運行服務器（使用默認配置config.yaml 案例中用的LOOP_BACK 模擬串口，無需真實串口和串口設備）
uv run src/mcp2mqtt/服務器端

📚 詳細文檔

📄 API文檔

mcp2mqtt API 文檔

🖼️ 相關圖片

• 配置示例圖
• 運行界面圖

如需進一步幫助，請參考官方文檔或聯繫支持團隊。