Skip to content
Development
Command

/describe-component

Generate an AI-optimised component description

shell
$ npx -y skills add murphytrueman/design-system-ops --agent claude-code

Ships with design-system-ops. Installing the plugin gets this command.

How it fires

How this command gets triggered: by you, by Claude, or both.

  • Fires itselfClaude auto-loads it when your prompt matches the work.
  • You can call itInvoke it directly when you want it.
  • Slash command/describe-component

Context preview

What this command does when you run it.

Generate an AI-optimised component description

Command definition

describe-component.md
description: Generate an AI-optimised component description
allowed-tools: Read, Write, Grep, Glob, Bash(cat:*), Bash(find:*), Bash(head:*), Bash(ls:*), Bash(sort:*), Bash(tail:*), Bash(wc:*)

Run the ai-component-description skill to generate a structured, machine-readable description for a design system component.

Load the ai-component-description skill from ${CLAUDE_PLUGIN_ROOT}/skills/ai-component-description/SKILL.md and follow its complete workflow.

Before starting, read the knowledge notes declared in the skill's frontmatter `references:` field, located in ${CLAUDE_PLUGIN_ROOT}/knowledge-notes/.

Produce a six-section description: 1. Purpose — what the component does and when to use it 2. Props — every prop with type, default, and guidance 3. Anti-patterns — what NOT to do (use the inference guide for new components) 4. Composition rules — how it works with other components 5. Accessibility — keyboard, screen reader, ARIA, focus 6. Usage examples — concrete code showing correct usage

Also generate the structured JSON metadata for machine-readable manifests.

Run the self-test: could an AI agent select this component correctly, configure it, and avoid misuse based solely on this description?

The component to describe: $ARGUMENTS

Read it on GitHub ↗
Ships withdesign-system-ops

Claude Code skills for the work that keeps a design system alive.

Get the whole plugin, auto-invoked
Stats
151
Stars
0
Views
7
Forks
Maintained
Maintenance
HTML
Language
MIT
License
1mo ago
Last commit
4mo ago
Created

Repo: murphytrueman/design-system-ops