Componentsv2.189.0
Iconsv1.19.0
MCPv0.8.61
Tokensv0.34.3

MCP server

Connect AI tools to Pluma docs, component metadata, and migration guidance through the Pluma MCP server.


Pluma MCP Server

Model Context Protocol (MCP) server for accessing Pluma design system components and documentation.

🚀 Quick Start

Running in Cursor

To use this MCP server in Cursor, add the following configuration to your ~/.cursor/mcp.json:

{
  "mcpServers": {
    "pluma": {
      "command": "pnpm",
      "args": ["dlx", "@customerio/pluma-mcp@latest"],
      "env": {
        "GITHUB_TOKEN": "your_github_token_here",
        "NPM_CONFIG_USERCONFIG": "/path/to/your/.npmrc"
      }
    }
  }
}

Environment Variables:

  • GITHUB_TOKEN: Required for accessing private repositories (if applicable)
  • NPM_CONFIG_USERCONFIG: Path to your .npmrc file for package registry authentication

Claude Code

To use this MCP server in Claude Code, add the following to your ~/.claude.json:

"mcpServers": {
  "pluma": {
    "command": "pnpm",
    "args": [
      "dlx",
      "@customerio/pluma-mcp@latest"
    ],
    "env": {
      "GITHUB_TOKEN": "${GITHUB_TOKEN}",
      "NPM_CONFIG_USERCONFIG": "/path/to/your/.npmrc"
    }
  }
}

Environment Variables:

  • GITHUB_TOKEN: Required for accessing private repositories (if applicable)
  • NPM_CONFIG_USERCONFIG: Path to your .npmrc file for package registry authentication

🛠️ Development

Setup

  1. Clone the repository and navigate to the MCP package:

    cd packages/mcp
  2. Install dependencies:

    pnpm install
  3. Build the project:

    pnpm run build

Development Workflow

  1. Build documentation and components:

    pnpm run build:docs    # Build docs from the docs package
    pnpm run build:components  # Generate component data
  2. Full build:

    pnpm run build  # Runs prebuild + TypeScript compilation
  3. Quick development build:

    pnpm run build:fast  # Skip docs/components, just compile TypeScript
  4. Run in development mode:

    pnpm run dev
  5. Type checking:

    pnpm run typecheck

Testing

pnpm test                    # Run tests
pnpm run test:with-build     # Build then test
pnpm run test:with-fast-build # Fast build then test

🔍 Testing with MCP Inspector

The MCP Inspector is a great tool for testing your MCP server during development.

Test Locally Built Server

  1. Build the server:

    pnpm run build
  2. Run the inspector with your local build:

    pnpm dlx @modelcontextprotocol/inspector node dist/index.js

Test Published Package

mcp-inspector pnpm dlx @customerio/pluma-mcp@latest

The inspector will open a web interface where you can:

  • View available tools
  • Test tool calls interactively
  • Inspect server responses
  • Debug any issues