Skip to main content

Changelog

All notable changes to the Shelly API Docs MCP Server will be documented in this file.

The format is based on Keep a Changelog.

[2026.04.11] - 2026-04-11

Added

  • New get_script_api tool for looking up Shelly Script API methods (Shelly.getComponentStatus, Timer.set, MQTT.subscribe, etc.) — the methods available inside device scripts
  • New script_help prompt with scripting best practices: synchronous vs asynchronous patterns, event-driven design, resource limits
  • New script format for get_example tool — generates idiomatic on-device script code using synchronous methods where available
  • Script API methods are now indexed (60 methods across Shelly, Timer, MQTT, BLE, Virtual, HTTPServer, UART, AES, and utility APIs)
  • get_api_method now includes scripting hints for GetStatus/GetConfig methods, recommending the synchronous Shelly.getComponentStatus()/Shelly.getComponentConfig() alternatives

Changed

  • Tool descriptions updated to distinguish between RPC API methods and Script API methods, guiding AI toward the correct tool for scripting questions

[2026.04.10] - 2026-04-10

Added

  • Initial release of the Shelly API Docs MCP Server
  • 7 tools: search_docs, search_changelog, get_document, get_api_method, list_devices, list_methods, get_example
  • 4 resources: shelly://docs, shelly://methods, shelly://devices, shelly://components
  • 3 prompts: api_help, device_setup, code_example
  • Setup guides for Claude Desktop, Cursor, VS Code, Windsurf, ChatGPT, Continue.dev, and Cline
  • Health check endpoint at /mcp/health
  • Remote MCP server using Streamable HTTP transport