Metadata-Version: 2.4
Name: thingspanel-mcp
Version: 0.1.10
Summary: MCP server for ThingsPanel IoT platform
Author-email: ThingsPanel <info@thingspanel.com>
License:                                  Apache License
                                   Version 2.0, January 2004
                                http://www.apache.org/licenses/
        
           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
        
           1. Definitions.
        
              "License" shall mean the terms and conditions for use, reproduction,
              and distribution as defined by Sections 1 through 9 of this document.
        
              "Licensor" shall mean the copyright owner or entity authorized by
              the copyright owner that is granting the License.
        
              "Legal Entity" shall mean the union of the acting entity and all
              other entities that control, are controlled by, or are under common
              control with that entity. For the purposes of this definition,
              "control" means (i) the power, direct or indirect, to cause the
              direction or management of such entity, whether by contract or
              otherwise, or (ii) ownership of fifty percent (50%) or more of the
              outstanding shares, or (iii) beneficial ownership of such entity.
        
              "You" (or "Your") shall mean an individual or Legal Entity
              exercising permissions granted by this License.
        
              "Source" form shall mean the preferred form for making modifications,
              including but not limited to software source code, documentation
              source, and configuration files.
        
              "Object" form shall mean any form resulting from mechanical
              transformation or translation of a Source form, including but
              not limited to compiled object code, generated documentation,
              and conversions to other media types.
        
              "Work" shall mean the work of authorship, whether in Source or
              Object form, made available under the License, as indicated by a
              copyright notice that is included in or attached to the work
              (an example is provided in the Appendix below).
        
              "Derivative Works" shall mean any work, whether in Source or Object
              form, that is based on (or derived from) the Work and for which the
              editorial revisions, annotations, elaborations, or other modifications
              represent, as a whole, an original work of authorship. For the purposes
              of this License, Derivative Works shall not include works that remain
              separable from, or merely link (or bind by name) to the interfaces of,
              the Work and Derivative Works thereof.
        
              "Contribution" shall mean any work of authorship, including
              the original version of the Work and any modifications or additions
              to that Work or Derivative Works thereof, that is intentionally
              submitted to Licensor for inclusion in the Work by the copyright owner
              or by an individual or Legal Entity authorized to submit on behalf of
              the copyright owner. For the purposes of this definition, "submitted"
              means any form of electronic, verbal, or written communication sent
              to the Licensor or its representatives, including but not limited to
              communication on electronic mailing lists, source code control systems,
              and issue tracking systems that are managed by, or on behalf of, the
              Licensor for the purpose of discussing and improving the Work, but
              excluding communication that is conspicuously marked or otherwise
              designated in writing by the copyright owner as "Not a Contribution."
        
              "Contributor" shall mean Licensor and any individual or Legal Entity
              on behalf of whom a Contribution has been received by Licensor and
              subsequently incorporated within the Work.
        
           2. Grant of Copyright License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              copyright license to reproduce, prepare Derivative Works of,
              publicly display, publicly perform, sublicense, and distribute the
              Work and such Derivative Works in Source or Object form.
        
           3. Grant of Patent License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              (except as stated in this section) patent license to make, have made,
              use, offer to sell, sell, import, and otherwise transfer the Work,
              where such license applies only to those patent claims licensable
              by such Contributor that are necessarily infringed by their
              Contribution(s) alone or by combination of their Contribution(s)
              with the Work to which such Contribution(s) was submitted. If You
              institute patent litigation against any entity (including a
              cross-claim or counterclaim in a lawsuit) alleging that the Work
              or a Contribution incorporated within the Work constitutes direct
              or contributory patent infringement, then any patent licenses
              granted to You under this License for that Work shall terminate
              as of the date such litigation is filed.
        
           4. Redistribution. You may reproduce and distribute copies of the
              Work or Derivative Works thereof in any medium, with or without
              modifications, and in Source or Object form, provided that You
              meet the following conditions:
        
              (a) You must give any other recipients of the Work or
                  Derivative Works a copy of this License; and
        
              (b) You must cause any modified files to carry prominent notices
                  stating that You changed the files; and
        
              (c) You must retain, in the Source form of any Derivative Works
                  that You distribute, all copyright, patent, trademark, and
                  attribution notices from the Source form of the Work,
                  excluding those notices that do not pertain to any part of
                  the Derivative Works; and
        
              (d) If the Work includes a "NOTICE" file as part of its
                  distribution, then any Derivative Works that You distribute must
                  include a readable copy of the attribution notices contained
                  within such NOTICE file, excluding those notices that do not
                  pertain to any part of the Derivative Works, in at least one
                  of the following places: within a NOTICE file distributed as part
                  of the Derivative Works; within the Source form or documentation,
                  if provided along with the Derivative Works; or, within a
                  display generated by the Derivative Works, if and wherever such
                  third-party notices normally appear. The contents of the NOTICE
                  file are for informational purposes only and do not modify the
                  License. You may add Your own attribution notices within
                  Derivative Works that You distribute, alongside or as an addendum
                  to the NOTICE text from the Work, provided that such additional
                  attribution notices cannot be construed as modifying the License.
        
              You may add Your own copyright statement to Your modifications and
              may provide additional or different license terms and conditions
              for use, reproduction, or distribution of Your modifications, or
              for any such Derivative Works as a whole, provided Your use,
              reproduction, and distribution of the Work otherwise complies with
              the conditions stated in this License.
        
           5. Submission of Contributions. Unless You explicitly state otherwise,
              any Contribution intentionally submitted for inclusion in the Work
              by You to the Licensor shall be under the terms and conditions of
              this License, without any additional terms or conditions.
              Notwithstanding the above, nothing herein shall supersede or modify
              the terms of any separate license agreement you may have executed
              with Licensor regarding such Contributions.
        
           6. Trademarks. This License does not grant permission to use the trade
              names, trademarks, service marks, or product names of the Licensor,
              except as required for reasonable and customary use in describing the
              origin of the Work and reproducing the content of the NOTICE file.
        
           7. Disclaimer of Warranty. Unless required by applicable law or
              agreed to in writing, Licensor provides the Work (and each
              Contributor provides its Contributions) on an "AS IS" BASIS,
              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
              implied, including, without limitation, any warranties or conditions
              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
              PARTICULAR PURPOSE. You are solely responsible for determining the
              appropriateness of using or redistributing the Work and assume any
              risks associated with Your exercise of permissions under this License.
        
           8. Limitation of Liability. In no event and under no legal theory,
              whether in tort (including negligence), contract, or otherwise,
              unless required by applicable law (such as deliberate and grossly
              negligent acts) or agreed to in writing, shall any Contributor be
              liable to You for damages, including any direct, indirect, special,
              incidental, or consequential damages of any character arising as a
              result of this License or out of the use or inability to use the
              Work (including but not limited to damages for loss of goodwill,
              work stoppage, computer failure or malfunction, or any and all
              other commercial damages or losses), even if such Contributor
              has been advised of the possibility of such damages.
        
           9. Accepting Warranty or Additional Liability. While redistributing
              the Work or Derivative Works thereof, You may choose to offer,
              and charge a fee for, acceptance of support, warranty, indemnity,
              or other liability obligations and/or rights consistent with this
              License. However, in accepting such obligations, You may act only
              on Your own behalf and on Your sole responsibility, not on behalf
              of any other Contributor, and only if You agree to indemnify,
              defend, and hold each Contributor harmless for any liability
              incurred by, or claims asserted against, such Contributor by reason
              of your accepting any such warranty or additional liability.
        
           END OF TERMS AND CONDITIONS
        
           Copyright 2024 ThingsPanel
        
           Licensed under the Apache License, Version 2.0 (the "License");
           you may not use this file except in compliance with the License.
           You may obtain a copy of the License at
        
               http://www.apache.org/licenses/LICENSE-2.0
        
           Unless required by applicable law or agreed to in writing, software
           distributed under the License is distributed on an "AS IS" BASIS,
           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
           See the License for the specific language governing permissions and
           limitations under the License. 
