data
Payload CMS MCP, CLI, and Lua Integration for AI Agents
Payload CMS integration docs for AI agents: MCP gateway setup, Payload CMS CLI commands, Lua API reference, credentials, and function schemas.Payload CMS for agents
Credentials can be configured manually in web or CLI hosts.
Use this integration from Lua code mode, the headless integrations CLI, or the KosmoKrator MCP gateway. The same package metadata powers all three surfaces.
Agent Surfaces
Machine-Readable Metadata
Function Catalog
| Function | Type | Parameters | Description |
|---|---|---|---|
payload-cms.payload_cms_list_collections | Read read | 0 | List all collections defined in the Payload CMS instance. Returns each collection's slug, labels, and field configuration. |
payload-cms.payload_cms_get_collection | Read read | 1 | Get detailed information about a specific collection by its slug. Returns field definitions, labels, default sort, and other configuration. |
payload-cms.payload_cms_list_documents | Read read | 5 | List documents in a Payload CMS collection. Supports pagination (limit, page), sorting, and filtering via the where parameter. Returns document IDs, timestamps, and field values. |
payload-cms.payload_cms_get_document | Read read | 2 | Get detailed information about a specific document by its ID within a collection. Returns all field values, timestamps, and metadata. |
payload-cms.payload_cms_create_document | Write write | 2 | Create a new document in a Payload CMS collection. Provide the collection slug and a JSON object of field values. The document is created as a draft by default (if versions are enabled on the collection). |
payload-cms.payload_cms_list_users | Read read | 2 | List users in the Payload CMS instance. Supports pagination with limit and page parameters. Returns user IDs, emails, names, and roles. |
payload-cms.payload_cms_get_current_user | Read read | 0 | Get the profile of the currently authenticated Payload CMS user. Returns email, name, roles, and account metadata. |