使用说明

项目简介

ThingsPanel MCP Server 是一个基于 Model Context Protocol (MCP) 构建的应用后端，专为 ThingsPanel 物联网平台设计。它充当大型语言模型 (LLM) 客户端与 ThingsPanel 平台之间的桥梁，使得用户可以通过自然语言查询和控制物联网设备及数据。该服务器实现了 MCP 协议的关键功能，包括资源管理（物联网设备和数据）、工具注册（设备操作、数据查询等）和 Prompt 模板定义（自然语言交互模式）。

主要功能点

自然语言设备交互: 通过自然语言查询设备状态、遥测数据，并控制设备行为。
实时设备数据访问: 支持获取设备的实时遥测数据和历史数据。
设备管理功能: 提供设备列表查询、设备详情查看、设备在线状态检查等功能。
平台数据分析: 支持获取租户级别的设备统计信息和趋势报告。
灵活的设备控制: 允许通过遥测控制、属性设置和命令下发等多种方式控制设备。
物模型集成: 强调基于设备物模型进行操作，确保控制指令的有效性和准确性。
标准 MCP 协议支持: 遵循 MCP 协议规范，易于与兼容的 LLM 客户端集成。

安装步骤

环境准备: 确保已安装 Python 3.8 或更高版本。

安装 ThingsPanel MCP Server: 可以选择使用 pip 安装或从源代码安装。

Option 1: 使用 pip 安装 (推荐)

pip install thingspanel-mcp

Option 2: 从源代码安装

git clone https://github.com/ThingsPanel/thingspanel-mcp.git
cd thingspanel-mcp
pip install -e .

服务器配置

ThingsPanel MCP Server 需要配置 ThingsPanel 平台的 API Key 和 Base URL 才能正常工作。配置方式有多种，推荐使用命令行配置，以保护敏感信息。

MCP 客户端配置示例 (claude_desktop_config.json):

{
  "mcpServers": {
    "thingspanel": {
      "command": "thingspanel-mcp",
      "args": [
        "--api-key", "Your API Key",  // 替换为您的 ThingsPanel API Key
        "--base-url", "Your Base URL"   // 替换为您的 ThingsPanel Base URL，例如 "http://demo.thingspanel.cn/"
      ]
    }
  }
}

配置参数说明:

'command': MCP 服务器的启动命令，这里设置为 'thingspanel-mcp' (安装后添加到系统路径)。
'args': 启动命令的参数列表，包括:
- '--api-key': ThingsPanel 平台的 API Key，用于身份验证。请替换为您的实际 API Key。
- '--base-url': ThingsPanel 平台的 Base URL，指向您的 ThingsPanel 平台地址。请替换为您的实际平台地址。

其他配置方法 (不推荐在 MCP 客户端配置中使用，仅供参考):

命令行配置 (服务器启动时配置):

thingspanel-mcp --api-key "Your API Key" --base-url "Your ThingsPanel Base URL"

环境变量配置 (服务器运行时读取): 设置环境变量 'THINGSPANEL_API_KEY' 和 'THINGSPANEL_BASE_URL'。

基本使用方法

配置完成后，启动 ThingsPanel MCP Server，并将其配置到兼容的 MCP 客户端（如 Claude Desktop）。客户端即可通过自然语言指令与 ThingsPanel 平台进行交互。

交互示例:

查询设备状态: "设备 [设备ID或设备名称] 在线吗？"
获取遥测数据: "获取设备 [设备ID或设备名称] 的温度"
控制设备: "打开设备 [设备ID或设备名称] 的开关"
查看平台概览: "获取租户概览信息"

请参考仓库 README 或项目文档了解更多使用细节和支持的自然语言指令。

关键词