The chat responses are generated using Generative AI technology for intuitive search and may not be entirely accurate. They are not intended as professional advice. For full details, including our use rights, privacy practices and potential export control restrictions, please refer to our Generative AI Service Terms of Use and Generative AI Service Privacy Information. As this is a test version, please let us know if something irritating comes up. Like you get recommended a chocolate fudge ice cream instead of an energy managing application. If that occurs, please use the feedback button in our contact form!
Skip to content

Siemens iX MCP Server

The Siemens iX MCP server provides AI assistants and agents with access to the Siemens Industrial Experience (iX) design system and component API documentation through Retrieval-Augmented Generation (RAG). This enables more accurate and relevant assistance when building applications with iX components across Angular, React, Vue, and Web Components.

Siemens iX

Overview

  • Local MCP server that ships with all iX design system documentation, component APIs, examples, and icon information
  • Integrates with your IDE and AI agent setup (VS Code / GitHub Copilot, Cline, Zed, and others)
  • Packages available for all supported iX technology stacks
  • Use cases include:
    • Get design system best practice information
    • Generate or modify pages using iX components
    • Export components to your project
    • Review project text according to UX writing guidelines
    • Find icons related to a topic

Prerequisites

  • Node.js 20+
  • An LLM token from my.siemens.com with the llm scope (used for embedding generation)
  • An IDE or agent setup of your choice (VS Code with GitHub Copilot, Cline, Zed, etc.)

Installation

The MCP package version must match your @siemens/ix version. Choose the package for your technology stack and use the distribution tag @ix<version> to always get the latest compatible MCP package.

Your packageMCP package
@siemens/ix@siemens/ix-mcp
@siemens/ix-angular@siemens/ix-mcp-angular
@siemens/ix-react@siemens/ix-mcp-react
@siemens/ix-vue@siemens/ix-mcp-vue

Project installation

npm install --save-dev --save-exact @siemens/ix-mcp@ix4.0.0

# Or with yarn
yarn add -D --exact @siemens/ix-mcp@ix4.0.0

Global installation

npm install -g @siemens/ix-mcp@ix4.0.0

Quick Start

  1. Navigate to your project directory and run the initial setup:

    npx @siemens/ix-mcp init
    

    If your token is already configured, use:

    npx @siemens/ix-mcp setup
    

    Note

    Run this command in the root of every project where you want to use the MCP server.

  2. Follow the prompts to enter your LLM token and choose which tools to configure.

  3. Restart your AI tool and start prompting:

    • "How do I use the search component from @siemens/ix?"
    • "Show me examples of @siemens/charts-ng usage"
    • "Implement a dashboard with different widgets"
    • "Find icons related to AI or machine learning"
    • "Review the texts of this project"

Further Reading