Glossary#

The terms this documentation uses, each defined once.

Plone#

Plone#

An open source content management system written in Python. plone-client works with Plone 6; see Compatibility.

Volto#

The React frontend of Plone 6, which edits pages as blocks. It runs as a separate server in front of the Plone backend.

Classic UI#

The server-rendered interface of Plone, an alternative to Volto. A Classic UI site stores text in fields, not in blocks.

plone.restapi#

The add-on that ships with Plone and exposes its content and settings as a JSON API. Everything plone-client does goes through it, or through a service of the Volto server.

++api++#

A segment in a URL that sends the request to plone.restapi, as in https://example.org/++api++/news. plone-client adds it for you, and removes it from the URLs it reads.

site root#

The top of a Plone site, path / in plone-client. On a backend without a frontend, its URL ends in the site id, as in http://localhost:8080/Plone.

content item#

One thing stored in a site, such as a page, a news item, or an image. Each has a path, a UID, and a content type.

content type#

The kind of a content item, which decides its fields. plone.restapi calls its id @type, and the catalog calls it portal_type.

portal_type#

The id of a content type, such as Document or News Item.

folderish#

Said of a content item that can hold others. On a Volto site, a Document is folderish, and the Folder type usually cannot be added.

block#

One piece of a page on a Volto site, such as a paragraph, an image, or a grid. A block is a JSON object with an @type, stored in the blocks field of its item.

blocks_layout#

The field of a content item that lists the ids of its blocks in display order.

slate#

The rich text block of Volto, and the JSON format of its value.

lead image#

The picture that represents an item in listings. On a Volto site it is preview_image_link, a relation to an Image; on other sites it is an image field. See Content model.

workflow#

The states a content item goes through, such as private and published, and who can see it in each.

transition#

A step from one workflow state to another, such as publish or retract.

review_state#

The name of the workflow state a content item is in.

UID#

The unique id of a content item, which stays the same when the item moves.

resolveuid#

A link form that points to a UID and not to a path, so that it survives moves.

plone-client#

ref#

How you name an item in plone-client: a path, a URL inside the site, uid:<UID>, or a resolveuid link. See Managers.

manager#

An attribute of PloneClient that groups the calls to one service, such as client.content. See Services.

operation#

A task of several requests in the right order, such as creating a page with its images. See Operations.

profile#

A named site in the configuration file: its URL, its user, and where its secret is. See Manage profiles.

group#

A name for several profiles, which the MCP server can serve together.

keyring#

The password store of your operating system, such as the macOS Keychain. plone-client keeps the secrets of profiles there by default.

secret#

The password or token of a profile.

read-only#

A mode of a client or a profile that refuses every change before sending it.

dry run#

A mode that does not send changes, and shows what it would have sent. Compare it with read-only in Preview changes and protect a site.

confirmation#

The question destructive commands ask before they run, which --yes answers in advance.

exit code#

The number a command returns to the shell. plone-client gives each kind of failure its own; see Command line.

frontend_url#

The address of the Volto server of a site, which plone-client needs to ask it which blocks the site has.

demo site#

https://demo.plone.org, a public Plone site that anyone can use and that resets every night.

Compose site#

The Plone site with Volto and sample content that the docker-compose.yml of this repository starts on your computer. See Run a Plone site for testing.

Assistants and agents#

assistant#

A chat application backed by a language model, such as Claude Desktop, which uses tools through MCP.

coding agent#

A language model that runs commands in a terminal or an editor, such as Claude Code, Codex, or Cursor.

skill#

A file that teaches a coding agent how to use a tool. See Agent skill.

MCP#

The Model Context Protocol, a standard way to offer tools and resources to a language model.

tool#

A function that an MCP server offers and that a model can call.

resource#

Data that an MCP server offers at a URI, which the application reads and gives to the model.

instructions#

The text an MCP server sends its clients, which explains to the model how to use it.