hui-docs-mcp
v1.0.2
Published
HUI文档搜索MCP服务
Readme
HUI 组件库的 MCP 服务
HUI MCP 服务提供了一套完整的 HUI 组件库文档查询接口,可以通过 MCP 协议获取组件文档、版本信息和更新记录。
功能特性
- 获取组件列表(基础组件和扩展组件)
- 查询基础组件文档
- 查询扩展组件文档
- 获取组件版本信息
- 查看版本发布更新记录
安装
npm install
npm run build使用方法
启动服务
npm start可用工具
get-component-list- 功能:获取 HUI 组件列表,包含基础组件与扩展组件
- 参数:无
- 返回:组件列表,包含组件名称、描述和文档链接
get-base-component- 功能:获取 HUI 基础组件文档
- 参数:
- componentName: 组件名称(必填)
- version: 组件版本(可选,默认最新版本)
- 返回:组件的 Markdown 格式文档
get-extend-component- 功能:获取 HUI 扩展组件文档
- 参数:
- componentName: 组件名称(必填)
- version: 组件版本(可选,默认最新版本)
- 返回:组件的 Markdown 格式文档
get-component-versions- 功能:获取 HUI 组件版本信息
- 参数:无
- 返回:最新版本号和所有可用版本列表
get-release-notes- 功能:获取 HUI 组件库版本发布更新日志
- 参数:
- version: 版本号(可选,不指定则返回所有版本记录)
- 返回:版本发布记录,包含更新内容和日期
调试
进入 build 目录
npx @modelcontextprotocol/inspector node index.js使用
mcp server json 配置
{
"mcpServers": {
"hui_doc_search": {
"name": "hui_doc_search",
"command": "npx",
"args": [
"-y",
"hui-docs-mcp"
],
"env":{
"VERSION":"组件版本号,可选值,如果配置了,那么就是取这个版本号的内容,值,只针对基础组件,不针对扩展组件"
}
}
}
}