Developers
Zinn® Cache abilities reference
Zinn® Cache registers its actions with the WordPress Abilities API. The same abilities are MCP tools on the site's own server and REST routes under /wp-json/wp-abilities/v1. This page is generated from the plugin's own registry.
Endpoints
MCP over HTTP (streamable)
https://example.com/wp-json/zinn-cache/v1/mcpMCP over WP-CLI (standard input and output)
wp mcp-adapter serve --server=zinn-cache --user=<login>REST: list the abilities
/wp-json/wp-abilities/v1/abilities?category=zinn-cacheREST: run an ability
/wp-json/wp-abilities/v1/abilities/<name>/runAuthentication and permissions
HTTP requests authenticate with a WordPress application password (HTTP Basic). Connecting to the MCP server needs the capability shown below; every ability then checks its own permission, per object. Read-only abilities run with GET and their input in the query string; the others with POST and a JSON body {"input": {…}}.
Examples
# REST: run an ability
curl -u your-username:your-application-password \
"https://example.com/wp-json/wp-abilities/v1/abilities/zinn-cache/get-diagnostics/run"# MCP (JSON-RPC over HTTP, after "initialize")
{"jsonrpc":"2.0","id":2,"method":"tools/call","params":{"name":"zinn-cache-get-diagnostics","arguments":{}}}All abilities
Generated from the plugin's abilities.json, which is itself generated from a running site; a test fails when the two disagree.
| Ability | What it does | Edition | REST | Permission | Parameters |
|---|---|---|---|---|---|
zinn-cache/clean-databasezinn-cache-clean-database | Clean up the database (Pro) Removes, in the background, the kinds of clutter switched on in the settings. What is removed cannot be brought back. | Pro edition | POST …/abilities/zinn-cache/clean-database/run | manage_options | none |
zinn-cache/convert-imageszinn-cache-convert-images | Convert all existing images (Pro) Starts converting the media library's images to the modern formats switched on in the settings, in the background. | Pro edition | POST …/abilities/zinn-cache/convert-images/run | manage_options | none |
zinn-cache/get-cache-analyticszinn-cache-get-cache-analytics | Read the cache analytics (Pro) Returns the object cache's hit rate and traffic for the last hours (hours, up to 720), its slowest commands, and which plugins miss the cache most. | Pro edition | GET …/abilities/zinn-cache/get-cache-analytics/run | manage_options | hours: integer |
zinn-cache/get-diagnosticszinn-cache-get-diagnostics | Read the diagnostics report Returns the diagnostics report support asks for: versions, server limits, the cache state and recent errors. It holds no passwords or keys. | Free edition | GET …/abilities/zinn-cache/get-diagnostics/run | manage_options | none |
zinn-cache/get-image-progresszinn-cache-get-image-progress | Read the image conversion progress (Pro) Returns how far converting (or removing) the images has got. | Pro edition | GET …/abilities/zinn-cache/get-image-progress/run | manage_options | none |
zinn-cache/get-pro-settingszinn-cache-get-pro-settings | Read the Cache Pro settings (Pro) Returns every Cache Pro setting (warm-up, images, scripts and styles, database clean-up, smart purging, the finder). Secrets are never returned. | Pro edition | GET …/abilities/zinn-cache/get-pro-settings/run | manage_options | none |
zinn-cache/get-settingszinn-cache-get-settings | Read the cache settings Returns every cache setting. The Redis password is never returned, only whether one is saved. | Free edition | GET …/abilities/zinn-cache/get-settings/run | manage_options | none |
zinn-cache/get-slow-querieszinn-cache-get-slow-queries | Read the slow-query finder (Pro) Returns the slowest database queries and outgoing calls the finder has seen, with the plugin or theme that made each one. | Pro edition | GET …/abilities/zinn-cache/get-slow-queries/run | manage_options | none |
zinn-cache/get-statuszinn-cache-get-status | Read the cache status Returns whether the page cache and the object cache are on and working, how many pages are cached, and the object cache's connection and hit numbers. | Free edition | GET …/abilities/zinn-cache/get-status/run | manage_options | none |
zinn-cache/get-warmup-progresszinn-cache-get-warmup-progress | Read the warm-up progress (Pro) Returns whether the warm-up is running, how many pages it has visited and how many failed. | Pro edition | GET …/abilities/zinn-cache/get-warmup-progress/run | manage_options | none |
zinn-cache/preview-database-cleanupzinn-cache-preview-database-cleanup | Preview the database clean-up (Pro) Counts what a clean-up would remove, per kind (revisions, drafts, spam, expired temporary data and the like). Nothing is removed. | Pro edition | GET …/abilities/zinn-cache/preview-database-cleanup/run | manage_options | none |
zinn-cache/purgezinn-cache-purge | Purge the cache Discards cached pages: everything (all: true), some addresses (urls) or everything tagged (tags). Pages are rebuilt as visitors arrive. | Free edition | POST …/abilities/zinn-cache/purge/run | manage_options (the REST route's own check) | all: boolean, urls: array, tags: array |
zinn-cache/remove-converted-imageszinn-cache-remove-converted-images | Remove all converted images (Pro) Deletes every converted copy of the images in the background; the originals stay. | Pro edition | POST …/abilities/zinn-cache/remove-converted-images/run | manage_options | none |
zinn-cache/reset-settingszinn-cache-reset-settings | Put the cache settings back to their defaults Puts every cache setting back to its default, as the Reset button does. The saved Redis password is removed too. | Free edition | POST …/abilities/zinn-cache/reset-settings/run | manage_options | none |
zinn-cache/reset-slow-querieszinn-cache-reset-slow-queries | Clear the slow-query findings (Pro) Forgets every slow query and slow call found so far, and the finder starts again. | Pro edition | POST …/abilities/zinn-cache/reset-slow-queries/run | manage_options | none |
zinn-cache/update-pro-settingszinn-cache-update-pro-settings | Change the Cache Pro settings (Pro) Changes the Cache Pro settings you send (settings: key to value) and keeps the rest. Each value is checked exactly as on the Cache Pro screen; an unknown key is refused. | Pro edition | POST …/abilities/zinn-cache/update-pro-settings/run | manage_options | settings: object (required) |
zinn-cache/update-settingszinn-cache-update-settings | Change the cache settings Changes the settings you send and keeps the rest (page cache, how long pages stay cached, the object cache and its Redis connection, purging rules and exclusions). Values are checked and corrected exactly as on the Cache screen. | Free edition | POST …/abilities/zinn-cache/update-settings/run | manage_options | lscache_enabled: boolean, lscache_ttl: integer, object_cache_enabled: boolean, auto_purge_enabled: boolean, purge_on_upgrade: boolean, exclude_uris: array|object|string, exclude_query_keys: array|object|string, exclude_cookies: array|object|string, redis_host: string, redis_port: integer, redis_database: integer, redis_username: string, redis_password: string, redis_key_prefix: string, browser_ttl: integer, cache_logged_out_only: boolean, purge_on_comment: boolean, ttl_overrides: array|object|string |
zinn-cache/warm-cachezinn-cache-warm-cache | Warm the cache (Pro) Starts visiting every page in the sitemaps in the background, so visitors get cached pages. Follow it with zinn-cache/get-warmup-progress. | Pro edition | POST …/abilities/zinn-cache/warm-cache/run | manage_options | none |