OpenParable
Skip to content
← Back to skills

Writing Registry Meta

Development
writing-registry-meta

Writing Registry Meta is an Agent Skill for development published in the siriwatknp/mui-treasury repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Use this skill when writing meta file for MUI Treasury registry.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/siriwatknp/mui-treasury/blob/HEAD/.claude/skills/writing-registry-meta/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/writing-registry-meta, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

  • The meta file must be in JSON format.
  • The meta file must be located in the same directory as the registry file.
  • The meta file must have the same name as the registry file, but with a .meta.json extension.
  • The meta file must contain the following fields:
    • name: The registry name in kebab-case, same as file name without extension.
    • title: The name of the registry usually the same as the component name in Pascal case.
    • type: always "registry:item".
    • description: IMPORTANT! Describe the registry in detail to help LLM understand what the interface looks like and its purpose. Start with "Integrated [library name]" if using third-party libraries (e.g., Base UI). Focus on visible features (buttons, labels, states) and accessibility. DO NOT list individual Material UI components.
    • meta: Additional metadata about the registry
      • category: one of "primitive", "ai"
      • previewClassName: The extra class name to add to the preview container.

IMPORTANT! after writing/updating a meta file, run pnpm registry:build to populate the registry index.