Agent skill

Business Events

by mendixlabs in mendixlabs/mxcli

Define event-driven APIs over Kafka with Mendix business event services — publish and subscribe contracts, CREATE/DROP/DESCRIBE.

Apache-2.0Auto-check passedBackend & APIs

Install Business Events

skills CLI
$ npx skills add mendixlabs/mxcli --skill business-events -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install mendixlabs/mxcli business-events --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/mendixlabs/mxcli.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.claude/skills/mendix/business-events .claude/skills/business-events && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
business-events
GitHub stars
129
Token cost
~1.3k tokens
SKILL.md length
396 words
Files
1
Skills in repo
72
Repo updated
First seen
Licence
Apache-2.0

At a glance

Define event-driven APIs over Kafka with Mendix business event services — publish and subscribe contracts, CREATE/DROP/DESCRIBE.

  • Works in 6 steps: Define a Business Event Service with… → Create entities prefixed with PBE_ that… → Entity attributes must exactly match the… → …
  • Building publish/subscribe integration between apps
  • SKILL.md covers When to Use This Skill, Commands, Message Definition Syntax and Service Properties, plus 3 more sections
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

Business Events is an agent skill from mendixlabs/mxcli. Define event-driven APIs over Kafka with Mendix business event services — publish and subscribe contracts, CREATE/DROP/DESCRIBE. Use when building publish/subscribe integration between apps, or inspecting the business event services a project already has.

Its SKILL.md is about 1.3k tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Backend & APIs, covering Event-driven systems. It works with Apache Kafka and Java. The repository describes itself as: Mendix cli tool, a headless way to work with Mendix projects. Enables Mendix projects for use with 3rd party agentic coding tools like Claude Code and Copilot. Includes a… The licence is Apache-2.0.

When your agent uses it

  • Building publish/subscribe integration between apps
  • Inspecting the business event services a project already has

Example prompts

  • “/business-events”

Workflow steps

6 steps, taken from the first numbered list in SKILL.md.

  1. Define a Business Event Service with PUBLISH messages
  2. Create entities prefixed with PBE_ that extend BusinessEvents.PublishedBusinessEvent
  3. Entity attributes must exactly match the message attributes (no extra attributes on the entity)
  4. In microflows, create an instance of the event entity, populate its attributes, commit it
  5. Call BusinessEvents.PublishBusinessEvent_V2 passing the entity instance
  6. For subscribe operations, link a handler microflow in the service definition

What it can do on your machine

Read from SKILL.md and the folder at commit 22d9ea6. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md (its code samples are sql).

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Business Events loads about 1.3k tokens when it runs. Until then it costs about 68 tokens; SKILL.md has 396 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~68
When it runs · the whole SKILL.md, loaded when a task matches
~1.3k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from mendixlabs/mxcli at commit 22d9ea6, republished under its Apache-2.0 licence (© mendixlabs). 396 words, ~1,345 tokens.

