nocobase-app-plugin-__NOCOBASE_SHORT_NAME__

Scaffolds a development draft documenting App-facing capabilities for a NocoBase plugin.

9|3|Updated Aug 14, 2026
One-click install
npx skills add https://github.com/nocobase/nocobase3 --skill nocobase-app-plugin-nocobase-short-name-nocobase
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: nocobase-app-plugin-__NOCOBASE_SHORT_NAME__
Source: https://github.com/nocobase/nocobase3/tree/main/packages/tools/create-plugin/template/skills/nocobase-app-plugin-__NOCOBASE_SHORT_NAME__
Command: npx skills add https://github.com/nocobase/nocobase3 --skill nocobase-app-plugin-nocobase-short-name-nocobase

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? When building a NocoBase plugin, developers need a structured starting point for documenting the plugin's App-facing behavior before it is synchronized to an App. This Skill provides a scaffolded draft template that enforces consistent documentation of public contracts, prerequisites, workflows, and permissions. ## Core Features & Use Cases - Structured Draft Template: Provides predefined sections covering use triggers, public surfaces, prerequisites, App workflow, ownership, permissions, and verification. - Placeholder-Driven Scaffolding: Uses template variables like the plugin short name and display name so generated plugins start with a consistent documentation skeleton. - Use Case: A developer generates a new NocoBase plugin via the create-plugin tool and uses this draft to record which public contracts are implemented and how the App integration should behave before release. ## Quick Start Replace each placeholder section of the draft with verified App-facing behavior for your NocoBase plugin before synchronizing it to an App.

Frequently Asked Questions about nocobase-app-plugin-__NOCOBASE_SHORT_NAME__

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

FAQPage Schema
How do I document App-facing behavior for a NocoBase plugin?▼

Start from the draft template and fill in each section: use triggers, public surfaces, prerequisites, App workflow, ownership, permissions, and verification. Replace all placeholder text with verified behavior before synchronizing the plugin to an App.

What sections should a NocoBase plugin development draft include?▼

The draft includes use triggers, implemented public contracts, prerequisites such as registration and authentication, the shortest executable App workflow, ownership boundaries, permission constraints, and observable verification criteria.

Is this NocoBase plugin draft ready for production use?▼

No. It is explicitly a development draft scaffold. Every placeholder section must be replaced with verified App-facing behavior, and synchronization alone does not count as behavioral proof.

How do I verify a NocoBase plugin's App integration works?▼

List observable App behavior in the verification section, such as rendered UI elements or working workflows. The draft states that synchronization alone is not behavioral proof, so verification must be based on actual App behavior.