moqui-service-writer

Generate, validate, and format Moqui service and entity XML definitions.

Updated Oct 28, 2025
One-click install
npx skills add https://github.com/schue/moqui-skill --skill moqui-service-writer
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: moqui-service-writer
Source: https://github.com/schue/moqui-skill/tree/main
Command: npx skills add https://github.com/schue/moqui-skill --skill moqui-service-writer

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve?

Moqui development teams often face friction when designing, validating, and maintaining Moqui XML definitions for services, entities, and queries. This skill provides a centralized guide, ready templates, and tooling that ensure definitions follow framework patterns and best practices.

Core Features & Use Cases

  • Service and entity validation across XML definitions using scripts/validate_service.py and scripts/validate_entity.py to catch pattern or structure issues early
  • XML formatting and consistency with format_moqui_xml.py to standardize style across projects
  • Generation templates and interactive scaffolding via scripts/generate_service.py plus ready asset/templates in assets/ to accelerate new component creation
  • Reference patterns and field guidance in references/ to support correct Moqui design
  • Use Case: Start a new Moqui module, generate a service, validate it, and format XML in a single workflow.

Quick Start

Use the Moqui Service Writer Skill to scaffold and validate Moqui services and entities. Example: generate a new service template, then validate and format your XML.

Frequently Asked Questions about moqui-service-writer

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I validate Moqui XML service definitions for pattern compliance?

Moqui service validation catches structural and pattern issues early using dedicated validation scripts. The Skill includes validate_service.py to check your XML definitions against framework conventions, ensuring services follow Moqui best practices before deployment.

Can I generate Moqui service templates to scaffold new components faster?

Yes. Generate service templates interactively using scripts/generate_service.py and ready-to-use templates in the assets/ directory. This accelerates new component creation by providing scaffolding that follows Moqui patterns.

What's the best way to standardize XML formatting across a Moqui project?

Use format_moqui_xml.py to enforce consistent XML style across all service, entity, and query definitions. Standardized formatting reduces drift and makes code reviews easier across your Moqui modules.

How do I start a new Moqui module with validated services and entities?

Generate service and entity templates, validate them against framework patterns using the included scripts, then format XML for consistency. The Skill supports the complete workflow from scaffolding through validation in a single pass.

Can I validate entity and query definitions along with services?

Yes. The Skill provides validate_entity.py and supports entity and query validation alongside service validation. Reference patterns guide correct Moqui design across all three definition types.

Does this work with existing Moqui module updates and audits?

Yes. The validation and formatting scripts apply to both new module creation and updates to existing definitions. Use them during audits to catch pattern drift and ensure consistency across your Moqui codebase.