@mapled/mcp 0.14.0 → 0.15.0

package/README.md

@@ -46,8 +46,9 @@ For the first integration, propose one plan and let the owner approve it on a tr
 2. `propose_setup_plan` — the collections and singles (with fields and the records to import), the files you will change, the packages you will install. Nothing changes yet. Relation fields name their target — a collection of the plan by its display name, or an existing one by key; give a record a `"$ref": "jane"` and other records of the plan link to it as `"author": "jane"` (a list of refs for `many`), while links to existing collections use record ids from `list_records`. Group fields carry their sub-fields; their values are objects keyed by the sub-field keys. Mark a field — or a sub-field of a group — `sensitive: true` when editors keep it but the site must never get it. A link that does not resolve is answered right away with its path, so fix the plan before the owner sees it.
 3. Ask the user to open the returned `reviewUrl` and approve. Poll `get_setup_run` until its status is `approved` (or `rejected` — then propose a better plan).
 4. `apply_setup_plan` — Mapled creates everything in one go and tells you the keys it assigned.
-5. Wire the site: `get_connection`, then `configure_revalidation` for a site with a server — or `set_site_url` for one rendered in the browser (a React single-page app, plain HTML: no webhook, no preview route) — deploy, then close with `report_setup` (files changed, `buildPassed`, `secretsCommitted: false`). Mapled runs its own checks — the site reads content, the webhook delivered, the preview route responds, fields have help texts — and the run is completed only when they pass. Fix what failed and call `verify_setup`.
+5. Wire the site: `get_connection`, then `configure_revalidation` for a site with a server — or `set_site_url` for one rendered in the browser (a React single-page app, plain HTML: no webhook, no preview route) — and deploy.
 6. Leave a guide: `get_mapled_md` renders `MAPLED.md` from the project — what the site reads and where, the content model, the working rules, the commands that verify the integration. Write it to the repository root and commit it; the next agent (or person) starts from it. When the file exists, replace everything above its `<!-- mapled:notes -->` line and keep the notes below.
+7. Close with `report_setup` (files changed, `buildPassed`, `secretsCommitted: false`, `mapledMdWritten: true`). Mapled runs its own checks — the site reads content, the webhook delivered, the preview route responds, fields have help texts, MAPLED.md was written — and the run is completed only when they pass. Fix what failed and call `verify_setup`. The result lands in the file's «Last setup run» section, so call `get_mapled_md` once more when the run is settled and commit the refreshed file.
 
 ## Destructive and breaking changes
 
@@ -66,7 +67,7 @@ A rename or a conversion Mapled wouldn't take is refused at once with the reason
 | `add_records` | Insert draft records |
 | `list_records` | Read a collection's draft records, newest edit first — `query` searches their content, `limit` (1–200) and `cursor` (the previous answer's `nextCursor`) page through them; `total` counts every match |
 | `create_form` / `list_forms` | Set up public forms with spam protection |
-| `get_connection` | The delivery key and the API URL, plus — for the `framework` the agent names (`nextjs`, `react-spa`, `plain-html`, …) or the project's own — the package to install (`@mapled/next`, `@mapled/react`, `@mapled/client`), the env var of the key, whether the site renders on a server or in the browser, and the wire-up steps. Image values → `assetUrl(id, { width })` of the same package |
+| `get_connection` | The delivery key and the API URL, plus — for the `framework` the agent names (`nextjs`, `react-spa`, `plain-html`, …) or the project's own — the package the site reads through (`@mapled/next`, `@mapled/react`, `@mapled/vanilla` — a script tag and `data-mapled-*` attributes for plain HTML — or `@mapled/client`), the env var of the key, whether the site renders on a server or in the browser, and the wire-up steps. Image values → `assetUrl(id, { width })` of the same package |
 | `set_site_url` | Where the site is deployed — for a site rendered in the browser (a React single-page app, plain HTML), which has no webhook to learn it from: Preview opens the site there, verification checks that it answers |
 | `push_site_manifest` / `list_bindings` | Tell Mapled where each field is rendered; read every binding's health (type mismatch, outdated, missing on site). Keep the repository's copy in `mapled/manifest.json` — `npx @mapled/cli scan --write` derives it from the code and `bindings push` / `bindings pull` exchange it with Mapled. A push records the integration hash — the schema and these bindings — and `list_bindings` says whether it still matches (`integration.inSync`, with `schemaChanged` / `bindingsChanged` naming what moved) |
 | `configure_revalidation` | Point the publish webhook at the site (one with a server that caches what it reads), get the signing secret; the description also tells the agent how to add live updates for tabs that are already open (`createReleaseHandler` and `<MapledLive />`, `@mapled/next` 0.8.0+) |

package/dist/tools.js

