Skip to content
Back to search

thingsboard-mcp

Connect AI agents to your ThingsBoard IoT platform via Model Context Protocol (MCP). Query devices, manage entities, analyze telemetry, and automate operations — all through natural language.

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/thingsboard--thingsboard-mcp/badge.svg)](/listings/thingsboard--thingsboard-mcp)

HTML

<a href="/listings/thingsboard--thingsboard-mcp"><img src="/api/listings/thingsboard--thingsboard-mcp/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

You need a ThingsBoard instance ([Cloud](https://thingsboard.cloud), [EU Cloud](https://eu.thingsboard.cloud), [self-hosted CE/PE](https://thingsboard.io/docs/user-guide/install/installation-options/), or [Edge](https://thingsboard.io/docs/user-guide/install/edge/installation-options/)) and an API key (ThingsBoard 4.3+) or username/password.

<details open> <summary><b>Claude Desktop</b></summary>

Add to your `claude_desktop_config.json`:

{
  "mcpServers": {
    "thingsboard": {
      "command": "docker",
      "args": ["run", "-i", "--rm", "-e", "THINGSBOARD_URL", "-e", "THINGSBOARD_API_KEY", "thingsboard/mcp"],
      "env": {
        "THINGSBOARD_URL": "https://thingsboard.cloud",
        "THINGSBOARD_API_KEY": "YOUR_API_KEY"
      }
    }
  }
}

</details>

<details> <summary><b>Cursor</b></summary>

Add to `~/.cursor/mcp.json` (global) or `.cursor/mcp.json` (project):

{
  "mcpServers": {
    "thingsboard": {
      "command": "docker",
      "args": ["run", "-i", "--rm", "-e", "THINGSBOARD_URL", "-e", "THINGSBOARD_API_KEY", "thingsboard/mcp"],
      "env": {
        "THINGSBOARD_URL": "https://thingsboard.cloud",
        "THINGSBOARD_API_KEY": "YOUR_API_KEY"
      }
    }
  }
}

</details>

<details> <summary><b>VS Code Copilot</b></summary>

Add to your VS Code `settings.json` or `.vscode/mcp.json`:

{
  "mcp": {
    "servers": {
      "thingsboard": {
        "command": "docker",
        "args": ["run", "-i", "--rm", "-e", "THINGSBOARD_URL", "-e", "THINGSBOARD_API_KEY", "thingsboard/mcp"],
        "env": {
          "THINGSBOARD_URL": "https://thingsboard.cloud",
          "THINGSBOARD_API_KEY": "YOUR_API_KEY"
        }
      }
    }
  }
}

</details>

<details> <summary><b>Claude Code</b></summary>

claude mcp add thingsboard \
  -e THINGSBOARD_URL=https://thingsboard.cloud \
  -e THINGSBOARD_API_KEY=YOUR_API_KEY \
  -- docker run -i --rm -e THINGSBOARD_URL -e THINGSBOARD_API_KEY thingsboard/mcp

</details>

<details> <summary><b>SSE Mode (any HTTP-based MCP client)</b></summary>

Start the server:

docker run --rm -p 8000:8000 \
  -e THINGSBOARD_URL=https://thingsboard.cloud \
  -e THINGSBOARD_API_KEY=YOUR_API_KEY \
  -e SPRING_AI_MCP_SERVER_STDIO=false \
  -e SPRING_WEB_APPLICATION_TYPE=servlet \
  thingsboard/mcp

Then point your MCP client to `http://localhost:8000/sse`.

</details>

> **Legacy auth**: If your ThingsBoard version is older than 4.3, use `THINGSBOARD_USERNAME` and `THINGSBOARD_PASSWORD` instead of `THINGSBOARD_API_KEY`.

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 498 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. # ThingsBoard MCP Server
  2. [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://github.com/thingsboard/mcp-server/blob/master/LICENSE)
  3. [![Docker](https://img.shields.io/docker/v/thingsboard/mcp?label=Docker%20Hub&sort=semver)](https://hub.docker.com/r/thingsboard/mcp)
  4. [![Java](https://img.shields.io/badge/Java-17%2B-orange)](https://github.com/thingsboard/mcp-server)
  5. Connect AI agents to your [ThingsBoard](https://thingsboard.io) IoT platform via [Model Context Protocol (MCP)](https://modelcontextprotocol.io). Query devices, manage entities, analyze telemetry, and automate operations — all through natural language.
  6. Works with Claude Desktop, Cursor, VS Code Copilot, Claude Code, and any MCP-compatible client.
  7. ## Quick Start
  8. You need a ThingsBoard instance ([Cloud](https://thingsboard.cloud), [EU Cloud](https://eu.thingsboard.cloud), [self-hosted CE/PE](https://thingsboard.io/docs/user-guide/install/installation-options/), or [Edge](https://thingsboard.io/docs/user-guide/install/edge/installation-options/)) and an API key (ThingsBoard 4.3+) or username/password.
  9. <details open>
  10. <summary><b>Claude Desktop</b></summary>
  11. Add to your `claude_desktop_config.json`:
  12. ```json
  13. {
  14. "mcpServers": {
  15. "thingsboard": {
  16. "command": "docker",
  17. "args": ["run", "-i", "--rm", "-e", "THINGSBOARD_URL", "-e", "THINGSBOARD_API_KEY", "thingsboard/mcp"],
  18. "env": {
  19. "THINGSBOARD_URL": "https://thingsboard.cloud",
  20. "THINGSBOARD_API_KEY": "YOUR_API_KEY"
  21. }
  22. }
  23. }
  24. }
  25. ```
  26. </details>
  27. <details>
  28. <summary><b>Cursor</b></summary>
  29. Add to `~/.cursor/mcp.json` (global) or `.cursor/mcp.json` (project):
  30. ```json
  31. {
  32. "mcpServers": {
  33. "thingsboard": {
  34. "command": "docker",
  35. "args": ["run", "-i", "--rm", "-e", "THINGSBOARD_URL", "-e", "THINGSBOARD_API_KEY", "thingsboard/mcp"],
  36. "env": {
  37. "THINGSBOARD_URL": "https://thingsboard.cloud",
  38. "THINGSBOARD_API_KEY": "YOUR_API_KEY"
  39. }
  40. }
  41. }
  42. }
  43. ```
  44. </details>
  45. <details>
  46. <summary><b>VS Code Copilot</b></summary>
  47. Add to your VS Code `settings.json` or `.vscode/mcp.json`:
  48. ```json
  49. {
  50. "mcp": {
  51. "servers": {
  52. "thingsboard": {
  53. "command": "docker",
  54. "args": ["run", "-i", "--rm", "-e", "THINGSBOARD_URL", "-e", "THINGSBOARD_API_KEY", "thingsboard/mcp"],
  55. "env": {
  56. "THINGSBOARD_URL": "https://thingsboard.cloud",
  57. "THINGSBOARD_API_KEY": "YOUR_API_KEY"
  58. }
  59. }
  60. }
  61. }
  62. }
  63. ```
  64. </details>
  65. <details>
  66. <summary><b>Claude Code</b></summary>
  67. ```bash
  68. claude mcp add thingsboard \
  69. -e THINGSBOARD_URL=https://thingsboard.cloud \
  70. -e THINGSBOARD_API_KEY=YOUR_API_KEY \
  71. -- docker run -i --rm -e THINGSBOARD_URL -e THINGSBOARD_API_KEY thingsboard/mcp
  72. ```
  73. </details>
  74. <details>
  75. <summary><b>SSE Mode (any HTTP-based MCP client)</b></summary>
  76. Start the server:
  77. ```bash
  78. docker run --rm -p 8000:8000 \
  79. -e THINGSBOARD_URL=https://thingsboard.cloud \
  80. -e THINGSBOARD_API_KEY=YOUR_API_KEY \
  81. -e SPRING_AI_MCP_SERVER_STDIO=false \
  82. -e SPRING_WEB_APPLICATION_TYPE=servlet \
  83. thingsboard/mcp
  84. ```
  85. Then point your MCP client to `http://localhost:8000/sse`.
  86. </details>
  87. > **Legacy auth**: If your ThingsBoard version is older than 4.3, use `THINGSBOARD_USERNAME` and `THINGSBOARD_PASSWORD` instead of `THINGSBOARD_API_KEY`.
  88. ## What You Can Do
  89. Ask questions in natural language and get structured results from your ThingsBoard instance:
  90. | | |
  91. |---|---|
  92. | **Query devices and entities** | **Analyze time-series data** |
  93. | ![Get My Devices](images/get_my_devices_example.png) | ![Analyze Data](images/analyze_data_example.png) |
  94. | **Generate and save telemetry** | **Get anomaly analysis** |
  95. | ![Generate Data](images/generate_sample_data_example.png) | ![Analysis Result](images/analyze_result_example.png) |
  96. **120+ tools** across 10 tool groups:
  97. - **Devices** — create, update, delete, list, search by name/type/group
  98. - **Assets** — CRUD, list by tenant/customer, search
  99. - **Customers** — CRUD, list, search by title
  100. - **Users** — CRUD, list, admin/customer user management
  101. - **Alarms** — create, acknowledge, clear, delete, query by severity
  102. - **Telemetry** — read/write attributes and time-series, aggregation, TTL
  103. - **Relations** — create, delete, navigate entity relationships
  104. - **OTA Packages** — upload, download, assign firmware/software to devices
  105. - **Entity Groups** (PE) — manage groups, assign/remove entities
  106. - **Entity Data Query** — complex filtered queries across all entity types with attribute/telemetry filters
  107. ## Installation
  108. ### Docker (Recommended)
  109. ```bash
  110. docker pull thingsboard/mcp
  111. ```
  112. The Docker image supports two transport modes:
  113. - **STDIO** (default) — for clients that launch the server as a subprocess (Claude Desktop, Cursor, etc.)
  114. - **SSE** — for clients that connect over HTTP
  115. See [Quick Start](#quick-start) for usage examples.
  116. ### Download Binary
  117. ```bash
  118. wget https://github.com/thingsboard/mcp-server/releases/download/v2.1.0/thingsboard-mcp-server-2.1.0.jar
  119. ```
  120. Run with:
  121. ```bash
  122. # STDIO mode
  123. java -jar thingsboard-mcp-server-2.1.0.jar
  124. # SSE mode
  125. java -Dspring.ai.mcp.server.stdio=false -Dspring.main.web-application-type=servlet -jar thingsboard-mcp-server-2.1.0.jar
  126. ```
  127. <details>
  128. <summary><b>Binary client configuration</b></summary>
  129. If you're using the JAR file instead of Docker, use this in your `claude_desktop_config.json`:
  130. ```json
  131. {
  132. "mcpServers": {
  133. "thingsboard": {
  134. "command": "java",
  135. "args": ["-jar", "/absolute/path/to/thingsboard-mcp-server-2.1.0.jar"],
  136. "env": {
  137. "THINGSBOARD_URL": "https://thingsboard.cloud",
  138. "THINGSBOARD_API_KEY": "YOUR_API_KEY"
  139. }
  140. }
  141. }
  142. }
  143. ```
  144. </details>
  145. ### Build from Source
  146. Requires Java 17+ and Maven 3.6+.
  147. ```bash
  148. git clone https://github.com/thingsboard/mcp-server.git
  149. cd mcp-server
  150. mvn clean install -DskipTests
  151. java -jar target/thingsboard-mcp-server-2.1.0.jar
  152. ```
  153. ## Configuration
  154. ### Environment Variables
  155. | Variable | Description | Default |
  156. |----------|-------------|---------|
  157. | `THINGSBOARD_URL` | Base URL of your ThingsBoard instance | *required* |
  158. | `THINGSBOARD_API_KEY` | API key for authentication (recommended for 4.3+) | |
  159. | `THINGSBOARD_USERNAME` | Username for authentication (legacy) | |
  160. | `THINGSBOARD_PASSWORD` | Password for authentication (legacy) | |
  161. | `THINGSBOARD_LOGIN_INTERVAL_SECONDS` | Session refresh interval | `1800` |
  162. | `HTTP_BIND_ADDRESS` | HTTP bind address (SSE mode) | `127.0.0.1` |
  163. | `HTTP_BIND_PORT` | HTTP port (SSE mode) | `8000` |
  164. | `SPRING_AI_MCP_SERVER_STDIO` | Enable STDIO transport | `true` |
  165. | `SPRING_WEB_APPLICATION_TYPE` | `none` for STDIO, `servlet` for SSE | `none` |
  166. | `SPRING_AI_MCP_SERVER_SSE_ENDPOINT` | SSE endpoint path | `/sse` |
  167. | `SPRING_AI_MCP_SERVER_SSE_MESSAGE_ENDPOINT` | SSE message endpoint path | `/mcp/message` |
  168. <details>
  169. <summary><b>Advanced: connection and logging</b></summary>
  170. | Variable | Description | Default |
  171. |----------|-------------|---------|
  172. | `THINGSBOARD_CONNECTION_MAX_RETRIES` | Max connection retry attempts | `3` |
  173. | `THINGSBOARD_CONNECTION_RETRY_DELAY_SECONDS` | Delay between retries | `5` |
  174. | `THINGSBOARD_CONNECTION_CONNECT_TIMEOUT_SECONDS` | HTTP connect timeout | `10` |
  175. | `THINGSBOARD_CONNECTION_READ_TIMEOUT_SECONDS` | HTTP read timeout | `60` |
  176. | `LOG_LEVEL_APP` | Application log level | `info` |
  177. | `LOG_LEVEL_TOOLS` | Tool execution log level | `info` |
  178. | `LOG_LEVEL_TOOL_RESPONSE` | Tool response log level | `info` |
  179. | `LOGGING_PATTERN_CONSOLE` | Logback console pattern | `%d{yyyy-MM-dd HH:mm:ss} \| %-5level \| %logger{1} \| %msg%n` |
  180. | `LOGGING_CONSOLE_TARGET` | Log output target | `System.err` |
  181. </details>
  182. ### Tool Groups
  183. The server exposes **120+ tools** which may exceed context limits for some clients. Disable groups you don't need:
  184. | Variable | Group | Tools | Default |
  185. |----------|-------|-------|---------|
  186. | `THINGSBOARD_TOOLS_EDQ` | Entity Data Query + Guides | 40 | `true` |
  187. | `THINGSBOARD_TOOLS_TELEMETRY` | Telemetry & Attributes | 11 | `true` |
  188. | `THINGSBOARD_TOOLS_DEVICE` | Devices | 11 | `true` |
  189. | `THINGSBOARD_TOOLS_ASSET` | Assets | 8 | `true` |
  190. | `THINGSBOARD_TOOLS_ALARM` | Alarms | 9 | `true` |
  191. | `THINGSBOARD_TOOLS_OTA` | OTA Packages | 11 | `true` |
  192. | `THINGSBOARD_TOOLS_RELATION` | Relations | 8 | `true` |
  193. | `THINGSBOARD_TOOLS_CUSTOMER` | Customers | 7 | `true` |
  194. | `THINGSBOARD_TOOLS_USER` | Users | 9 | `true` |
  195. | `THINGSBOARD_TOOLS_GROUP` | Entity Groups (PE only) | 10 | `true` |
  196. **Example** — reduce to ~50 tools for clients with limited context:
  197. ```json
  198. {
  199. "env": {
  200. "THINGSBOARD_TOOLS_EDQ": "false",
  201. "THINGSBOARD_TOOLS_OTA": "false",
  202. "THINGSBOARD_TOOLS_GROUP": "false",
  203. "THINGSBOARD_TOOLS_USER": "false"
  204. }
  205. }
  206. ```
  207. ## Available Tools
  208. <details>
  209. <summary><b>Device Tools (11)</b></summary>
  210. | Tool | Description |
  211. |------|-------------|
  212. | `createOrUpsertDevice` | Create or update a device by name. Primary tool for most device tasks. |
  213. | `saveDevice` | Create or update the device object from raw JSON. Advanced tool. |
  214. | `deleteDevice` | Delete the device by id. |
  215. | `getDeviceById` | Fetch the Device object based on the provided Device Id. |
  216. | `getDeviceCredentialsByDeviceId` | Get device credentials by device id. |
  217. | `getTenantDevices` | Returns a page of devices owned by tenant. |
  218. | `getTenantDevice` | Get tenant device by name. |
  219. | `getCustomerDevices` | Returns a page of devices assigned to customer. |
  220. | `getUserDevices` **(PE)** | Returns a page of devices available for the current user. |
  221. | `getDevicesByIds` | Get devices by ids. |
  222. | `getDevicesByEntityGroupId` **(PE)** | Returns a page of devices in a specified entity group. |
  223. </details>
  224. <details>
  225. <summary><b>Asset Tools (8)</b></summary>
  226. | Tool | Description |
  227. |------|-------------|
  228. | `saveAsset` | Create or update the asset object. |
  229. | `deleteAsset` | Delete the asset by id. |
  230. | `getAssetById` | Get the Asset object by id. |
  231. | `getTenantAssets` | Returns a page of assets owned by tenant. |
  232. | `getTenantAsset` | Get tenant asset by name. |
  233. | `getCustomerAssets` | Returns a page of assets assigned to customer. |
  234. | `getUserAssets` **(PE)** | Returns a page of assets available for the current user. |
  235. | `getAssetsByEntityGroupId` **(PE)** | Returns a page of assets in a specified entity group. |
  236. </details>
  237. <details>
  238. <summary><b>Customer Tools (7)</b></summary>
  239. | Tool | Description |
  240. |------|-------------|
  241. | `saveCustomer` | Create or update the customer object. |
  242. | `deleteCustomer` | Delete the customer by id. |
  243. | `getCustomerById` | Get the Customer object by id. |
  244. | `getCustomers` | Returns a page of customers owned by tenant. |
  245. | `getTenantCustomer` | Get customer by title. |
  246. | `getUserCustomers` **(PE)** | Returns a page of customers available for the user. |
  247. | `getCustomersByEntityGroupId` **(PE)** | Returns a page of customers in a specified entity group. |
  248. </details>
  249. <details>
  250. <summary><b>User Tools (9)</b></summary>
  251. | Tool | Description |
  252. |------|-------------|
  253. | `saveUser` | Create or update the user object. |
  254. | `deleteUser` | Delete the user by id. |
  255. | `getUserById` | Fetch the User object by id. |
  256. | `getUsers` | Returns a page of users owned by tenant or customer. |
  257. | `getTenantAdmins` | Returns a page of tenant administrator users. |
  258. | `getCustomerUsers` | Returns a page of users assigned to a customer. |
  259. | `getAllCustomerUsers` **(PE)** | Returns a page of all customer users for the current tenant. |
  260. | `getUsersForAssign` | Returns users that can be assigned to an alarm. |
  261. | `getUsersByEntityGroupId` **(PE)** | Returns a page of users in a specified entity group. |
  262. </details>
  263. <details>
  264. <summary><b>Alarm Tools (9)</b></summary>
  265. | Tool | Description |
  266. |------|-------------|
  267. | `saveAlarm` | Create or update the alarm object. |
  268. | `deleteAlarm` | Delete the alarm by id. |
  269. | `ackAlarm` | Acknowledge the alarm. |
  270. | `clearAlarm` | Clear the alarm. |
  271. | `getAlarmInfoById` | Get alarm info by id (includes originator name). |
  272. | `getAlarms` | Get a page of alarms for the selected entity. |
  273. | `getAllAlarms` | Get a page of alarms for the current user owner. |
  274. | `getHighestAlarmSeverity` | Get highest alarm severity by originator. |
  275. | `getAlarmTypes` | Get unique alarm types. |
  276. </details>
  277. <details>
  278. <summary><b>OTA Tools (11)</b></summary>
  279. | Tool | Description |
  280. |------|-------------|
  281. | `saveOtaPackageInfo` | Create or update OTA package info. |
  282. | `saveOtaPackageData` | Upload OTA package binary from a file path. |
  283. | `downloadOtaPackage` | Download OTA package binary to a local file path. |
  284. | `getOtaPackageInfoById` | Get OTA package info by id. |
  285. | `getOtaPackageById` | Get OTA package by id. |
  286. | `getOtaPackages` | Get OTA packages (paged). |
  287. | `getOtaPackagesByDeviceProfile` | Get OTA packages by device profile and type. |
  288. | `assignOtaPackageToDevice` | Assign or clear OTA package for a device. |
  289. | `assignOtaPackageToDeviceProfile` | Assign or clear OTA package for a device profile. |
  290. | `countByDeviceProfileAndEmptyOtaPackage` | Count devices without assigned OTA package. |
  291. | `deleteOtaPackage` | Delete OTA package by id. |
  292. </details>
  293. <details>
  294. <summary><b>Relation Tools (8)</b></summary>
  295. | Tool | Description |
  296. |------|-------------|
  297. | `saveRelation` | Create or update a relation. |
  298. | `deleteRelation` | Delete a relation between two entities. |
  299. | `deleteRelations` | Delete all relations for an entity. |
  300. | `getRelation` | Get a relation between two entities. |
  301. | `findInfoByFrom` | Find relations from an entity (includes entity names). |
  302. | `findByFromWithRelationType` | Find relations from an entity filtered by type. |
  303. | `findInfoByTo` | Find relations to an entity (includes entity names). |
  304. | `findByToWithRelationType` | Find relations to an entity filtered by type. |
  305. </details>
  306. <details>
  307. <summary><b>Telemetry Tools (11)</b></summary>
  308. | Tool | Description |
  309. |------|-------------|
  310. | `getAttributeKeys` | Get all attribute keys for an entity. |
  311. | `getAttributeKeysByScope` | Get attribute keys by scope. |
  312. | `getAttributes` | Get attributes for an entity. |
  313. | `getAttributesByScope` | Get attributes by scope. |
  314. | `getTimeseriesKeys` | Get all time-series keys for an entity. |
  315. | `getLatestTimeseries` | Get latest time-series values. |
  316. | `getTimeseries` | Get time-series data for a time range. |
  317. | `saveDeviceAttributes` | Save device attributes. |
  318. | `saveEntityAttributesV2` | Save entity attributes. |
  319. | `saveEntityTelemetry` | Save entity telemetry data. |
  320. | `saveEntityTelemetryWithTTL` | Save entity telemetry with TTL. |
  321. </details>
  322. <details>
  323. <summary><b>Entity Group Tools — PE only (10)</b></summary>
  324. | Tool | Description |
  325. |------|-------------|
  326. | `saveEntityGroup` | Create or update an entity group. |
  327. | `deleteEntityGroup` | Delete an entity group by id. |
  328. | `getEntityGroupById` | Get entity group by id. |
  329. | `getEntityGroupsByType` | Get entity groups by entity type. |
  330. | `getEntityGroupByOwnerAndNameAndType` | Get entity group by owner, type, and name. |
  331. | `getEntityGroupsByOwnerAndType` | Get entity groups by owner and type. |
  332. | `getEntityGroupsForEntity` | Get groups containing a specified entity. |
  333. | `getEntityGroupsByIds` | Get entity groups by ids. |
  334. | `addEntitiesToEntityGroup` | Add entities to a group. |
  335. | `removeEntitiesFromEntityGroup` | Remove entities from a group. |
  336. </details>
  337. <details>
  338. <summary><b>Entity Data Query Tools (19)</b></summary>
  339. Complex filtered queries across all entity types. Supports entity fields, attributes, and latest telemetry with key filters.
  340. | Tool | Description |
  341. |------|-------------|
  342. | `findEntityDataBySingleEntityFilter` | Find data for one entity by ID. |
  343. | `findEntityDataByEntityGroupFilter` **(PE)** | Find data by entity group. |
  344. | `findEntityDataByEntityListFilter` | Find data for a list of entity IDs. |
  345. | `findEntityDataByEntityNameFilter` | Find data by name prefix. |
  346. | `findEntityDataByEntityTypeFilter` | Find data by entity type. |
  347. | `findEntityDataByEntityGroupListFilter` **(PE)** | Find data for multiple groups. |
  348. | `findEntityDataByEntityGroupNameFilter` **(PE)** | Find data for groups by name prefix. |
  349. | `findEntityDataByEntitiesGroupNameFilter` **(PE)** | Find data for entities in a named group. |
  350. | `findEntityDataByStateEntityOwnerFilter` | Find data for entity owner. |
  351. | `findEntityDataByAssetTypeFilter` | Find assets by type. |
  352. | `findEntityDataByDeviceTypeFilter` | Find devices by type. |
  353. | `findEntityDataByEdgeTypeFilter` | Find edges by type. |
  354. | `findEntityDataByEntityViewTypeFilter` | Find entity views by type. |
  355. | `findEntityDataByRelationsQueryFilter` | Find related entities. |
  356. | `findEntityDataByAssetSearchQueryFilter` | Find related assets. |
  357. | `findEntityDataByDeviceSearchQueryFilter` | Find related devices. |
  358. | `findEntityDataByEntityViewSearchQueryFilter` | Find related entity views. |
  359. | `findEntityDataByApiUsageStateFilter` | Find API usage data. |
  360. | `findEntityDataByEdgeQueryFilter` | Find related edges. |
  361. </details>
  362. <details>
  363. <summary><b>Entity Count Query Tools (18)</b></summary>
  364. Count entities matching filters. Same filter types as Entity Data Query.
  365. | Tool | Description |
  366. |------|-------------|
  367. | `countBySingleEntityFilter` | Count by single entity ID. |
  368. | `countByEntityGroupFilter` **(PE)** | Count by entity group. |
  369. | `countByEntityListFilter` | Count by entity ID list. |
  370. | `countByEntityNameFilter` | Count by name prefix. |
  371. | `countByEntityTypeFilter` | Count by entity type. |
  372. | `countByEntityGroupListFilter` **(PE)** | Count by multiple groups. |
  373. | `countByEntityGroupNameFilter` **(PE)** | Count by group name prefix. |
  374. | `countByEntitiesGroupNameFilter` **(PE)** | Count entities in a named group. |
  375. | `countByAssetTypeFilter` | Count assets by type. |
  376. | `countByDeviceTypeFilter` | Count devices by type. |
  377. | `countByEdgeTypeFilter` | Count edges by type. |
  378. | `countByEntityViewTypeFilter` | Count entity views by type. |
  379. | `countByApiUsageStateFilter` | Count API usage rows. |
  380. | `countByRelationsQueryFilter` | Count related entities. |
  381. | `countByAssetSearchQueryFilter` | Count related assets. |
  382. | `countByDeviceSearchQueryFilter` | Count related devices. |
  383. | `countByEntityViewSearchQueryFilter` | Count related entity views. |
  384. | `countByEdgeQueryFilter` | Count related edges. |
  385. </details>
  386. <details>
  387. <summary><b>Guide Tools (3)</b></summary>
  388. Documentation tools that help LLMs construct correct queries.
  389. | Tool | Description |
  390. |------|-------------|
  391. | `getEdqGuide` | Get documentation for creating Entity Data Queries. |
  392. | `getEdqCountGuide` | Get documentation for creating Entity Count Queries. |
  393. | `getKeyFiltersGuide` | Get documentation for creating key filters. |
  394. </details>
  395. ## License
  396. This project is licensed under the Apache License 2.0 — see the [LICENSE](LICENSE) file for details.

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.