Skip to content
Back to search

trmnl-mcp

Hosted MCP server for TRMNL ePaper displays: https://trmnl.com/mcp

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/usetrmnl--trmnl-mcp/badge.svg)](/listings/usetrmnl--trmnl-mcp)

HTML

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

Install

i

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 · 79 lines
  1. # TRMNL MCP server
  2. Run your [TRMNL](https://trmnl.com) ePaper displays from any AI agent that speaks the Model Context Protocol (MCP): devices, playlists, plugins and new screens.
  3. The server is hosted by TRMNL. There is nothing to install or run. This repository holds the description that MCP registries read; the server code lives in the TRMNL web app.
  4. - Endpoint: `https://trmnl.com/mcp` (streamable HTTP)
  5. - Registry name: `com.trmnl/trmnl`
  6. - Setup for each client (Claude, ChatGPT, Cursor and others): https://help.trmnl.com/en/articles/17432548-mcp-server
  7. ## Connect
  8. There are two ways to sign in. Each opens a different set of tools.
  9. ### Whole account (OAuth)
  10. Add `https://trmnl.com/mcp` as a remote MCP server. Your client opens the TRMNL sign-in page, and you pick what the agent may do. You can change or revoke that later under Account, Connected agents.
  11. ```json
  12. {
  13. "mcpServers": {
  14. "trmnl": {
  15. "type": "http",
  16. "url": "https://trmnl.com/mcp"
  17. }
  18. }
  19. }
  20. ```
  21. ### One plugin (MCP key)
  22. On a plugin's settings page in the TRMNL dashboard, click "Generate MCP Key". The key reaches that one plugin only. "Revoke Key" on the same page cuts off access straight away.
  23. ```json
  24. {
  25. "mcpServers": {
  26. "trmnl": {
  27. "type": "http",
  28. "url": "https://trmnl.com/mcp?api_key=${TRMNL_MCP_API_KEY}"
  29. }
  30. }
  31. }
  32. ```
  33. ## What an agent can do
  34. With an account sign-in, each tool is an operation of the [TRMNL REST API](https://trmnl.com/api-docs), in read and write pairs:
  35. - Devices: list, claim, change settings, flash the screen to identify one, mirror another device
  36. - Playlists: add, hide, reorder and remove screens
  37. - Plugins and plugin settings: create private plugins, change their settings, send data
  38. - Markup: read and write a plugin's HTML and Liquid for each screen size
  39. - Recipes: search, read and install community plugins
  40. - Themes, profile and apps
  41. With a plugin MCP key:
  42. - Markups: read, write, list sizes, screenshot, and list or restore earlier versions
  43. - Integrations: show settings, write settings, refresh data, read logs
  44. - Merge variables: show the data the markup renders from
  45. - Recipes: search and pull markup from community recipes
  46. - Design system: the TRMNL framework's rules, classes and examples
  47. ## Example
  48. > Make a screen that shows today's sales from our warehouse on my TRMNL in the office.
  49. The agent creates a private plugin, writes markup for each screen size, sends the numbers as merge variables, previews the result, and adds it to the device's playlist.
  50. ## Limits
  51. - Each connection may send 60 requests a minute.
  52. - A change that renders a screen counts against the account's hourly render allowance. Past it the server answers 429 until the hour is up.
  53. ## More
  54. - Authentication for agents: https://trmnl.com/auth.md
  55. - TRMNL CLI: https://github.com/usetrmnl/cli
  56. - Support: https://help.trmnl.com

Ratings and comments

Sign in to rate this skill.

Sign in

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