@mdui/mcp 2.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025-present zdhxiong@gmail.com
+
+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,29 @@
+# @mdui/mcp
+
+An MCP server tailored for mdui. It provides read-only, offline, deterministic tools to discover components, icons, CSS tokens, and documentation. Designed for AI agents and IDEs to query structured data reliably.
+
+## Available tools
+
+- `list_components` — Lists all mdui Web Components (excluding standalone icon elements).
+- `get_component_metadata` — Retrieves detailed API metadata for a component by tag name.
+- `list_css_classes` — Lists all global CSS utility classes with brief descriptions.
+- `list_css_variables` — Lists all global CSS custom properties (design tokens).
+- `list_documents` — Lists all documentation pages.
+- `get_document` — Fetches a documentation page by key or component tag name.
+- `list_icon_codes` — Lists icon codes for a Material Icons variant.
+- `list_icon_components` — Lists standalone icon custom elements and their import statements for a variant.
+
+## Setup
+
+### Claude Desktop / Cursor
+
+```json
+{
+  "mcpServers": {
+    "mdui": {
+      "command": "npx",
+      "args": ["-y", "@mdui/mcp"]
+    }
+  }
+}
+```

package/data/components.d.ts

@@ -0,0 +1,43 @@
+interface ComponentProperty {
+    name: string;
+    attribute: string | null;
+    reflects?: boolean;
+    description: string;
+    type: string;
+    default?: string;
+}
+interface ComponentMethod {
+    name: string;
+    signature: string;
+    description: string;
+}
+interface ComponentEvent {
+    name: string;
+    description: string;
+}
+interface ComponentSlot {
+    name: string;
+    description: string;
+}
+interface ComponentCssPart {
+    name: string;
+    description: string;
+}
+interface ComponentCssProperty {
+    name: string;
+    description: string;
+}
+interface Component {
+    tagName: string;
+    description: string;
+    docUrl: string;
+    usage: string;
+    properties: ComponentProperty[];
+    methods: ComponentMethod[];
+    events: ComponentEvent[];
+    slots: ComponentSlot[];
+    cssParts: ComponentCssPart[];
+    cssProperties: ComponentCssProperty[];
+}
+export declare const components: Component[];
+export {};