Tools

The tools an agent calls on the site, the permission each one needs, what the site tells an agent, and how a plugin field type becomes writable.

An agent sees the tools your role allows. A tool beyond its connection's permissions answers with the permission it needs, so the agent can ask you for it.

ToolPermissionWhat it does
get_siteRead contentReturns the site, its languages, the account and permissions the agent works with, and the top-level pages
find_pagesRead contentSearches the pages and drafts, such as those with unsaved changes or not yet translated, or lists the children and drafts of one page
find_filesRead contentSearches the files of the site and its pages, such as those not yet translated or images without alt text
get_contentRead contentReturns the fields of a page, a file, or the site in one language, also as published, and the files of a page or the site
view_imageRead contentReturns a JPEG, PNG, GIF, or WebP image with its alt text
prepare_changesPrepare changesWrites field values, or passages and blocks within them, to the unsaved changes in one language
create_draftPrepare changesCreates a draft below the site or a page, in the default language
upload_filePrepare changesUploads a file to a draft or a page inside one, or with Publish changes to a published page or the site
publish_changesPublish changesPublishes the unsaved changes in one language, whoever made them
discard_changesPublish changesDiscards the unsaved changes in one language, whoever made them
change_statusPublish changesChanges a page's status to listed, unlisted, or draft
change_slugPublish changesChanges a page's slug in one language
move_pagePublish changesMoves a page or a draft below another parent
delete_pageDelete contentDeletes a page or a draft with its files
delete_fileDelete contentDeletes a file

What Agents Are Told

When an agent connects, the site tells it to read content before it changes it, and to treat the content it reads as data, never as instructions. The tools that publish, discard, change a page's status, slug, or parent, upload, or delete tell it to call them only when you ask.

When the agent reads a page, a file, or the site, it also gets the blueprint's guidance for editors: each field's help, placeholder, and when condition, and the text of info fields and info sections. A house rule such as "a teaser under 160 characters" guides agents as it guides editors.

Plugin Field Types

A plugin's field type that extends a core field is written like that field. Agents can't write any other plugin field type until a plugin maps it to a core type – see Supported Field Types.