npm - @vint.tri/report_gen_mcp - Versions diffs - 1.2.2 → 1.3.1 - Mend

@vint.tri/report_gen_mcp 1.2.2 → 1.3.1

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.

Files changed (11) hide show

package/IMPROVED_AI_INSTRUCTIONS.md +468 -0
package/IMPROVED_NEURAL_NETWORK_INSTRUCTIONS.md +468 -0
package/PUBLICATION_CONFIRMATION.md +27 -32
package/README.md +4 -4
package/REPORT_TOOL_USAGE_RULE.md +32 -0
package/UPDATED_AI_INSTRUCTIONS.md +504 -0
package/UPDATED_NEURAL_NETWORK_INSTRUCTIONS.md +504 -0
package/dist/index.js +1 -1
package/dist/utils/reportGenerator.js +56 -5
package/package.json +1 -1
package/test_neural_network_instructions.js +105 -0

package/UPDATED_NEURAL_NETWORK_INSTRUCTIONS.md ADDED Viewed

@@ -0,0 +1,504 @@
+# ОБНОВЛЕННЫЕ Инструкции для нейросети по работе с инструментом report_gen_mcp
+**ВАЖНО:** ВСЕГДА ИСПОЛЬЗУЙТЕ ИНСТРУМЕНТ `report_gen_mcp` КАЖДЫЙ РАЗ, КОГДА ПОЛЬЗОВАТЕЛЬ ЗАПРАШИВАЕТ СОЗДАНИЕ ОТЧЕТА ИЛИ ВИЗУАЛИЗАЦИИ ДАННЫХ!
+Этот документ содержит специальные инструкции для нейросети при работе с инструментом `report_gen_mcp`, чтобы обеспечить правильное взаимодействие с пользователем после генерации отчетов.
+## Обязательное использование инструмента
+**КЛЮЧЕВОЕ ПРАВИЛО:** КАЖДЫЙ РАЗ, КОГДА ПОЛЬЗОВАТЕЛЬ ХОЧЕТ ПОЛУЧИТЬ ОТЧЕТ, ВИЗУАЛИЗАЦИЮ ДАННЫХ, ДИАГРАММУ ИЛИ ГРАФИК, НЕЗАВИСИМО ОТ ФОРМАТА ЗАПРОСА, ВЫ ДОЛЖНЫ ИСПОЛЬЗОВАТЬ ИНСТРУМЕНТ `report_gen_mcp`!
+НЕ пытайтесь создавать отчеты самостоятельно или предлагать пользователю делать это вручную. ВСЕГДА используйте инструмент `report_gen_mcp`.
+## Общие принципы работы
+При использовании инструмента `report_gen_mcp` для генерации отчетов, нейросеть должна следовать определенному протоколу взаимодействия с пользователем, чтобы обеспечить полную и удобную работу с созданными отчетами.
+## Поддерживаемые элементы отчета
+Инструмент поддерживает вставку в отчеты следующих элементов:
+1. **Диаграммы** (charts) - различные типы графиков (bar, line, pie, doughnut, radar, polarArea)
+2. **Изображения** (images) - два типа:
+   - Сгенерированные сервисом pollinations.ai по текстовому описанию
+   - По URL из интернета
+## Требования к оформлению отчетов
+При создании отчетов необходимо придерживаться следующих требований по оформлению:
+1. **Красивое форматирование**:
+   - Используйте заголовки разных уровней (H1, H2, H3) для структурирования контента
+   - Добавляйте списки (маркированные и нумерованные) для лучшей читаемости
+   - Используйте выделение важной информации (жирный шрифт, курсив)
+   - Разделяйте смысловые блоки пустыми строками
+2. **Визуализация данных**:
+   - Всегда добавляйте диаграммы для числовых данных
+   - Выбирайте подходящий тип диаграммы в зависимости от характера данных
+   - Добавляйте поясняющие подписи к диаграммам
+   - Используйте разнообразные цвета для лучшей визуализации
+3. **Изображения**:
+   - Добавляйте тематические изображения для иллюстрации контента
+   - Используйте изображения высокого качества
+   - Добавляйте альтернативный текст для изображений
+   - При необходимости регулируйте размеры изображений
+## После генерации отчета
+После успешной генерации отчета с помощью метода `generate-report`, нейросеть получает всю необходимую информацию напрямую в ответе от метода. Необходимо предоставить пользователю следующую информацию:
+### 1. Предоставление информации пользователю
+Из ответа метода `generate-report` извлеките следующую информацию и предоставьте пользователю:
+1. **Путь к файлу**: Абсолютный путь к созданному отчету
+2. **Ссылка на файл**: Кликабельная file:// ссылка для открытия отчета в браузере
+3. **Содержимое файла**: Полный текст HTML содержимого отчета
+Обязательно покажите пользователю содержимое файла, чтобы он мог сразу ознакомиться с результатом без необходимости открывать файл отдельно.
+Пример формата ответа пользователю:
+```
+Отчет успешно создан!
+📁 Путь к файлу: /полный/путь/к/отчету.html
+🌐 Ссылка для открытия в браузере: file:///полный/путь/к/отчету.html
+📄 Содержимое отчета:
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="UTF-8">
+  <title>Report</title>
+  <style>
+    body { font-family: Arial, sans-serif; }
+    .chart-container, .image-container { margin: 20px 0; }
+  </style>
+  <script src="https://cdn.jsdelivr.net/npm/chart.js"></script>
+</head>
+<body>
+  <h1>Отчет</h1>
+  <div class="chart-container">
+    <!-- Chart.js chart code -->
+  </div>
+  <div class="image-container">
+    <!-- Generated image -->
+    <img src="https://image.pollinations.ai/prompt/красивый%20закат" alt="красивый закат">
+  </div>
+</body>
+</html>
+Вы можете открыть отчет, кликнув на ссылку выше или скопировав путь к файлу.
+```
+### 2. Альтернативный подход (при необходимости)
+Если по какой-то причине информация не была получена напрямую из метода `generate-report`, можно использовать дополнительные инструменты:
+#### Получение информации о файле
+Используйте инструмент `get-report-url` для получения полной информации о созданном отчете:
+```json
+{
+  "method": "tools/call",
+  "params": {
+    "name": "get-report-url",
+    "arguments": {
+      "filePath": "/путь/к/созданному/отчету.html"
+    }
+  }
+}
+```
+#### Прикрепление содержимого файла
+Для того чтобы пользователь мог сразу просмотреть содержимое отчета без необходимости открывать файл, используйте инструмент `get-report-file`:
+```json
+{
+  "method": "tools/call",
+  "params": {
+    "name": "get-report-file",
+    "arguments": {
+      "filePath": "/путь/к/созданному/отчету.html"
+    }
+  }
+}
+```
+## Формат данных для диаграмм (графиков)
+Очень важно правильно формировать данные для диаграмм, чтобы избежать ошибок. Ниже приведены точные требования к формату данных для каждого типа диаграмм.
+### Общие правила для всех типов диаграмм
+1. Все цветовые значения (`backgroundColor`, `borderColor`) должны быть представлены в виде **массивов строк**, даже если это один цвет.
+2. Все числовые данные (`data`) должны быть представлены в виде массивов чисел.
+3. Все текстовые метки (`labels`) должны быть представлены в виде массивов строк.
+### Линейные диаграммы (line)
+```json
+{
+  "type": "line",
+  "config": {
+    "labels": ["Январь", "Февраль", "Март", "Апрель", "Май"],
+    "datasets": [
+      {
+        "label": "Продажи (USD)",
+        "data": [12000, 19000, 15000, 18000, 22000],
+        "borderColor": ["rgba(54, 162, 235, 1)"], // ВАЖНО: массив, даже для одного цвета!
+        "fill": false
+      }
+    ],
+    "options": {
+      "title": "Ежемесячные продажи"
+    }
+  }
+}
+```
+**Важно**: `borderColor` должен быть массивом строк, даже если используется только один цвет.
+### Столбчатые диаграммы (bar)
+```json
+{
+  "type": "bar",
+  "config": {
+    "labels": ["Январь", "Февраль", "Март", "Апрель", "Май"],
+    "datasets": [
+      {
+        "label": "Продажи (USD)",
+        "data": [12000, 19000, 15000, 18000, 22000],
+        "backgroundColor": ["#FF6384", "#36A2EB", "#FFCE56", "#4BC0C0", "#9966FF"], // Массив цветов
+        "borderColor": ["#FF6384", "#36A2EB", "#FFCE56", "#4BC0C0", "#9966FF"] // Массив цветов
+      }
+    ],
+    "options": {
+      "title": "Ежемесячные продажи"
+    }
+  }
+}
+```
+**Важно**: `backgroundColor` и `borderColor` должны быть массивами строк, даже если используется только один цвет.
+### Круговые диаграммы (pie)
+```json
+{
+  "type": "pie",
+  "config": {
+    "labels": ["Красный", "Синий", "Желтый", "Зеленый", "Фиолетовый"],
+    "datasets": [
+      {
+        "data": [12, 19, 3, 5, 2],
+        "backgroundColor": ["#FF6384", "#36A2EB", "#FFCE56", "#4BC0C0", "#9966FF"], // Массив цветов
+        "borderColor": ["#FF6384", "#36A2EB", "#FFCE56", "#4BC0C0", "#9966FF"] // Массив цветов
+      }
+    ],
+    "options": {
+      "title": "Распределение по категориям"
+    }
+  }
+}
+```
+**Важно**: `backgroundColor` и `borderColor` должны быть массивами строк, даже если используется только один цвет.
+### Кольцевые диаграммы (doughnut)
+```json
+{
+  "type": "doughnut",
+  "config": {
+    "labels": ["Красный", "Синий", "Желтый", "Зеленый", "Фиолетовый"],
+    "datasets": [
+      {
+        "data": [12, 19, 3, 5, 2],
+        "backgroundColor": ["#FF6384", "#36A2EB", "#FFCE56", "#4BC0C0", "#9966FF"], // Массив цветов
+        "borderColor": ["#FF6384", "#36A2EB", "#FFCE56", "#4BC0C0", "#9966FF"] // Массив цветов
+      }
+    ],
+    "options": {
+      "title": "Распределение по категориям"
+    }
+  }
+}
+```
+**Важно**: `backgroundColor` и `borderColor` должны быть массивами строк, даже если используется только один цвет.
+### Радарные диаграммы (radar)
+```json
+{
+  "type": "radar",
+  "config": {
+    "labels": ["Eating", "Drinking", "Sleeping", "Designing", "Coding", "Cycling", "Running"],
+    "datasets": [
+      {
+        "label": "Person 1",
+        "data": [65, 59, 90, 81, 56, 55, 40],
+        "backgroundColor": ["rgba(255, 99, 132, 0.2)"], // Массив цветов
+        "borderColor": ["rgba(255, 99, 132, 1)"] // Массив цветов
+      }
+    ],
+    "options": {
+      "title": "Радарная диаграмма"
+    }
+  }
+}
+```
+**Важно**: `backgroundColor` и `borderColor` должны быть массивами строк, даже если используется только один цвет.
+### Полярные диаграммы (polarArea)
+```json
+{
+  "type": "polarArea",
+  "config": {
+    "labels": ["Red", "Green", "Yellow", "Grey", "Blue"],
+    "datasets": [
+      {
+        "data": [11, 16, 7, 3, 14],
+        "backgroundColor": ["#FF6384", "#4BC0C0", "#FFCE56", "#E7E9ED", "#36A2EB"], // Массив цветов
+        "borderColor": ["#FF6384", "#4BC0C0", "#FFCE56", "#E7E9ED", "#36A2EB"] // Массив цветов
+      }
+    ],
+    "options": {
+      "title": "Полярная диаграмма"
+    }
+  }
+}
+```
+**Важно**: `backgroundColor` и `borderColor` должны быть массивами строк.
+## Формат данных для изображений
+### Изображения, сгенерированные pollinations.ai
+```json
+{
+  "type": "pollinations",
+  "config": {
+    "prompt": "красивый закат над океаном",
+    "width": 512,
+    "height": 512,
+    "model": "flux",
+    "seed": 12345,
+    "nologo": true,
+    "enhance": true
+  }
+}
+```
+### Изображения по URL
+```json
+{
+  "type": "url",
+  "config": {
+    "url": "https://example.com/image.jpg",
+    "alt": "Описание изображения",
+    "width": 500,
+    "height": 300
+  }
+}
+```
+## ПРАВИЛА ФОРМАТИРОВАНИЯ ПАРАМЕТРОВ (КРИТИЧЕСКИ ВАЖНО!)
+### 1. ПАРАМЕТР "elements" ДОЛЖЕН БЫТЬ ОБЪЕКТОМ!
+❌ НЕПРАВИЛЬНО (это вызывает ошибку "Expected object, received string"):
+```json
+{
+  "method": "generate-report",
+  "params": {
+    "document": "# Отчет\n\n[[chart:mychart]]",
+    "elements": "{ \"mychart\": { \"type\": \"bar\", \"config\": { \"labels\": [\"A\", \"B\", \"C\"], \"datasets\": [{ \"label\": \"Data\", \"data\": [1, 2, 3], \"backgroundColor\": [\"red\", \"green\", \"blue\"], \"borderColor\": [\"red\", \"green\", \"blue\"] }] } }",
+    "outputFile": "report.html"
+  }
+}
+```
+✅ ПРАВИЛЬНО (elements - это объект, а не строка):
+```json
+{
+  "method": "generate-report",
+  "params": {
+    "document": "# Отчет\n\n[[chart:mychart]]",
+    "elements": {
+      "mychart": {
+        "type": "bar",
+        "config": {
+          "labels": ["A", "B", "C"],
+          "datasets": [{
+            "label": "Data",
+            "data": [1, 2, 3],
+            "backgroundColor": ["red", "green", "blue"],
+            "borderColor": ["red", "green", "blue"]
+          }]
+        }
+      }
+    },
+    "outputFile": "report.html"
+  }
+}
+```
+### 2. ЦВЕТОВЫЕ ЗНАЧЕНИЯ ДОЛЖНЫ БЫТЬ МАССИВАМИ!
+❌ НЕПРАВИЛЬНО (это вызывает ошибку):
+```json
+"backgroundColor": "red"
+"borderColor": "blue"
+```
+✅ ПРАВИЛЬНО (всегда используйте массивы):
+```json
+"backgroundColor": ["red"]
+"borderColor": ["blue"]
+```
+### 3. ЧИСЛОВЫЕ ДАННЫЕ ДОЛЖНЫ БЫТЬ МАССИВАМИ!
+❌ НЕПРАВИЛЬНО:
+```json
+"data": 10
+```
+✅ ПРАВИЛЬНО:
+```json
+"data": [10]
+```
+### 4. ТЕКСТОВЫЕ МЕТКИ ДОЛЖНЫ БЫТЬ МАССИВАМИ!
+❌ НЕПРАВИЛЬНО:
+```json
+"labels": "Январь"
+```
+✅ ПРАВИЛЬНО:
+```json
+"labels": ["Январь"]
+```
+## Пример полного взаимодействия
+Вот пример того, как должно выглядеть полное взаимодействие с пользователем после генерации отчета:
+1. Генерация отчета:
+```json
+{
+  "method": "generate-report",
+  "params": {
+    "document": "# Отчет\n\n[[chart:mychart]]\n\n[[image:myimage]]",
+    "elements": {
+      "mychart": {
+        "type": "bar",
+        "config": {
+          "labels": ["A", "B", "C"],
+          "datasets": [{
+            "label": "Data",
+            "data": [1, 2, 3],
+            "backgroundColor": ["red", "green", "blue"],
+            "borderColor": ["red", "green", "blue"]
+          }]
+        }
+      },
+      "myimage": {
+        "type": "pollinations",
+        "config": {
+          "prompt": "beautiful landscape with mountains",
+          "width": 600,
+          "height": 400
+        }
+      }
+    },
+    "outputFile": "report.html"
+  }
+}
+```
+2. Ответ от метода `generate-report` уже содержит всю необходимую информацию:
+```json
+{
+  "content": [
+    {
+      "type": "text",
+      "text": "Report generated successfully.\n\nFOR THE NEURAL NETWORK: Please present the following information to the user:\n1. Path to file: /path/to/report.html\n2. Web browser link: file:///path/to/report.html\n3. File content:\n<!DOCTYPE html>\n<html>...</html>"
+    }
+  ]
+}
+```
+3. Ответ пользователю (на основе информации из ответа метода):
+```
+Отчет успешно создан!
+📁 Путь к файлу: /path/to/report.html
+🌐 Ссылка для открытия в браузере: file:///path/to/report.html
+Содержимое отчета:
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="UTF-8">
+  <title>Report</title>
+  <style>
+    body { font-family: Arial, sans-serif; }
+    .chart-container, .image-container { margin: 20px 0; }
+  </style>
+  <script src="https://cdn.jsdelivr.net/npm/chart.js"></script>
+</head>
+<body>
+  <h1>Отчет</h1>
+  <div class="chart-container">
+    <!-- Chart.js chart code -->
+  </div>
+  <div class="image-container">
+    <!-- Generated image -->
+    <img src="https://image.pollinations.ai/prompt/beautiful%20landscape%20with%20mountains" alt="beautiful landscape with mountains">
+  </div>
+</body>
+</html>
+Вы можете открыть отчет, кликнув на ссылку выше или скопировав путь к файлу.
+```
+## Частые ошибки и как их избежать
+1. **Ошибка формата параметров**: Передача `elements` как строки вместо объекта
+   - ❌ Неправильно: `"elements": "{\"mychart\":{...}}"`
+   - ✅ Правильно: `"elements": {"mychart":{...}}`
+2. **Ошибка формата цвета**: Передача `borderColor` или `backgroundColor` как строк вместо массивов
+   - ❌ Неправильно: `"borderColor": "red"`
+   - ✅ Правильно: `"borderColor": ["red"]`
+3. **Ошибка формата данных**: Передача числовых данных как отдельных значений вместо массивов
+   - ❌ Неправильно: `"data": 10`
+   - ✅ Правильно: `"data": [10]`
+4. **Ошибка формата меток**: Передача меток как отдельных значений вместо массивов
+   - ❌ Неправильно: `"labels": "Январь"`
+   - ✅ Правильно: `"labels": ["Январь"]`
+## Дополнительные рекомендации
+1. Всегда проверяйте успешность выполнения каждой операции перед переходом к следующему шагу
+2. Если какой-либо шаг завершается ошибкой, сообщите пользователю об этом и предложите решение
+3. Убедитесь, что все пути к файлам корректны и файлы действительно существуют
+4. При работе с Claude Desktop используйте параметр `tempDirectory` при генерации отчетов для избежания проблем с правами доступа
+5. Создавайте отчеты с красивым оформлением, используя заголовки, списки и другие элементы форматирования
+6. Добавляйте в отчеты диаграммы и изображения для лучшей визуализации данных
+Следование этим инструкциям обеспечит качественное и полное взаимодействие с пользователем при работе с инструментом генерации отчетов.

