Watermelon UI Developers
This page is the fastest way for an engineer or agent to understand Watermelon UI from the outside in. Watermelon exposes a small but intentional set of public resources so humans and AI systems can discover the project, inspect the public catalog, and understand where source-backed contribution paths live.
Recommended starting points
- llms.txt: concise project guidance and when-to-use instructions
- OpenAPI: public HTTP contract for machine-readable endpoints
- Watermelon UI Auth Docs: current authentication model for public APIs and MCP
- Watermelon UI MCP Docs: hosted endpoint and MCP client setup guidance
- Watermelon UI Status & Integrations: build metadata, endpoints, and ops links
- Sitemap: crawlable public URL inventory
- Public catalog summary: counts by content type
- Public catalog entries: list catalog entries by kind
Public API
The public API is read-only and designed to help agents inspect the Watermelon catalog without scraping the UI. It currently supports summary, filtered listing, and single-entry lookup across animated components, blocks, dashboards, and templates. JSON errors are structured with machine-readable codes, messages, and resolution hints.
MCP
Watermelon also provides MCP support for agent workflows. The hosted MCP endpoint is intended for mcp.watermelon.sh and the platform repository also contains a repository-backed local MCP server for development and source-aware automation.
Source of truth
The UI is helpful for browsing, but the repositories are the source of truth for implementation and contribution: