Skip to main content
Glama

MCP Modus

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?"

Related MCP server: Component Library MCP Server

Setup

Choose one of the two options below:

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.

Component

Description

modus-wc-accordion

Expandable/collapsible content sections

modus-wc-alert

Contextual feedback messages

modus-wc-autocomplete

Text input with suggestions

modus-wc-avatar

User profile images

modus-wc-badge

Status indicators and labels

modus-wc-breadcrumbs

Navigation path indicators

modus-wc-button

Interactive action buttons

modus-wc-button-group

Grouped buttons with selection modes

modus-wc-card

Content container with elevation

modus-wc-checkbox

Boolean input control

modus-wc-chip

Compact interactive elements

modus-wc-collapse

Animated show/hide content

modus-wc-date

Date picker input

modus-wc-divider

Visual content separator

modus-wc-dropdown-menu

Contextual menu with trigger

modus-wc-file-dropzone

Drag-and-drop file upload

modus-wc-handle

Resizable panel divider

modus-wc-icon

Modus icon display

modus-wc-input-feedback

Form validation messages

modus-wc-input-label

Form field labels

modus-wc-loader

Loading state indicators

modus-wc-logo

Trimble/Viewpoint brand logos

modus-wc-menu

Navigation menu container

modus-wc-menu-item

Menu navigation items

modus-wc-modal

Dialog overlays

modus-wc-navbar

Top navigation bar

modus-wc-number-input

Numeric input with controls

modus-wc-pagination

Page navigation controls

modus-wc-panel

Structured layout container

modus-wc-progress

Progress indicators

modus-wc-radio

Single-select option control

modus-wc-rating

Star rating input

modus-wc-select

Dropdown selection input

modus-wc-side-navigation

Sidebar navigation

modus-wc-skeleton

Loading placeholder

modus-wc-slider

Range value selector

modus-wc-stepper

Multi-step process indicator

modus-wc-switch

Toggle on/off control

modus-wc-table

Data table display

modus-wc-tabs

Tabbed content navigation

modus-wc-text-input

Single-line text input

modus-wc-textarea

Multi-line text input

modus-wc-theme-switcher

Theme selection control

modus-wc-time-input

Time picker input

modus-wc-toast

Notification messages

modus-wc-toolbar

Action button container

modus-wc-tooltip

Contextual hover information

modus-wc-typography

Text styling component

modus-wc-utility-panel

Slide-out utility panel

🎨 Design System Rules (6 guides)

Comprehensive design guidelines for building consistent Modus applications.

Guide

Coverage

modus_colors

Color tokens, semantic colors, theme palettes

modus_icons

Icon names, sizes, usage guidelines

typography

Font families, sizes, weights, line heights

spacing

Spacing scale, margins, padding values

breakpoints

Responsive breakpoints, media queries

radius_stroke

Border radius values, stroke widths

βš™οΈ Project Setup Guides (5 guides)

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

Guide

Coverage

setup_html

HTML project setup, CDN usage, basic integration

setup_react

React project setup, npm installation, component usage

theme_usage

Theme implementation, light/dark modes, customization

testing

Testing guidelines, accessibility testing, best practices

universal_rules

General 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

Author

Built by Julian Oczkowski β€” I build AI tools for knowledge work.

Available Tools

10 tools
find_by_attributeB

Find components that have a specific attribute or property.

Inputs: attribute (required).

get_component_docsB

Get the complete documentation for a specific Modus Web Component including attributes, events, and usage examples.

Inputs: component (required).

get_design_rulesA

Get specific design rules for Modus Web Components (colors, icons, spacing, typography, etc.).

Inputs: category (required).

get_development_rulesB

Get universal development rules and best practices for Modus Web Components.

Inputs: no named parameters.

get_setup_guideC

Get setup instructions for HTML or React projects using Modus Web Components.

Inputs: type (required).

get_theme_usageB

Get theme implementation guidelines and usage instructions.

Inputs: no named parameters.

list_all_componentsA

List all available Modus Web Components with their categories.

Inputs: no named parameters.

list_design_categoriesA

List all available design rule categories.

Inputs: no named parameters.

search_componentsC

Search for Modus Web Components by name or keyword. Returns a list of matching components with brief descriptions.

Inputs: query (required).

search_design_rulesA

Search across all design rules by keyword or term.

Inputs: query (required).

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

Loading tool schema changelog…

    TDQS

    A3.6/5.0

    Scored across 10 tools

    Disambiguation4/5

    Tools are mostly distinct, but find_by_attribute and search_components have overlapping functionality for finding components, which could cause confusion. Descriptions help disambiguate them.

    Naming Consistency5/5

    All tool names follow a consistent snake_case pattern with verb_noun structure (e.g., get_component_docs, list_all_components). The actions are clearly indicated by the initial verb.

    Tool Count5/5

    With 10 tools, the server is well-scoped for a component library documentation and rule set. Each tool serves a clear purpose without being overwhelming.

    Completeness5/5

    The tool surface covers all major aspects of working with Modus Web Components: component discovery, documentation, design rules, development rules, setup, and theme usage. No obvious gaps for a documentation server.

    Maintenance

    ActivityInactive
    ResponsivenessNo recent community issues

    Related MCP Connectors

    Related MCP Servers