@electra-ui/components-mcp
v1.2.0
Published
MCP server with a component catalog for the @electra-ui/components Angular UI library (Electra design system)
Readme
@electra-ui/components-mcp
MCP-сервер (Model Context Protocol) с каталогом компонентов Angular UI-библиотеки @electra-ui/components (дизайн-система Electra). Позволяет AI-ассистентам искать компоненты, изучать их API, смотреть примеры использования и находить иконки — без открытия документации.
Возможности
- 127 компонентов с полными контрактами: inputs / outputs / models, типы, значения по умолчанию, deprecated-пометки, related-компоненты (например, семейство
eInput) - 770 примеров кода из документации и test-stand (TypeScript / HTML / LESS), включая унаследованные примеры для под-компонентов (примеры
eToastдоступны дляe-toast-container) - 55 иконок из набора
icons-me(включая размеры_x20/_x24) - Двуязычность: русский и английский (
lang: "ru" | "en") - Только чтение — сервер не изменяет файлы и не выполняет код
Инструменты (tools)
| Tool | Назначение |
|---|---|
| electra_get_catalog_info | Версия библиотеки, количество компонентов/примеров/иконок |
| electra_search_components | Поиск компонентов по названию/селектору/описанию |
| electra_get_component_api | Полный контракт компонента (inputs, outputs, models) |
| electra_get_component_examples | Примеры кода для компонента |
| electra_find_components_by_use_case | Подбор компонента по сценарию («выбор даты», «таблица с фильтрами») |
| electra_search_icons | Поиск иконки по имени (kebab-case) |
В некоторых клиентах имена инструментов отображаются с префиксом сервера, например electra-components_electra_search_components.
Режимы работы
| Режим | Описание | Когда используется |
|---|---|---|
| workspace (по умолчанию) | Каталог строится на лету из исходников Nx-воркспейса (~1 с при старте) | Разработка внутри монорепозитория Electra |
| package | Каталог читается из <пакет>/catalog/*.json, сгенерированного при сборке | Установка пакета извне |
Переключение — переменной окружения ELECTRA_MCP_MODE; корень воркспейса можно задать через ELECTRA_ROOT (иначе определяется автоматически по nx.json).
Установка
npm install @electra-ui/components-mcpТребуется Node.js >= 22.14. Парсер исходников использует TypeScript compiler API (входит в зависимости пакета).
Подключение к клиентам
Сервер поддерживает два транспорта:
| Транспорт | Когда использовать | Включение |
|---|---|---|
| stdio (по умолчанию) | локальный запуск пакета (npx) | ELECTRA_MCP_TRANSPORT=stdio |
| http (Streamable HTTP) | сервер развёрнут в контейнере, клиенты подключаются по сети | ELECTRA_MCP_TRANSPORT=http |
Подключение по HTTP
В HTTP-режиме сервер слушает http://<host>:8100/mcp и отдаёт диагностику по GET /health.
Общий стенд библиотеки:
{ "mcp": { "electra-components": { "type": "remote", "url": "http://az-builder-dev.oikdev.local:8100/mcp", "enabled": true } } }Ответ /health:
{
"status": "ok",
"server": "electra-components-mcp",
"version": "1.1.2",
"mode": "package",
"components": 127,
"warnings": 0
}Переменные окружения:
| Переменная | По умолчанию | Назначение |
|---|---|---|
| ELECTRA_MCP_TRANSPORT | stdio | stdio или http |
| ELECTRA_MCP_HOST | 0.0.0.0 | адрес прослушивания |
| ELECTRA_MCP_PORT | 8100 | порт |
| ELECTRA_MCP_ALLOWED_HOSTS | — | список разрешённых Host через запятую (защита от DNS rebinding) |
| ELECTRA_MCP_MODE | авто | package в контейнере, чтобы не строить каталог из исходников |
ELECTRA_MCP_ALLOWED_HOSTS проверяет и /health: если клиенты ходят по имени и порту,
в списке должно быть это имя, а для HEALTHCHECK контейнера — 127.0.0.1.
Порт в значениях указывать не нужно.
Примеры конфигурации клиентов:
// OpenCode (remote, общий стенд)
{ "mcp": { "electra-components": { "type": "remote", "url": "http://az-builder-dev.oikdev.local:8100/mcp", "enabled": true } } }// Cursor / Claude Desktop (remote, общий стенд)
{ "mcpServers": { "electra-components": { "url": "http://az-builder-dev.oikdev.local:8100/mcp" } } }Для собственного размещения подставьте свой адрес вместо адреса общего стенда.
Требования к запуску образа и контракт API — docs/manuals/mcp-image-handover.md;
сборка и публикация — docs/manuals/mcp-image-publish.md.
Требуется клиент с поддержкой транспорта Streamable HTTP (MCP spec 2025-06-18). Локальный запуск через npx (ниже) остаётся доступным как fallback.
Локальный запуск (stdio)
Команда запуска: npx electra-components-mcp (или прямой путь к бинарю после установки).
OpenCode (opencode.json)
{
"mcp": {
"electra-components": {
"type": "local",
"command": ["npx", "electra-components-mcp"],
"enabled": true
}
}
}Claude Desktop (claude_desktop_config.json)
{
"mcpServers": {
"electra-components": {
"command": "npx",
"args": ["electra-components-mcp"]
}
}
}Cursor (.cursor/mcp.json)
{
"mcpServers": {
"electra-components": {
"command": "npx",
"args": ["electra-components-mcp"]
}
}
}JetBrains Code Assistant (.codeassistant/mcp.json)
Формат аналогичен Cursor/Claude Desktop — см. выше.
Режим разработки (из исходников монорепозитория)
{
"mcpServers": {
"electra-components": {
"command": "node",
"args": ["D:/electra/dist/libs/components-mcp/src/index.js"],
"env": { "ELECTRA_MCP_MODE": "workspace", "ELECTRA_ROOT": "D:/electra" }
}
}
}Сначала соберите сервер и каталог: npm run build:mcp (в корне монорепо) или nx run components-mcp:build.
Проверка
npx @modelcontextprotocol/inspector npx electra-components-mcpРазработка
- Сборка:
npm run build:mcpв корне монорепо, илиnx run components-mcp:build(compile + генерация каталога) - Тесты:
nx run components-mcp:test - Линт:
nx run components-mcp:lint - Запуск по HTTP локально:
nx run components-mcp:serve-http(порт 8100) - Сборка Docker-образа:
nx run components-mcp:container(требует установленного Docker; копируетdistв контекст библиотеки) - Регенерация каталога:
nx run components-mcp:generate-catalog - Проверка актуальности каталога в CI:
node dist/libs/components-mcp/src/generate-catalog.js --check - Отчёт о пробелах документации (компоненты без примеров и doc-страниц):
docs/catalog-gaps.md, регенерируется при каждой сборке
License
Apache-2.0 © 2026 "Monitor Electric" JSC
Поддержка и развитие
Дружинин Михаил [email protected] [email protected]
