ThingsBoard MCP server

This MCP (Model Context Protocol) server for Thingsboard allows you to connect and interact with Thingsboard IoT platform. It provides a streamlined interface for device management and data processing through the Model Context Protocol.

Setting Up Your Environment

To get started with the Thingsboard MCP server, you'll need to set up your environment first using the uv package manager.

Windows Setup

# Install uv
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

# Create virtual environment
uv venv

# Activate virtual environment
.venv\Scripts\activate

Linux Setup

# Install uv
curl -LsSf https://astral.sh/uv/install.sh | sh

# Create virtual environment
uv venv

# Activate virtual environment
source .venv/bin/activate

Configuration

Before running the server, you need to configure the environment variables:

1. Create an environment file by copying the example:

   cp .env.example .env
   

2. Edit the .env file and add the necessary variables to connect to your Thingsboard instance. These typically include:

   • Connection credentials
   • Server endpoints
   • Authentication details

Installing Dependencies

Once your environment is set up, install the required dependencies:

uv pip install -r pyproject.toml

Running the Server

After installation and configuration, you can start the MCP server with:

uv run src/thingsboard.py

The server will start and connect to your Thingsboard instance using the credentials provided in your .env file.

Usage

When the server is running, it acts as a bridge between client applications and your Thingsboard instance using the Model Context Protocol. You can now connect your client applications to this server to interact with your IoT devices and data.

Make sure your Thingsboard instance is accessible and that you've properly configured the connection details in the .env file for successful operation.

How to add this MCP server to Cursor

There are two ways to add an MCP server to Cursor. The most common way is to add the server globally in the ~/.cursor/mcp.json file so that it is available in all of your projects.

If you only need the server in a single project, you can add it to the project instead by creating or adding it to the .cursor/mcp.json file.

Adding an MCP server to Cursor globally

To add a global MCP server go to Cursor Settings > MCP and click "Add new global MCP server".

When you click that button the ~/.cursor/mcp.json file will be opened and you can add your server like this:

{
    "mcpServers": {
        "cursor-rules-mcp": {
            "command": "npx",
            "args": [
                "-y",
                "cursor-rules-mcp"
            ]
        }
    }
}

Adding an MCP server to a project

To add an MCP server to a project you can create a new .cursor/mcp.json file or add it to the existing one. This will look exactly the same as the global MCP server example above.

How to use the MCP server

Once the server is installed, you might need to head back to Settings > MCP and click the refresh button.

The Cursor agent will then be able to see the available tools the added MCP server has available and will call them when it needs to.

You can also explictly ask the agent to use the tool by mentioning the tool name and describing what the function does.