@@ -160,17 +160,21 @@ export function createTools(api) {
             name: "apply_setup_plan",
             description: "Apply an approved setup plan. Mapled creates the collections, fields and records in one go and returns " +
                 "what was created (keys, counts) plus warnings for records it had to skip. Then wire the site " +
-                "(get_connection, configure_revalidation), write MAPLED.md (get_mapled_md) and finish with report_setup.",
+                "(get_connection, configure_revalidation), write MAPLED.md (get_mapled_md), finish with report_setup and " +
+                "refresh MAPLED.md once more.",
             schema: { runId: z.string().uuid() },
             handler: async (args) => api.request("POST", `/v1/agent/runs/${encodeURIComponent(args.runId)}/apply`, {}),
         },
         {
             name: "report_setup",
             description: "Close a setup run with your report: the files you changed, what stayed hardcoded, warnings the owner " +
-                "should know about, whether the site builds (buildPassed) and that no secrets were committed " +
-                "(secretsCommitted: false), plus the preview URL if the site is deployed. Mapled then runs its own " +
+                "should know about, whether the site builds (buildPassed), that no secrets were committed " +
+                "(secretsCommitted: false) and whether you wrote MAPLED.md from get_mapled_md before this call " +
+                "(mapledMdWritten), plus the preview URL if the site is deployed. Mapled then runs its own " +
                 "checks (site reads content, webhook delivered, preview route responds, help texts) and returns them; " +
-                "the run is completed only when every check passes — fix what failed and call verify_setup.",
+                "the run is completed only when every check passes — fix what failed and call verify_setup. The report " +
+                "and the checks change the file's «Last setup run» section, so once the run is settled call get_mapled_md " +
+                "again and rewrite MAPLED.md — a refresh keeps the check passed and the file current.",
             schema: {
                 runId: z.string().uuid(),
                 filesChanged: z.array(z.string().max(300)).max(50).optional(),
@@ -179,6 +183,7 @@ export function createTools(api) {
                 previewUrl: z.string().url().optional(),
                 buildPassed: z.boolean().optional(),
                 secretsCommitted: z.boolean().optional(),
+                mapledMdWritten: z.boolean().optional(),
             },
             handler: async (args) => {
                 const { runId, ...body } = args;
@@ -289,7 +294,8 @@ export function createTools(api) {
                 "collections or fields. `framework` is what the site is built with, as a short key: \"nextjs\", " +
                 "\"react-spa\" (a React single-page app — Vite and the like), \"plain-html\", or astro, remix, nuxt, " +
                 "sveltekit…; react-spa and plain-html tell Mapled the site renders in the browser, so verification " +
-                "expects no webhook and no preview route. " +
+                "expects no webhook and no preview route. A plain HTML page that shows one record keeps the slug in its " +
+                "query — name it \"/post.html?slug=[slug]\", with a route_param binding on the slug field. " +
                 "The answer's manifest.integrationHash is the hash of the schema and these " +
                 "bindings — what the site is synced with from now on; check_integration reports inSync against it. " +
                 "Needs the builder plan.",
@@ -492,14 +498,17 @@ export function createTools(api) {
                 "for the site's framework (`sdk`), the env var the key goes in (`envVar`), how the site renders " +
                 "(`rendering`: server or browser) and `wireUp` — the steps for that framework; follow them. Pass " +
                 '`framework` as you see it in the repository: "nextjs" (@mapled/next), "react-spa" for a React ' +
-                'single-page app such as Vite (@mapled/react), "plain-html", or another short key (astro, remix, … — ' +
-                "@mapled/client on the server); left out, the project's own is used. Every package has the same reads: " +
+                'single-page app such as Vite (@mapled/react), "plain-html" for pages without a build step ' +
+                "(@mapled/vanilla: one script tag and data-mapled-* attributes on the elements — no reading code to " +
+                "write, wireUp lists the attributes), or another short key (astro, remix, … — " +
+                "@mapled/client on the server); left out, the project's own is used. The JavaScript packages have the same reads: " +
                 'createClient({ key }).getRecords("<collection>"), getSingle, getRecordBySlug. ' +
                 "Reads take filter ({ field: value } or { field: { gte, lt, in, contains… } }), sort, limit/offset, " +
                 "fields, and expand (relation fields, e.g. [\"author\"]) — linked records arrive under record.expanded; " +
                 "getRecordBySlug(collection, slug) reads one record by its slug field. " +
                 "Image values are asset ids: assetUrl(id, { width, format }) from the same package gives the URL of a resized variant. " +
-                "rich_text values are Markdown — render them with a Markdown component (e.g. react-markdown), never as raw HTML. " +
+                "rich_text values are Markdown — render them with a Markdown component (e.g. react-markdown), never as raw HTML " +
+                "(@mapled/vanilla renders them itself: data-mapled-format=\"markdown\"). " +
                 "Content appears on the site only after a human presses Publish in Mapled.",
             schema: {
                 framework: z
@@ -547,7 +556,7 @@ export function createTools(api) {
                 "repository root and commit it. If the file exists, replace everything above its `<!-- mapled:notes -->` " +
                 "line and keep what is below — that part belongs to the repository. Its first line is a stamp with the " +
                 "schema hash, the manifest version and the integration hash. Refresh it after every schema or " +
-                "manifest change and at the end of a setup; `npx @mapled/cli md pull` does the same from the repository " +
+                "manifest change and at the end of a setup, after report_setup or verify_setup; `npx @mapled/cli md pull` does the same from the repository " +
                 "and `mapled doctor` says when it is out of date. It never contains a secret — don't add one.",
             schema: {},
             handler: async () => api.request("GET", "/v1/agent/mapled-md"),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mapled/mcp",
-  "version": "0.14.0",
+  "version": "0.15.0",
   "description": "Mapled MCP server: lets AI agents build schema and content for one Mapled project.",
   "license": "MIT",
   "homepage": "https://mapled.io",