developer-toolsdesign

Modus Design System

by julianoczkowski

Discover Modus Design System: comprehensive docs, specs, and guides for React UI library and component implementation in

Provides access to Trimble's Modus design system documentation, component specifications, design rules, and implementation guides for HTML/React projects through automated indexing and structured search capabilities.

github stars

5

Pre-bundled documentation - no external API callsNPX option requires no installationSearchable component library with 10+ tools

best for

  • / Frontend developers using Trimble's Modus design system
  • / Teams building HTML/React applications with Modus components
  • / Developers needing quick access to design system documentation

capabilities

  • / Search for Modus Web Components by name or keyword
  • / Get complete component documentation with attributes and examples
  • / Find components by specific attributes or properties
  • / Get design rules for colors, icons, spacing, and typography
  • / Get setup instructions for HTML or React projects
  • / Get theme implementation guidelines

what it does

Provides AI assistants with access to Trimble's Modus design system documentation, including component specs, design rules, and setup guides for HTML/React projects.

about

Modus Design System is a community-built MCP server published by julianoczkowski that provides AI assistants with tools and capabilities via the Model Context Protocol. Discover Modus Design System: comprehensive docs, specs, and guides for React UI library and component implementation in It is categorized under developer tools, design. This server exposes 10 tools that AI clients can invoke during conversations and coding sessions.

how to install

You can install Modus Design System in your AI client of choice. Use the install panel on this page to get one-click setup for Cursor, Claude Desktop, VS Code, and other MCP-compatible clients. This server runs locally on your machine via the stdio transport. This server supports remote connections over HTTP, so no local installation is required.

license

MIT

Modus Design System is released under the MIT license. This is a permissive open-source license, meaning you can freely use, modify, and distribute the software.

readme

MCP Modus

<div align="left"> <img src="assets/hero_modus_mcp.png" alt="Modus 2 MCP" width="600"> </div> <a href="https://glama.ai/mcp/servers/@julianoczkowski/mcp-modus"> <img width="380" height="200" src="https://glama.ai/mcp/servers/@julianoczkowski/mcp-modus/badge" alt="Modus MCP server" /> </a>

NPM Version License: MIT

AI assistant for Modus Web Components - Get instant help with component documentation, design rules, and setup guides directly in your IDE.

What This Does

This MCP server gives AI assistants (like Cursor, Claude, VS Code) access to complete Modus Web Components documentation. Ask questions like:

  • "How do I use a Modus button with primary color?"
  • "What are the Modus color guidelines?"
  • "Show me how to set up a React project with Modus components"
  • "Which components have a disabled attribute?"

Setup

Choose one of the two options below:

Option 1: NPX (Recommended - No Installation)

For any IDE with MCP support:

{
  "mcpServers": {
    "modus-docs": {
      "command": "npx",
      "args": ["-y", "@julianoczkowski/mcp-modus"]
    }
  }
}

Benefits: No installation required, always uses latest version, no permission issues, secure pre-bundled documentation.

Option 2: Global Install

  1. Install globally:

    npm install -g @julianoczkowski/mcp-modus
    

    Note: On some systems, you may need sudo npm install -g @julianoczkowski/mcp-modus

  2. Use this config:

    {
      "mcpServers": {
        "modus-docs": {
          "command": "mcp-modus"
        }
      }
    }
    

Benefits: Faster startup, works offline after installation, secure pre-bundled documentation.

IDE-Specific Instructions

For Cursor IDE

  1. Go to Settings → Features → MCP
  2. Click "Add New MCP Server"
  3. Use one of the JSON configs above

For VS Code (with Continue)

Add to ~/.continue/config.json using one of the JSON configs above.

For Claude Desktop

Add to your config file using one of the JSON configs above:

  • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
  • Windows: %APPDATA%/Claude/claude_desktop_config.json

What You Get

📚 Component Documentation (49 components)

Complete API documentation for all Modus Web Components including attributes, events, methods, slots, and usage examples.

