# @aleph-alpha/lib-mcp 中文文档

规范地址：https://npmcn.com/package/%40aleph-alpha/lib-mcp/

版本：5\.4\.0
npm 元数据更新时间：2026-10-28T11:38:16.017Z
中文译文更新时间：2026-11-05T21:58:39.945Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40aleph-alpha/lib-mcp
原文对照：https://npmcn.com/package/%40aleph-alpha/lib-mcp/?lang=original
项目主页：https://docs.aleph-alpha.com/

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：1.7 MB，9 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.13\.0
- 运行依赖：2 个
- peer 依赖：@aleph-alpha/chat-kit ~5\.4\.0，@aleph-alpha/ui-library ~5\.3\.0
- 首次发布：2026-02-03T10:41:46.052Z
- 最新版本发布：2026-10-06T13:45:21.471Z
- 近 30 天下载量：14549（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：21（近 12 个月 21 个）

## 中文简介

用于UI库和ChatKit组件发现工具的MCP服务器.

## 安装

```sh
npm install @aleph-alpha/lib-mcp
```

也可以使用：`pnpm add @aleph-alpha/lib-mcp`、`yarn add @aleph-alpha/lib-mcp`、`bun add @aleph-alpha/lib-mcp`

## README

# @aleph-alpha/lib-mcp (英语)

MCP(模式上下文协议)服务器,用于UI库和ChatKit组件发现工具.

## 概览

这个软件包提供了一个MCP服务器,可以让AI助手(如克洛德和Cursor)从中发现并理解组件:

-   [`@aleph-alpha/ui-library`](https://npmcn.com/package/%40aleph-alpha/ui-library) —— 说 `Ui*` 组件
-   [`@aleph-alpha/chat-kit`](https://npmcn.com/package/%40aleph-alpha/chat-kit) —— 说 `Ck*` 组件

它提供了列出现有部件和检索详细文件的工具,包括道具、示例和使用指南.

## 安装

安装 `@aleph-alpha/lib-mcp` 与您想要查询其文件的组件包一起。 需要UI 库; ChatKit 是可选的, 只有在您想要时才需要 `Ck*` 组件文件.

```bash
# UI Library only
pnpm add @aleph-alpha/lib-mcp @aleph-alpha/ui-library

# UI Library + ChatKit
pnpm add @aleph-alpha/lib-mcp @aleph-alpha/ui-library @aleph-alpha/chat-kit
```

> ChatKit 文档需要 `@aleph-alpha/chat-kit` 出版《公约》 `src/` 目录( 组件) `types.ts` 财务报告和审定财务报表 `*.stories.ts` 文档). 若为 `get_chat_kit_docs` 返回“找不到 talk- kit 源目录”,升级 `@aleph-alpha/chat-kit` 改为包含 `src/` 在其公布的文件中.

## 使用量

### 配置 MCP 服务器

运行安装命令以配置您的 IDE :

```bash
# For Claude Code
npx @aleph-alpha/lib-mcp mcp-install

# For both Claude Code and Cursor
npx @aleph-alpha/lib-mcp mcp-install --cursor

# For VS Code
npx @aleph-alpha/lib-mcp mcp-install --vscode
```

安装后, 请重新启动您的 IDE 以激活 MCP 工具 .

### 可用的 MCP 工具

配置后, 您的 AI 助手可使用以下工具 :

#### UI 库工具

##### `list_components`

列出所有可用的 UI 库组件 。 支持按名称、类别或描述进行可选过滤.

```
list_components
list_components --filter="button"
list_components --filter="form"
```

##### `get_component_docs`

为特定UI图书馆部分检索全部文件,包括:

-   构成部分说明
-   带有类型、默认和描述的道具
-   次级构成部分(如适用)
-   使用指南
-   代码示例

```
get_component_docs UiButton
get_component_docs Button  # "Ui" prefix is optional
```

#### ChatKit 工具

可用时间 `@aleph-alpha/chat-kit` 在此软件包旁边安装.

##### `list_chat_kit_components`

列出所有可用的 ChatKit (`Ck*`) 组件。 支持按名称、类别或描述进行可选过滤.

```
list_chat_kit_components
list_chat_kit_components --filter="history"
list_chat_kit_components --filter="message"
```

##### `get_chat_kit_docs`

为特定的 ChatKit 组件获取完整的文档,其形状与 `get_component_docs`数字 :

-   构成部分说明
-   带有类型、默认和描述的道具
-   次级构成部分(如适用)
-   使用指南
-   代码示例

```
get_chat_kit_docs CkHistory
get_chat_kit_docs History  # "Ck" prefix is optional
```

#### 设置工具

##### `get_setup_guide`

返回将 UI 库整合到项目中的设置和安装指南(UnoCSS config,Vite config,需要依赖,以及MCP设置指令).

```
get_setup_guide
```

## 发展

### 大楼

```bash
pnpm build
```

### 生成组件元数据

重现 `components-meta.json` (UI图书馆)和 `chat-kit-components-meta.json` (ChatKit)通过扫描每个软件包的源文件.

```bash
pnpm generate:component-meta
```

### 测试

```bash
pnpm test
```

## 如何运作

MCP服务器从每个软件包的源版式读取组件元数据:

1.  **`types.ts`**: 提取道具、其类型、说明和组件级JSDoc标签(`@category`, (中文(简体) ), `@useCases`, (中文(简体) ), `@keywords`, (中文(简体) ), `@related`(中文(简体) )
2.  **`*.stories.ts`**: 从故事书故事中摘录代码示例和使用指导
3.  **`index.ts`**: 检测文件所列部件的子部件出口
4.  **`components-meta.json` 编号 : `chat-kit-components-meta.json`**: 用于更快查找的预生成元数据

UI 库组件读取自 `@aleph-alpha/ui-library/src/**`,以及来自 `@aleph-alpha/chat-kit/src/components/**`。两个软件包必须发布 `src/` 用于文档的目录,用于在从 `node_modules`。 。 。 .

## CLI 命令

| 命令 | 说明 |
| --- | --- |
| `mcp-install` | 为 IDE 配置 MCP 服务器 (S)`--cursor`, (中文(简体) ), `--vscode` 添加额外的IDE) |
| `serve` | 启动 MCP 服务器( 由 IDE 内部使用) |
| `--help` | 显示帮助消息 |

## 许可证

阿帕奇 - 2.0

## 常见问题

### @aleph-alpha/lib-mcp 是什么？

用于UI库和ChatKit组件发现工具的MCP服务器\.

### 如何安装 @aleph-alpha/lib-mcp？

在项目目录运行 npm install @aleph-alpha/lib-mcp，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@aleph-alpha/chat-kit（~5\.4\.0）、@aleph-alpha/ui-library（~5\.3\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。它还提供命令行工具 ui-library-mcp，可以用 npx ui-library-mcp 直接运行。

### @aleph-alpha/lib-mcp 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @aleph-alpha/lib-mcp 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @aleph-alpha/lib-mcp 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=22\.13\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @aleph-alpha/lib-mcp 可以商用吗？

@aleph-alpha/lib-mcp 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @aleph-alpha/lib-mcp 的下载量有多少？

根据 npm 官方下载统计，@aleph-alpha/lib-mcp 在 2026/10/06 – 2026/11/04 这 30 天内被下载 14,549 次，日均约 485 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @aleph-alpha/lib-mcp 还在维护吗？

最新版本 5\.4\.0 发布于 2026/10/06（1 个月前）；至今共发布 21 个版本，其中过去 12 个月发布了 21 个；首次发布于 2026/02/03。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。