Project-URL: Homepage, https://github.com/ThingsPanel/thingspanel-mcp
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: mcp<2.0.0,>=1.2.0
Requires-Dist: httpx>=0.23.0
Requires-Dist: websockets>=13.0
Dynamic: license-file

# ThingsPanel MCP

[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
[![Python Version](https://img.shields.io/pypi/pyversions/thingspanel-mcp.svg)](https://pypi.org/project/thingspanel-mcp/)
[![PyPI version](https://badge.fury.io/py/thingspanel-mcp.svg)](https://pypi.org/project/thingspanel-mcp/)

ThingsPanel MCP connects MCP-compatible assistants to ThingsPanel and ThingsVis APIs. It offers both focused IoT tools and individually named API tools with fixed, source-audited routes.

[English](https://github.com/ThingsPanel/thingspanel-mcp/blob/codex/release-0.1.10/README.md) | [中文](https://github.com/ThingsPanel/thingspanel-mcp/blob/codex/release-0.1.10/README_CN.md)

## What it includes

- 376 MCP tools: 363 generated API tools plus 13 focused device, telemetry, dashboard, and control tools.
- The generated set covers 311 ThingsPanel and 52 ThingsVis API operations, including device, telemetry, alarms, groups, products, service access, dashboards, and uploads.
- 177 generated read operations. The remaining 186 write or control operations require the tool argument confirmed=true.
- Structured JSON results, business-code error detection, path encoding, file upload support, and bounded SSE/WebSocket reads.
- Authentication profiles for ThingsPanel and ThingsVis. Authorization is always enforced by the connected service.

The complete allow-listed API inventory is in src/thingspanel_mcp/api_manifest.json. The tool definitions fix the HTTP method and route; callers provide path_params, query, body, and optional file_path values.

## Requirements and installation

- Python 3.8 or later.
- A ThingsPanel account and a credential accepted by the target API. ThingsVis operations may require ThingsVis credentials as well.

Install from PyPI:

    python -m pip install --upgrade thingspanel-mcp

Run without a persistent installation using uv:

    uvx --from thingspanel-mcp thingspanel-mcp --help

Install from source:

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

## Authentication and permissions

ThingsPanel Community supports SYS_ADMIN and TENANT_ADMIN. It does not have tenant subusers; tenant-user accounts are an Enterprise edition capability. ThingsPanel API keys map to tenant-administrator permissions. A system administrator must use a ThingsPanel login JWT.

ThingsVis credentials are separate from ThingsPanel credentials. The ThingsVis SSO exchange uses the ThingsPanel JWT from the selected profile; ThingsVis validates that token server-to-server and derives the role from the verified identity. The MCP caller cannot submit a role or user identity to elevate access.

Use a profile for each identity. The default profile is used when a tool does not specify profile. The 13 focused convenience tools use the default profile; the generated API tools accept an explicit profile argument.

Create ~/.thingspanel/config.json:

    {
      "base_url": "https://thingspanel.example.com",
      "api_prefix": "/api/v1",
      "thingsvis_base_url": "https://thingsvis.example.com",
      "thingsvis_api_prefix": "/api/v1",
      "profiles": {
        "default": {
          "thingspanel_token": "<tenant-admin-jwt>",
          "thingsvis_token": "<thingsvis-jwt>",
          "thingsvis_open_api_key": "<dashboard-open-api-key>"
        },
        "tenant_admin": {
          "thingspanel_token": "<tenant-admin-jwt>"
        },
        "superadmin": {
          "thingspanel_token": "<sys-admin-jwt>"
        }
      }
    }

Keep this file private; on macOS or Linux, restrict access with chmod 600 ~/.thingspanel/config.json. Never commit real credentials.

Environment variables can override the default profile and endpoints:

    THINGSPANEL_CONFIG_PATH
    THINGSPANEL_BASE_URL
    THINGSPANEL_API_PREFIX
    THINGSPANEL_TOKEN
    THINGSPANEL_API_KEY
    THINGSPANEL_REFRESH_TOKEN
    THINGSVIS_BASE_URL
    THINGSVIS_API_PREFIX
    THINGSVIS_TOKEN
    THINGSVIS_REFRESH_TOKEN
    THINGSVIS_OPEN_API_KEY
    THINGSVIS_INTERNAL_SECRET

Named profile credentials use THINGSPANEL_PROFILE_<NAME>_TOKEN, THINGSPANEL_PROFILE_<NAME>_API_KEY, THINGSPANEL_PROFILE_<NAME>_THINGSPANEL_REFRESH_TOKEN, THINGSPANEL_PROFILE_<NAME>_THINGSVIS_TOKEN, and THINGSPANEL_PROFILE_<NAME>_THINGSVIS_REFRESH_TOKEN. For example, THINGSPANEL_PROFILE_SUPERADMIN_TOKEN. Environment credentials are loaded at process startup.

For a single default identity, the command line is also available:

    thingspanel-mcp --token "<ThingsPanel login JWT>" --base-url "https://thingspanel.example.com"

Use --api-key only when connecting as a tenant administrator. The token and API-key command-line arguments may be visible to local process inspection; a protected config file or a secret manager is preferable.

## Configure an MCP client

The default transport is stdio. SSE is available with --transport sse. Keep credentials outside client configuration by pointing the server to a protected config file or by using the client's environment support.

### Codex

Add this to ~/.codex/config.toml:

    [mcp_servers.thingspanel]
    command = "uvx"
    args = ["--from", "thingspanel-mcp==0.1.10", "thingspanel-mcp"]

    [mcp_servers.thingspanel.env]
    THINGSPANEL_CONFIG_PATH = "/absolute/path/to/.thingspanel/config.json"

Restart or refresh Codex MCP servers after changing the configuration.

### Claude Desktop

Add a server entry to claude_desktop_config.json:

    {
      "mcpServers": {
        "thingspanel": {
          "command": "uvx",
          "args": ["--from", "thingspanel-mcp==0.1.10", "thingspanel-mcp"],
          "env": {
            "THINGSPANEL_CONFIG_PATH": "/absolute/path/to/.thingspanel/config.json"
          }
        }
      }
    }

### WorkBuddy

For local stdio use, add a server entry to ~/.workbuddy/mcp.json:

    {
      "mcpServers": {
        "thingspanel": {
          "type": "stdio",
          "command": "uvx",
          "args": ["--from", "thingspanel-mcp==0.1.10", "thingspanel-mcp"],
          "env": {
            "THINGSPANEL_CONFIG_PATH": "/absolute/path/to/.thingspanel/config.json"
          }
        }
      }
    }

This local configuration is separate from publishing a WorkBuddy marketplace connector. Marketplace submission also needs connector metadata, an MCP manifest, an icon, and review. For user-entered credentials, follow WorkBuddy's token-auth configuration. A Skill is optional for standard MCP tool schemas, but is useful for guiding tool selection and safe workflows across this large tool set. See the [WorkBuddy connector guide](https://open.workbuddy.cn/docs/connector).

## Calling tools

Each generated tool represents exactly one allow-listed API operation. For example, a device-detail tool uses path_params for its route identifier:

    path_params = {"id": "device-id"}
    profile = "tenant_admin"

Supply query parameters in query and JSON request data in body. File-upload tools accept file_path and, where needed, upload_field. Choose the profile that owns the requested data; do not ask the MCP server to impersonate another role.

For every generated write or control tool, first explain the intended action and obtain the user's approval in the host application. Then call the tool with confirmed=true. If confirmed is false, the tool returns confirmation_required and a request preview without sending the request. This flag is an additional guard, not a replacement for user approval or backend authorization.

Streaming tools accept stream_messages from 1 to 20 and stream_seconds from 1 to 30. Defaults are 5 messages and 5 seconds.

## Results and troubleshooting

Successful calls return a structured result similar to:

    {"ok": true, "status": 200, "data": {...}}

Failed calls return ok=false with status and error information where available. ThingsPanel business codes are checked even when HTTP status is 200.

- A configuration error naming a profile means that profile is missing or lacks credentials for that service.
- A 401 or 403 means the credential is invalid or its service-side role cannot access that operation.
- A response with confirmation_required is a write preview. Set confirmed=true only after the action has been approved.
- A missing_path_parameter error means a required route value is absent from path_params.
- SSE and WebSocket results are intentionally bounded; a partial result may mean the configured time or message limit was reached.
- For URL or proxy issues, check the service base URL and API prefix for that environment.

## Security notes

- The server never trusts a caller-supplied role; the connected backend is authoritative.
- API tools are allow-listed from the checked-in manifest. They do not accept arbitrary method or URL values.
- 186 generated writes and controls require confirmed=true, and remain subject to backend permissions.
- Tokens and API keys are not printed by request error handling. Keep local config files private and rotate credentials according to your organization's policy.

## Development

Run the unit tests with python -m pytest. Build release files with python -m build, then validate their metadata with python -m twine check dist/*. Use tools/build_api_manifest.py to regenerate the checked-in API inventory and tools/audit_apifox_source.py to review source-documentation differences.

## License

Apache License 2.0. See LICENSE.
