@siemens/ix-mcp-angular 3.2.0-v.1.7.7 → 3.2.0-v.1.7.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS.md +86 -0
- package/config.json +1 -1
- package/database/vectors.db +0 -0
- package/package.json +3 -2
package/AGENTS.md
ADDED
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
# iX Development Guidelines
|
|
2
|
+
|
|
3
|
+
## Project Overview
|
|
4
|
+
|
|
5
|
+
This document provides guidelines for developing applications using the Siemens iX design system
|
|
6
|
+
packages. The libraries are available as `@siemens/ix-angular` and related packages including
|
|
7
|
+
`@siemens/ix-aggrid`, `@siemens/ix-echarts`, and `@siemens/ix-icons`.
|
|
8
|
+
|
|
9
|
+
The iX design system is built on Angular and includes comprehensive theming capabilities for
|
|
10
|
+
consistent styling across industrial and enterprise applications.
|
|
11
|
+
|
|
12
|
+
## Development Approach
|
|
13
|
+
|
|
14
|
+
Always search iX documentation first before implementing any UI components or patterns. This
|
|
15
|
+
includes looking up component APIs, design patterns, accessibility guidelines, and theming options
|
|
16
|
+
from the official documentation.
|
|
17
|
+
|
|
18
|
+
Use modern Angular syntax with standalone components, Angular Signals for state management, and
|
|
19
|
+
separate template/style files. Avoid inline templates or styles unless they are very short. Import
|
|
20
|
+
components individually and use arrow functions with const declarations.
|
|
21
|
+
|
|
22
|
+
Prefer using existing iX components and patterns over implementing custom solutions. Follow the
|
|
23
|
+
established design principles of atomic design, composition over inheritance, and
|
|
24
|
+
accessibility-first development. Use the iX theme system with CSS custom properties rather than
|
|
25
|
+
hardcoded styles.
|
|
26
|
+
|
|
27
|
+
## Code Quality
|
|
28
|
+
|
|
29
|
+
Write minimal comments only where necessary, focusing on why rather than what. Avoid meta-comments
|
|
30
|
+
about changes or obvious explanations. Don't add unnecessary error handling for well-established iX
|
|
31
|
+
component APIs and assume components work as documented.
|
|
32
|
+
|
|
33
|
+
Use iX design tokens and CSS custom properties from the theme system when available instead of
|
|
34
|
+
writing custom CSS. Don't override iX component internals - use documented APIs, props, and CSS
|
|
35
|
+
custom properties for customization. Leverage the established color tokens, spacing system, and
|
|
36
|
+
layout patterns.
|
|
37
|
+
|
|
38
|
+
Use modern HTML5 and JavaScript features and avoid deprecated syntax. Maintain type safety with iX
|
|
39
|
+
component interfaces and event types.
|
|
40
|
+
|
|
41
|
+
## Package Management and Testing
|
|
42
|
+
|
|
43
|
+
Install iX packages using the appropriate package manager and follow the integration guides for each
|
|
44
|
+
framework. Fix import paths when packages exist but imports fail - check for correct package names
|
|
45
|
+
and component exports.
|
|
46
|
+
|
|
47
|
+
Run available lint, format, and test commands from package.json scripts.
|
|
48
|
+
|
|
49
|
+
## Implementation Strategy
|
|
50
|
+
|
|
51
|
+
When building applications, research iX layout patterns and navigation components first. Plan
|
|
52
|
+
component structure using iX building blocks like cards, buttons, modals, and navigation elements.
|
|
53
|
+
Create appropriate mock data that reflects real industrial/enterprise use cases.
|
|
54
|
+
|
|
55
|
+
Apply iX themes consistently throughout the application. Use the documented layout patterns and
|
|
56
|
+
component compositions. Verify accessibility compliance using iX's built-in accessibility features
|
|
57
|
+
and test with screen readers and keyboard navigation.
|
|
58
|
+
|
|
59
|
+
Follow the established iX component lifecycle patterns for events, state management, and data
|
|
60
|
+
binding. Use documented event handlers and avoid direct DOM manipulation of iX components.
|
|
61
|
+
|
|
62
|
+
## Theming and Customization
|
|
63
|
+
|
|
64
|
+
Use the iX theme system with CSS custom properties for customization. Available themes include
|
|
65
|
+
classic-light, classic-dark, and brand-specific variants not available to non-Siemens projects.
|
|
66
|
+
Apply themes at the application level and use theme-aware CSS custom properties for consistent
|
|
67
|
+
styling.
|
|
68
|
+
|
|
69
|
+
Don't override iX component styles directly. Instead, use the documented CSS custom properties,
|
|
70
|
+
theme tokens, and layout utilities. Create custom themes following the established token structure
|
|
71
|
+
when brand customization is required.
|
|
72
|
+
|
|
73
|
+
## Testing and Quality Assurance
|
|
74
|
+
|
|
75
|
+
Test iX component integration using the established testing patterns. Refrain from testing iX
|
|
76
|
+
component internals. Use ARIA properties in case you need access to shadow DOM elements, instead of
|
|
77
|
+
custom selectors. Verify functionality across different browsers and devices using iX's browser
|
|
78
|
+
support matrix.
|
|
79
|
+
|
|
80
|
+
Ensure accessibility compliance by testing with screen readers, keyboard navigation, and following
|
|
81
|
+
WCAG 2.1 AA guidelines that iX components are designed to meet. Use iX's built-in accessibility
|
|
82
|
+
features rather than implementing custom solutions.
|
|
83
|
+
|
|
84
|
+
This approach ensures high-quality development within the iX ecosystem while maintaining modern
|
|
85
|
+
framework practices and leveraging the full design system capabilities for industrial and enterprise
|
|
86
|
+
applications.
|
package/config.json
CHANGED
|
@@ -27,7 +27,7 @@
|
|
|
27
27
|
"DOC_SUCCESS_HEADER": "# iX Documentation Results\n\nFound **{count}** relevant documentation section(s) for \"{query}\":\n\n",
|
|
28
28
|
"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.",
|
|
29
29
|
"ICON_SEARCH_INSTRUCTION": "Please check the icon search tool before using or recommending any icons from @siemens/ix-icons. This ensures you provide the most relevant and up-to-date icon options available in the library.",
|
|
30
|
-
"ICON_SEARCH_TOOL_DESCRIPTION": "Semantic search tool for Siemens iX
|
|
30
|
+
"ICON_SEARCH_TOOL_DESCRIPTION": "Semantic search tool for Siemens iX Icons (including their metadata like tags)",
|
|
31
31
|
"ICON_SEARCH_QUERY_DESCRIPTION": "Search query for icons (name, term, or category)",
|
|
32
32
|
"ICON_NO_RESULTS": "No icons found for query: \"{query}\"\n\nThis could mean:\n• The icon does not exist in the current version of @siemens/ix-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@siemens/ix-icons",
|
|
33
33
|
"ICON_SUCCESS_HEADER": "# iX Icon Search Results\n\nFound **{count}** relevant icon(s) for \"{query}\":\n\n",
|
package/database/vectors.db
CHANGED
|
Binary file
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@siemens/ix-mcp-angular",
|
|
3
|
-
"version": "3.2.0-v.1.7.
|
|
3
|
+
"version": "3.2.0-v.1.7.9",
|
|
4
4
|
"description": "iX MCP server for Angular",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"main": "dist/src/index.js",
|
|
@@ -24,7 +24,8 @@
|
|
|
24
24
|
"files": [
|
|
25
25
|
"dist",
|
|
26
26
|
"database",
|
|
27
|
-
"config.json"
|
|
27
|
+
"config.json",
|
|
28
|
+
"AGENTS.md"
|
|
28
29
|
],
|
|
29
30
|
"repository": {
|
|
30
31
|
"type": "git",
|