writing-registry-meta

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

⭐2.4kstars🔀150forks📁View on GitHub🕐Updated Dec 24, 2025⬇️1downloads

When & Why to Use This Skill

This Claude skill automates the creation and management of metadata files for the MUI Treasury registry. It ensures that all registry items are correctly documented with standardized JSON schemas, strict naming conventions, and detailed component descriptions, facilitating better integration with LLMs and UI libraries while streamlining the development workflow.

Use Cases

  • Registry Contribution: Automatically generating the required .meta.json file when adding a new component to the MUI Treasury to ensure all mandatory fields are present.
  • Metadata Standardization: Enforcing strict kebab-case naming conventions and directory structures for registry files to maintain project consistency.
  • LLM Context Optimization: Crafting detailed, accessibility-focused component descriptions that help other AI agents understand the interface and its dependencies.
  • Workflow Automation: Ensuring the registry index is updated by reminding the user or agent to trigger the build command after metadata modifications.
namewriting-registry-meta
descriptionUse this skill when writing meta file for MUI Treasury registry.
  • 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.