内容
# @coreui/docs-mcp
一款 [模型上下文协议](https://modelcontextprotocol.io) 服务器，将官方的 **CoreUI 文档**带入您的 AI 编程工具中。询问您的助手如何使用 CoreUI 组件，它会从当前的文档中回答 — 组件、属性、事件、插槽和示例 — 而不是过时的训练数据。
支持 **Bootstrap（原生）、React 和 Vue**。Angular 即将到来。
服务器按需从 `coreui.io` 读取实时文档并在本地缓存，因此它始终反映已部署的文档，无需更新。
## 用法
通过 `npx` 在标准输入/输出上运行 — 无需安装。
```bash
npx @coreui/docs-mcp --framework react
```
### Claude 代码
```bash
claude mcp add coreui-docs -- npx -y @coreui/docs-mcp --framework react
```
### Claude 桌面版 / Cursor / Windsurf / VS Code
将以下内容添加到 MCP 服务器配置（`claude_desktop_config.json`、`.cursor/mcp.json`、`.vscode/mcp.json` 等）：
```json
{
"mcpServers": {
"coreui-docs": {
"command": "npx",
"args": ["-y", "@coreui/docs-mcp", "--framework", "react"]
}
}
}
```
## 配置
| 参数 | 环境变量 | 默认值 | 描述 |
| -------------------- | ------------------------- | --------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| `--framework <列表>` | `COREUI_DOCS_FRAMEWORKS` | `bootstrap,react,vue` | 已启用的版本（逗号分隔）。第一个是工具的默认值。 |
| `--base-url <网址>` | `COREUI_DOCS_BASE_URL` | `https://coreui.io` | CoreUI 站点的来源。`/ <框架> /docs` 路径会自动追加 — 仅在预发布或自行托管的镜像中覆盖。 |
| `--ttl <分钟>` | `COREUI_DOCS_TTL_MINUTES` | `360` | 缓存新鲜度窗口。 |
| — | `COREUI_DOCS_CACHE_DIR` | 操作系统缓存目录 | 磁盘缓存位置。 |
## 工具
| 工具 | 描述 |
| --------------------------- | -------------------------------------------------------------------------------------- |
| `list_components` | 列出框架的文档页面，可选过滤器按章节或子字符串。 |
| `search_docs` | 搜索文档并返回最佳匹配页面及其网址。 |
| `get_doc_page` | 通过 slug、组件名称或网址获取页面的完整 Markdown。 |
| `get_component_api` | 组件的结构化 API（属性/事件/插槽）。适用于 React 和 Vue。 |
| `get_cross_framework_links` | 每个 CoreUI 框架的组件文档网址。 |
## 开发
```bash
yarn install
yarn lint
yarn format
yarn typecheck
yarn test
yarn build
```
## 许可证
[MIT](LICENSE) © [CoreUI](https://coreui.io)
