@maxisoft/instantcms-mcp 1.2.3

package/dist/registry/knowledge-tools.js

@@ -0,0 +1,441 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.registerKnowledgeTools = registerKnowledgeTools;
+const zod_1 = require("zod");
+const hooks_tool_js_1 = require("../tools/hooks-tool.js");
+const addon_tool_js_1 = require("../tools/addon-tool.js");
+const scaffold_tool_js_1 = require("../tools/scaffold-tool.js");
+const layout_tool_js_1 = require("../tools/layout-tool.js");
+const db_tool_js_1 = require("../tools/db-tool.js");
+const controllers_tool_js_1 = require("../tools/controllers-tool.js");
+const hooks_js_1 = require("../data/hooks.js");
+const schemas_js_1 = require("../data/schemas.js");
+const mcp_result_js_1 = require("../utils/mcp-result.js");
+function registerKnowledgeTools(server) {
+    // ── 3. Список хуков ──────────────────────────────────────────────────────
+    server.tool('list_hooks', 'Список всех доступных хуков InstantCMS с краткими описаниями. Поддерживает фильтрацию по категории и типу', {
+        category: zod_1.z
+            .string()
+            .optional()
+            .describe(`Фильтр по категории. Доступные: ${hooks_js_1.hookCategories.join(', ')}`),
+        type: zod_1.z
+            .enum(['filter', 'action'])
+            .optional()
+            .describe('Тип хука: filter (изменяет данные) или action (реагирует на событие)'),
+        limit: zod_1.z.number().int().min(1).max(200).optional(),
+        cursor: zod_1.z.string().optional(),
+    }, async ({ category, type, limit, cursor }) => {
+        const result = (0, hooks_tool_js_1.listHooks)(category, type, { limit, cursor });
+        return (0, mcp_result_js_1.successResult)(result);
+    });
+    // ── 4. Детали хука ───────────────────────────────────────────────────────
+    server.tool('get_hook_details', 'Подробная информация о конкретном хуке: параметры, возвращаемый тип, пример реализации, как зарегистрировать в manifest.xml', {
+        hook_name: zod_1.z
+            .string()
+            .describe('Имя хука. Пример: content_after_add_approve, user_registered, html_filter'),
+    }, async ({ hook_name }) => {
+        const result = (0, hooks_tool_js_1.getHookDetails)(hook_name);
+        return {
+            content: [
+                {
+                    type: 'text',
+                    text: JSON.stringify(result, null, 2),
+                },
+            ],
+        };
+    });
+    // ── 5. Поиск хуков ───────────────────────────────────────────────────────
+    server.tool('search_hooks', 'Полнотекстовый поиск хуков по имени, описанию, категории или параметрам', {
+        query: zod_1.z
+            .string()
+            .describe("Поисковый запрос. Пример: 'после добавления материала', 'profile', 'email'"),
+    }, async ({ query }) => {
+        const result = (0, hooks_tool_js_1.searchHooks)(query);
+        return {
+            content: [
+                {
+                    type: 'text',
+                    text: JSON.stringify(result, null, 2),
+                },
+            ],
+        };
+    });
+    // ── 6. API компонента ────────────────────────────────────────────────────
+    server.tool('get_component_api', 'API конкретного класса/компонента InstantCMS: методы, сигнатуры, описания, примеры вызовов', {
+        component_name: zod_1.z
+            .string()
+            .describe('Имя компонента или класса. Пример: cmsModel, cmsTemplate, cmsRequest, cmsCache, cmsEventsManager'),
+    }, async ({ component_name }) => {
+        const result = (0, addon_tool_js_1.getComponentApi)(component_name);
+        return {
+            content: [
+                {
+                    type: 'text',
+                    text: JSON.stringify(result, null, 2),
+                },
+            ],
+        };
+    });
+    // ── 7. Список компонентов ────────────────────────────────────────────────
+    server.tool('list_components', 'Список всех документированных компонентов и классов InstantCMS с кратким описанием и способом доступа', { limit: zod_1.z.number().int().min(1).max(200).optional(), cursor: zod_1.z.string().optional() }, async ({ limit, cursor }) => {
+        const result = (0, addon_tool_js_1.listComponents)({ limit, cursor });
+        return (0, mcp_result_js_1.successResult)(result);
+    });
+    // ── 8. Валидация дополнения ──────────────────────────────────────────────
+    server.tool('validate_addon', 'Валидация структуры дополнения InstantCMS. Проверяет наличие обязательных файлов, правильность классов, соглашения об именовании', {
+        files: zod_1.z
+            .record(zod_1.z.string().min(1).max(500), zod_1.z.string().max(2_000_000))
+            .refine(files => Object.keys(files).length <= 500, 'Не более 500 файлов')
+            .describe("Map файлов дополнения: {путь_к_файлу: содержимое}. Пример: {'frontend.php': '<?php class myaddon...'}"),
+    }, async ({ files }) => {
+        const result = (0, addon_tool_js_1.validateAddon)(files);
+        return {
+            content: [
+                {
+                    type: 'text',
+                    text: JSON.stringify(result, null, 2),
+                },
+            ],
+        };
+    });
+    // ── 9. Типы полей форм ───────────────────────────────────────────────────
+    server.tool('get_field_types', 'Информация о типах полей для форм InstantCMS (fieldString, fieldList, fieldImage и др.) с примерами использования', {
+        field_type: zod_1.z
+            .string()
+            .optional()
+            .describe('Имя конкретного типа поля для детальной информации. Если не указан — возвращает все типы'),
+    }, async ({ field_type }) => {
+        const result = (0, addon_tool_js_1.getFieldTypes)(field_type);
+        return {
+            content: [
+                {
+                    type: 'text',
+                    text: JSON.stringify(result, null, 2),
+                },
+            ],
+        };
+    });
+    // ── 10. Примеры кода ─────────────────────────────────────────────────────
+    server.tool('get_code_example', 'Получить готовый пример кода для типовой задачи в InstantCMS', {
+        task: zod_1.z
+            .string()
+            .describe("Описание задачи. Пример: 'список с пагинацией', 'обработка AJAX', 'кэширование', 'работа с хуками', 'загрузка файлов'"),
+    }, async ({ task }) => {
+        const result = (0, addon_tool_js_1.getCodeExample)(task);
+        return {
+            content: [
+                {
+                    type: 'text',
+                    text: JSON.stringify(result, null, 2),
+                },
+            ],
+        };
+    });
+    // ── 11. Генерация шаблона ────────────────────────────────────────────────
+    server.tool('scaffold_template', 'Генерирует скаффолд шаблона (темы) для InstantCMS: manifest.php, main.tpl.php, базовые CSS/JS', {
+        name: zod_1.z.string().describe('Техническое имя шаблона (латинские буквы). Пример: mytheme'),
+        title: zod_1.z.string().describe('Отображаемое название. Пример: My Beautiful Theme'),
+        author: zod_1.z.string().optional().describe('Имя автора'),
+    }, async (opts) => {
+        const result = (0, scaffold_tool_js_1.scaffoldTemplate)(opts);
+        return {
+            content: [
+                {
+                    type: 'text',
+                    text: JSON.stringify(result, null, 2),
+                },
+            ],
+        };
+    });
+    // ── 12. Структура шаблона ────────────────────────────────────────────────
+    server.tool('get_template_structure', 'Полная структура шаблона InstantCMS: обязательные и опциональные файлы, переменные доступные в .tpl.php, переопределение шаблонов контроллеров', {}, async () => {
+        return {
+            content: [
+                {
+                    type: 'text',
+                    text: JSON.stringify({
+                        ...schemas_js_1.templateStructure,
+                        available_tpl_variables: {
+                            $cms_template: 'Экземпляр cmsTemplate — управление выводом',
+                            $cms_user: 'Текущий пользователь (id, login, is_logged, group_id, ...)',
+                            $cms_config: 'Конфигурация сайта',
+                            'Все ключи из render()': "Переменные, переданные из контроллера через render('tpl', ['var' => val])",
+                        },
+                        tpl_helpers: {
+                            "href_to('ctrl', 'action', $params)": 'Генерация URL',
+                            "href_to_admin('ctrl', 'action')": 'URL в админку',
+                            'htmlspecialchars($str)': 'Экранирование HTML',
+                            LANG_CONST: 'Языковые константы',
+                            'date_format($date)': 'Форматирование даты',
+                        },
+                    }, null, 2),
+                },
+            ],
+        };
+    });
+    // ── 13. Генерация схемы виджетов (layout scheme) ─────────────────────────
+    server.tool('scaffold_layout_scheme', `Генерирует YAML-схему расположения виджетов для импорта в шаблон modern InstantCMS.
+Схема описывает ряды (rows) и колонки (cols) Bootstrap 4 сетки с позициями для виджетов.
+Результат импортируется через: Панель управления → Оформление → Шаблоны → Modern → Схема → Импорт.
+Можно задать произвольную схему через параметр rows, или использовать готовый пресет через preset.`, {
+        template: zod_1.z
+            .string()
+            .optional()
+            .default('modern')
+            .describe('Имя шаблона. По умолчанию: modern'),
+        preset: zod_1.z.enum(['simple', 'with_sidebar_left', 'modern_full']).optional()
+            .describe(`Готовый пресет схемы. Используйте вместо rows для быстрого старта:
+  simple          — шапка + контент/сайдбар + подвал
+  with_sidebar_left — три колонки: лево/контент/право + двухколоночный футер
+  modern_full     — полная схема modern (топ-бар, лого, навбар, баннер, три колонки, префутер, футер)`),
+        rows: zod_1.z
+            .array(zod_1.z.object({
+            title: zod_1.z.string().describe('Отображаемое название ряда в админке'),
+            tag: zod_1.z
+                .string()
+                .nullish()
+                .describe('HTML тег Bootstrap row-элемента. null = без тега. Примеры: div, main'),
+            parent_col: zod_1.z
+                .string()
+                .optional()
+                .describe('position_name колонки-родителя (для вложенных рядов). Ряд будет вложен внутрь этой позиции'),
+            nested_position: zod_1.z
+                .string()
+                .optional()
+                .default('after')
+                .describe("Позиция вложения: 'after' (после виджетов, по умолчанию)"),
+            class: zod_1.z
+                .string()
+                .nullish()
+                .describe('CSS классы на Bootstrap row-элементе. Bootstrap 4: py-3, mt-auto'),
+            outer_tag: zod_1.z
+                .string()
+                .optional()
+                .describe('Внешний HTML тег-обёртка вокруг ряда. Примеры: header, footer, section, div, nav'),
+            outer_class: zod_1.z.string().optional().describe('CSS классы внешнего тега'),
+            container: zod_1.z
+                .string()
+                .optional()
+                .describe("Класс контейнера Bootstrap 4: 'container', 'container-fluid', '' (без контейнера). По умолчанию: 'container'"),
+            container_tag: zod_1.z.string().optional().describe('HTML тег контейнера. По умолчанию: div'),
+            container_class: zod_1.z
+                .string()
+                .optional()
+                .describe("CSS классы контейнера. Примеры: 'd-flex justify-content-between align-items-center flex-nowrap'"),
+            no_gutters: zod_1.z.boolean().optional().describe('Добавить Bootstrap no-gutters к ряду'),
+            cols: zod_1.z
+                .array(zod_1.z.object({
+                title: zod_1.z.string().describe('Отображаемое название колонки'),
+                position: zod_1.z
+                    .string()
+                    .optional()
+                    .describe('Имя позиции для привязки виджетов. Авто-генерируется как pos_N если не задано. Используйте con_* для полноширинных позиций'),
+                tag: zod_1.z
+                    .string()
+                    .optional()
+                    .describe('HTML тег колонки. По умолчанию: div. Примеры: article, aside, nav'),
+                class: zod_1.z
+                    .string()
+                    .nullish()
+                    .describe('CSS классы на колонке. Bootstrap 4: mb-3 mb-md-4'),
+                type: zod_1.z
+                    .enum(['typical', 'custom'])
+                    .optional()
+                    .default('typical')
+                    .describe('Тип колонки: typical = обычная Bootstrap-колонка, custom = кастомный HTML с {position}'),
+                wrapper: zod_1.z
+                    .string()
+                    .optional()
+                    .describe("Для type=custom: HTML-обёртка с плейсхолдером {position}. Примеры: '{position}' или '<div class=\"my-wrap\">{position}</div>'"),
+                col: zod_1.z
+                    .string()
+                    .optional()
+                    .describe('Bootstrap 4 col-класс (xs/default). Примеры: col, col-sm-12, col-sm'),
+                col_md: zod_1.z
+                    .string()
+                    .optional()
+                    .describe('Bootstrap 4 col-md класс. Примеры: col-md-6, col-md'),
+                col_lg: zod_1.z
+                    .string()
+                    .optional()
+                    .describe('Bootstrap 4 col-lg класс. Примеры: col-lg-8, col-lg-4, col-lg-3, col-lg'),
+                col_xl: zod_1.z
+                    .string()
+                    .optional()
+                    .describe('Bootstrap 4 col-xl класс. Примеры: col-xl-2'),
+                col_class: zod_1.z
+                    .string()
+                    .optional()
+                    .describe('Переопределить все responsive классы одним значением'),
+                order: zod_1.z.number().optional().describe('Bootstrap order (default). 0 = без order'),
+                cut_before: zod_1.z
+                    .boolean()
+                    .optional()
+                    .describe('Вставить Bootstrap w-100 перед колонкой (принудительный перенос строки)'),
+            }))
+                .describe('Колонки ряда'),
+        }))
+            .min(1)
+            .max(100)
+            .optional()
+            .describe('Массив рядов схемы. Используйте вместо preset для кастомной схемы'),
+    }, async ({ template, preset, rows }) => {
+        let input;
+        if (preset && !rows) {
+            // Use preset
+            const p = layout_tool_js_1.layoutPresets[preset];
+            input = { ...p.scheme, template: template || p.scheme.template };
+        }
+        else if (rows) {
+            input = { template: template || 'modern', rows };
+        }
+        else {
+            // Default: list presets
+            return {
+                isError: true,
+                content: [
+                    {
+                        type: 'text',
+                        text: JSON.stringify({
+                            error: 'Укажите preset или rows',
+                            available_presets: (0, layout_tool_js_1.listLayoutPresets)(),
+                        }, null, 2),
+                    },
+                ],
+            };
+        }
+        const result = (0, layout_tool_js_1.scaffoldLayoutScheme)(input);
+        return {
+            content: [
+                {
+                    type: 'text',
+                    text: JSON.stringify(result, null, 2),
+                },
+            ],
+        };
+    });
+    // ── 14. Список пресетов схем виджетов ────────────────────────────────────
+    server.tool('list_layout_presets', 'Список готовых пресетов схем расположения виджетов для шаблона modern InstantCMS. Используйте preset в scaffold_layout_scheme для быстрой генерации.', {}, async () => {
+        return {
+            content: [
+                {
+                    type: 'text',
+                    text: JSON.stringify((0, layout_tool_js_1.listLayoutPresets)(), null, 2),
+                },
+            ],
+        };
+    });
+    // ── 15. Анализ структуры базы данных ──────────────────────────────────────
+    server.tool('introspect_database', 'Анализ структуры базы данных InstantCMS. Без параметров — список всех таблиц. С параметром table_name — детали конкретной таблицы.', {
+        table_name: zod_1.z
+            .string()
+            .optional()
+            .describe('Имя таблицы (без префикса cms_). Пример: users, content_types, widgets'),
+    }, async ({ table_name }) => {
+        const result = (0, db_tool_js_1.introspectDatabase)(table_name);
+        return {
+            content: [
+                {
+                    type: 'text',
+                    text: JSON.stringify(result, null, 2),
+                },
+            ],
+        };
+    });
+    // ── 16. Описание конкретной таблицы ──────────────────────────────────────
+    server.tool('describe_table', 'Подробное описание таблицы: поля, индексы, связи, типы данных. Генерирует примеры SQL-запросов.', {
+        table_name: zod_1.z
+            .string()
+            .describe('Имя таблицы (можно с префиксом cms_ или без). Пример: cms_users, content_types'),
+    }, async ({ table_name }) => {
+        const result = (0, db_tool_js_1.describeTable)(table_name);
+        return {
+            content: [
+                {
+                    type: 'text',
+                    text: JSON.stringify(result, null, 2),
+                },
+            ],
+        };
+    });
+    // ── 17. Типы контента ────────────────────────────────────────────────────
+    server.tool('list_content_types', 'Информация о типах контента: cms_content_types, cms_con_pages, cms_users. Поля, ключи, связи.', {}, async () => {
+        const result = (0, db_tool_js_1.listContentTypes)();
+        return {
+            content: [
+                {
+                    type: 'text',
+                    text: JSON.stringify(result, null, 2),
+                },
+            ],
+        };
+    });
+    // ── 18. Карта событий (events) ────────────────────────────────────────────
+    server.tool('list_database_events', 'Все зарегистрированные события (хуки) из таблицы cms_events. Показывает какой контроллер на какое событие подписан.', {}, async () => {
+        const result = (0, db_tool_js_1.listDatabaseEvents)();
+        return {
+            content: [
+                {
+                    type: 'text',
+                    text: JSON.stringify(result, null, 2),
+                },
+            ],
+        };
+    });
+    // ── 19. Анализ контроллера ───────────────────────────────────────────────
+    server.tool('analyze_controller', 'Подробная информация о контроллере: класс, наследование, экшены, трейты, файлы.', {
+        name: zod_1.z.string().describe('Имя контроллера. Пример: content, users, messages'),
+        type: zod_1.z.enum(['frontend', 'backend']).optional().describe('Тип контроллера'),
+    }, async ({ name, type }) => {
+        const result = (0, controllers_tool_js_1.analyzeController)(name, type);
+        return {
+            content: [
+                {
+                    type: 'text',
+                    text: JSON.stringify(result, null, 2),
+                },
+            ],
+        };
+    });
+    // ── 20. Список контроллеров ──────────────────────────────────────────────
+    server.tool('list_controllers', 'Список всех контроллеров: frontend и backend. Можно фильтровать по типу.', {
+        filter: zod_1.z.enum(['frontend', 'backend']).optional().describe('Фильтр по типу контроллера'),
+    }, async ({ filter }) => {
+        const result = (0, controllers_tool_js_1.listControllers)(filter);
+        return {
+            content: [
+                {
+                    type: 'text',
+                    text: JSON.stringify(result, null, 2),
+                },
+            ],
+        };
+    });
+    // ── 21. Экшены контроллера ───────────────────────────────────────────────
+    server.tool('get_controller_actions', 'Список всех экшенов контроллера с параметрами, видимостью и трейтами.', {
+        name: zod_1.z.string().describe('Имя контроллера. Пример: content, users'),
+        type: zod_1.z.enum(['frontend', 'backend']).optional().describe('Тип контроллера'),
+    }, async ({ name, type }) => {
+        const result = (0, controllers_tool_js_1.getControllerActionsList)(name, type);
+        return {
+            content: [
+                {
+                    type: 'text',
+                    text: JSON.stringify(result, null, 2),
+                },
+            ],
+        };
+    });
+    // ── 22. Системные трейты ─────────────────────────────────────────────────
+    server.tool('list_system_traits', 'Список всех системных трейтов icms используемых в контроллерах. Трейты предоставляют готовую функциональность.', {}, async () => {
+        const result = (0, controllers_tool_js_1.listSystemTraits)();
+        return {
+            content: [
+                {
+                    type: 'text',
+                    text: JSON.stringify(result, null, 2),
+                },
+            ],
+        };
+    });
+}

