@vint.tri/report_gen_mcp 1.7.28 → 1.7.30

package/ULTIMATE_INSTRUCTIONS.md

@@ -0,0 +1,76 @@
+# Главная инструкция по работе с инструментом report_gen_mcp
+
+**ЦЕЛЬ:** Генерация качественных, визуально насыщенных HTML-отчетов по запросу пользователя.
+
+**КЛЮЧЕВОЕ ПРАВИЛО:** При любом запросе, связанном с отчетами, диаграммами или графиками, **всегда используй инструмент `report_gen_mcp`**. Не пытайся отвечать текстом или генерировать отчеты самостоятельно.
+
+---
+
+### **АЛГОРИТМ ДЕЙСТВИЙ**
+
+**Шаг 1: Определи суть запроса**
+- Пойми, о чем пользователь хочет получить отчет (например, "финансовые показатели Apple", "сравнение акций Tesla и Google").
+
+**Шаг 2: Спланируй визуальные элементы**
+- Придумай **1-2 диаграммы** и **1 изображение**, которые хорошо проиллюстрируют тему отчета.
+- Для каждой диаграммы определи тип (`bar`, `line`, `pie` и т.д.) и данные.
+- Для изображения придумай текстовый промпт для генерации.
+
+**Шаг 3: Подготовь параметры для вызова инструмента**
+- **`document` (string):** Напиши текст отчета в формате Markdown. Вставь в него плейсхолдеры для визуальных элементов, например: `[[chart:sales_chart]]` и `[[image:cover_image]]`.
+- **`elements` (object):** Создай **ОБЪЕКТ**, где ключи — это названия твоих плейсхолдеров, а значения — это конфигурации для их генерации.
+- **`outputFile` (string):** Придумай понятное имя для HTML-файла, например `apple_report_2024.html`.
+
+**Шаг 4: Сформируй `elements` ПРАВИЛЬНО (КРИТИЧЕСКИ ВАЖНО!)**
+
+- **`elements` — это ОБЪЕКТ, а не строка!**
+- **Для диаграмм:**
+  - `labels`, `data`, `backgroundColor`, `borderColor` — **ВСЕГДА МАССИВЫ**, даже для одного значения.
+    - `labels`: `["Q1", "Q2"]`
+    - `data`: `[100, 150]`
+    - `backgroundColor`: `["#FF6384", "#36A2EB"]`
+  - `options.title`: **ВСЕГДА СТРОКА**. `"Продажи по кварталам"`
+- **Для изображений:**
+  - Используй `type: "pollinations"` и `config: { prompt: "..." }`.
+
+---
+
+### **ИДЕАЛЬНЫЙ ПРИМЕР ВЫЗОВА**
+
+```json
+{
+  "method": "generate-report",
+  "params": {
+    "document": "# Отчет о продажах\n\nАнализ квартальных продаж.\n\n[[chart:sales]]\n\nИзображение, отражающее успех:\n\n[[image:success_image]]",
+    "elements": {
+      "sales": {
+        "type": "bar",
+        "config": {
+          "labels": ["Q1", "Q2", "Q3", "Q4"],
+          "datasets": [{
+            "label": "Продажи 2024",
+            "data": [120, 150, 130, 180],
+            "backgroundColor": ["#FF6384", "#36A2EB", "#FFCE56", "#4BC0C0"]
+          }],
+          "options": {
+            "title": "Квартальные продажи"
+          }
+        }
+      },
+      "success_image": {
+        "type": "pollinations",
+        "config": {
+          "prompt": "business growth and financial success chart"
+        }
+      }
+    },
+    "outputFile": "sales_report_2024.html"
+  }
+}
+```
+
+---
+
+### **Что делать после вызова?**
+
+Инструмент вернет путь к файлу. Ты должен показать его пользователю вместе со ссылками для просмотра.

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AA0fA;;;;;GAKG;AACH,wBAAsB,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;IAC5D,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,GAAG,OAAO,CAAC;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAAC,CAgCjD"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAgYA;;;;;GAKG;AACH,wBAAsB,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;IAC5D,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,GAAG,OAAO,CAAC;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAAC,CAgCjD"}

