@digital-finance-ui/ui-kit-mcp 0.2.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md ADDED
@@ -0,0 +1,43 @@
1
+ # @digital-finance-ui/ui-kit-mcp
2
+
3
+ MCP-сервер для `@sber-digital-finance-ui/ui-kit` — даёт кодовому агенту точные пропсы, типы, категории и примеры для всех компонентов библиотеки, а не только для задокументированных в Storybook.
4
+
5
+ ## Установка
6
+
7
+ ```bash
8
+ npm install @sber-digital-finance-ui/ui-kit @digital-finance-ui/ui-kit-mcp
9
+ ```
10
+
11
+ Конфиг MCP-клиента:
12
+
13
+ ```json
14
+ {
15
+ "mcpServers": {
16
+ "sber-digital-finance-ui-ui-kit": {
17
+ "command": "node",
18
+ "args": ["node_modules/@digital-finance-ui/ui-kit-mcp/dist/server.js"]
19
+ }
20
+ }
21
+ }
22
+ ```
23
+
24
+ Библиотека `@sber-digital-finance-ui/ui-kit` не обязательна: без неё сервер работает на вшитом индексе и предупреждает об этом в ответах (`libNotInstalled`). Если библиотека установлена и её версия несёт собственные данные, сервер берёт их — так пропсы всегда соответствуют именно вашей версии.
25
+
26
+ ## Инструменты
27
+
28
+ - `list_components({ type?, category?, scope?, role?, limit?, offset? })` — каталог компонентов с фильтрами по типу (`wrapper`/`composition`/`standalone`/`form`), категории и области. По умолчанию отдаёт только самостоятельные компоненты (`role: "primary"`); слоты compound-компонентов и служебные примитивы скрыты, `role: "all"` снимает фильтр. Без `limit` список сам бюджетируется под лимит ответа — остаток добирается фильтрами или `limit`/`offset`.
29
+ - `search_components({ query })` — поиск по компонентам и фичам с учётом синонимов задачи на русском и английском. В результатах есть `chooseWhen`/`supersededBy` — по ним выбирают между конкурирующими компонентами.
30
+ - `get_component({ name })` — компактная карточка: описание, категория, `minimalUsage` (синтетический вызов из обязательных пропсов), заголовки доступных примеров, ссылки на родителя и связанные экспорты.
31
+ - `get_component_props({ name, part? })` — полные пропсы, собственные и унаследованные. Отсортированы: обязательные → с описанием → без описания → `deprecated` в конец, чтобы при обрезке по бюджету терялось наименее нужное.
32
+ - `get_component_examples({ name, title? })` — только настоящие примеры кода, до 4 суммарно.
33
+ - `list_features({ component })`, `get_feature({ component, feature })`, `get_feature_examples({ component, feature, title? })` — крупные возможности сложных компонентов (фильтрация, редактирование, выделение и т.п.) отдельно от плоского списка пропсов.
34
+ - `get_type({ name })` — определения типов, на которые ссылаются пропсы.
35
+
36
+ ## Ресурсы
37
+
38
+ - `sber-digital-finance-ui-ui-kit://catalog/categories` — категории каталога с количеством компонентов по типам.
39
+ - `sber-digital-finance-ui-ui-kit://catalog/installation-guide` — установка пакета, подключение стилей и токенов, использование компонентов и иконок.
40
+
41
+ ## Требования
42
+
43
+ Node.js >= 20.