`get_component_api`

Returns the full props API for a design system component.

Reference

Parameters

Name
component
Type
string · required
Description
Component name (e.g., Button, nys-button, Select)
Name
includeExamples
Type
boolean · optional
Description
Include usage examples
Name
format
Type
enum · optional
Description
Output format (typescript · json-schema · markdown)
Name
layerId
Type
string · optional
Description
Layer UUID for layer-specific preset resolution (uuid)

Returns

{
  component          Component name
  description        What the component does
  props              Array of prop definitions with:
    name           Prop name
    type           TypeScript type
    required       Whether the prop is required
    default        Default value (if any)
    description    What the prop does
    allowedValues  Valid values for enum types
  presets            Available presets for this component with name, description, props
  examples           Usage examples (if includeExamples=true)
  relatedComponents  Components often used together
  importStatement    How to import the component
}

Description

Returns the full props API for a design system component.

Use this tool when you need to know exactly what props a component accepts, including types, defaults, and allowed values. Essential for generating type-safe component code.

Parameters:

component (required): Component name (e.g., "Button", "Select", "Input")
includeExamples (optional): Include usage examples (default: false)
format (optional): Output format - 'typescript' | 'json-schema' | 'markdown' (default: 'typescript')

Use this BEFORE generating component code to ensure correct prop usage.

Source

Defined in packages/mcp/src/tools.ts. The request handler lives alongside its registration in packages/mcp/src/tools/.

get_component_api

Copy link to sectionReference