Download SKILL.mdSave it as .claude/skills/business-events/SKILL.md (or your agent's skills folder).
name
business-events
description
Define event-driven APIs over Kafka with Mendix business event services — publish and subscribe contracts, CREATE/DROP/DESCRIBE. Use when building publish/subscribe integration between apps, or inspecting the business event services a project already has.

Business Events

When to Use This Skill

Use this skill when the user wants to:

  • Define event-driven APIs using Kafka/message brokers
  • Create business event services that publish events
  • View or describe existing business event services
  • Set up publish/subscribe message channels

Commands

View Business Events
sql
-- List all business event service documents
list business event services;

-- Filter by module
list business event services in MyModule;

-- List all business event client documents (future)
list business event clients;

-- List individual messages across all services
list business events;

-- Filter messages by module
list business events in MyModule;

-- Full MDL description (round-trippable)
describe business event service Module.ServiceName;
Create a Business Event Service
sql
mdl 1;
create business event service Module.CustomerEventsApi
(
  ServiceName: 'CustomerEventsApi',
  EventNamePrefix: 'com.example'
)
{
  message CustomerChangedEvent (CustomerId: long) publish
    entity Module.PBE_CustomerChangedEvent;
  message AddressChangedEvent (AddressId: long) publish
    entity Module.PBE_AddressChangedEvent;
};
Create or Modify (Idempotent Update — Preferred)

Preserves the existing UUID so other documents that reference this service remain valid. OR REPLACE is accepted as a synonym.

sql
mdl 1;
create or modify business event service Module.CustomerEventsApi
(
  ServiceName: 'CustomerEventsApi',
  EventNamePrefix: ''
)
{
  message CustomerChangedEvent (CustomerId: long) publish
    entity Module.PBE_CustomerChangedEvent;
};
Drop a Business Event Service
sql
mdl 1;
drop business event service Module.CustomerEventsApi;

Message Definition Syntax

message <MessageName> (<AttrName>: <type>, ...) publish|subscribe
  [entity <Module.EntityName>]
  [microflow <Module.MicroflowName>];
Supported Attribute Types
  • string - Text
  • integer - 32-bit integer
  • long - 64-bit integer
  • decimal - Precise decimal number
  • boolean - True/false
  • datetime - Date and time

Service Properties

PropertyDescription
ServiceNameThe service name used in the event broker
EventNamePrefixPrefix added to event names (can be empty)
folderOptional folder path for the service document

Operations

OperationDescription
publishThis service publishes the event (other apps subscribe)
subscribeThis service subscribes to the event (other apps publish)

Publishing Events from Microflows

There is no dedicated microflow activity for publishing business events. Instead, Mendix provides Java actions in the BusinessEvents marketplace module. Use call java action to publish an event from a microflow:

sql
-- Create an event entity instance and publish it
create microflow Module.ACT_PublishCustomerChanged
  folder 'ACT'
begin
  $event = create Module.PBE_CustomerChangedEvent (CustomerId = $CustomerId);
  commit $event;
  call java action BusinessEvents.PublishBusinessEvent_V2(EventObject = $event);
end;
Available Java Actions (from BusinessEvents module)
Java ActionDescription
BusinessEvents.PublishBusinessEvent_V2Publish an event (recommended)
BusinessEvents.PublishBusinessEventPublish an event (legacy)
BusinessEvents.ConsumeBusinessEventConsume/acknowledge an event
BusinessEvents.PublishEventsPublish multiple events
BusinessEvents.StartupBusinessEventsInitialize the event broker connection
BusinessEvents.ShutdownBusinessEventsShut down the event broker connection
Show full SKILL.md (165 more words)Show less
Typical Pattern
  1. Define a Business Event Service with PUBLISH messages
  2. Create entities prefixed with PBE_ that extend BusinessEvents.PublishedBusinessEvent
  3. Entity attributes must exactly match the message attributes (no extra attributes on the entity)
  4. In microflows, create an instance of the event entity, populate its attributes, commit it
  5. Call BusinessEvents.PublishBusinessEvent_V2 passing the entity instance
  6. For subscribe operations, link a handler microflow in the service definition

Checklist

  • Linked entities must exist before creating the service
  • Entities must extend BusinessEvents.PublishedBusinessEvent (for published events)
  • Entity attributes must exactly match the message attributes (no extra/missing attributes)
  • Entity names use qualified format: Module.EntityName
  • Entities for published events are conventionally prefixed with PBE_
  • Attribute types must be valid (String, Integer, Long, Decimal, Boolean, DateTime)
  • Use describe business event service to verify the result
  • The DESCRIBE output is parseable and can be used as a CREATE statement
  • To publish events from microflows, use call java action BusinessEvents.PublishBusinessEvent_V2
  • The BusinessEvents module must be included in the project (marketplace module)

© mendixlabs, Apache-2.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in .claude/skills/mendix/business-events of mendixlabs/mxcli.

Open the folder on GitHubat commit 22d9ea6

Compare with similar skills

Business Events next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Business Events compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Business Events this skillmendixlabs/mxcli129—~1.3kAutomated safety check: PassApache-2.0
Streaming Dataancoleman/ai-design-components525—~2.9kAutomated safety check: PassMIT
123 Java Design Patternsjabrena/plinth447—~1.1kAutomated safety check: PassApache-2.0
323 Frameworks Spring Boot Testing Acceptance Testsjabrena/plinth447—~1.2kAutomated safety check: PassApache-2.0
133 Java Testing Acceptance Testsjabrena/plinth447—~1.3kAutomated safety check: PassApache-2.0
Databricks Zerobus Ingestdatabricks/databricks-agent-skills345—~6.3kAutomated safety check: PassCustom licence

Similar skills

  • Streaming Data

    ancoleman/ai-design-components

    Build event streaming and real-time data pipelines with Kafka, Pulsar, Redpanda, Flink, and Spark.

    525 GitHub stars~2.9k tokensUpdated 10 mo ago
    Backend & APIsAuto-check passed
  • A skill your agent uses when you need to select, review, or implement Java design and integration patterns — including classic Java design patterns, REST API patterns, Kafka and event-driven…

    447 GitHub stars~1.1k tokensUpdated 2 days ago
    Backend & APIsAuto-check passed
  • A skill your agent uses when you need to implement acceptance tests from maintainer-authored or maintainer-sanitized Gherkin scenario facts for Spring Boot applications — including selecting…

    447 GitHub stars~1.2k tokensUpdated 2 days ago
    Backend & APIsAuto-check passed
  • A skill your agent uses when you need to implement acceptance tests from maintainer-sanitized Gherkin scenario facts for framework-agnostic Java (no Spring Boot, Quarkus, Micronaut) — confirming…

    447 GitHub stars~1.3k tokensUpdated 2 days ago
    Testing & QAAuto-check passed
  • Databricks Zerobus Ingest

    databricks/databricks-agent-skills

    Official

    Push records from apps, services, devices, or scripts directly into Unity Catalog Delta tables with Zerobus Ingest: SDKs (Python, TypeScript, Go, Java, Rust, C++, .NET), REST, OTLP, MQTT, Arrow…

    345 GitHub stars~6.3k tokensUpdated today
    DevOps & CloudAuto-check passed
  • Io Connectors

    Kilo-Org/kilo-marketplace

    Guides development and usage of I/O connectors in Apache Beam.

    190 GitHub stars~1.3k tokensUpdated 11 days ago
    DatabasesAuto-check passed

More from mendixlabs/mxcli

All 72 skills in this repo
  • Mendix Odata Pushdown

    mendixlabs/mxcli

    Push OData query options into the SQL of a Mendix resource served by a read microflow, so $filter, $orderby, $top, $skip, $count and the key lookup reach the database instead of being silently…

    129 GitHub stars~2.5k tokensUpdated today
    Auto-check passed
  • Mendix Vega Charts

    mendixlabs/mxcli

    Chart a Mendix app with Vega-Lite through a pluggable widget that takes the specification and the data as separate properties, so the model emits rows and never assembles a chart payload.

    129 GitHub stars~3k tokensUpdated today
    Auto-check passed
  • Mendix Bulk Oql Dml

    mendixlabs/mxcli

    Run set-based INSERT, UPDATE and DELETE against Mendix entities through OQL statements, which the runtime supports and Studio Pro cannot author.

    129 GitHub stars~1.4k tokensUpdated today
    Auto-check passed
  • Agents

    mendixlabs/mxcli

    Author Mendix AI agent documents in MDL — Model, Knowledge Base, Consumed MCP Service and Agent, with variables, tools and multi-line prompts.

    129 GitHub stars~2.2k tokensUpdated today
    Auto-check passed
  • Analyze Runtime

    mendixlabs/mxcli

    Find out what a running Mendix app actually does — logs, Prometheus metrics, OpenTelemetry traces and the model catalog, joined across sources.

    129 GitHub stars~2.8k tokensUpdated today
    Auto-check passed
  • Assess Migration

    mendixlabs/mxcli

    Investigate an existing non-Mendix application (Java, .NET, Python, Node, PHP, …) and produce a structured migration assessment for Mendix.

    129 GitHub stars~3.6k tokensUpdated today
    Auto-check: notes

Categories

Questions about Business Events

What does Business Events do?

Define event-driven APIs over Kafka with Mendix business event services — publish and subscribe contracts, CREATE/DROP/DESCRIBE. Business Events is an agent skill from mendixlabs/mxcli. Define event-driven APIs over Kafka with Mendix business event services — publish and subscribe contracts, CREATE/DROP/DESCRIBE.

When should I use Business Events?

Business Events fits situations like: building publish/subscribe integration between apps; inspecting the business event services a project already has.

How do I install Business Events in Claude Code?

Run `npx skills add mendixlabs/mxcli --skill business-events -a claude-code`. Or copy the skill folder (.claude/skills/mendix/business-events in mendixlabs/mxcli) into .claude/skills/business-events in your project. Claude Code loads it when a task matches its description.

How do I install Business Events in Codex?

Run `npx skills add mendixlabs/mxcli --skill business-events -a codex`. Or copy the skill folder (.claude/skills/mendix/business-events in mendixlabs/mxcli) into .agents/skills/business-events in your project. Codex loads it when a task matches its description.

Can I use Business Events in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add mendixlabs/mxcli --skill business-events -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/business-events, .gemini/skills/business-events, .github/skills/business-events and .opencode/skills/business-events in your project.

What does Business Events need to run?

SKILL.md names no scripts, command-line tools or credentials: Business Events is instructions for the agent only.

Does Business Events access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Business Events safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Business Events use?

Business Events is published under the Apache-2.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Business Events use?

About 1.3k tokens (SKILL.md is roughly 5.4k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Business Events?

Skills that share tags, products or a category with Business Events: Streaming Data (ancoleman/ai-design-components, 525 stars), 123 Java Design Patterns (jabrena/plinth, 447 stars), 323 Frameworks Spring Boot Testing Acceptance Tests (jabrena/plinth, 447 stars) and 133 Java Testing Acceptance Tests (jabrena/plinth, 447 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Business Events?

mendixlabs (a GitHub organization) maintains it in mendixlabs/mxcli, which has 129 GitHub stars. The repository holds 72 skills in this directory. The repository was last updated on October 10, 2026.

Source: mendixlabs/mxcli on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.