janela 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2416bb876bf67b3cda96853cc4cee216fd8c153a0ec4930d8243512be5c8c163
-  data.tar.gz: 1b4a35484a9d04d696771376389ab35dc17b76469ce772de54e48ed7017f5cc5
+  metadata.gz: 76a888911baddb25729442ecf07cf8975467f05792eb1881d1a6c9ec1c3d05e9
+  data.tar.gz: e3718fafdaf889aed3fd4459b722e5ed0db5b39ecffb771cb4c5599c34c0bfb9
 SHA512:
-  metadata.gz: 6f20d48d6dfcb473861d0e20b9116e135498d6879a79f9c5720a184b35a66be4189d7e74bc51431d116f4955c73b458af59ff428062e237ee0a2421564436ad0
-  data.tar.gz: 5b9c28323e356a9c6833ea25d0c0e3ef8c92225848ef7611fb4c3aeafb95bd75e7c0087d9b3957d819c161fedd1bfacd915b3731382ae78cf6874dca94202645
+  metadata.gz: 3cb99e213c2afbf7e7a570fe4c02b34f1c07fb6d7dc70e0d0fad4753c50264a3466e6f7661c52fb545a4ffa6b50a8fb1b63a6eed5e3ecbd4dd6b7670f21ed9ec
+  data.tar.gz: d9fbcebdd34dd825aeb98c98dc449ce92be38b50b1839e83c838730c0c5e9c3258e42d8410d818702032642496688279c0a9e1c361621d228d50dd7e92b9ea6d

data/CHANGELOG.md

