文档查询 MCP ​

@asam-ui/mcp 是独立 stdio 文档服务,提供组件目录、公开 API、完整 TS/JS SFC 和接入指南。 不需要克隆私有主仓、启动 Storybook 或访问内网。MCP 与 Skill 可分别使用。

@asam-ui/mcp@1.0.0 固定版本配置如下。 使用下面的固定版本配置,通过 pnpm dlx 启动,无须下载本地 tarball。

最小配置 ​

Node.js >=22.19.0。在 Codex 的 ~/.codex/config.toml 或项目 .codex/config.toml 添加:

toml
[mcp_servers.asam_ui]
command = "pnpm"
args = ["dlx", "@asam-ui/mcp@1.0.0"]
startup_timeout_sec = 60

重新加载宿主后查看 ASAM 的四个文档工具。Windows 找不到 pnpm 时改为 pnpm.cmd。 配置格式见 Codex MCP 文档。

其他宿主:VS Code

在项目 .vscode/mcp.json 添加:

json
{
	"servers": {
		"asam-ui": {
			"type": "stdio",
			"command": "pnpm",
			"args": ["dlx", "@asam-ui/mcp@1.0.0"]
		}
	}
}

在 VS Code MCP 服务列表启动并信任服务。Windows 找不到 pnpm 时使用 pnpm.cmd。 其他宿主按自己的格式使用相同 command/args;VS Code 的 servers 与一些宿主的 mcpServers 格式不同。VS Code 配置说明。

验证一次查询 ​

让 Agent:“用 ASAM 文档工具查 AsamButton 的 size 类型,再取 basic 的 TS 示例, 确认返回组件版本 1.0.0”。工具顺序:

  1. list_components:查询 Button,得到精确公开名称。
  2. get_component_api:component 为 AsamButton、section 为 props、member 为 size。
  3. get_component_example:component 为 AsamButton、demo 为 basic、language 为 ts。

返回组件版本、文档 sourceSha 和快照哈希;API 与示例应同源。 API 支持分页;示例不传 demo 时列出可用示例,选择后返回完整文件及适用许可。 get_guide 提供 installation、provider、theme、skill。

配对与更新 ​

当前 MCP 配对组件 1.0.0。产品来源 95d210547399a367f54d2e4a8cb14592900a9b7b,官网资料来源 1be15fe9f6716d9e813ce33d3541b9129eeb21fe。MCP 包来源 ad747a7d4931075dd187eef64a3851ebb184c5d2。

包内固定压缩快照 SHA256:c6a1862c0455a2429371f186b289a2d27918899ce9ba810c2d27cbe98c5174e8;manifest SHA256:19f704f934b65b5bca85a564886eb0b827f06045e18b84207ad3270524812675。运行时读取包内固定资料,不追随网站最新内容。MCP 与组件包可独立版本发布,以本页配对信息和安装包类型为准。

指南快照 SHA256:b56a66c9e2ffd1e6deda1d4b09b32bf3e20bdfc1e6725dde138c8585663b1262;输入快照 SHA256:767faeef297abd04fc686850d4a61da5218a08f948c5b15dad7d83fb1d0f49df。

公开输入与 SHA256

更新时安装新的固定 MCP 版本;工具参数 version 与其资料不符会明确报错。

未知组件、示例、版本或非法参数返回错误。资料缺失/损坏时启动失败,诊断写 stderr。 没有 MCP 时直接读 组件资料 与安装包声明即可。

资料来源、离线使用与宿主验证范围

常规接入使用本页固定 npm 版本,tarball 仅用于离线消费与维护。 服务只查询公开资料,不提供业务数据、消费源码读取或代码写入工具。

安装后按本页步骤查询并核对返回的组件版本、来源与快照哈希;宿主配置不等于实际查询已通过。返回的数据仍需结合消费项目的类型检查、构建和真实渲染结果使用。

本 MCP 使用完整许可与自有资料/SFC 使用附录。 第三方内容及原组件包仍保留各自许可。

搜索文档

Tab 选择结果 Enter 打开 Esc 关闭