package/dist/index.js CHANGED Viewed

@@ -102,7 +102,7 @@ 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.2.1",
+        version: "1.3.1",
     }, {
         // Disable health check to prevent automatic calls
         capabilities: {

package/dist/utils/reportGenerator.js CHANGED Viewed

@@ -100,18 +100,69 @@ export async function generateReport(document, elements, outputFile) {
     // Wrap in full HTML template with Chart.js library
     const template = `
   <!DOCTYPE html>
-  <html lang="en">
+  <html lang="ru">
   <head>
     <meta charset="UTF-8">
-    <title>Report</title>
+    <title>Отчет</title>
     <style>
-      body { font-family: Arial, sans-serif; }
-      .chart-container, .image-container { margin: 20px 0; }
+      body {
+        font-family: Arial, sans-serif;
+        margin: 40px;
+        background-color: #f5f5f5;
+      }
+      .container {
+        max-width: 1200px;
+        margin: 0 auto;
+        background-color: white;
+        padding: 30px;
+        border-radius: 10px;
+        box-shadow: 0 0 10px rgba(0,0,0,0.1);
+      }
+      h1, h2, h3 {
+        color: #333;
+      }
+      h1 {
+        border-bottom: 2px solid #3498db;
+        padding-bottom: 10px;
+      }
+      h2 {
+        border-left: 4px solid #3498db;
+        padding-left: 15px;
+      }
+      .chart-container, .image-container {
+        margin: 30px 0;
+        text-align: center;
+      }
+      .chart-container canvas, .image-container img {
+        max-width: 100%;
+        height: auto;
+        border: 1px solid #ddd;
+        border-radius: 5px;
+      }
+      p {
+        line-height: 1.6;
+        text-align: justify;
+      }
+      ul, ol {
+        margin: 20px 0;
+        padding-left: 30px;
+      }
+      li {
+        margin: 10px 0;
+      }
+      strong {
+        color: #e74c3c;
+      }
+      em {
+        color: #2ecc71;
+      }
     </style>
     <script src="https://cdn.jsdelivr.net/npm/chart.js"></script>
   </head>
   <body>
-    <%- htmlContent %>
+    <div class="container">
+      <%- htmlContent %>
+    </div>
   </body>
   </html>
   `;

package/package.json CHANGED Viewed

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