@ui-layouts/mcp 为 AI 助手提供了多种有价值的工具，帮助他们搜索、理解和检索 UI 组件从 ui-layouts.com 中获取。

每个工具都可以独立使用，但它们被设计成一个完整的“组件探索流程”。

📦 安装与MCP设置

要求

• Node.js： >=20.10.0
• MCP 客户端： Claude 桌面、光标或兼容 MCP 客户端

快速开始

使用npx运行@ui-layouts/mcp，无需全局安装。以下是推荐的入门方式：

💡 注意： npx 在需要时会自动下载并运行最新版本的 @ui-layouts/mcp。无需全局安装！

使用 Claude Code （CLI）

这会以 CLI-safe 名称 ui-layouts-mcp 注册 MCP 服务器，同时仍使用 @ui-layouts/mcp npm 包。

---

🛠️ 工具

🔍 search_components

通过组件名称、键、组、标签或 href 搜索 ui-layouts.com 组件注册表。 它进行智能匹配，寻找符合你条件的组件，并返回每个匹配的详细信息。

当它有用时

@ui-layouts/mcp

@ui-layouts/mcp provides AI assistants with several valuable tools to help them search, understand, and retrieve UI components from ui-layouts.com.

Each tool can be used independently, but they are designed to work together as a complete “component exploration pipeline.”

📦 Installation & MCP Setup

Requirements

• Node.js: >=20.10.0
• MCP Client: Claude Desktop, Cursor, or compatible MCP client

Quick Start

Run @ui-layouts/mcp without installing it globally using npx. This is the recommended way to get started:

{
  "mcpServers": {
    "ui-layouts-mcp": {
      "type": "stdio",
      "command": "npx",
      "args": ["@ui-layouts/mcp"]
    }
  }
}

💡 Note: npx will automatically download and run the latest version of @ui-layouts/mcp when needed. No global installation required!

Using with Claude Code (CLI)

claude mcp add ui-layouts-mcp --scope user -- npx -y @ui-layouts/mcp

This registers the MCP server under the CLI-safe name ui-layouts-mcp while still using the @ui-layouts/mcp npm package.

---

🛠️ Tools

🔍 search_components

Search through the ui-layouts.com component registry by component name, key, group, tags, or href. It performs intelligent matching to find components that meet your criteria and returns detailed information about each match.

When it’s useful

• To find a specific UI component by name or tag
• To explore available components by category
• To discover components with particular design or functional features

---

📘 get_docs

Fetch the complete documentation for a component from ui-layouts.com. You can choose how much content to return, including:

• raw_html — the original HTML of the documentation page
• text — plain text extracted from HTML
• snippet — the main section (e.g. or content only)

When it’s useful

• To read implementation guides and examples
• To view a component’s structure, props, or variants
• To extract technical explanations for AI-assisted reasoning or integration

---

🧩 get_component_meta

Fetch structured HTML metadata for a specific component from ui-layouts.com. It includes fields such as title, description, keywords, Open Graph, Twitter card, and even custom metadata like component-names and available-components.

When it’s useful

• To understand a component’s intent or SEO context
• To generate previews or summaries automatically
• To retrieve linked componentNames for source code lookup

---

💾 get_source_code