Pluma
Docs index

Get started

What Pluma is Concepts First 5 minutes

Guides: the 5 steps of every site

Step 1 · Create the site Step 2 · Invite your agent Model your content Create and publish content Step 3 · Connect the MCP Images and files Step 4 · Invite your team Step 5 · Deploy on Netlify Deploy on Vercel Generic webhook deploy Composable pages Migrate from repo files Staging and previews Migrate from Contentful · pending Billing · pending AI visibility Analytics AI answers Search Console and Bing Site preview

API

API · conventions Delivery API Preview API Management API Agents Webhooks

MCP

MCP MCP tools MCP OAuth

Reference

Rich text

Errors

Errors Error: check_unavailable Error: invalid_body Error: invalid_key Error: invalid_parameter Error: invite_expired Error: invite_used Error: key_cannot Error: missing_key Error: not_found Error: rate_limited Error: validation_failed Error: version_conflict Error: wrong_space

Frameworks

Astro Plain fetch
docs/guides/invite-your-agent.md View markdown →

Step 2 · Invite your agent

You don't set up anything technical. You create a link, give it to your agent (Claude, ChatGPT, Claude Code, Cursor), and it does the rest: it reads your site, proposes how to model the content, imports it and connects your site to Pluma.

For you (the owner)

  1. In your site, go to Assistants → Invite agent. Give it a name: "María's Claude".

  2. Pluma shows you text ready to copy:

    Connect my site to Pluma. Read the instructions at https://pluma.so/join/… and follow them.

  3. Paste it to your agent. The link works only once and expires in 24 hours.

  4. When your agent redeems it, it shows up in Agents with its name. Everything it does is recorded in the activity with the "agent" tag.

  5. You can revoke it in one click. It stops working right away.

Step 2 of the checklist checks itself off when your agent has redeemed the link and created at least one content type and one entry. Until then, your site's home shows those three checks one by one, so a connected agent that hasn't modeled anything yet is easy to spot.

What your agent can do

Can Cannot
Read all your content, published and drafts Delete the site
Create and edit content types, entries and files Invite or remove people
Publish Create management keys or invite other agents
Create delivery and preview keys for your site Give itself more permissions

Everything it creates starts as a draft. It can publish, but the guide asks it to show you the plan first, and to ask you before publishing a change to something you didn't name or that shows up on more than one page.

For your agent

The link returns markdown with everything it needs. Summary of the steps it asks for:

  1. Redeem the link to get its token (shown once).
  2. Read the current site: where the content lives today (config, collections, JSON, markdown with frontmatter). See Migrate from files.
  3. Propose the model (types and fields) and show it to you before creating anything.
  4. Create the types with dry_run=true first, then for real.
  5. Import entries and images.
  6. Create a delivery key for the site build.
  7. Change the site code to read from Pluma, on a branch with a PR.
  8. Leave you a report: what it created, what it imported and what it couldn't map.

The endpoint reference is in Agents and Management API.