@@ -5,6 +5,23 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.13.0] - 2026-10-02
+
+### Changed
+
+- **The vitral theme draws charts in its own colours.** Bars, doughnut slices and pie slices were the stained glass accent for the first and Janela's neutral set for the other seven; vitral now sets all eight, as soft glass tones: a muted blue, sage, lavender, plum, clay, teal, ochre and dusty rose, with the grey of lead came for anything past the eighth. A first version in saturated jewel tones was rejected by eye as a rainbow against the pale tiles, so these sit at about half the chroma and lean on differences in lightness. They were chosen as an ordered set and checked together, with adjacent colour-vision separation of 12.4 (the target is 8) and adjacent normal-vision separation of 15.8 (the floor is 15). Slot 1 is a softer blue of vitral's own; `--janela-accent` stays the stronger blue for what is selected. A host that uses vitral and has set its own `--janela-series-N` keeps them. No action needed (ADR 026, #67).
+
+### Fixed
+
+- **The engine's own chart partial compiles through Herb.** Rails 8.2 renders HTML templates through Herb, which refuses ERB that writes an attribute's name or sits in attribute position, and `janela/queries/_query.html.erb` did both for the chart's canvas. It is now one `tag.canvas` call that renders the same attributes, so a host on the 8.2 defaults is not broken by Janela's own template. A host that has copied that partial keeps its copy, which Herb will reject if it still has ERB in an attribute position: `bin/rails app:herb:check` on Rails 8.2 lists any. No action needed otherwise.
+- **The doctor no longer calls `Janela::PanesController` a stale name.** It reported an error that the name "is now `Janela::QueriesController`", true from 0.7 until 0.12 added a `Janela::PanesController` back as the stored-pane form's controller, which owns `pane_params`. A host patching that form was told to move the patch to a controller with no `pane_params`, which would have silently stopped its extra pane param saving, and the error failed `janela:doctor` until the check was silenced. It is now a warning that says what the name means today. The check is still silenced by `stale-identifiers`, and `Janela::SnapshotPanesController` is unchanged (#74).
+
+### Added
+
+- **Tools for an agent: `Janela::Tools`.** An agent in a host had no way to read or arrange a dashboard except by writing `Janela::Frame` and `Janela::Pane` rows from a console. `Janela::Tools.new(scope:)` is plain Ruby with a name, a description and a JSON schema for each of `describe_vocabulary`, `list_frames`, `get_frame` and `read_pane`, and with `write: true`, `add_pane`, `update_pane`, `remove_pane` and `move_pane`. `scope:` is required and takes a model class and returns a relation, the answer `policy_scope` gives, so a read or a change reaches only what the caller may see; leaving it out raises `Janela::Unscoped` when the tools are built. Janela registers nothing, serves nothing and depends on no MCP library: [docs/agents.md](docs/agents.md) shows the adapter for the official Ruby SDK, which Janela's own tests run. No action needed (ADR 053, #73).
+
+- **The doctor notices a skipped migration, not only a missing table.** `bin/rails janela:doctor` reported a missing `janela_panes` and said nothing when the table was there but a release had added a column to it, so a host that upgraded and did not run `db:migrate` was told all was well, and met an error the first time a pane form or a stored pane read `height`, `prominence` or `companions`. A new `unmigrated-columns` check lists the missing columns by table and names the two commands. It can be silenced by that name like any other (ADR 021, ADR 035).
+
 ## [0.12.0] - 2026-10-01
 
 ### Added
@@ -40,7 +57,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 
 - **A range in the URL no longer narrows the time pane it names.** `q[placed_on_gteq]` and `q[placed_on_lt]` from a reader now scope every other pane and leave a time pane on that dimension showing its whole series with the range marked, where before it narrowed that pane's own series. A range a host fixes with `where:` or `default_where` still narrows it. See `UPGRADING.md` (ADR 045).
-- **A bar chart's bars are no longer all one colour.** Each bar is now drawn in the palette colour for its position, so a host that has seen every bar in `--janela-accent` will see the first bar in the accent and the rest in new colours. A line chart is unchanged. To keep the old look, set `--janela-series-2` to `--janela-series-8` to your accent; see `UPGRADING.md` (ADR 046).
+- **A bar chart's bars are no longer all one colour.** Each bar is now drawn in the palette colour for its position, so a host that has seen every bar in `--janela-accent` will see the first bar in the accent and the rest in new colours. A line chart is unchanged. To keep the old look, set `--janela-series-2` to `--janela-series-8`, and `--janela-series-other`, to your accent; see `UPGRADING.md` (ADR 046).
 
 ### Fixed
 
@@ -256,6 +273,7 @@ First alpha, installed from GitHub for testing in a single host application.
 - Only models that declare a `janela` block are addressable over HTTP.
 - ADRs 001 to 004 in `docs/decisions/`, shipped inside the gem.
 
+[0.13.0]: https://github.com/retail-tasker/janela/releases/tag/v0.13.0
 [0.12.0]: https://github.com/retail-tasker/janela/releases/tag/v0.12.0
 [0.11.0]: https://github.com/retail-tasker/janela/releases/tag/v0.11.0
 [0.10.0]: https://github.com/retail-tasker/janela/releases/tag/v0.10.0

data/README.md

@@ -6,7 +6,7 @@ PowerBI-style dashboards and cross-filtering slicers, native to Rails and Active
 
 ## First principle
 
-Janela is a PowerBI-style library built on Ruby and Stimulus, meant to drop onto any Ruby on Rails application. No JS framework, no build step of its own, no separate frontend app. Just a gem you add to an existing Rails app's Gemfile and two Stimulus controllers that ship with it.
+Janela is a PowerBI-style library built on Ruby and Stimulus, meant to drop onto any Ruby on Rails application. No JS framework, no build step of its own, no separate frontend app. Just a gem you add to an existing Rails app's Gemfile and two Stimulus controllers that ship with it, plus an optional third for the theme.
 
 ## Why
 
@@ -14,7 +14,7 @@ Every Rails BI option today is one of:
 
 - **SQL-first** (Blazer). Powerful, but the query is a black box to your models and associations.
 - **Admin-panel-first** (RailsAdmin, ActiveAdmin, Motor Admin, Avo). Association-aware filtering, but built for CRUD, not for composing multiple charts that filter each other.
-- **A dead end for cross-filtering**. None of the above let clicking one chart re-scope every other chart on the page. That's the actual PowerBI/Tableau slicer experience, and nothing in the Rails ecosystem does it as a first-class citizen.
+- **A dead end for cross-filtering**. None of the above are built around clicking one chart to re-scope every other chart on the page. That's the PowerBI/Tableau slicer experience, and it's what Janela is for.
 
 Janela's bet: the same dashboard definition should serve two audiences without being two systems.
 
@@ -23,11 +23,11 @@ Janela's bet: the same dashboard definition should serve two audiences without b
 
 ## Installation
 
-Janela is an alpha on [rubygems.org](https://rubygems.org/gems/janela). It has two halves, a gem and an npm package:
+Janela is an alpha on [rubygems.org](https://rubygems.org/gems/janela). It is a gem, plus a JavaScript package installed from GitHub if your app bundles its JavaScript. An app on importmap-rails needs only the gem. It needs Rails 8.0+ and Ruby 3.3+ (see Requirements below).
 
 ```ruby
 # Gemfile
-gem "janela", "~> 0.12"
+gem "janela", "~> 0.13"
 ```
 
 ```ruby
@@ -35,6 +35,15 @@ gem "janela", "~> 0.12"
 mount Janela::Engine => "/dashboards"   # or /reports, or wherever you like
 ```
 
+Janela reads nothing until your `ApplicationController` says what a visitor may see, so the first visit to `/dashboards` raises `Janela::Unscoped` without it. An app with nothing to hide answers once:
+
+```ruby
+# app/controllers/application_controller.rb
+private def policy_scope(model) = model.all
+```
+
+If you use stored frames or snapshots, run `bin/rails janela:install:migrations && bin/rails db:migrate` (see Frames below), and finish with `bin/rails janela:doctor`, which checks the install and says what to fix. The rest of this section is the JavaScript.
+
 Then register the two Stimulus controllers. How depends on how your app ships JavaScript.
 
 **With jsbundling (esbuild, bun, webpack):**
@@ -322,7 +331,7 @@ The engine serves an index and a page per frame at the mount root, so you can in
 
 No model's route key is all digits, so a frame id and a pane URL cannot be confused. Both pages read through `policy_scope(Janela::Frame)`, so a frame your scope does not return is a 404 rather than a page, and so is a pane row under it.
 
-These pages render in Janela's own minimal layout, which loads the gem's stylesheet and nothing else. It does not load Turbo or Stimulus, because those come from your bundler and the engine cannot name them. So Janela's own pages are correct, styled, **static** dashboards: every pane is rendered inline and the numbers are right, filters in the URL apply, and nothing cross-filters when you click. A chart pane needs Chart.js, so on these pages it draws nothing; put a frame on your own page, where your JavaScript is, for the interactive version.
+These pages render in Janela's own minimal layout, which loads the gem's stylesheet and nothing else. It does not load Turbo or Stimulus, because those come from your bundler and the engine cannot name them. So Janela's own pages are correct, styled, **static** dashboards: every pane is rendered inline and the numbers are right, filters in the URL apply, and nothing cross-filters when you click. A chart pane needs Chart.js, so on these pages it renders as its table (ADR 018); put a frame on your own page, where your JavaScript is, for the interactive version. Each page links back to your application's root, which you can rename in your own locale file under `janela.actions.home`.
 
 The noun in the headings is `Janela::Frame.model_name.human`, so rename it in your own locale file rather than in a setting:
 
@@ -418,7 +427,7 @@ Render a stored pane the same way you render a live one:
 <%= janela_snapshot_pane @snapshot, Order, :revenue, by: :status, as: :bar %>
 ```
 
-Inside a dashboard a pane is a Turbo Frame and carries no layout at all. Opened directly it renders in Janela's own minimal layout, which deliberately loads no assets, because the gem cannot know your asset names or whether you bundle. A direct pane link therefore shows its numbers unstyled, and a chart pane shows nothing, since the chart needs Stimulus.
+Inside a dashboard a pane is a Turbo Frame and carries no layout at all. Opened directly it renders in Janela's own minimal layout, which loads the gem's stylesheet and none of your JavaScript, because the gem cannot know your asset names or whether you bundle. A direct pane link therefore shows its numbers styled, and a bar or line chart draws nothing, since the chart needs Stimulus. A table and a ring (which is drawn as SVG on the server) still show.
 
 To make direct pane links styled and chart-capable, give Janela a small layout of your own that loads your assets and nothing else:
 
@@ -487,25 +496,19 @@ Scoping is automatic when you use Pundit: `Janela::ApplicationController` calls
 
 **Multi tenancy** has its own guide: [docs/multi-tenancy.md](docs/multi-tenancy.md). It covers what goes through your scope, worked wiring for Pundit, acts_as_tenant and CanCanCan, what owns a frame the analyst creates, and what rows a scheduled snapshot freezes.
 
-### The pages Janela serves
+### Giving an agent access
 
-Mounting the engine gives you an index of frames and a page per frame with no
-work at all, which is enough to navigate on the day you install it:
+Frames and panes are rows, so an agent can arrange a dashboard if it has tools. Janela gives you the tool definitions as plain Ruby and leaves the registering to you, because your application knows who is asking and Janela does not (ADR 053):
 
-```
-/insights      every frame your policy scope returns
-/insights/3    one frame
-```
+```ruby
+tools = Janela::Tools.new(scope: ->(model) { policy_scope(model) })   # read only
+tools = Janela::Tools.new(scope: ->(model) { policy_scope(model) }, write: true)
 
-Both go through your `policy_scope`, so a frame another tenant owns is a 404. Each page carries a link back to your application's root, so they are not a dead end; rename it in your own locale file under `janela.actions.home`, or override the engine's layout if you want your whole navigation there.
+Janela::Tools.all          # name, description, input_schema, read_only
+tools.call("read_pane", pane_id: 4)
+```
 
-These pages load Janela's own stylesheet and nothing of yours, because the gem
-cannot know your asset names or bundler. Two consequences worth knowing. They
-do not cross-filter, since that needs Stimulus. And a pane whose row asks for a
-chart renders as its **table** here, because there is no chart runtime on the
-page and a table needs nothing: the same frame rendered in your own page with
-`janela_frame(@frame)` draws the chart. A renderer is a viewing choice, not part
-of the pane (ADR 018).
+`scope:` is required and is the same answer your `policy_scope` gives, so an agent reads and changes only what the person it acts for can. The read tools list the vocabulary and frames and read a pane's values. The write tools add, change, remove and move panes, and are off unless asked for. Janela serves no MCP endpoint, edits no configuration and depends on no MCP library; [docs/agents.md](docs/agents.md) shows the few lines that register them with the official Ruby SDK.
 
 ### Checking an installation
 
@@ -558,11 +561,11 @@ Deliberately out of scope: natural-language query, a separate data warehouse, a
 
 ## Status
 
-**v0.12.0 alpha.** The measures/dimensions DSL, time dimensions, cross-filtering with multi-selection, bar, line, doughnut and pie charts, pane URLs, shareable dashboard URLs, snapshots, database-backed frames found by owner and key, panes that hold words or a host partial as well as a query, a host-fixed filter no click can remove and a frame's own permanent one beside it, STI subclasses, the engine's own pages for reading and editing them and the optional vitral theme work and are covered by unit and real-browser tests, with the classes a theme may target documented in [Theming Janela](docs/theming.md). Not yet built: a visual editor, drill-down on time panes, other chart types. [Vista](docs/roadmap.md), the roadmap, says what 1.0 means and which of these are in it; open work is in [GitHub Issues](https://github.com/retail-tasker/janela/issues).
+**v0.13.0 alpha.** The measures/dimensions DSL, time dimensions, cross-filtering with multi-selection, bar, line, doughnut and pie charts, pane URLs, shareable dashboard URLs, snapshots, database-backed frames found by owner and key, panes that hold words or a host partial as well as a query, a host-fixed filter no click can remove and a frame's own permanent one beside it, STI subclasses, the engine's own pages for reading and editing them, tools an agent can use to read and arrange a dashboard, and the optional vitral theme work and are covered by unit and real-browser tests, with the classes a theme may target documented in [Theming Janela](docs/theming.md). Not yet built: a visual editor, and narrowing a time pane's own granularity by clicking one of its buckets (a click on a bucket does filter the others). [Vista](docs/roadmap.md), the roadmap, says what 1.0 means and which of these are in it; open work is in [GitHub Issues](https://github.com/retail-tasker/janela/issues).
 
 ## Development
 
-Janela is a Rails engine. It ships with a minimal host application in `test/dummy` that mounts the engine at `/janela`, so the gem is always developed and tested against a real Rails app with a real (SQLite) database.
+Janela is a Rails engine. It ships with a minimal host application in `test/dummy` that mounts the engine at `/dashboards`, so the gem is always developed and tested against a real Rails app with a real (SQLite) database.
 
 After checking out the repo, run `bin/setup` to install dependencies. Then:
 
@@ -575,13 +578,13 @@ bin/rails console     # console inside the dummy app, engine loaded
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/retail-tasker/janela. Pull requests are reviewed on the merits of the diff, whether a person or an agent wrote them. [CONTRIBUTING.md](CONTRIBUTING.md) says how to run the tests, when a change needs a decision record first, and what to write down for the people who upgrade. Contributors are expected to adhere to the [code of conduct](https://github.com/retail-tasker/janela/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/retail-tasker/janela. Pull requests are reviewed on the merits of the diff, whether a person or an agent wrote them. [CONTRIBUTING.md](https://github.com/retail-tasker/janela/blob/main/CONTRIBUTING.md) says how to run the tests, when a change needs a decision record first, and what to write down for the people who upgrade. Contributors are expected to adhere to the [code of conduct](https://github.com/retail-tasker/janela/blob/main/CODE_OF_CONDUCT.md).
 
 ## Support and security
 
 Janela is pre-1.0 and its public surface can still move between releases, with an upgrade note each time. Issues and pull requests are read when the maintainers can get to them; there is no support contract and no promised response time.
 
-To report a vulnerability, use the private form described in [SECURITY.md](SECURITY.md) and not a public issue. Releases are cut by the two maintainers and published from a protected workflow; the steps are in [RELEASING.md](RELEASING.md).
+To report a vulnerability, use the private form described in [SECURITY.md](https://github.com/retail-tasker/janela/blob/main/SECURITY.md) and not a public issue. Releases are cut by the two maintainers and published from a protected workflow; the steps are in [RELEASING.md](https://github.com/retail-tasker/janela/blob/main/RELEASING.md).
 
 ## License
 

data/UPGRADING.md

@@ -12,6 +12,38 @@ bin/rails janela:doctor
 
 It reads your application and lists what still needs changing.
 
+## 0.12.0 to 0.13.0
+
+No migration, and nothing you must change. Two things you may see.
+
+**The doctor treats `Janela::PanesController` as a warning.**
+
+0.7 renamed it to `Janela::QueriesController`, and 0.12 added a
+`Janela::PanesController` back as the stored-pane form's controller, which owns
+`pane_params`. The doctor used to call every mention of the name an error. It now
+warns, and says what the name means today. If you patch the form's
+`pane_params`, leave it where it is. If you patched how a query renders, that
+patch belongs on `Janela::QueriesController`.
+
+**A host that copied `janela/queries/_query.html.erb` should check it.**
+
+Rails 8.2 renders HTML templates through Herb, which refuses ERB that writes an
+attribute's name or sits in attribute position. Janela's own copy of the partial
+no longer does either, so it compiles. A copy of yours keeps the old markup,
+which Herb will reject if it has ERB in an attribute position. On Rails 8.2:
+
+```bash
+bin/rails herb:check
+```
+
+lists what it rejects. On earlier Rails there is nothing to do.
+
+**Optional: tools for an agent.**
+
+`Janela::Tools` gives an agent the tools to read and arrange a dashboard. It is
+not on unless you build it, and nothing registers itself. See
+[docs/agents.md](docs/agents.md).
+
 ## 0.11.0 to 0.12.0
 
 One migration step, if you use stored frames.
@@ -63,7 +95,7 @@ in `--janela-series-2` to `--janela-series-8`, and every bar after the
 eighth in `--janela-series-other`. Until now every bar was the accent.
 Line charts are unchanged.
 
-If you want the old look, set the seven to your accent:
+If you want the old look, set the other eight to your accent:
 
 ```css
 :root {
@@ -549,6 +581,11 @@ Most applications do not.
 `Janela::Pane` is reserved for a database record in a later release,
 which is why the runtime object had to give the name up.
 
+`Janela::PanesController` was renamed in this table, and 0.12 added a
+`Janela::PanesController` back: the stored-pane form's controller, which owns
+`pane_params`. The doctor warns about the name without calling it an error,
+because only you know which one your code means.
+
 If you override Janela's view, move your copy from
 `app/views/janela/panes/` to `app/views/janela/queries/`.
 

data/app/assets/stylesheets/vitral.css

@@ -69,6 +69,27 @@
      janela.css draws agree with the parts this one does. */
   --janela-line: var(--vitral-came-soft);
   --janela-accent: rgb(40, 110, 205);
+
+  /* The colours a bar, a doughnut slice or a pie slice is drawn in, by
+     position (ADR 046, ADR 026). Soft glass rather than bright: a first
+     version in saturated jewel tones read as a rainbow against the pale tiles,
+     so these sit at about half the chroma and lean on differences in lightness
+     to keep neighbours apart (the plum and the dusty rose are the darker ones).
+     Chosen as an ordered set and run through the palette checker: adjacent
+     colour vision separation 12.4 (target 8) and adjacent normal vision
+     separation 15.8 (floor 15). The order is what keeps neighbours apart, so a
+     reorder has to be re-checked. Slot 1 is a softer blue of its own and not
+     the accent, which stays the stronger blue for what is selected. The neutral
+     past the eighth is the grey of lead came. */
+  --janela-series-1: #608fcb;
+  --janela-series-2: #56ab81;
+  --janela-series-3: #a492da;
+  --janela-series-4: #91507d;
+  --janela-series-5: #be774e;
+  --janela-series-6: #159da9;
+  --janela-series-7: #c29e51;
+  --janela-series-8: #994b59;
+  --janela-series-other: #8794a6;
 }
 
 /* Opt in, because a theme that repaints a host's <body> uninvited is not a

data/app/views/janela/queries/_query.html.erb

@@ -15,21 +15,21 @@
     <figcaption class="janela-chart-title" id="<%= title_id %>"><%= query.title %></figcaption>
     <%# A height puts the canvas in a box of fixed size for the chart to fill;
         with none there is no box and the chart is what it always was (ADR 047). %>
-    <% canvas = capture do %>
-    <canvas class="janela-chart"
-            data-controller="janela--chart"
-            data-action="janela--chart:toggle->janela--frame#toggle"
-            data-janela--chart-type-value="<%= query.renderer %>"
-            data-janela--chart-title-value="<%= query.title %>"
-            data-janela--chart-selected-value="<%= query.selected_values.to_json %>"
-            data-janela--chart-labels-value="<%= result.keys.to_json %>"
-            data-janela--chart-values-value="<%= result.values.map(&:to_f).to_json %>"
-            data-janela--chart-formatted-value="<%= result.values.map { |measured| query.format(measured) }.to_json %>"
-            data-janela--chart-filters-value="<%= query.filters_for(result.keys).to_json %>"
-            <%= tag.attributes(aria: { description: (t("janela.time.click_hint") if query.time? && query.clickable?) }) %>
-            <%= "data-janela--chart-fixed-height-value=true".html_safe if query.boxed? %>
-            role="img" aria-labelledby="<%= title_id %>"></canvas>
-    <% end %>
+    <% canvas = tag.canvas(
+         class: "janela-chart", role: "img",
+         aria: { labelledby: title_id, description: (t("janela.time.click_hint") if query.time? && query.clickable?) },
+         data: {
+           controller: "janela--chart",
+           action: "janela--chart:toggle->janela--frame#toggle",
+           "janela--chart-type-value": query.renderer,
+           "janela--chart-title-value": query.title,
+           "janela--chart-selected-value": query.selected_values.to_json,
+           "janela--chart-labels-value": result.keys.to_json,
+           "janela--chart-values-value": result.values.map(&:to_f).to_json,
+           "janela--chart-formatted-value": result.values.map { |measured| query.format(measured) }.to_json,
+           "janela--chart-filters-value": query.filters_for(result.keys).to_json,
+           "janela--chart-fixed-height-value": (true if query.boxed?)
+         }) %>
     <%= query.boxed? ? tag.div(canvas, class: "janela-chart-box janela-h-#{query.height}") : canvas %>
   </figure>
 <% else %>

data/docs/agents.md

@@ -0,0 +1,97 @@
+---
+Topics: agents, mcp, tools, authorisation, host-integration
+---
+
+# Giving an Agent Access to Janela
+
+Frames and panes are rows (ADR 012), so an agent could always arrange a
+dashboard by writing them from a console. This page is for giving it tools
+instead: read a frame, read a pane's values, and, if you choose, add, change,
+remove and move panes. The reasoning is in ADR 053.
+
+The short version: Janela gives you the tool definitions as plain Ruby. You
+build them with the answer to "what may this caller read", and you register
+them with whatever MCP library your application already runs. Janela
+registers nothing, detects nothing and serves nothing, because it cannot
+know who is asking and your application can.
+
+## Building the tools
+
+```ruby
+tools = Janela::Tools.new(scope: ->(model) { policy_scope(model) })
+```
+
+`scope:` is required. It takes a model class and returns a relation: the same
+answer your `policy_scope` gives a Janela controller (ADR 032). Leave it out
+and `Janela::Unscoped` is raised when the tools are built, because a tool with
+no scope would read every row of every model. Every read the tools make passes
+that relation, and frames and panes are found through it too, so a caller can
+change only what it can see.
+
+Build the tools where you know who is asking, which for an MCP server is when a
+tool is called. They are cheap to construct.
+
+## What they do
+
+| Tool | Does | Needs `write: true` |
+| --- | --- | --- |
+| `describe_vocabulary` | The models, measures, dimensions, renderers and granularities the `janela` blocks declare. An agent should offer nothing else. | no |
+| `list_frames` | The frames the scope returns: id, name, owner, pane count. | no |
+| `get_frame` | One frame with its panes in position order. | no |
+| `read_pane` | A pane's values, through the scope. Filters are Ransack predicates on declared dimensions, bounded as a reader's are (ADR 025). | no |
+| `add_pane` | Add a pane to the end of a frame. | yes |
+| `update_pane` | Change a pane. An invalid change leaves it as it was. | yes |
+| `remove_pane` | Remove a pane and close the gap. | yes |
+| `move_pane` | Move a pane one place up or down. | yes |
+
+The write tools are off unless you build the tools with `write: true`. Their
+inputs are the pane's own attributes, the ones the README
+names, and nothing else: an attribute that is not a pane's is refused rather
+than dropped. A pane Janela would refuse is refused with its own reason, for
+example `Measure "nonsense" is not a measure of Order`.
+
+There is no tool to create a frame or take a snapshot. Your code finds or makes
+a frame with `Janela::Frame.for` (ADR 041), and a snapshot needs an owner and a
+scope you have named (ADR 033, ADR 034).
+
+## Registering them
+
+`Janela::Tools.all` is the list of definitions, and needs no scope: each has a
+`name`, a `description`, an `input_schema` (JSON Schema) and `read_only`.
+`tools.call(name, arguments)` runs one and returns a Hash, or raises a
+`Janela::Error` (`NotFound`, `BadRequest` or `Unscoped`) that an adapter reports
+to the agent as the tool's own error.
+
+For the official Ruby SDK, the `mcp` gem, an adapter looks like this. It is run
+by Janela's own tests, so it cannot drift from the code. `server_context` is
+whatever your server was built with, and is where you keep the caller; the
+scope is built from it at the moment of the call.
+
+```ruby
+def janela_server(write: false)
+  tools = Janela::Tools.all(write: write).map do |tool|
+    MCP::Tool.define(name: tool.name, description: tool.description, input_schema: tool.input_schema,
+                     annotations: { read_only_hint: tool.read_only }) do |server_context:, **arguments|
+      # The scope is built per call, because who is asking is known only now.
+      scope = ->(model) { server_context[:scope].call(model) }
+      result = Janela::Tools.new(scope: scope, write: write).call(tool.name, arguments)
+      MCP::Tool::Response.new([ { type: "text", text: result.to_json } ])
+    rescue Janela::Error => error
+      MCP::Tool::Response.new([ { type: "text", text: error.message } ], error: true)
+    end
+  end
+
+  MCP::Server.new(name: "janela", tools: tools, server_context: { scope: yield })
+end
+```
+
+`mcp` is not a dependency of Janela, and a host using another library writes the
+same few lines against it.
+
+## What Janela does not do
+
+It does not serve MCP, detect a server, edit your configuration or install
+anything. It holds no credentials and has no idea who your agent is. Whether an
+agent may reach your MCP server at all is your server's authentication, which
+Janela never sees. Everything it adds is the question it already asks: what may
+this caller read?

data/docs/composing.md

@@ -23,12 +23,12 @@ with your own classes plus the hooks in [Theming Janela](theming).
 | `janela_frame do ... end` | anywhere inside the block | the page needs a heading, text, links or a layout of its own |
 | `janela_frame @frame` | none | the dashboard is data an analyst edits without a deploy |
 
-A stored frame renders panes and nothing else. That is deliberate (ADR
-012): a row names a measure the model declared, so an analyst arranges
-what is shown and cannot put arbitrary content on the page. If a
-dashboard needs a heading and an explanation, write them in the page
-around the frame, or use the block form. Whether a stored frame should
-hold content of its own, such as text or an image, has not been decided.
+A stored frame renders panes, and a pane is either a query, a few words
+the analyst writes (a heading, a sentence, a link), or a partial you
+wrote and they place by name (ADR 039). What an analyst writes is
+escaped, never markup, so a row cannot put arbitrary content on the page
+(ADR 012). Anything richer than that, an icon, an image, a layout of your
+own, goes in the page around the frame, or use the block form.
 
 ```erb
 <h2>Orders</h2>
@@ -58,9 +58,9 @@ same classes a stored frame gets from its integers:
 
 Every direct child is a grid item, your own elements included, so a
 heading can take a whole row and a text box can sit between two panes.
-`janela_pane` takes no class of its own yet
-([#29](https://github.com/retail-tasker/janela/issues/29)), so wrap a
-pane to span it:
+`janela_pane` takes no class of its own, and will not: arranging panes
+beyond the shipped grid is the host's (see the roadmap). So wrap a pane
+to span it:
 
 ```erb
 <div class="janela-span-2"><%= janela_pane Order, :revenue, by: :status, as: :bar %></div>
@@ -195,11 +195,11 @@ and number, so the figure needs a `<div>` rather than a `<p>` around it,
 and a line of CSS to put the numbers side by side. Without it they
 stack.
 
-A done out of total figure cannot be two panes yet. A measure has no
-condition of its own, so there is no pane for the done half. Compute it
-as the progress bar below does. A measure that is itself the ratio is
-proposed in ADR 038
-([#27](https://github.com/retail-tasker/janela/issues/27)).
+A done out of total figure over a yes or no column is one pane: a
+`ratio:` measure is the share of rows where a boolean is true (ADR 038).
+When the condition is not a column, a measure has no condition of its own,
+so there is no pane for the done half; compute it as the progress bar
+below does.
 
 ### A progress bar