kirby-mcp

🥈Silver

Kirby MCP is a CLI-first server for Kirby CMS projects. It enables developers to inspect blueprints, templates, and plugins, interact with a real Kirby runtime, and access a bundled knowledge base. It connects to Kirby CMS projects and integrates with Claude for enhanced workflows.

4500Updated 1mo ago

Intermediate30min to implementautomation

Saves ~50 min per use

Quick InstallView Source

git clone https://github.com/bnomei/kirby-mcp.git

Works with:

Claude

Overview

About This Skill

How to Use

1. **Install Kirby MCP**: Ensure Kirby MCP is installed and running in your environment. You can verify this by running `kirby-mcp --version` in your terminal. 2. **Connect to Your Project**: Use the `connect` command in Kirby MCP to link to your Kirby CMS project. For example: `kirby-mcp connect /var/www/my-site`. 3. **Inspect Blueprints**: Run the inspection command (e.g., `kirby-mcp inspect blueprint article.yml`). Replace `article.yml` with the name of your blueprint file. 4. **Review Output**: Analyze the output for issues like missing fields, inconsistencies, or deprecated options. Use the suggestions to update your blueprints and templates. 5. **Iterate and Test**: After making changes, re-run the inspection to ensure all issues are resolved. Test the updated blueprints in your Kirby admin panel to confirm they work as expected.

Setup & Installation

Quick Install

No install command available. Check the GitHub repository for manual installation instructions.

Alternative Install (Git Clone)

git clone https://github.com/bnomei/kirby-mcp

Requirements

Claude Code or compatible AI agent
Works with: Claude

Quick Start Guide

Install the Skill

Copy the install command above and run it in your terminal.

Open Your AI Agent

Launch Claude Code, Cursor, or your preferred AI coding agent.

Try It Out

Use the prompt template or examples below to test the skill.

Customize

Adapt the skill to your specific use case and workflow.

Usage Examples

Prompt Template

Use Kirby MCP to inspect the [BLUEPRINT_NAME] blueprint in my Kirby CMS project located at [PROJECT_PATH]. Check for missing fields, incorrect validation rules, or deprecated options in the blueprint configuration. Then, list all templates that use this blueprint and identify any inconsistencies between the blueprint and template files. Finally, suggest improvements to standardize the field types and validation rules across all templates using this blueprint.

Example Output

I’ve inspected the `article.yml` blueprint in your Kirby CMS project at `/var/www/my-site` and found the following issues:

1. **Missing Fields**: The `article.yml` blueprint is missing a `slug` field, which is critical for URL generation. The `title` field is present but lacks validation for minimum length (currently set to 3 characters, but no maximum limit is enforced).

2. **Inconsistent Templates**: Three templates (`article.php`, `blog-post.php`, and `news.php`) reference this blueprint. However, `news.php` uses a `text` field for the `body` instead of the `textarea` field defined in the blueprint. This inconsistency could lead to rendering issues in the admin panel.

3. **Deprecated Options**: The `status` field in the blueprint uses `draft`, `listed`, and `unlisted`, but the `unlisted` option is deprecated in Kirby 4.x. Replace it with `hidden` for future compatibility.

**Suggested Improvements**:
- Add a `slug` field with the `required: true` and `type: slug` options.
- Standardize the `body` field across all templates to use `type: textarea` with a `maxLength: 5000` validation rule.
- Update the `status` field to use `hidden` instead of `unlisted`.

These changes will ensure consistency, improve validation, and align with Kirby 4.x best practices.