KD Components MCP Server

一个模型上下文协议 (MCP) 服务器，提供有关 kd-fe 组件库、业务中常用代码片段的全面信息。

API

该服务器提供 12 个 MCP API：

1. list_components

列出所有可用的 kd-components 组件及其标签名、描述和依赖关系。

2. get_component

获取指定 kd-components 组件的资源信息，包括API文档、使用示例和源码文件。

参数：

• componentName: 组件名称（必需，例如："kd-affix"）

3. list_directives

列出所有可用的 kd-components 指令及其名称、描述、参数和依赖关系。

4. get_directive

获取指定 kd-components 指令的详细信息和源码文件内容。

参数：

• directiveName: 指令名称（必需，例如："clickDown"）

5. list_mixins

列出所有可用的 kd-components mixins 及其名称、描述、参数和返回值信息。

6. get_mixin

获取指定 kd-components mixin 的详细信息和源码文件内容。

参数：

• mixinName: Mixin 名称（必需，例如："mBlurRequired"）

7. list_template_mixins

列出所有可用的 kd-fe 项目中模板 mixins 及其名称、描述、关键词、依赖关系和使用场景。

8. get_template_mixin

获取指定 kd-fe 项目中模板 mixin 的详细信息和源码内容。

参数：

• mixinName: 模板 mixin 名称（必需，例如："tableMixin"），可用模板名称包括：
  • autoSearchMixin：配合 kd-auto-search 组件的常用的变量和操作，用于为表格提供条件筛选操作
  • kdOwnerMixin：配合 kd-owner 组件使用，用于远程搜索用户列表
  • resizeObserverMixin：监听单个容器元素尺寸变化
  • scrollListMixin：无限滚动页面，且滚动区域展示 card 子元素的混入
  • tableMixin：包含 kd-simple-table 组件的常用的变量和操作；同时还自动引入了 auto-search-mixin

9. list_template_views

列出所有可用的 kd-fe 项目中视图模板及其名称、描述、关键词、依赖关系和使用场景。

10. get_template_view

获取指定 kd-fe 项目中常用页面模板的详细信息和源码内容。

参数：

• templateName: 视图模板名称（必需，例如："simpleListPage"），可用模板名称包括：
  • editorPage： 复杂单步编辑页面；el-form嵌套kd-simple-table
  • simpleListPage： 基础表格列表页面模板；一般用于基础的表格列表页面，包含页面标题、表格搜索框、页面级操作、表格
  • stickyPage: 左侧固定、自动吸顶，内容部分包含多个条件筛选组件

11. list_template_components

列出所有可用的 kd-fe 项目中模板组件及其名称、描述、关键词、依赖关系和使用场景。

12. get_template_component

获取指定 kd-fe 项目中模板组件的详细信息和源码内容。

参数：

• componentName: 模板组件名称（必需，例如："BasicChart"），可用组件名称包括：
  • BasicChart： 基于 echarts 的基础图表组件模板，提供关于图表组件的按需加载和基础封装
  • RowSelectGroup： 基于 kd-row-select 组件的多条件筛选，行选择组组件模板，支持多选、单选、全选、反选等操作，支持筛选条件配置、保存、重置等操作
  • SortButton： 排序按钮组组件模板，可按需定义排序按钮名称、排序字段、排序方式
  • FilterTree： 基于el-tree组件的过滤树组件，支持关键词搜索，自定义节点图标，节点内容支持tooltip
  • OperateTree： 基于el-tree组件的自定义树组件，包含：关键词搜索，自定义节点图标，节点内容支持tooltip，依赖PopoverButton组件实现自定义节点按钮组
  • PopoverButton： 基于 el-popover 的下拉弹出框按钮组件，支持内容配置、触发按钮配置、事件回调等
  • EditorDrawer： 基于 kd-drawer 组件的数据编辑抽屉模板
  • BasicDialog： 基于 kd-dialog 组件的基础对话框模板
  • BasicDrawer： 基于 kd-drawer 组件的基础抽屉模板
  • TextEllipsis： 文本截断组件，支持文本截断
  • StickyLayout： 粘性布局组件，支持固定头部和左侧导航

MCP 集成```

在 MCP 客户端中配置：

{
  "mcpServers": {
    "kd-components": {
      "command": "npx",
      "args": ["-y", "kd-fe-mcp"]
    }
  }
}

推荐使用 npx 方式，它会自动管理包版本并确保使用最新版本。

许可证

本项目采用 Apache License 2.0 许可证 - 查看 LICENSE 文件了解详情。