Vývojáři

Referat schopností pluginu Zinn® Cache

Zinn® Cache registruje své akce pomocí WordPress Abilities API. Stejné schopnosti jsou nástroji MCP na vlastním serveru webu a cestami REST pod /wp-json/wp-abilities/v1. Tato stránka je generována z vlastního registru pluginu.

Uživatelská příručka: připojení aplikace s umělou inteligencí

Zinn®, náš Viking, jásá, když se asistent s umělou inteligencí připojuje k nástrojům platformy.

Koncové body

MCP přes HTTP (streamovatelné)

https://example.com/wp-json/zinn-cache/v1/mcp

MCP přes WP-CLI (standardní vstup a výstup)

wp mcp-adapter serve --server=zinn-cache --user=<login>

REST: vypsat funkce

/wp-json/wp-abilities/v1/abilities?category=zinn-cache

REST: spustit schopnost

/wp-json/wp-abilities/v1/abilities/<name>/run

Autentizace a oprávnění

HTTP požadavky se ověřují pomocí aplikačního hesla WordPress (HTTP Basic). Připojení k serveru MCP vyžaduje níže zobrazenou oprávněnost; každá schopnost pak kontroluje své vlastní oprávnění pro každý objekt. Schopnosti pouze pro čtení běží s metodou GET a vstupem v řetězci dotazu; ostatní s metodou POST a tělem JSON {„input“: {…}}.

Příklady

# REST: spustit schopnost
curl -u your-username:your-application-password \
  "https://example.com/wp-json/wp-abilities/v1/abilities/zinn-cache/get-cache-layers/run"
# MCP (JSON-RPC over HTTP, after "initialize")
{"jsonrpc":"2.0","id":2,"method":"tools/call","params":{"name":"zinn-cache-get-cache-layers","arguments":{}}}

Všechny oprávnění

Vygenerováno ze souboru abilities.json v pluginu, který se sám generuje z běžícího webu; test selže, pokud se tyto dva zdroje neshodují.

