allexd2010/thingsboard-mcp

By allexd2010

•Updated about 1 year ago

ThingsBoard MCP Server

Image

Overview Tags

allexd2010/thingsboard-mcp repository overview

⁠🚀 ThingsBoard MCP Server

Asynchronous MCP (Model Context Protocol) server for ThingsBoard API integration

⁠📋 Description

ThingsBoard MCP Server provides a comprehensive set of tools for working with ThingsBoard through the MCP protocol. The server supports all major operations with devices, assets, telemetry, alarms, and other ThingsBoard components.

⁠✨ Key Features

🔧 40+ MCP tools for ThingsBoard operations
🚀 Asynchronous architecture for high performance
📊 Real-time monitoring and telemetry
🔔 Alarm and notification management
📈 Data visualization and dashboards
🔐 Security and authentication
🐳 Ready-to-use Docker image for quick deployment

⁠🏗️ Architecture

┌─────────────────┐    ┌──────────────────┐    ┌─────────────────┐
│   Cursor IDE    │    │  MCP Server      │    │  ThingsBoard    │
│   (Client)      │◄──►│  (FastMCP)       │◄──►│  (API Server)   │
└─────────────────┘    └──────────────────┘    └─────────────────┘
                              │
                              ▼
                       ┌──────────────────┐
                       │  Tool Registry   │
                       │  (Categories)    │
                       └──────────────────┘

⁠🚀 Quick Start

⁠1. Running with Docker Compose

# docker-compose.yml
version: '3.8'
services:
  thingsboard-mcp:
    image: allexd2010/thingsboard-mcp:latest
    container_name: thingsboard-mcp
    environment:
      TB_HOST: your-thingsboard-host
      TB_PORT: 9090
      TB_USERNAME: [email protected]
      TB_PASSWORD: yourpassword
      TB_SSL: false
      TB_TIMEOUT: 30
      FASTMCP_HOST: 0.0.0.0
      FASTMCP_PORT: 8000
      FASTMCP_LOG_LEVEL: INFO
    ports:
      - "8000:8000"
    restart: unless-stopped

⁠2. Running with Docker

docker run -d \
  --name thingsboard-mcp \
  -p 8000:8000 \
  -e TB_HOST=your-thingsboard-host \
  -e TB_PORT=9090 \
  -e [email protected] \
  -e TB_PASSWORD=yourpassword \
  -e FASTMCP_HOST=0.0.0.0 \
  -e FASTMCP_PORT=8000 \
  allexd2010/thingsboard-mcp:latest

⁠3. Verifying Operation

# Check status
docker ps

# View logs
docker logs thingsboard-mcp

# Test availability
curl http://localhost:8000/sse

⁠🔧 Configuration

⁠Environment Variables

Variable	Description	Default Value
`TB_HOST`	ThingsBoard host	`localhost`
`TB_PORT`	ThingsBoard port	`9090`
`TB_USERNAME`	Username	`[email protected]`
`TB_PASSWORD`	Password	`tenant`
`TB_SSL`	Use SSL connection	`false`
`TB_TIMEOUT`	Connection timeout	`30`
`FASTMCP_HOST`	MCP server host	`0.0.0.0`
`FASTMCP_PORT`	MCP server port	`8000`
`FASTMCP_LOG_LEVEL`	Logging level	`INFO`

⁠Configuration Examples

⁠Local ThingsBoard

docker run -d \
  --name thingsboard-mcp \
  -p 8000:8000 \
  -e TB_HOST=localhost \
  -e TB_PORT=9090 \
  -e [email protected] \
  -e TB_PASSWORD=tenant \
  allexd2010/thingsboard-mcp:latest

⁠ThingsBoard Cloud

docker run -d \
  --name thingsboard-mcp \
  -p 8000:8000 \
  -e TB_HOST=demo.thingsboard.io \
  -e TB_PORT=443 \
  -e [email protected] \
  -e TB_PASSWORD=yourpassword \
  -e TB_SSL=true \
  allexd2010/thingsboard-mcp:latest

⁠🛠️ MCP Tools

⁠📂 Tool Categories

⁠🔧 Entities

Devices - create, update, delete devices
Assets - manage assets and their properties
Customers - work with ThingsBoard customers
Users - manage users and roles

⁠📊 Data

Telemetry - receive and send telemetry data
Attributes - work with device and asset attributes
Events - process events and notifications

⁠🔔 Monitoring

Alarms - create and manage alarms
Notifications - notification system
Audit - audit and security logs

⁠📈 Visualization

Dashboards - create and manage dashboards
Widgets - configure widgets and charts
Reports - generate reports

⁠⚙️ System

Rules - rule chains and data processing
Profiles - device and asset profiles
Configuration - system settings

⁠📋 Available Tools List

# Get categories list
docker exec thingsboard-mcp python src/app.py --list-categories

# Get services list
docker exec thingsboard-mcp python src/app.py --list-services

# Run with specific categories
docker exec thingsboard-mcp python src/app.py --categories entities monitoring

⁠🔍 Diagnostics

⁠Status Check

# Container status
docker ps thingsboard-mcp

# Server logs
docker logs thingsboard-mcp

# Environment variables
docker exec thingsboard-mcp env | grep -E "(TB_|FASTMCP_)"

# Test ThingsBoard connection
docker exec thingsboard-mcp curl -I http://$TB_HOST:$TB_PORT

⁠Monitoring

# Real-time logs
docker logs -f thingsboard-mcp

# Resource usage
docker stats thingsboard-mcp

# Error search
docker logs thingsboard-mcp | grep -i error

⁠🐳 Docker Images

⁠Available Tags

Tag	Description
`latest`	Latest stable version
`1.0`	Version 1.0
`dev`	Development version

⁠Image Sizes

Base image: python:3.11-slim
Final size: ~200MB
Layers: Optimized for caching

⁠Security

✅ Non-root user in container
✅ Minimal permissions
✅ Vulnerability scanning
✅ Regular updates

⁠📚 Usage Examples

⁠Cursor IDE Integration

MCP Configuration in Cursor

// mcp-config.json
{
  "mcpServers": {
    "thingsboard-mcp": {
      "command": "docker",
      "args": ["exec", "-i", "thingsboard-mcp", "python", "src/app.py", "--categories", "monitoring"],
      "env": {
        "PYTHONPATH": "/app"
      }
    }
  }
}

Usage in Chat

User: "Show all devices"
Cursor: [Uses MCP tool to get device list]

User: "Create new device named 'Sensor001'"
Cursor: [Uses MCP tool to create device]

Tag summary

Recent tags

Content type

Image

Digest

sha256:aba883f4d…

Size

142.9 MB

Last updated

about 1 year ago

docker pull allexd2010/thingsboard-mcp:1.0