Skip to content

Commit 02c272a

Browse files
oetikerclaude
andcommitted
Add Claude Code plugin for Checkmk plugin development
Move the plugin development guide from cmk-plugin-guide/ into a Claude Code skill at skills/checkmk-plugin/. The skill provides guided help for building, upgrading, and packaging Checkmk 2.3.x plugins including SNMP, agent-based, special agents, notifications, metrics, rulesets, and bakery. Install via: /install-plugin https://github.com/oposs/mkp-builder Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent d7d606c commit 02c272a

22 files changed

+636
-509
lines changed

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
!/.github
88
!/.mkp-builder.ini.example
99
!/.clinerules
10-
!/cmk-plugin-guide
10+
!/skills
1111
*~
1212
*.swp
1313
*.bak

CHANGES.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
99

1010
### New
1111

12+
- Add notification plugin support to mkp-builder (collects from `local/share/check_mk/notifications/`, creates `notifications.tar`)
13+
- Add Claude Code plugin with Checkmk 2.3.x plugin development skill (`skills/checkmk-plugin/`)
14+
- Install via `/install-plugin https://github.com/oposs/mkp-builder` in Claude Code
15+
1216
### Changed
17+
- Move plugin development guide from `cmk-plugin-guide/` into `skills/checkmk-plugin/references/`
18+
- Update README with Claude Code plugin install instructions
1319

1420
### Fixed
1521

README.md

Lines changed: 31 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@
55

66
> **⚠️ Disclaimer**: This is an independent, community-developed tool and is **not officially affiliated with or endorsed by Checkmk GmbH**. This project was developed by reverse-engineering existing MKP package formats and studying Checkmk documentation. Any issues, bugs, or incompatibilities are our responsibility and should be reported to this project's issue tracker, not to Checkmk support.
77
8-
> **📚 Plugin Development Guide**: Since many users of mkp-builder are developing Checkmk plugins, we maintain comprehensive modular documentation for Checkmk 2.3.x plugin development in [`cmk-plugin-guide/`](cmk-plugin-guide/). The guide covers agent plugins, SNMP plugins, special agents, check plugins, rulesets, graphing, bakery integration, and metric migration with practical examples and best practices. Start with the [guide index](cmk-plugin-guide/00-index.md) or read the [guide overview](cmk-plugin-guide/README.md).
9-
108
> **🚨 Breaking Changes in v2.0.0**: If you're upgrading from v1.x, please note that v2.0.0 introduces breaking changes. The configuration file format has changed from `.mkp-builderrc` to `.mkp-builder.ini` with INI format syntax. GitHub Action input names have also been updated. See the [changelog](CHANGES.md) for full migration details.
119
1210
A reusable GitHub Action for building Checkmk MKP (Monitoring Konfiguration Package) files from local directory structures.
@@ -20,6 +18,37 @@ A reusable GitHub Action for building Checkmk MKP (Monitoring Konfiguration Pack
2018
- 🧹 **Clean**: No permanent changes to your repository
2119
-**Fast**: Downloads build tools on-demand, no bloated containers
2220

21+
## Claude Code Plugin: Checkmk Plugin Development Guide
22+
23+
This repo includes a comprehensive Checkmk 2.3.x plugin development guide
24+
as a [Claude Code](https://claude.com/claude-code) skill. Once installed,
25+
Claude will automatically use the guide whenever you ask it to build, upgrade,
26+
or package Checkmk plugins.
27+
28+
### Install
29+
30+
```
31+
/install-plugin https://github.com/oposs/mkp-builder
32+
```
33+
34+
### What it covers
35+
36+
- Agent-based check plugins, SNMP plugins, special agents
37+
- Metrics, graphing, and perfometers
38+
- Rulesets and GUI configuration
39+
- Bakery integration for automatic agent deployment
40+
- Notification plugins (Slack, Teams, webhooks, etc.)
41+
- Metric migration (renaming metrics while preserving RRD history)
42+
- MKP packaging with the `oposs/mkp-builder` GitHub Action
43+
44+
### Example prompts
45+
46+
- *"Build an SNMP plugin to monitor my Liebert UPS"*
47+
- *"Upgrade my old v1 check plugin to the v2 API"*
48+
- *"Create a notification plugin that sends alerts to Teams"*
49+
- *"Add graphs and configurable thresholds to my plugin"*
50+
- *"Package my plugin as an MKP with a GitHub Actions release workflow"*
51+
2352
## Quick Start
2453

2554
```yaml

cmk-plugin-guide/00-index.md

Lines changed: 0 additions & 95 deletions
This file was deleted.

cmk-plugin-guide/01-quickstart.md

Lines changed: 0 additions & 190 deletions
This file was deleted.

0 commit comments

Comments
 (0)