@mijadesign/nut-mcp
v1.0.0-alpha.3
Published
MCP server for @mijadesign/mjui-react-taro component library
Keywords
Readme
Mija Design MCP
专为 @mijadesign/mjui-react-taro 定制的 MCP Server,用于让 AI 编码工具按组件库文档生成代码。
它会读取组件索引、组件 Markdown 文档和中文别名配置,提供组件列表、组件搜索、组件 API 与示例查询能力。
工具列表
| 工具 | 作用 | 使用建议 |
| ------------------- | ---------------------------------------- | ------------------------------------------ |
| list_components | 列出全部组件,并按分组归类 | 不确定组件名时先调用 |
| search_components | 按关键词、中文别名、组件名、描述搜索组件 | 找到候选组件后继续调用 get_component_doc |
| get_component_doc | 获取指定组件的 props、示例、版本和说明 | 生成代码前必须调用,避免使用不存在的 prop |
数据来源
运行时依赖以下文档数据:
docs/docs/components-index.jsondocs/docs/aliases.jsondocs/docs/components/**/index.md
运行时优先读取当前包内的 docs/docs。未生成包内文档时,本地开发会回退读取仓库根目录的 docs/docs。发布前会通过 prepare:docs 复制一份到当前包内,发布后的 npm 包会读取包内文档。
发布:
npm run prepack
npm publish --access public发布后如何使用
发布后,在支持 MCP 的 IDE 或 AI 编码工具中添加 stdio server 配置:
{
"mcpServers": {
"mija-design": {
"command": "npx",
"args": ["-y", "@mijadesign/nut-mcp"]
}
}
}如果已经全局安装:
npm install -g @mijadesign/nut-mcp可配置为:
{
"mcpServers": {
"mija-design": {
"command": "mija-mcp",
"args": []
}
}
}客户端连接成功后,AI 工具应按这个顺序使用:
- 不确定组件时,调用
search_components或list_components。 - 确认组件后,调用
get_component_doc获取 props 与 demos。 - 生成代码时只使用文档返回的 prop 和示例结构。
示例提问:
使用 Mija Design 的按钮和弹窗组件实现确认删除流程。生成代码前先查询组件文档。维护说明
- 组件库文档有新增或改动时,需同步更新发布此包