package/dist/index.js

@@ -4,12 +4,12 @@ import { program } from 'commander';
 import { generateReport } from './utils/reportGenerator.js';
 import path from 'path';
 import fs from 'fs-extra';
-import os from 'os';
 import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
 import { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js';
 import { z } from 'zod';
 import { pathToFileURL } from 'url';
 import { ImageGenerator } from './mcp/imageGenerationServer.js';
+import { createReportFromTextTool } from './tools/createReportFromText.js';
 // Check if we're running in stdio mode (no command-line arguments)
 const isStdioMode = process.argv.length === 2;
 // For CLI and HTTP API modes, check for mandatory REPORTS_DIR environment variable
@@ -103,158 +103,39 @@ if (process.argv.length === 2) {
     // No command specified, run in stdio mode using MCP SDK
     const mcpServer = new McpServer({
         name: "report_gen_mcp",
-        version: "1.7.28"
+        version: "1.7.30"
     }, {
         // Disable health check to prevent automatic calls
         capabilities: {
             tools: {}
         }
     });
-    // Register the generate-report tool
-    mcpServer.registerTool("generate-report", {
-        description: "Generate an HTML report with embedded charts and images",
-        inputSchema: {
-            document: z.string().describe("Markdown document with element placeholders [[chart:id]] or [[image:id]]"),
-            elements: z.record(z.union([
-                // Chart configurations
-                z.object({
-                    type: z.enum(["bar", "line", "pie", "doughnut", "radar", "polarArea"]),
-                    config: z.object({
-                        labels: z.array(z.string()),
-                        datasets: z.array(z.object({
-                            label: z.string().optional(),
-                            data: z.array(z.number()),
-                            backgroundColor: z.array(z.string()).optional(),
-                            borderColor: z.array(z.string()).optional(),
-                            fill: z.boolean().optional(),
-                        })),
-                        options: z.object({
-                            title: z.string().optional(),
-                        }).optional(),
-                    }),
-                }).describe("Chart configuration"),
-                // Pollinations.ai generated images
-                z.object({
-                    type: z.literal("pollinations"),
-                    config: z.object({
-                        prompt: z.string().describe("Text description of the image to generate"),
-                        width: z.number().optional().default(512).describe("Width of the image in pixels"),
-                        height: z.number().optional().default(512).describe("Height of the image in pixels"),
-                        model: z.string().optional().default("flux").describe("Model to use for image generation"),
-                        seed: z.number().optional().describe("Seed for reproducible image generation"),
-                        nologo: z.boolean().optional().default(true).describe("Remove logo from the image"),
-                        enhance: z.boolean().optional().default(true).describe("Enhance image quality"),
-                    }),
-                }).describe("Pollinations.ai generated image configuration"),
-                // URL images (including local file URLs and web URLs)
-                z.object({
-                    type: z.literal("url"),
-                    config: z.object({
-                        url: z.string().describe("URL of the image (can be file:// or http(s)://)"),
-                        alt: z.string().optional().describe("Alternative text for the image"),
-                        width: z.number().optional().describe("Width of the image in pixels"),
-                        height: z.number().optional().describe("Height of the image in pixels"),
-                    }),
-                }).describe("Image from URL configuration"),
-                // Local images (backward compatibility)
-                z.object({
-                    type: z.literal("image"),
-                    config: z.object({
-                        url: z.string().describe("File URL of the image"),
-                        alt: z.string().optional().describe("Alternative text for the image"),
-                        width: z.number().optional().describe("Width of the image in pixels"),
-                        height: z.number().optional().describe("Height of the image in pixels"),
-                    }),
-                }).describe("Local image file configuration"),
-                // AssetId support for neural network responses (new format)
-                z.object({
-                    type: z.literal("url"),
-                    assetId: z.string().optional().describe("Asset ID for generated images (used by neural networks)"),
-                    config: z.object({
-                        url: z.string().optional().describe("URL of the image (can be populated from assetId)"),
-                        alt: z.string().optional().describe("Alternative text for the image"),
-                        width: z.number().optional().default(512).describe("Width of the image in pixels"),
-                        height: z.number().optional().default(512).describe("Height of the image in pixels"),
-                    }).optional(),
-                }).describe("Image with assetId support for neural network responses"),
-            ])).describe("Report elements (charts and images) mapped by ID"),
-            outputFile: z.string().optional().describe("Output HTML file path"),
-            tempDirectory: z.string().optional().describe("Temporary directory for file storage (optional, will use REPORTS_DIR environment variable if set)"),
-        },
+    // Register the NEW, simplified tool
+    mcpServer.registerTool(createReportFromTextTool.name, {
+        description: createReportFromTextTool.description,
+        inputSchema: createReportFromTextTool.inputSchema,
     }, async (params) => {
-        // Handle case where arguments might be sent as a JSON string by Claude desktop
         let processedParams = params;
-        if (typeof params === 'string') {
-            try {
-                processedParams = JSON.parse(params);
-            }
-            catch (parseError) {
-                throw new Error('Invalid JSON string in arguments');
-            }
-        }
-        else if (params.arguments && typeof params.arguments === 'object') {
+        if (params.arguments && typeof params.arguments === 'object') {
             processedParams = params.arguments;
         }
-        // Extract parameters correctly, ensuring outputFile is not nested within elements
-        const { document, elements, charts, outputFile = 'report.html', tempDirectory } = processedParams;
-        // Поддержка обратной совместимости: если переданы charts, используем их как elements
-        const reportElements = elements || charts || {};
-        // Determine the output directory:
-        // 1. Use REPORTS_DIR environment variable if set
-        // 2. Fall back to tempDirectory parameter if provided
-        // 3. Default to system temp directory if neither is available
-        let outputDir;
-        if (process.env.REPORTS_DIR) {
-            outputDir = process.env.REPORTS_DIR;
-            // Ensure the reports directory exists
-            try {
-                fs.ensureDirSync(outputDir);
-            }
-            catch (error) {
-                throw new Error(`Cannot create or access the reports directory: ${outputDir}`);
-            }
-        }
-        else if (tempDirectory) {
-            outputDir = tempDirectory;
-        }
-        else {
-            outputDir = os.tmpdir();
-        }
-        const outputPath = path.resolve(outputDir, outputFile);
-        try {
-            const result = await generateReport(document, reportElements, outputPath);
-            // Generate proper file URL
-            const fileUrl = pathToFileURL(outputPath).href;
-            // Read the file content
-            const fileContent = await fs.readFile(outputPath, 'utf8');
-            // Create a comprehensive result object
-            const comprehensiveResult = {
-                success: true,
-                message: "Report generated successfully",
-                filePath: outputPath,
-                fileUrl: fileUrl,
-                fileContent: fileContent
-            };
-            // Return comprehensive information for neural network to use
-            // Neural network should present to user: file path, web link, and file content
-            return {
-                content: [
-                    {
-                        type: "text",
-                        text: `Report generated successfully.
+        const result = await createReportFromTextTool.execute(processedParams);
+        const fileUrl = pathToFileURL(result.filePath).href;
+        const fileContent = await fs.readFile(result.filePath, 'utf8');
+        return {
+            content: [
+                {
+                    type: "text",
+                    text: `Report generated successfully.
 
 FOR THE NEURAL NETWORK: Please present the following information to the user:
-1. Path to file: ${outputPath}
+1. Path to file: ${result.filePath}
 2. Web browser link: ${fileUrl}
 3. File content:
 ${fileContent}`
-                    }
-                ]
-            };
-        }
-        catch (error) {
-            throw error;
-        }
+                }
+            ]
+        };
     });
     // Register a new tool for editing existing reports
     mcpServer.registerTool("edit-report", {

package/dist/tools/createReportFromText.d.ts

@@ -0,0 +1,17 @@
+import { z } from 'zod';
+export declare const createReportFromTextTool: {
+    name: string;
+    description: string;
+    inputSchema: {
+        documentText: z.ZodString;
+        outputFile: z.ZodString;
+    };
+    execute: ({ documentText, outputFile }: {
+        documentText: string;
+        outputFile: string;
+    }) => Promise<{
+        success: boolean;
+        filePath: string;
+    }>;
+};
+//# sourceMappingURL=createReportFromText.d.ts.map

package/dist/tools/createReportFromText.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createReportFromText.d.ts","sourceRoot":"","sources":["../../src/tools/createReportFromText.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAyCxB,eAAO,MAAM,wBAAwB;;;;;;;4CAOW;QAAE,YAAY,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAA;KAAE;;;;CAM3F,CAAC"}

package/dist/tools/createReportFromText.js

@@ -0,0 +1,49 @@
+import { generateReport } from '../utils/reportGenerator.js';
+import { z } from 'zod';
+// Эта функция будет извлекать данные из текста и генерировать элементы
+function extractElementsFromText(documentText) {
+    const elements = {};
+    let newDocument = documentText;
+    // Пример: ищем финансовые данные для графика
+    const revenueMatches = [...documentText.matchAll(/Доход: \$([\d,.]+) миллиарда/gi)];
+    if (revenueMatches.length > 0) {
+        const labels = revenueMatches.map((match, i) => `Квартал ${i + 1}`);
+        const data = revenueMatches.map(match => parseFloat(match[1].replace(/,/g, '')));
+        elements['revenue_chart'] = {
+            type: 'bar',
+            config: {
+                labels: labels,
+                datasets: [{
+                        label: 'Общий доход, млрд $',
+                        data: data,
+                        backgroundColor: ['rgba(54, 162, 235, 0.6)']
+                    }]
+            }
+        };
+        newDocument += '\n\n## Визуализация дохода\n\n[[chart:revenue_chart]]';
+    }
+    // Пример: добавляем изображение на основе контекста
+    if (/apple/i.test(documentText)) {
+        elements['context_image'] = {
+            type: 'pollinations',
+            config: {
+                prompt: 'a modern and sleek design representing apple products innovation'
+            }
+        };
+        newDocument += '\n\n## Иллюстрация\n\n[[image:context_image]]';
+    }
+    return { newDocument, elements };
+}
+export const createReportFromTextTool = {
+    name: "create-report-from-text",
+    description: "Creates a full HTML report from a given text by automatically generating charts and images.",
+    inputSchema: {
+        documentText: z.string().describe("The full text of the report in Markdown format."),
+        outputFile: z.string().describe("The desired output HTML file name (e.g., 'report.html').")
+    },
+    execute: async ({ documentText, outputFile }) => {
+        const { newDocument, elements } = extractElementsFromText(documentText);
+        // Вызываем старый генератор с автоматически созданными параметрами
+        return await generateReport(newDocument, elements, outputFile);
+    }
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vint.tri/report_gen_mcp",
-  "version": "1.7.28",
+  "version": "1.7.30",
   "description": "CLI tool for generating HTML reports with embedded charts and images",
   "main": "dist/index.js",
   "bin": {

package/NEURAL_NETWORK_INSTRUCTIONS.md

@@ -1,81 +0,0 @@
-# Финальные инструкции для нейросети по работе с инструментом report_gen_mcp v1.8.0
-
-**ВАЖНО:** ВСЕГДА ИСПОЛЬЗУЙТЕ ИНСТРУМЕНТ `report_gen_mcp` КАЖДЫЙ РАЗ, КОГДА ПОЛЬЗОВАТЕЛЬ ЗАПРАШИВАЕТ СОЗДАНИЕ ОТЧЕТА, ВИЗУАЛИЗАЦИЮ ДАННЫХ, ДИАГРАММУ, ГРАФИК ИЛИ ЛЮБОЕ ИЗМЕНЕНИЕ СУЩЕСТВУЮЩЕГО ОТЧЕТА!
-
-## 1. Обязательное использование инструмента
-
-**КЛЮЧЕВОЕ ПРАВИЛО:** При любом запросе пользователя, связанном с созданием или изменением отчетов, диаграмм или графиков, вы **обязаны** использовать инструмент `report_gen_mcp`. Не пытайтесь создавать отчеты вручную.
-
-## 2. Требования к качеству отчетов
-
-Каждый сгенерированный отчет должен быть:
-- **Информативным:** Содержать анализ данных, выводы и рекомендации.
-- **Визуально насыщенным:** Включать **как минимум одну диаграмму и одно изображение**, релевантные теме отчета.
-- **Красиво оформленным:** Использовать заголовки, списки и выделение текста для лучшей читаемости.
-
-## 3. Работа с файлами
-
-- **Сохранение:** Все отчеты автоматически сохраняются в **системную временную директорию**. Вам не нужно указывать полный путь — только имя файла в параметре `outputFile`.
-- **Возврат данных:** Инструмент вернет вам полный путь к созданному файлу, который вы должны предоставить пользователю вместе со ссылками для просмотра.
-
-## 4. Формат параметров (КРИТИЧЕСКИ ВАЖНО!)
-
-### 4.1. Параметр `elements`
-
-- `elements` **ВСЕГДА** должен быть **ОБЪЕКТОМ**, а не строкой.
-
-  - ❌ **НЕПРАВИЛЬНО:** `"elements": "{...}"`
-  - ✅ **ПРАВИЛЬНО:** `"elements": {...}`
-
-### 4.2. Параметры диаграмм (`charts`)
-
-- **Массивы, массивы и еще раз массивы!**
-  - `labels`: **ВСЕГДА** массив строк. `["Январь"]`
-  - `data`: **ВСЕГДА** массив чисел. `[100]`
-  - `backgroundColor`: **ВСЕГДА** массив строк. `["red"]`
-  - `borderColor`: **ВСЕГДА** массив строк. `["blue"]`
-- `options.title`: **ВСЕГДА** простая строка. `"Мой график"`
-
-**Примечание:** Система теперь пытается автоматически исправлять некоторые ошибки форматирования (например, одиночные значения в массивы или парсинг строки `elements`), но для гарантированной работы **всегда** придерживайтесь правильного формата.
-
-## 5. Пример идеального вызова
-
-```json
-{
-  "method": "generate-report",
-  "params": {
-    "document": "# Отчет о продажах\n\nАнализ квартальных продаж.\n\n[[chart:sales]]\n\n![бизнес-успех]([[image:success]])",
-    "elements": {
-      "sales": {
-        "type": "bar",
-        "config": {
-          "labels": ["Q1", "Q2", "Q3", "Q4"],
-          "datasets": [{
-            "label": "Продажи 2024",
-            "data": [120, 150, 130, 180],
-            "backgroundColor": ["#FF6384", "#36A2EB", "#FFCE56", "#4BC0C0"]
-          }],
-          "options": {
-            "title": "Квартальные продажи"
-          }
-        }
-      },
-      "success": {
-        "type": "pollinations",
-        "config": {
-          "prompt": "график роста и успеха в бизнесе"
-        }
-      }
-    },
-    "outputFile": "sales_report.html"
-  }
-}
-```
-
-## 6. Ответ пользователю
-
-После успешной генерации отчета предоставьте пользователю:
-1.  **Путь к файлу** (из ответа инструмента).
-2.  **Ссылку `file://`** для локального открытия.
-3.  **Ссылку `http://localhost:3000/...`** (Web link 2) для надежного отображения всех элементов.
-4.  **Полное содержимое HTML-файла**.