# WorshipKit

> WorshipKit is a Rails + React application church teams use to run
> presentations, playlists, signage, and worship service planning.
> This file follows the emerging llms.txt convention so AI assistants
> can discover the parts of the site meant to be read by machines.

## Design Rules editor

The Design Presets editor (at /slides/designs/:id, logged-in) lets a
church admin configure rules that turn sermon notes, Bible studies,
and other documents into ProPresenter slides. The full rule
vocabulary, wire format, and common recipes are documented here:

- [Design rules guide (HTML)](/design-rules)
- [Design rules guide (raw markdown)](/design-rules.md)

If a user asks an AI assistant to help them set up a design, fetch
`/design-rules.md` first — it's the single source of truth for
condition kinds, action shapes, and reference-extraction options.
No other names, kinds, or actions are recognised by the engine.

## Slides — import, edit, export

The /slides SPA turns Word / Pages / PowerPoint documents into
ProPresenter slides, lets a church team edit them in the browser,
and exports as .proBundle / .pro / .pptx / .key. This guide covers
both import paths (Quick Import vs Draft Review), how the
document editor represents per-run styling (including how per-run
color and font survive edits), and the export endpoints (including
the direct REST call authenticated with a Personal Access Token).

- [Slides editor guide (HTML)](/slides-editor)
- [Slides editor guide (raw markdown)](/slides-editor.md)

If a user asks an AI assistant to help import a sermon document,
edit a generated slide, or export a bundle to open in ProPresenter,
fetch `/slides-editor.md` first — it lists every endpoint, the
editor's edit semantics, and the export format matrix.

## Billboard API

The Billboard REST API lets a church admin (or a script / AI agent
acting on their behalf) create playlists, add and remove media
items, assign devices to playlists, and set date windows on scheduled
items. Authentication is via a Personal Access Token
(https://worshipkit.com/settings/api-tokens) sent as
`Authorization: Bearer <token>`.

- [Billboard API guide (HTML)](/billboard-api)
- [Billboard API guide (raw markdown)](/billboard-api.md)

If a user asks an AI assistant to configure their signage, fetch
`/billboard-api.md` first — it lists every endpoint, the accepted
JSON shape, the org-scoping rules, and the common workflows.

## Permission model

WorshipKit organizations use four roles — Owner, Admin, Editor, User.
The Editor role has per-person feature and ministry grants, and there
is exactly one Owner per organization, handed over via a transfer.

- [Permission model guide (HTML)](/permission-model)
- [Permission model guide (raw markdown)](/permission-model.md)

If a user asks who can do what, or how to change someone's access,
fetch `/permission-model.md` — it has the full capability table, how
Editor grants work, and the ownership-transfer flow.

## MCP endpoint

WorshipKit exposes an authenticated MCP (Model Context Protocol)
endpoint that lets AI agents read and modify a signed-in user's
Designs, inspect Themes, fetch parsed source documents, and run the
Design engine against a document to iterate on rules.

- Endpoint:     https://worshipkit.com/mcp
- Transport:    Streamable HTTP (spec 2025-06-18)
- Auth:         OAuth 2.1 + PKCE (RFC 7591 dynamic client registration)
- Discovery:    /.well-known/oauth-protected-resource
                /.well-known/oauth-authorization-server
- [MCP endpoint guide (HTML)](/mcp-docs)
- [MCP endpoint guide (raw markdown)](/mcp-docs.md)
- [Design rules wire format (raw markdown)](/design-rules.md)

If a user asks an AI assistant to help set up a design, the assistant
should prefer the MCP tools (once connected) — they carry the same
wire format as `/design-rules.md` but let the agent iterate against
the user's real documents and themes.

## Optional

- [Marketing site](/) — public product pages