<details> <summary><strong>View all 49 components</strong></summary>
ComponentDescription
modus-wc-accordionExpandable/collapsible content sections
modus-wc-alertContextual feedback messages
modus-wc-autocompleteText input with suggestions
modus-wc-avatarUser profile images
modus-wc-badgeStatus indicators and labels
modus-wc-breadcrumbsNavigation path indicators
modus-wc-buttonInteractive action buttons
modus-wc-button-groupGrouped buttons with selection modes
modus-wc-cardContent container with elevation
modus-wc-checkboxBoolean input control
modus-wc-chipCompact interactive elements
modus-wc-collapseAnimated show/hide content
modus-wc-dateDate picker input
modus-wc-dividerVisual content separator
modus-wc-dropdown-menuContextual menu with trigger
modus-wc-file-dropzoneDrag-and-drop file upload
modus-wc-handleResizable panel divider
modus-wc-iconModus icon display
modus-wc-input-feedbackForm validation messages
modus-wc-input-labelForm field labels
modus-wc-loaderLoading state indicators
modus-wc-logoTrimble/Viewpoint brand logos
modus-wc-menuNavigation menu container
modus-wc-menu-itemMenu navigation items
modus-wc-modalDialog overlays
modus-wc-navbarTop navigation bar
modus-wc-number-inputNumeric input with controls
modus-wc-paginationPage navigation controls
modus-wc-panelStructured layout container
modus-wc-progressProgress indicators
modus-wc-radioSingle-select option control
modus-wc-ratingStar rating input
modus-wc-selectDropdown selection input
modus-wc-side-navigationSidebar navigation
modus-wc-skeletonLoading placeholder
modus-wc-sliderRange value selector
modus-wc-stepperMulti-step process indicator
modus-wc-switchToggle on/off control
modus-wc-tableData table display
modus-wc-tabsTabbed content navigation
modus-wc-text-inputSingle-line text input
modus-wc-textareaMulti-line text input
modus-wc-theme-switcherTheme selection control
modus-wc-time-inputTime picker input
modus-wc-toastNotification messages
modus-wc-toolbarAction button container
modus-wc-tooltipContextual hover information
modus-wc-typographyText styling component
modus-wc-utility-panelSlide-out utility panel
</details>

🎨 Design System Rules (6 guides)

Comprehensive design guidelines for building consistent Modus applications.

GuideCoverage
modus_colorsColor tokens, semantic colors, theme palettes
modus_iconsIcon names, sizes, usage guidelines
typographyFont families, sizes, weights, line heights
spacingSpacing scale, margins, padding values
breakpointsResponsive breakpoints, media queries
radius_strokeBorder radius values, stroke widths

⚙️ Project Setup Guides (5 guides)

Step-by-step instructions for integrating Modus Web Components.

GuideCoverage
setup_htmlHTML project setup, CDN usage, basic integration
setup_reactReact project setup, npm installation, component usage
theme_usageTheme implementation, light/dark modes, customization
testingTesting guidelines, accessibility testing, best practices
universal_rulesGeneral development rules, coding standards

Example Usage

Once configured, ask your AI assistant:

"Create a Modus button with warning color and medium size"
"What spacing values should I use in my Modus design?"
"How do I set up a new React project with Modus Web Components?"
"Show me all Modus form components"
"What are the available Modus color tokens?"

The AI will use the MCP server to fetch the latest documentation and provide accurate, up-to-date answers.

Security & Reliability

  • 🔒 Pre-bundled Documentation: All documentation is included with the package - no runtime downloads
  • 🛡️ No External Dependencies: Runs completely offline after installation
  • ✅ Verified Content: Documentation is verified during our CI/CD process
  • 🚀 Fast & Secure: No network requests during operation
  • 🔐 Secure Publishing: Uses npm Trusted Publishers (OIDC) for secure, automated releases with automatic provenance attestation

Troubleshooting

Server Not Connecting

  • Ensure Node.js 20+ is installed: node --version (required for npm 11.5.1+ which supports OIDC)
  • For global install: verify with mcp-modus --help
  • Check IDE logs for error messages

Documentation Updates

Documentation is pre-bundled with each release for security and reliability. No downloads occur during installation or runtime.

Uninstalling

If you used the NPX option (Option 1), no permanent installation exists. NPX downloads are temporary.

If you used the Global Install option (Option 2), uninstall with:

npm uninstall -g @julianoczkowski/mcp-modus

Need Help?


Built for developers using Modus Web Components | MIT License | Made by Julian Oczkowski