| name | kirby-project-tour |
| description | Maps a Kirby project using Kirby MCP tools/resources, including roots, templates, snippets, controllers, models, blueprints, plugins, runtime status, and key config. Use when a user wants a project overview, file locations, or a quick orientation before making changes. |
Kirby Project Tour
Quick start
- Follow the workflow below for a structured tour.
KB entry points
kirby://kb/glossary/rootskirby://kb/glossary/templatekirby://kb/glossary/controllerkirby://kb/glossary/blueprintkirby://kb/glossary/plugin
Required inputs
- Focus area (Panel, frontend, performance, security).
- Desired depth and output format.
- Any known pain points to prioritize.
Output template
- Roots: templates, snippets, controllers, models, blueprints, content, config, plugins.
- Inventory: templates/snippets/controllers/models/blueprints/plugins counts and notable overrides.
- Config highlights: debug/cache/routes/languages.
- Risks or gaps: missing runtime, unknown plugins, stale blueprints.
- Next steps: 3 targeted recommendations (DX/perf/security).
First edits
- Content display tweaks:
site/templatesandsite/snippets. - Query logic:
site/controllers. - Panel schema:
site/blueprints.
Common pitfalls
- Reporting locations without reading
kirby://roots. - Skipping runtime install when indexes look empty.
Workflow
- Call
kirby:kirby_initto capture versions and composer audit details. - Read
kirby://rootsand summarize where templates, snippets, controllers, models, blueprints, content, config, and plugins live. - Inventory project surface (prefer parallel calls):
kirby:kirby_templates_indexkirby:kirby_snippets_indexkirby:kirby_controllers_indexkirby:kirby_models_indexkirby:kirby_blueprints_indexkirby:kirby_plugins_index
- If runtime-backed data is needed, check
kirby:kirby_runtime_statusand runkirby:kirby_runtime_installif required, then retry indexes. - Read key config values when relevant:
kirby://config/debug,kirby://config/cache,kirby://config/routes,kirby://config/languages. - Use
kirby:kirby_searchto jump into task playbooks (examples: "scaffold page type", "custom routes", "search page", "custom blocks"). - If you hit unfamiliar terms, consult
kirby://glossaryandkirby://glossary/{term}. - If you are unsure which tool/resource to use next, call
kirby:kirby_tool_suggestor readkirby://tools.
Output checklist
- Provide a "where to edit what" cheat sheet (template vs controller vs snippet vs blueprint vs content vs config).
- Highlight notable customizations (page models, plugins, blueprint overrides, unusual roots).
- Offer 3 next-step recommendations (DX, performance, security).