Start at the project README for the 60-second quick start. This folder holds the
deeper reference. If you're an AI agent, read AGENTS.md first — it's the canonical
guide to running Publisher and connecting over MCP.
Three runnable packages ship in the default examples environment, plus one standalone React app —
every doc below points back to one of them, and each example's README points back to the docs.
| Example |
What it shows |
| storefront |
A complete ecommerce model — joins, measures, # dashboard views, and a no-build HTML app. The flagship first-open package. |
| governed-analytics |
Givens, #(authorize), row-level access, and discovery curation in one small package. |
| html-data-app |
A no-build SaaS-subscriptions dashboard served from a package's public/ directory. |
| data-app |
Advanced/internal: a standalone React app built on the SDK, reading from storefront. Not a served package — run it with Vite. |
| Doc |
Read it when you want to… |
| publisher-app.md |
Navigate the built-in web app and see how the constructs surface. |
| ai-agents.md |
Connect an AI agent over MCP and ground it in your models. |
| explorer.md |
Build queries with the no-code visual query builder. |
| html-data-apps.md |
Ship a no-build HTML dashboard inside a package, hosted by Publisher. |
| api-overview.md |
Understand the REST + MCP surfaces and the resource hierarchy. |
| embedded-data-apps.md |
Advanced/internal: the React SDK the App is built from. |
Runtime parameters and access control all build on one mechanism — givens. Start
there for the primitive, then follow the application you need.
| Doc |
Read it when you want to… |
| givens.md |
Learn the base mechanism — declare runtime parameters, drive filter widgets, and reach access control. |
| row-level-access.md |
Restrict which rows a caller sees (given-scoped where: + #(authorize)). |
| authorize.md |
Gate who can query a whole source with #(authorize). |
| discovery-and-access.md |
Control what is discoverable and queryable (explores / queryableSources) — the visibility axis. |
| Doc |
Read it when you want to… |
| deployment.md |
Run a built server via npx, Docker, or Docker Compose. |
| configuration.md |
Look up an env var / CLI flag, or tune the OOM guards. |
| connections.md |
Connect BigQuery, Snowflake, Postgres, DuckDB, and more. |
| theming.md |
Customize colors, fonts, and light/dark mode. |
| Doc |
Read it when you want to… |
| architecture.md |
Understand how Malloy, Render, Publisher, and the SDK fit together. |
| development.md |
Build and hack on Publisher from a clone. |
| agent-skills/ |
Author or contribute the bundled agent skills. |
The complete user guide lives at
docs.malloydata.dev/documentation/user_guides/publishing.
