Skip to main content

get_typography_audit

Run a comprehensive typography health audit on a design system configuration.

Reference

Parameters

  • Name
    config
    Type
    record · optional
    Description

    Typography configuration object

  • Name
    design_system_id
    Type
    string · optional
    Description

    Design system ID to fetch config from database (uuid)

  • Name
    category
    Type
    enum · optional
    Description

    Filter to specific category (foundations · tokens · semantic · responsive · accessibility · usage)

  • Name
    include_fixes
    Type
    boolean · optional
    Description

    Include ready-to-apply fix patches (default: true)

  • Name
    quick
    Type
    boolean · optional
    Description

    Run quick audit (critical checks only) (default: false)

Description

Run a comprehensive typography health audit on a design system configuration.

Returns AI-friendly results including:

  • Health score (0-100), grade (A-F), and level (excellent/good/fair/poor/critical)
  • AI-friendly issue summaries with impact on code generation
  • Generation guidance: instructions for AI to compensate for typography weaknesses
  • Ready-to-apply fixes with config patches and code snippets

The AI should use this guidance to adapt its code generation:

  • If no fluid typography: use clamp() patterns
  • If tight line heights: prefer leading-relaxed
  • If missing semantic roles: use explicit text style tokens

Parameters:

  • config (optional): Typography configuration object to audit
  • design_system_id (optional): ID to fetch config from database
  • category (optional): Filter to specific category (foundations, tokens, semantic, responsive, accessibility, usage)
  • include_fixes (optional): Include ready-to-apply fix patches (default: true)
  • quick (optional): Run quick audit (critical checks only) for faster response

Examples:

  • get_typography_audit({ config: { fontSize: {...}, lineHeight: {...} } })
  • get_typography_audit({ design_system_id: "uuid-here" })
  • get_typography_audit({ category: "accessibility" })

Source

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

Was this page helpful?

Last reviewed by @jschuyler