@siemens/element-mcp 48.0.0-v.1.10.0

package/AGENTS.md

@@ -0,0 +1,57 @@
+# Element Development Guidelines
+
+## Project Overview
+
+This document provides guidelines for developing applications using the Siemens Element design
+system packages. The libraries are available under both `@siemens/` and `@simpl/` prefixes (legacy
+and some other non-public packages), including element-ng, charts-ng, maps-ng, dashboards-ng,
+native-charts-ng, and other related packages.
+
+The Element design system includes the element-theme package and comprehensive token system for
+consistent styling and theming across applications.
+
+## Development Approach
+
+Always search Element documentation first before implementing any UI components or patterns. This
+includes looking up UX guidelines, component APIs, helper classes like "card" and "button" which are
+considered components, and design patterns from the official documentation.
+
+Use modern Angular syntax with standalone components, Angular Signals for state management, and
+separate template/style files. Avoid inline templates or styles unless they are very short. Import
+components individually and use arrow functions with const declarations.
+
+Prefer using existing components and patterns over implementing your own. Do not use antipatterns
+such as card-in-card layouts, apply elevation sparingly and correctly. Use mock data to simulate
+real-world scenarios and maintain consistent theming throughout using Element design tokens and
+documented application layouts.
+
+## Code Quality
+
+Write minimal comments only where necessary and avoid meta-comments about changes. Don't add
+unnecessary try-catch blocks or one-line if statements without braces. Fix root causes rather than
+symptoms and assume APIs are available without fallbacks.
+
+Use utility classes from the Element design system when available instead of writing custom CSS.
+Don't override utility classes - create new identifying classes if customization is needed. Leverage
+color token variables and documented layout patterns. Use modern TypeScript features (like arrow
+functions and bind to const instead of function) and avoid deprecated or legacy syntax.
+
+## Package Management and Testing
+
+Install missing packages using appropriate package managers and fix import paths when packages exist
+but imports fail. Run lint, format, and test commands if available in the project, checking
+package.json for available scripts.
+
+Keep documentation changes minimal unless starting or changing an entire project. Focus on
+implementation over excessive documentation and create realistic, cohesive applications using the
+Element ecosystem components and design guidelines.
+
+## Implementation Strategy
+
+When building applications, research relevant layouts and navigation patterns first. Plan component
+structure with standalone imports, create appropriate mock data, and apply Element design tokens
+consistently. Use documented Element components and verify functionality through available testing
+suites.
+
+This approach ensures high-quality development within the Element ecosystem while maintaining modern
+Angular best practices and leveraging the full design system capabilities.

package/LICENSE.md