OprávněníCo to děláEdiceRESTOprávněníParametry
zinn-cache/clean-database
zinn-cache-clean-database
Vyčistit databázi (Pro)
Na pozadí odstraňuje druhy nepořádku zapnuté v nastavení. Co je odstraněno, nelze vrátit zpět.
Edice ProPOST …/abilities/zinn-cache/clean-database/runmanage_optionsžádné
zinn-cache/convert-images
zinn-cache-convert-images
Převést všechny existující obrázky (Pro)
Spustí na pozadí převod obrázků v knihovně médií do moderních formátů povolených v nastavení.
Edice ProPOST …/abilities/zinn-cache/convert-images/runmanage_optionsžádné
zinn-cache/detect-cache-layers
zinn-cache-detect-cache-layers
Zjistit mezipaměti před webem
Vyžádá domovskou stránku stejně jako návštěvník a zaznamená, které mezipaměti odpověděly. S parametrem sample: true také dvakrát vyžádá nejnovější stránky a spočítá, jak často je každá vrstva obsloužila ze své mezipaměti.
Bezplatná edicePOST …/abilities/zinn-cache/detect-cache-layers/runmanage_options (the REST route's own check)sample: boolean
zinn-cache/get-cache-analytics
zinn-cache-get-cache-analytics
Přečtěte si analytiku mezipaměti (Pro)
Vrací míru úspěšnosti a provoz objektové mezipaměti za poslední hodiny (hodiny, až 720), její nejpomalejší příkazy a pluginy, které mezipaměť míjejí nejčastěji.
Edice ProGET …/abilities/zinn-cache/get-cache-analytics/runmanage_optionshours: integer
zinn-cache/get-cache-layers
zinn-cache-get-cache-layers
Přečtěte si, co web ukládá do mezipaměti
Vrací informaci o tom, která mezipaměť obsluhuje stránky (LiteSpeed, nginx, Varnish, Apache, Cloudflare nebo disková mezipaměť pluginu), co zjistila poslední detekce, velikost jednotlivých vrstev tam, kde je WordPress dokáže přečíst, frontu promazávání, postupné obnovování a nedávná promazání.
Bezplatná ediceGET …/abilities/zinn-cache/get-cache-layers/runmanage_options (the REST route's own check)žádné
zinn-cache/get-diagnostics
zinn-cache-get-diagnostics
Přečtěte si diagnostickou zprávu
Vrací diagnostickou zprávu, kterou podpora vyžaduje: verze, limity serveru, stav mezipaměti a nedávné chyby. Neobsahuje žádná hesla ani klíče.
Bezplatná ediceGET …/abilities/zinn-cache/get-diagnostics/runmanage_optionsžádné
zinn-cache/get-image-progress
zinn-cache-get-image-progress
Přečtěte si průběh převodu obrázku (Pro)
Vrací, jak daleko pokročil převod (nebo odstranění) obrázků.
Edice ProGET …/abilities/zinn-cache/get-image-progress/runmanage_optionsžádné
zinn-cache/get-pro-settings
zinn-cache-get-pro-settings
Přečtěte si nastavení Cache Pro (Pro)
Vrací každé nastavení Cache Pro (zahřátí, obrázky, skripty a styly, vyčištění databáze, chytré promazávání, vyhledávač). Tajné klíče se nikdy nevrací.
Edice ProGET …/abilities/zinn-cache/get-pro-settings/runmanage_optionsžádné
zinn-cache/get-settings
zinn-cache-get-settings
Přečtěte si nastavení mezipaměti
Vrací všechna nastavení mezipaměti. Heslo pro Redis a token pro Cloudflare se nikdy nevrací, pouze informace o tom, zda jsou uloženy.
Bezplatná ediceGET …/abilities/zinn-cache/get-settings/runmanage_optionsžádné
zinn-cache/get-slow-queries
zinn-cache-get-slow-queries
Přečtěte si o vyhledávači pomalých dotazů (Pro)
Vrací nejpomalejší databázové dotazy a odchozí volání, které vyhledávač zaznamenal, spolu s pluginem nebo šablonou, které je provedly.
Edice ProGET …/abilities/zinn-cache/get-slow-queries/runmanage_optionsžádné
zinn-cache/get-status
zinn-cache-get-status
Přečíst stav mezipaměti
Vrací, zda je mezipaměť stránek a mezipaměť objektů zapnutá a funguje, kolik stránek je v mezipaměti uloženo a počty připojení a zásahů mezipaměti objektů.
Bezplatná ediceGET …/abilities/zinn-cache/get-status/runmanage_optionsžádné
zinn-cache/get-warmup-progress
zinn-cache-get-warmup-progress
Přečtěte si postup zahřívání (Pro)
Vrací informaci, zda zahřívání běží, kolik stránek navštívilo a kolik jich selhalo.
Edice ProGET …/abilities/zinn-cache/get-warmup-progress/runmanage_optionsžádné
zinn-cache/preview-database-cleanup
zinn-cache-preview-database-cleanup
Náhled vyčištění databáze (Pro)
Spočítá, co by vyčištění odstranilo, podle jednotlivých druhů (revize, koncepty, spam, expirovaná dočasná data a podobně). Nic se neodstraňuje.
Edice ProGET …/abilities/zinn-cache/preview-database-cleanup/runmanage_optionsžádné
zinn-cache/purge
zinn-cache-purge
Vyprázdnit mezipaměť
Odstraní stránky z mezipaměti: vše (all: true), některé adresy (urls) nebo vše s daným štítkem (tags). Stránky se znovu vytvoří při příchodu návštěvníků.
Bezplatná edicePOST …/abilities/zinn-cache/purge/runmanage_options (the REST route's own check)all: boolean, urls: array, tags: array
zinn-cache/purge-urls
zinn-cache-purge-urls
Vyprázdnit některé adresy na každé vrstvě mezipaměti
Odebere tyto adresy (cesty jako /about/ nebo celé adresy na tomto webu) současně z diskové mezipaměti, mezipaměti serveru a ze služby Cloudflare a uvede, co jednotlivé vrstvy odpověděly.
Bezplatná edicePOST …/abilities/zinn-cache/purge-urls/runmanage_options (the REST route's own check)urls: array (povinné)
zinn-cache/refresh-cache
zinn-cache-refresh-cache
Spusťte nebo zastavte postupné obnovování
action: start obnovuje každou stránku po dávkách za minutu (což provádějí aktualizace namísto vyprázdnění mezipaměti); action: stop ukončí probíhající obnovu.
Bezplatná edicePOST …/abilities/zinn-cache/refresh-cache/runmanage_options (the REST route's own check)action: start|stop (povinné)
zinn-cache/remove-converted-images
zinn-cache-remove-converted-images
Odebrat všechny převedené obrázky (Pro)
Na pozadí smaže každou převedenou kopii obrázků; originály zůstanou zachovány.
Edice ProPOST …/abilities/zinn-cache/remove-converted-images/runmanage_optionsžádné
zinn-cache/reset-settings
zinn-cache-reset-settings
Obnovte výchozí nastavení mezipaměti
Vrátí každé nastavení mezipaměti zpět na výchozí hodnotu, stejně jako tlačítko Obnovit. Uložené heslo pro Redis bude také odstraněno.
Bezplatná edicePOST …/abilities/zinn-cache/reset-settings/runmanage_optionsžádné
zinn-cache/reset-slow-queries
zinn-cache-reset-slow-queries
Vymazat nálezy pomalých dotazů (Pro)
Zapomene každý dosud nalezený pomalý dotaz a pomalé volání a vyhledávač se spustí znovu.
Edice ProPOST …/abilities/zinn-cache/reset-slow-queries/runmanage_optionsžádné
zinn-cache/update-pro-settings
zinn-cache-update-pro-settings
Změnit nastavení Cache Pro (Pro)
Změní nastavení Cache Pro, která odešlete (nastavení: klíč k hodnotě), a zbytek ponechá. Každá hodnota je zkontrolována přesně jako na obrazovce Cache Pro; neznámý klíč je odmítnut.
Edice ProPOST …/abilities/zinn-cache/update-pro-settings/runmanage_optionssettings: object (povinné)
zinn-cache/update-settings
zinn-cache-update-settings
Změnit nastavení mezipaměti
Změní nastavení, která odešlete, a zbytek zachová (mezipaměť stránek, jak dlouho zůstanou stránky v mezipaměti, mezipaměť objektů a její připojení k Redis, pravidla promazávání a výjimky). Hodnoty jsou zkontrolovány a opraveny přesně jako na obrazovce Cache.
Bezplatná edicePOST …/abilities/zinn-cache/update-settings/runmanage_optionslscache_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, server_cache: string, server_cache_headers: boolean, nginx_purge_method: string, nginx_purge_endpoint: string, nginx_http_verb: string, nginx_purge_address: string, nginx_cache_path: string, nginx_cache_levels: string, nginx_cache_key: string, nginx_key_variants: array|object|string, nginx_spool_dir: string, varnish_host: string, varnish_port: integer, varnish_method: string, apache_cache_root: string, apache_dir_levels: integer, apache_dir_length: integer, cloudflare_enabled: boolean, cloudflare_zone_id: string, cloudflare_api_token: string, cloudflare_purge_everything: boolean, refresh_batch: integer, refresh_load_limit: integer, redis_serializer: string, heartbeat_mode: string, font_display_swap: boolean, preconnect_origins: array|object|string, cdn_url: string, cdn_exclude: array|object|string
zinn-cache/warm-cache
zinn-cache-warm-cache
Zahřát mezipaměť (Pro)
Začne na pozadí navštěvovat každou stránku v souborech sitemap, aby návštěvníci získávali stránky z mezipaměti. Průběh je během běhu hlášen samostatně.
Edice ProPOST …/abilities/zinn-cache/warm-cache/runmanage_optionsžádné

Příkazy WP-CLI

Spusťte tyto příkazy na serveru pomocí WP-CLI. Každý příkaz kontroluje stejná oprávnění jako obrazovky pluginu; příklady jsou převzaty z nápovědy samotného pluginu.

PříkazCo to děláEdice
wp zinn-cache purge all
wp zinn-cache purge all
Vyprázdnit všechny stránky v mezipaměti.Bezplatná edice
wp zinn-cache purge post
<id>...
wp zinn-cache purge post 42
Vyprázdnit stránky příspěvku a výpisy, na kterých se zobrazuje (domovská stránka, archivy, kanály).Bezplatná edice
wp zinn-cache purge url
<url>...
wp zinn-cache purge url https://example.com/ /pricing/
Vymažte stránky v mezipaměti na těchto adresách URL.Bezplatná edice
wp zinn-cache refresh
<action>
wp zinn-cache refresh status
Spusťte, zastavte nebo zobrazte postupné obnovení (to, co po aktualizaci nahrazuje možnost „vymazat vše“).Bezplatná edice
wp zinn-cache server detect
wp zinn-cache server detect
Zkontrolujte, které mezipaměti odpovídají před webem (nginx, Varnish, Apache, LiteSpeed, Cloudflare).Bezplatná edice
wp zinn-cache server drain
wp zinn-cache server drain
Odešlete zařazená promazání mezipaměti serveru nyní namísto čekání na WP-Cron.Bezplatná edice
wp zinn-cache status
[--format=<format>]
wp zinn-cache status --format=json
Nahlaste stav objektové mezipaměti.Bezplatná edice

Akce a filtry

Každý háček, který plugin nabízí, včetně popisu z jeho zdrojového kódu. Filtry mění hodnotu; akce vám umožňují spustit kód v daném okamžiku; vstupní body jsou akce, které spouštíte, abyste plugin požádali o provedení nějaké akce.

WebhookDruhCo to děláParametryEdice
zinn_cache_control_headerFiltrovatFiltruje hodnotu cache-control odeslanou do LiteSpeed pro stránku, kterou lze ukládat do mezipaměti.string $value, int $ttlBezplatná edice
zinn_cache_fs_loadedAkceSpustí se po načtení SDK licenčního klíče, před zbytkem mezipaměti Zinn® Cache. Zde se můžete napojit na komunikaci s `zinn_cache_fs()`.žádnéBezplatná edice
zinn_cache_link_scan_post_typesFiltrovatTypy příspěvků, které kontrola zahrnuje.žádnéBezplatná edice
zinn_cache_mcp_abilitiesAkceSpustí se poté, co Zinn® Cache zaregistruje své schopnosti: Zinn® Cache Pro zde přidá své vlastní.žádnéBezplatná edice
zinn_cache_post_change_tagsFiltrovatFiltruje značky mezipaměti, které se vymažou při změně příspěvku.string[] $tags, int $post_id, string $post_typeBezplatná edice
zinn_cache_purge_allAkceVymažte vše z řádku Nástroje.žádnéBezplatná edice
zinn_cache_purge_hostsFiltrovatFiltruje názvy hostitelů, které mohou pročištění uvádět (pro web provozovaný na více doménách).string[] $hostsBezplatná edice
zinn_cache_purge_on_seo_changeFiltrovatFiltruje, zda změna provedená v Zinn® SEO promaže stránky, které změnila.bool $onBezplatná edice
zinn_cache_purge_planVstupní bod (spustíte ho)Vymažte přesně to, co plán uvádí: `do_action( 'zinn_cache_purge_plan', array( 'urls' => …, 'tags' => …, 'purge_all' => … ) )`.žádnéBezplatná edice
zinn_cache_purgedAkceSpustí se poté, co plugin vyvolá vymazání vyrovnávací paměti.array{purge_all:bool,urls:string[],tags:string[]} $planBezplatná edice
zinn_cache_purged_allAkceSpustí se po vyžádání úplného vymazání mezipaměti stránky.string $reasonBezplatná edice
zinn_cache_refresh_armedAkceSpouští se při zahájení dávkového obnovení.string $reasonBezplatná edice
zinn_cache_refresh_finishedAkceSpustí se, když postupné obnovení dosáhne konce webu.int $pagesBezplatná edice
zinn_cache_refresh_guardFiltrovatFiltruje, zda by se mělo obnovení v této minutě pozastavit (vlastní ochrana zátěže hostitele).string $reasonBezplatná edice
zinn_cache_refresh_urlsFiltrovatFiltruje adresy, které dávka obnovení vymaže — přidejte sem například adresy jednotlivých stránek v jiných jazycích.string[] $urlsBezplatná edice
zinn_cache_refreshed_urlsAkceSpouští se po vyčištění dávky obnovení (Zinn® Cache Pro tyto stránky znovu zahřeje).string[] $urlsBezplatná edice
zinn_cache_request_cacheableFiltrovatFiltruje, zda aktuální požadavek front-endu může být obsloužen z vyrovnávací paměti stránky.bool $cacheableBezplatná edice
zinn_cache_status_rowsFiltrovatFiltruje řádky tabulky „Co ukládá tento web do mezipaměti“ na stavové obrazovce.array<int,array{0:string,1:string}> $rows, array<string,mixed> $reportBezplatná edice
zinn_cache_ttlFiltrovatFiltruje dobu ukládání aktuální stránky do mezipaměti v sekundách.int $ttlBezplatná edice