package/dist/registry/language-tools.js

@@ -0,0 +1,99 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.registerLanguageTools = registerLanguageTools;
+const zod_1 = require("zod");
+const migration_tool_js_1 = require("../tools/migration-tool.js");
+const lang_tool_js_1 = require("../tools/lang-tool.js");
+function registerLanguageTools(server) {
+    // ═══════════════════════════════════════════════════════════════════════════
+    // LANGUAGE TOOLS
+    // ═══════════════════════════════════════════════════════════════════════════
+    // ── 40. Список языковых ключей ────────────────────────────────────────
+    server.tool('list_lang_keys', 'Возвращает типовые языковые константы для дополнения. Генерирует LANG_* ключи с значениями по умолчанию.', {
+        addon_name: zod_1.z.string().describe('Имя дополнения. Пример: myaddon'),
+        category: zod_1.z
+            .string()
+            .optional()
+            .describe('Фильтр по категории: system, actions, pages, buttons, status, fields, errors, permissions, dates, messages, pagination, sort'),
+    }, async ({ addon_name, category }) => {
+        const result = (0, lang_tool_js_1.listLangKeys)({ addon_name, category });
+        return {
+            content: [
+                {
+                    type: 'text',
+                    text: JSON.stringify(result, null, 2),
+                },
+            ],
+        };
+    });
+    // ── 41. Генерация языкового файла ───────────────────────────────────
+    server.tool('scaffold_lang', 'Генерирует готовый PHP файл с языковыми константами для дополнения.', {
+        addon_name: zod_1.z.string().describe('Имя дополнения. Пример: myaddon'),
+        keys: zod_1.z
+            .array(zod_1.z.string())
+            .optional()
+            .describe('Список ключей для генерации. Если пусто — все типовые.'),
+        custom_keys: zod_1.z
+            .array(zod_1.z.object({
+            key: zod_1.z.string().describe('Полный ключ, например: LANG_MYADDON_MY_KEY'),
+            value: zod_1.z.string().describe('Значение константы'),
+            category: zod_1.z.string().optional().describe('Категория'),
+        }))
+            .optional()
+            .describe('Дополнительные кастомные ключи'),
+    }, async ({ addon_name, keys, custom_keys }) => {
+        const result = (0, lang_tool_js_1.scaffoldLang)({ addon_name, keys, custom_keys });
+        return {
+            content: [
+                {
+                    type: 'text',
+                    text: JSON.stringify(result, null, 2),
+                },
+            ],
+        };
+    });
+    // ── 42. Генерация миграции с файлами ────────────────────────────────
+    server.tool('scaffold_migration', 'Генерирует install.php и uninstall.php файлы для дополнения. Включает создание таблиц, опционально тип контента и SEO настройки.', {
+        addon_name: zod_1.z.string().describe('Имя дополнения. Пример: myaddon'),
+        table_name: zod_1.z.string().describe('Имя таблицы без префикса. Пример: items'),
+        fields: zod_1.z
+            .array(zod_1.z.object({
+            name: zod_1.z.string().describe('Имя поля'),
+            type: zod_1.z.string().describe('Тип SQL: varchar(255), text, int(11), datetime, tinyint(1)'),
+            nullable: zod_1.z.boolean().optional().describe('Может быть NULL'),
+            default: zod_1.z.union([zod_1.z.string(), zod_1.z.number()]).optional().describe('Значение по умолчанию'),
+            extra: zod_1.z.string().optional().describe('Дополнительно: AUTO_INCREMENT'),
+            comment: zod_1.z.string().optional().describe('Комментарий к полю'),
+        }))
+            .describe('Поля таблицы'),
+        options: zod_1.z
+            .object({
+            comment: zod_1.z.string().optional().describe('Комментарий к таблице'),
+            indexes: zod_1.z
+                .array(zod_1.z.object({
+                name: zod_1.z.string().describe('Имя индекса'),
+                fields: zod_1.z.array(zod_1.z.string()).describe('Поля через запятую'),
+                type: zod_1.z.enum(['INDEX', 'UNIQUE', 'FULLTEXT']).optional().describe('Тип индекса'),
+            }))
+                .optional()
+                .describe('Дополнительные индексы'),
+            permissions: zod_1.z
+                .array(zod_1.z.string())
+                .optional()
+                .describe('Права доступа: view, add, edit, delete'),
+            content_type: zod_1.z.boolean().optional().describe('Создать тип контента'),
+            has_seo: zod_1.z.boolean().optional().describe('Добавить SEO настройки'),
+        })
+            .optional(),
+    }, async ({ addon_name, table_name, fields, options }) => {
+        const result = (0, migration_tool_js_1.scaffoldMigration)({ addon_name, table_name, fields, options });
+        return {
+            content: [
+                {
+                    type: 'text',
+                    text: JSON.stringify(result, null, 2),
+                },
+            ],
+        };
+    });
+}