Kirby Mcp

Kirby MCP

[](https://getkirby.com)

[](https://discordapp.com/users/bnomei) [](https://www.buymeacoffee.com/bnomei)

CLI-first MCP server for Composer-based Kirby CMS projects. It lets an IDE or agent inspect your Kirby project (blueprints, templates, plugins, docs) and interact with a real Kirby runtime. It ships with a local knowledge base of Kirby concepts and tasks. For agent-specific install steps (Claude Code, Codex CLI) and Skill sync, see Client setup.

It can also run as a projectless global reference MCP (kirby-mcp --global) for always-on Kirby docs/KB research. Global reference mode is intentionally separate from project-local MCP servers and cannot inspect, render, update, or run commands in a Kirby project.

> [!WARNING] > Prompt injection is a serious security threat, especially when used with documents retrieved from the internet. You might not see it happen when observing the conversation with the agent!

Quickstart

From your Kirby project root:

composer require bnomei/kirby-mcp --dev
vendor/bin/kirby-mcp install
vendor/bin/kirby-mcp

This quickstart is for a local stdio MCP server. If you want Kirby to serve a production HTTP /mcp route, install bnomei/kirby-mcp as a normal Composer dependency instead of --dev; see HTTP transport below.

Then configure your MCP client (Cursor/Claude Code/Codex CLI) using the examples in Client setup and copy the bundled Skills as described below.

See Client setup → Claude Code and Client setup → Codex CLI for per-agent install and Skill sync steps.

Global Reference Mode

Install once with Composer and run the global reference MCP anywhere:

composer global require bnomei/kirby-mcp
kirby-mcp --global

Use this mode for always-available Kirby research: bundled KB search, glossary, Panel field/section reference, hooks, extensions, update-schema guides, official docs search, and plugin directory search.

Global reference mode is projectless by design:

• It does not auto-detect or accept --project.
• It does not expose project/runtime tools such as kirby_roots, kirby_info, kirby_render_page, content updates, eval/query, runtime install, or IDE helper generation.
• If you need project context or mutations, add a separate project-local MCP server with vendor/bin/kirby-mcp.

Copy-paste request examples

Use these once your MCP client is connected to the server.

Planning & content

> [!TIP] > "Use the Kirby MCP to make a plan to..." is a reliable way to get your agent to use the tools and resources this MCP server provides. If you ask it to take action, it tends to edit files directly based on its training and skills.

Use the Kirby MCP to make a plan to... build a contact form page.

kirby_roots, kirby_blueprint_read, kirby_templates_index, kirby_snippets_index, kirby_controllers_index, kirby_render_page, kirby_dump_log_tail, kirby://config/{option}

Agent response example:

Here’s a Kirby MCP–driven plan for a new contact form page in this project:

- Confirm requirements: fields (name/email/message), spam protection (honeypot + csrf()), success UX (inline vs redirect), and whether to store submissions.
- Panel setup: reuse existing blueprint site/blueprints/pages/contact.yml; update site/blueprints/site.yml so the site “pages” section allows creating template contact.
- Create the page: add content/4_contact/contact.txt (or create via Panel once allowed) and fill recipient, subject, success, text.
- Frontend: add site/templates/contact.php + a snippet like site/snippets/contact-form.php (escape all echoed user input; include hidden CSRF field + honeypot).
- Controller: add site/controllers/contact.php to handle POST: check csrf(get('csrf')), validate with invalid(), then send mail via $kirby->email() using replyTo (never use user input as from) and an email template like site/templates/emails/contact.text.php (optional contact.html.php).
- Email config: add site/config/config.php email.transport/email.presets (current kirby://config/email is null).
- Verify with MCP: render the page via kirby_render_page(id='contact', noCache=true); debug with mcp_dump() + kirby_dump_log_tail(traceId=...); inspect blueprint/roots via kirby_blueprint_read(id='pages/contact') and kirby://roots.

---

Show me the fields available on the home page blueprint and what they do using the MCP.

kirby_blueprint_read, kirby_blueprints_index

---

Show me the current content of the about page.

kirby_read_page_content

---

Append " with AI" to the title of the home page with Kirby MCP.

kirby_read_page_content, kirby_update_page_content, kirby://field/text/update-schema

Resource shortcuts

> [!TIP] > Either on its own or with a request, the resources can be used to quickly bring knowledge and runtime information into the current context of your agent.

kirby://glossary/collection

kirby://glossary/{term}

---

What is the kirby://config/debug for production?

kirby://config/{option}

Search & docs

> [!TIP] > The MCP server ships with a local knowledge base about Kirby. It consists of a glossary, common tasks, and update guides for content fields. This reduces the need to rely on external resources and is very fast.

kirby search for collection filtering

kirby_search

---

> [!TIP] > But sometimes you or your agent needs to dig deeper. That is why the MCP server also provides a fallback to the official Kirby search and docs (not including the forum). You can trigger it by mentioning search online in your request.

kirby search online for panel permissions

kirby_online

---

> [!TIP] > When you need to discover third-party plugins, you can also search the official Kirby plugin directory and fetch details from each plugin page.

kirby search plugins online for e-commerce cart

kirby_online_plugins

---

> [!TIP] > Your agent will use the next tool under the hood itself, but you can use it as well to quickly check what the MCP server knows about a given topic.

What mcp tool should I use to... list plugins?

kirby_tool_suggest

Inventory (runtime + filesystem)

list blueprints, templates, snippets, collections, controllers, models, plugins, routes, roots

kirby_blueprints_loaded, kirby_blueprints_index, kirby_templates_index, kirby_snippets_index, kirby_collections_index, kirby_controllers_index, kirby_models_index, kirby_plugins_index, kirby_routes_index, kirby_roots

Debug, tinker/eval and running commands

> [!IMPORTANT] > The kirby_eval tool is disabled by default and CLI commands are protected by an allowlist/denylist, see config and security below.

kirby MCP tinker $site->index()->count()

kirby_eval

---

kirby MCP check query site.find('notes').unlisted.count
kirby MCP check query page.siblings.count (model: notes)

kirby_query_dot

---

run kirby cli command uuid:populate

kirby_run_cli_command

---

My home page renders incorrectly. Help me debug it with mcp_dump() to return the current $page object.

kirby_render_page, kirby_dump_log_tail, kirby_templates_index, kirby_snippets_index, kirby_controllers_index, kirby_models_index

Capabilities

> [!INFO] > kirby_init is required once per session before calling any other tool or resource but the agent should figure this out automatically. Some capabilities require the runtime wrappers because they query Kirby at runtime. Installing/updating them should happen automatically as well.

At initialization, the server tells the agent which tools/resources to use. The knowledge base cross-references them so the agent can find the next step.

Current inventory: 37 tools, 15 resources, 15 resource templates, 216 KB articles.

In global reference mode (kirby-mcp --global), the exposed surface is intentionally smaller: kirby_init, kirby_search, kirby_online, kirby_online_plugins, kirby_tool_suggest, and static reference resources/templates (kirby://kb, glossary, fields/sections, hooks, extensions, and update schemas).

🛠️ Tools

• kirby_blueprint_read — read a single blueprint by id
• kirby_blueprints_index — index blueprints, includes plugin-registered ones when runtime is installed
• kirby_blueprints_loaded — list blueprint ids loaded at runtime
• kirby_cache_clear — clear in-memory caches for this MCP session (StaticCache, config, composer, roots, tool index)
• kirby_cli_version — run kirby version and return stdout, stderr and exit code
• kirby_composer_audit — parse composer.json for scripts and quality tools
• kirby_collections_index — index named collections, includes plugin-registered ones when runtime is installed
• kirby_controllers_index — index controllers, includes plugin-registered ones when runtime is installed
• kirby_online — search official Kirby docs (online fallback) and optionally fetch markdown pages
• kirby_online_plugins — search the official Kirby plugins directory (online fallback) and optionally fetch plugin details
• kirby_dump_log_tail — tail .kirby-mcp/dumps.jsonl written by mcp_dump()
• kirby_eval — execute PHP in Kirby runtime for quick inspection, requires enable plus confirm
• kirby_query_dot — evaluate Kirby query language (dot-notation) strings, requires confirm and can be disabled via config
• kirby_generate_ide_helpers — generate regeneratable IDE helper files into .kirby-mcp/
• kirby_ide_helpers_status — report missing template/snippet PHPDoc @var hints for used Kirby globals + helper file freshness (mtime-based)
• kirby_info — project runtime info, composer audit and local environment detection
• kirby_init — session guidance plus project-specific audit, call once per session
• kirby_search — search the bundled local Kirby knowledge base markdown files (preferred)
• kirby_models_index — index registered page models with class and file path info
• kirby_plugins_index — index loaded plugins, prefers runtime truth when installed
• kirby_read_file_content — read file content/metadata by id or uuid
• kirby_read_page_content — read page content by id or uuid
• kirby_read_site_content — read site content
• kirby_read_user_content — read user content by id or email
• kirby_render_page — render a page by id or uuid and return HTML plus errors
• kirby_roots — resolved Kirby roots via kirby roots
• kirby_routes_index — list registered routes with best-effort source location (config/plugin)
• kirby_run_cli_command — run a Kirby CLI command, guarded by an allowlist
• kirby_runtime_install — install project-local Kirby MCP runtime CLI commands into the project
• kirby_runtime_status — check whether runtime command wrappers are installed
• kirby_snippets_index — index snippets, includes plugin-registered ones when runtime is installed
• kirby_templates_index — index templates, includes plugin-registered ones when runtime is installed
• kirby_tool_suggest — suggest the best next Kirby MCP tool/resource for a task
• kirby_update_file_content — update file metadata/content, plus confirm (see kirby://blueprint/file/update-schema + kirby://field/{type}/update-schema for payload shapes)
• kirby_update_page_content — update page content, plus confirm (see kirby://blueprint/page/update-schema + kirby://field/{type}/update-schema for payload shapes)
• kirby_update_site_content — update site content, plus confirm (see kirby://blueprint/site/update-schema + kirby://field/{type}/update-schema for payload shapes)
• kirby_update_user_content — update user content, plus confirm (see kirby://blueprint/user/update-schema + kirby://field/{type}/update-schema for payload shapes)

Update tool data input accepts either a JSON object or a JSON-encoded object string for backward compatibility. If your client supports MCP resource subscriptions, successful kirby_update_*_content writes emit notifications/resources/updated for subscribed content resources (kirby://site/content, kirby://page/content/{...}, kirby://file/content/{...}, kirby://user/content/{...}). Confirm-gated tools (kirby_update_*_content, kirby_eval, kirby_query_dot) keep explicit confirm=true; clients with MCP elicitation support may present an inline confirmation prompt and continue on accept.

📚 Resources

> [!TIP] > Call a resource to bring condensed knowledge into the current context of your agent.

Resources (read-only):

• kirby://commands — Kirby CLI command list, parsed from kirby help
• kirby://composer — composer audit, scripts and quality tooling
• kirby://extensions — Kirby plugin extensions list (links to kirby://extension/{name})
• kirby://fields — Kirby Panel field types list (links to kirby://field/{type})
• kirby://fields/update-schema — Kirby content field guides list (links to kirby://field/{type}/update-schema)
• kirby://blueprints/update-schema — Kirby blueprint update guides list (links to kirby://blueprint/{type}/update-schema)
• kirby://glossary — Kirby glossary terms list (links to kirby://glossary/{term})
• kirby://kb — bundled KB index (links to kirby://kb/{path})
• kirby://hooks — Kirby hook names list (links to kirby://hook/{name})
• kirby://info — project runtime info, composer audit and local environment detection
• kirby://roots — Kirby roots discovered via CLI, respects configured host
• kirby://sections — Kirby Panel section types list (links to kirby://section/{type})
• kirby://tools — weighted keyword index for Kirby MCP tools/resources/templates
• kirby://uuid/new — generate a new Kirby UUID string (respects content.uuid format)

Resource templates (dynamic):

• kirby://blueprint/{encodedId} — read a blueprint by URL-encoded id, e.g. pages%2Fhome
• kirby://cli/command/{command} — parsed kirby --help output, e.g. backup or uuid:generate
• kirby://config/{option} — read a Kirby config option by dot path
• kirby://extension/{name} — Kirby extension reference markdown from getkirby.com, e.g. commands or darkroom-drivers
• kirby://field/{type} — Kirby Panel field reference markdown from getkirby.com, e.g. blocks or email
• kirby://field/{type}/update-schema — bundled content field guide from kb/update-schema/{type}.md
• kirby://blueprint/{type}/update-schema — bundled blueprint update guide from kb/update-schema/blueprint-{type}.md
• kirby://glossary/{term} — read a bundled Kirby glossary entry by term, e.g. api or kql
• kirby://kb/{path} — read a bundled KB document by path (relative to kb/, no .md)
• kirby://hook/{name} — Kirby hook reference markdown from getkirby.com, e.g. file.changeName:after or file-changename-after
• kirby://file/content/{encodedIdOrUuid} — read file content/metadata by URL-encoded id or uuid
• kirby://page/content/{encodedIdOrUuid} — read page content by URL-encoded id or uuid
• kirby://section/{type} — Kirby Panel section reference markdown from getkirby.com, e.g. fields or files
• kirby://site/content — read site content
• kirby://susie/{phase}/{step} — easter egg resource template
• kirby://user/content/{encodedIdOrEmail} — read user content by URL-encoded id or email

Skills

Bundled Skills live in vendor/bnomei/kirby-mcp/skills after installation. Copy them into your agent’s local skills folder using the Client setup instructions below.

• kirby-project-tour — Project inventory and orientation (roots, blueprints, plugins) with next-step recommendations.
• kirby-content-migration — Safe content migrations with runtime read/update tools and update schemas.
• kirby-scaffold-page-type — Scaffold a page type (blueprint + template + optional controller/model) using project conventions.
• kirby-routing-and-representations — Custom routes, redirects, and content rep

…

Source & license

This open-source MCP server is cataloged on AgentStack and links to its original source — we do not rehost the code.

• Author: bnomei
• Source: bnomei/kirby-mcp
• License: MIT
• Homepage: https://forum.getkirby.com/t/kirby-mcp-inspect-blueprints-templates-plugins-interact-with-a-real-kirby-runtime-and-use-a-bundled-knowledge-base/35106

Install and usage instructions live in the source repository linked above.