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 文档
• 相关图片：
  • 配置示例图
  • 运行界面图

如需进一步帮助，请参考官方文档或联系支持团队。