@@ -0,0 +1,20 @@
+The MIT License
+
+Copyright (c) Siemens 2016 - 2025
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the “Software”), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,391 @@
+# Siemens MCP Server for Element
+
+A Model Context Protocol (MCP) server that provides AI assistants (Agents) with access to
+[Siemens Element](https://element.siemens.io) design system and component API documentation through
+Retrieval-Augmented Generation (RAG). This enables more accurate and relevant assistance with design
+system and component library APIs.
+
+## Usage and use cases
+
+- Local MCP server installation includes all design system documentation, component APIs, examples
+  and icon information
+- MCP server integration with your AI Agent setup of choice, integrated into your IDE (for example,
+  GitHub Copilot Agent integration within VS Code, or OpenCode, with project-related MCP
+  configuration)
+- Use cases include (but are not limited to):
+  - Get design system best practice information
+  - Export components
+  - Review project text according to UX writing guidelines
+  - Generate new pages using design system components
+  - Add and modify pages
+
+## Installation
+
+### Prerequisites
+
+- Node.js (20+ recommended)
+- Access to the API [https://api.siemens.com/llm](https://api.siemens.com) by creating a free token
+  at <https://my.siemens.com> with `llm` scope. We use the `embeddings` API. Siemens access is
+  required to request a token. We are working on a configurable alternative.
+- IDE/Agent/LLM setup of your choice (for example: VS Code, GitHub Copilot, Claude Sonnet 4.5)
+
+### Version selection
+
+We distribute a MCP server package `@siemens/element-mcp` for every `@siemens/element-ng` version.
+The version of `@siemens/element-mcp` must match your version of `@siemens/element-ng`. The version
+number of the MCP package `@siemens/element-mcp` is a combination of the `@siemens/element-ng`
+version and the version of the MCP code.
+
+For example, `@siemens/element-mcp@48.2.0-v.1.4.8` comes with the data of
+`@siemens/element-ng@48.2.0` and `v.1.4.8` is the version of the MCP script.
+
+To facilitate the version selection, we use
+[npm distribution tags](https://docs.npmjs.com/cli/commands/npm-dist-tag) `@element<version>` that
+match the version of `@siemens/element-ng`. When using the corresponding distribution tag on
+installation, you get the latest version of the MCP package that matches your `@siemens/element-ng`
+version and simplifies handling in your `package.json`.
+
+```json
+"dependencies": {
+    "@siemens/element-ng": "48.2.0",
+  },
+  "devDependencies": {
+    "@siemens/element-mcp": "48.2.0-v.1.4.8",
+  }
+```
+
+New MCP package versions on the same `element-ng` version are incremented like `48.2.0-v.1.4.9`,
+`48.2.0-v.1.4.10`, `48.2.0-v.1.5.0`.
+
+### Project installation
+
+```bash
+npm install --save-dev --save-exact @siemens/element-mcp@element48.2.0
+
+# Or with yarn
+yarn add -D --exact @siemens/element-mcp@element48.2.0
+```
+
+### Global installation
+
+```bash
+npm install -g @siemens/element-mcp@element48.2.0
+```
+
+### Upgrading
+
+Simply install the tag for your version and framework again:
+
+```bash
+# in project
+npm install --save-dev --save-exact @siemens/element-mcp@element48.3.0
+
+# with yarn
+yarn add -D --exact @siemens/element-mcp@element48.3.0
+
+# global
+npm install -g --save-exact @siemens/element-mcp@element48.3.0
+```
+
+## Quick Start
+
+After local project or global package installation, you need to initialize the MCP server and
+provide the access token.
+
+1. **Navigate to your project directory**:
+
+   ```bash
+   cd your-project
+   ```
+
+2. **Run initial setup**:
+
+   ```bash
+   npx @siemens/element-mcp init
+   ```
+
+   Or if token is already set up:
+
+   ```bash
+   npx @siemens/element-mcp setup
+   ```
+
+   > Important: Run this command in the root of every project where you want to use the MCP server.
+
+3. **Follow the prompts**:
+   - Enter your LLM token from https://my.siemens.com/ (requires 'llm' scope)
+   - This token is needed to generate embeddings for semantic search of the documentation. The
+     embeddings help find relevant documentation chunks, but the actual LLM (language model) that
+     processes your queries and generates responses is provided separately by your AI tool (e.g.,
+     GitHub Copilot, Claude, etc.)
+   - Choose which tools to configure (VS Code, Cline, Zed, etc.)
+   - Optionally set up Element instruction files for AI agents
+   - The tool will create MCP configuration files based on your selection, commit the local
+     configuration to share it (make sure it is not ignored by `.gitignore`)
+
+4. **Restart your AI tools** (VS Code, Cline, Zed, etc.)
+   - Ensure the server is running and trust the MCP server, e.g. click the "Server" icon in the
+     Github Copilot Chat panel in VS Code.
+   - **For GitHub Copilot in VS Code**: Make sure you are in Agent Mode (not Chat Mode). Use models
+     like **Claude Sonnet 4.5**.
+
+5. **Start prompting**:
+   - "How do I use the Filtered-Search component from @siemens/element-ng?"
+   - "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"
+
+> The MCP server starts automatically when your AI tools need it.
+
+## Setup Options
+
+During `init` or `setup`, select which configuration(s) to create:
+
+- **Local VS Code / GitHub Copilot (Repository)** creates a VS Code MCP configuration file at
+  `.vscode/mcp.json` in the current repository
+- **OpenCode (Repository)** creates `opencode.json` in the current repository for OpenCode AI
+- **OpenCode Global Settings** updates global OpenCode configuration
+  (`~/.config/opencode/opencode.json`)
+- **Cline Global Settings** updates global Cline MCP configuration
+- **VS Code / GitHub Copilot Global Config** writes user-level MCP config
+- **Zed Global Settings** configures Zed editor / agent MCP
+
+## AI Agent Instructions (optional)
+
+After MCP configuration, you can set up Element and Angular instruction files so AI agents work more
+effectively with your codebase. Do this in each repository where you want instructions.
+
+You have two options:
+
+- **Symbolic link to receive updates**  
+  Keeps files synced with the installed package. Requires the package to remain installed and may
+  not work on all systems or package managers. The tool can create symlinks automatically;
+  otherwise, create links yourself pointing to the installed package's `AGENTS.md` and Element
+  instructions.
+
+- **Copy the content** Copy the contents of the package’s `AGENTS.md` into one of the following in
+  your repo:
+  - `.github/instructions/Element.instructions.md`
+  - `AGENTS.md`
+  - `.github/copilot-instructions.md`
+
+If you prefer manual copy, open the package’s `AGENTS.md`, then paste it into your chosen file and
+commit it. Repeat per repository whenever you want to update the instructions.
+
+## Logging
+
+Per default no logging is performed, but you can enable local-only logging of all search queries and
+retrieval results during setup.
+
+### Manually enabling logging
+
+In your MCP configuration add the flag `--log` to log all search queries and retrieval results to
+local log files in `~/.element-mcp`.
+
+```json
+{
+  "servers": {
+    "@siemens/element-mcp": {
+      "type": "stdio",
+      "command": "npx",
+      "args": ["@siemens/element-mcp", "--log"]
+    }
+  }
+}
+```
+
+### Viewing and sharing logs
+
+To view logs, use the `npx @siemens/element-mcp log` command, select any relevant session and look
+at the output or the files copied to your current working directory.
+
+For feedback about the MCP and Agent results, please create an issue at
+[https://code.siemens.com/ux/sdl-mcp/issues](https://code.siemens.com/ux/sdl-mcp/issues), share your
+information, and include the relevant logs.
+
+## Usage
+
+### Commands
+
+#### Init (First-time setup)
+
+Complete initial setup: configure token and create all MCP configurations.
+
+```bash
+npx @siemens/element-mcp init
+```
+
+#### Setup (Update configurations)
+
+Create or update MCP configuration files for your tools (uses existing token).
+
+```bash
+npx @siemens/element-mcp setup
+```
+
+#### Setup Token
+
+Set or update only the LLM token in system keychain.
+
+```bash
+npx @siemens/element-mcp setup-token
+```
+
+#### Check
+
+Verify your installation and configuration.
+
+```bash
+npx @siemens/element-mcp check
+```
+
+#### Test
+
+Test the MCP server with a sample query.
+
+```bash
+npx @siemens/element-mcp test
+```
+
+#### Log
+
+Check your previous MCP retrieval logs (if enabled / not disabled).
+
+```bash
+npx @siemens/element-mcp log
+```
+
+### Use within WSL (Windows Subsystem for Linux)
+
+If you're using WSL, you need to configure the LLM token using environment variables instead of the
+system keychain. Before running any commands, add the following to a `.env` file in the project root
+(if you're using project installation):
+
+```
+SDL_MCP_TOKEN_ENV=true
+OPENAI_API_KEY=<your-key-here>
+```
+
+Make sure the `.env` file is in your `.gitignore` and can't be committed.
+
+Alternatively, or if you're using global installation, add these to your shell profile
+(`~/.zprofile` or `~/.bash_profile`):
+
+```bash
+export SDL_MCP_TOKEN_ENV=true
+export OPENAI_API_KEY=<your-key-here>
+```
+
+### Connection Issues
+
+- Verify that the MCP server is running (it should start automatically)
+- Restart your AI tool after configuration changes
+- Verify your LLM token is valid at https://my.siemens.com/
+
+## Manual Configuration
+
+If you prefer to set up the configurations manually, here are the required files and their contents.
+
+### VS Code (.vscode/mcp.json or User/mcp.json)
+
+```json
+{
+  "servers": {
+    "@siemens/element-mcp": {
+      "type": "stdio",
+      "command": "npx",
+      "args": ["@siemens/element-mcp"]
+    }
+  }
+}
+```
+
+### Cline (Global Cline MCP settings)
+
+```json
+{
+  "mcpServers": {
+    "@siemens/element-mcp": {
+      "command": "npx",
+      "args": ["@siemens/element-mcp"]
+    }
+  }
+}
+```
+
+### Zed (Global Zed settings)
+
+```json
+{
+  "context_servers": {
+    "@siemens/element-mcp": {
+      "source": "custom",
+      "command": "<path-to-npx, run which/where npx to find>",
+      "args": ["@siemens/element-mcp"],
+      "env": {}
+    }
+  }
+}
+```
+
+### OpenCode (Local or Global)
+
+For repository-level configuration, create `opencode.json` in your project root:
+
+```json
+{
+  "$schema": "https://opencode.ai/config.json",
+  "mcp": {
+    "element-mcp": {
+      "type": "local",
+      "command": ["npx", "-y", "@siemens/element-mcp"],
+      "enabled": true
+    }
+  },
+  "instructions": ["Element.instructions.md"]
+}
+```
+
+For global configuration, edit `~/.config/opencode/opencode.json`:
+
+```json
+{
+  "$schema": "https://opencode.ai/config.json",
+  "mcp": {
+    "element-mcp": {
+      "type": "local",
+      "command": ["npx", "-y", "@siemens/element-mcp"],
+      "enabled": true
+    }
+  }
+}
+```
+
+Learn more about OpenCode configuration at
+[https://opencode.ai/docs/config](https://opencode.ai/docs/config).
+
+## License
+
+The following applies for code and documentation of the git repository, unless explicitly mentioned.
+
+Copyright (c) Siemens 2016 - 2025
+
+MIT, see [LICENSE.md](LICENSE.md).
+
+### Open Source Software
+
+The software of this distributed MCP npm package consists of the database file and JavaScript files,
+which provide access to the database, implementing the Model Context Protocol. This package does not
+include any third party software. However, to use this software, you need the Open Source Software
+packages specified in the `dependencies` part of the [package.json](package.json) file, and their
+dependencies. When installing this package with a npm package manager, the dependencies are
+automatically installed (e.g., when using npm).
+
+## Support
+
+For issues and questions, please use the issue tracker at:
+[https://code.siemens.com/ux/sdl-mcp/issues](https://code.siemens.com/ux/sdl-mcp/issues)
+
+For suboptimal retrievals / agent behavior, consider attaching a relevant log to help us figure out
+how to improve the service, see [Viewing and sharing logs](#viewing-and-sharing-logs).

package/config.json

@@ -0,0 +1,36 @@
+{
+  "name": "@siemens/element-mcp",
+  "description": "Element MCP server",
+  "displayName": "Element",
+  "binName": "element-mcp",
+  "compatTokenName": "simpl-mcp",
+  "documentedName": "Element",
+  "projectName": "Element",
+  "searchToolName": "element-search",
+  "iconSearch": true,
+  "iconSearchToolName": "element-icon-search",
+  "iconName": "@simpl/element-icons",
+  "agentsFile": true,
+  "instructionFileName": "Element.instructions.md",
+  "observabilityLogging": false,
+  "exampleQuestions": [
+    "How do I use the Filtered-Search component from @siemens/element-ng?",
+    "Show me examples of @siemens/charts-ng usage",
+    "Implement a dashboard with different widgets",
+    "Find icons related to AI or machine learning"
+  ],
+  "texts": {
+    "DOC_SEARCH_INSTRUCTION": "MANDATORY: For ANY Angular development question, UI component inquiry, design pattern request, or frontend implementation need, you MUST immediately use the search tool before providing any response relevant to UI / Design Systems or Angular implementations. Re-check it to get clarifications and more accurate API often, but do not search if completely unrelated or you just searched the exact same. This applies to ALL Angular-related queries regardless of whether (SiMPL) Element libraries are explicitly mentioned. The tool provides access to version-specific Siemens (SiMPL) Element documentation that is automatically tuned to match the user's library versions. This ensures you get the exact APIs, components, and implementation patterns available in their specific setup rather than generic Angular advice. Always search first to leverage the comprehensive @siemens/element-ng, @siemens/maps-ng, @siemens/charts-ng, @siemens/dashboards-ng, @siemens/native-charts-ng, @siemens/element-theme, and @siemens/element-translate-ng documentation before offering any Angular guidance.",
+    "DOC_SEARCH_TOOL_DESCRIPTION": "Semantic search tool for Siemens (SiMPL) Element Design System and Angular component libraries. This tool provides intelligent search across comprehensive documentation for:\n\nSupported Libraries:\n• @siemens/element-ng - Core UI components (buttons, inputs, modals, etc.)\n• @siemens/maps-ng - Interactive mapping components\n• @siemens/charts-ng - Data visualization charts\n• @siemens/dashboards-ng - Dashboard layout components\n• @siemens/native-charts-ng - Native charting solutions\n• @siemens/element-theme - (S)CSS theme and utility classes similar to bootstrap\n• @siemens/element-translate-ng - Translation abstraction layer\n\nUse Cases:\n• Find component APIs and properties\n• Discover usage examples and code snippets\n• Learn about component styling and theming\n• Understand integration patterns\n• Explore design system guidelines\n\nSearch Tips:\n• Use component names: \"button\", \"chart\", \"map\"\n• Describe functionality: \"data visualization\", \"user input\"\n• Ask about APIs: \"input\", \"output\", \"attributes\", \"methods\", \"type\"\n\nThe search returns relevant documentation chunks with similarity scores and contextual headers to help you find exactly what you need.",
+    "DOC_SEARCH_QUERY_DESCRIPTION": "Search query for (SiMPL) Element documentation. Can include component names, functionality descriptions, API questions, or usage patterns. Examples: \"button component\", \"chart configuration\", \"map markers\", \"dashboard layout\"",
+    "DOC_NO_RESULTS": "No Documentation Found\n\nNo results found for query: \"{query}\"\n\nThis could mean:\n• The component or feature doesn't exist in the current documentation\n• The feature isn't documented yet\n• The search terms don't match available content\n• Try different keywords or component names\n\nSuggestions:\n• Check component name spelling (e.g., \"button\" vs \"btn\")\n• Try broader terms (e.g., \"input\" instead of \"text-field\")\n• Search for library names: \"@siemens/element-ng, @siemens/charts-ng, @siemens/maps-ng, @siemens/dashboards-ng, @siemens/native-charts-ng, @siemens/element-theme, and @siemens/element-translate-ng\"\n• Use functionality terms: \"navigation\", \"data display\", \"user input\"\n\nAvailable Libraries:\n• @siemens/element-ng - Core UI components (buttons, inputs, modals, etc.)\n• @siemens/maps-ng - Interactive mapping components\n• @siemens/charts-ng - Data visualization charts\n• @siemens/dashboards-ng - Dashboard layout components\n• @siemens/native-charts-ng - Native charting solutions\n• @siemens/element-theme - (S)CSS theme and utility classes similar to bootstrap\n• @siemens/element-translate-ng - Translation abstraction layer",
+    "DOC_SUCCESS_HEADER": "# Element Angular Documentation Results\n\nFound **{count}** relevant documentation section(s) for \"{query}\":\n\n",
+    "DOC_RESULT_NOTE": "> Note: If documentation mentions missing API docs or examples, those features may not be available in the current version. The search results show the most relevant available documentation based on semantic similarity.\n\n> Need more specific results? Try refining your search with more specific terms or component names.\n\n> Not all information provided here is relevant to your query or task, make sure to only use what is relevant for the user request.",
+    "ICON_SEARCH_INSTRUCTION": "Please check the icon search tool before using or recommending any icons from @simpl/element-icons. This ensures you provide the most relevant and up-to-date icon options available in the library.",
+    "ICON_SEARCH_TOOL_DESCRIPTION": "Semantic search tool for Siemens (SiMPL) Element Icons (including their metadata like tags)",
+    "ICON_SEARCH_QUERY_DESCRIPTION": "Search query for icons (name, term, or category)",
+    "ICON_NO_RESULTS": "No icons found for query: \"{query}\"\n\nThis could mean:\n• The icon does not exist in the current version of @simpl/element-icons\n• The icon was renamed or removed\n• The search terms don't match available icons\n\nSuggestions:\n• Check spelling or try broader terms (e.g., \"settings\" instead of \"gear\")\n\nAvailable Libraries:\n@simpl/element-icons",
+    "ICON_SUCCESS_HEADER": "# Element Icon Search Results\n\nFound **{count}** relevant icon(s) for \"{query}\":\n\n",
+    "ICON_RESULT_NOTE": "> Note: If the icon does not appear to exist, update @simpl/element-icons to the latest compatible version (non-breaking).\n> See usage guidelines and examples in the documentation for how to use icons."
+  }
+}

package/dist/src/cli.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=cli.d.ts.map

package/dist/src/cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../../../src/mcp/cli.ts"],"names":[],"mappings":""}