# QuickWatch

> Build Wear OS watch screens, tiles and complications from a description, with a live preview. AI assistants build a project (watch.json plus sample data.json) through the MCP server at https://quickwatch.app/mcp, or without a connector by showing the watch with the preview script and giving the user an "Open in QuickWatch" link (https://quickwatch.app/new#c=...).

## Workflow

1. If the QuickWatch connector (https://quickwatch.app/mcp) is available, use its tools: they build, validate and preview in the chat.
2. Otherwise write watch.json and sample data.json (mock data goes in data.json).
3. Show the preview with the npm package @quickwatch/preview (https://cdn.jsdelivr.net/npm/@quickwatch/preview@0/dist/quickwatch-preview.min.js) in an inline widget or HTML artifact: `QuickWatch.widget(element, watchJson, dataJson)` shows the watch, its screens and an Open in QuickWatch button. It is QuickWatch's own renderer; do not hand-draw a mock-up of the watch.
4. Give the user the Open in QuickWatch link (https://quickwatch.app/new#c=...) so they can keep it and send it to their watch.

Start with the agent guide: it has the schema essentials, the component and surface limits, two worked examples and the link format with JavaScript and Python snippets. Publishing to a watch and pairing need the user's email account; agents never publish or approve anything themselves.

## Docs

- [Agent guide](https://quickwatch.app/docs/agent-guide.md): how to write watch.json and data.json, limits, worked examples, the Open in QuickWatch link
- [Full context](https://quickwatch.app/llms-full.txt): the agent guide, a schema summary and every example in one file
- [Preview it in the chat](https://quickwatch.app/docs/agent-guide.md#preview-it-in-the-chat): without the connector, load https://cdn.jsdelivr.net/npm/@quickwatch/preview@0/dist/quickwatch-preview.min.js in an inline widget and call `QuickWatch.widget(element, watchJson, dataJson)` to show the real watch with an Open in QuickWatch button

## Schema

- [watch.json JSON Schema](https://quickwatch.app/schema/quickwatch.schema.json): the project format (schemaVersion 2)
- [Capabilities](https://quickwatch.app/schema/capabilities.json): components, tile templates, complication kinds, actions, filters, icons and surface limits

## Examples

- [agent-status](https://quickwatch.app/schema/examples/agent-status.json): What the coding agents are doing, tokens and spend; The latest GitHub Actions run (sample data: https://quickwatch.app/schema/examples/agent-status.data.json)
- [departures](https://quickwatch.app/schema/examples/departures.json): Next metro and bus departures; As many departures as fit on one tile (sample data: https://quickwatch.app/schema/examples/departures.data.json)
- [hello](https://quickwatch.app/schema/examples/hello.json): A greeting and today's visitor count (sample data: https://quickwatch.app/schema/examples/hello.data.json)
- [home-controls](https://quickwatch.app/schema/examples/home-controls.json): Home Assistant on your home Wi-Fi: door, lights, fan; The living room lamp; One-tap scenes for the house (sample data: https://quickwatch.app/schema/examples/home-controls.data.json)
- [webhook-status](https://quickwatch.app/schema/examples/webhook-status.json): Deliveries to the orders endpoint; Share of webhooks delivered today (sample data: https://quickwatch.app/schema/examples/webhook-status.data.json)

## MCP

- [MCP server metadata](https://quickwatch.app/.well-known/mcp/server.json): MCP Registry server.json, streamable HTTP at https://quickwatch.app/mcp
- [OAuth protected resource metadata](https://quickwatch.app/.well-known/oauth-protected-resource/mcp): OAuth 2.1 with PKCE; clients register with a client ID metadata document or dynamic registration

## Optional

- [Agent guide as HTML](https://quickwatch.app/docs/agent-guide)
- [MCP server card (draft)](https://quickwatch.app/.well-known/mcp/server-card.json): the MCP Server Card extension; the path is not standardised yet