npm - @vint.tri/report_gen_mcp - Versions diffs - 1.0.46 → 1.1.0 - Mend

@vint.tri/report_gen_mcp 1.0.46 → 1.1.0

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 (2805) hide show

package/README.md CHANGED Viewed

@@ -23,7 +23,7 @@ npm install -g @vint.tri/report_gen_mcp@1.0.45
 ### Direct Execution with npx
 ```bash
-REPORTS_DIR=./reports npx @vint.tri/report_gen_mcp@1.0.45
+REPORTS_DIR=./reports npx @vint.tri/report_gen_mcp@1.0.43
 ```
 ## Usage
@@ -96,6 +96,17 @@ When calling the `generate-report` method, you need to provide three main pieces
 2. **charts**: An object mapping chart IDs to their configurations
 3. **outputFile**: (Optional) The name of the output HTML file
+#### After Generating a Report
+After successfully generating a report, it's important to provide the user with complete information about the generated file. To do this, you should use the `get-report-url` and `get-report-file` tools:
+1. **Provide File Path and URL**: Use the `get-report-url` tool to get the file path and a clickable URL for the report
+2. **Attach the File Content**: Use the `get-report-file` tool to retrieve and attach the actual file content
+This ensures that users receive:
+- The absolute file path to the generated report
+- A clickable file:// URL to open the report directly in a browser
 #### Document Format
 Your document should be a Markdown string that can include chart placeholders in the format `[[chart:chartId]]`. For example:
@@ -366,9 +377,10 @@ npm test
 ### Methods
 1. `generate-report`: Creates an HTML report with embedded charts
-2. `get-report-url`: Returns a clickable URL for a generated report file
-3. `health`: Checks if the tool is running correctly
-4. `mcp:list-tools`: Returns available tools (used by Claude Desktop)
+2. `get-report-url`: Returns a clickable URL for a generated report file and shows all available formats
+3. `get-report-file`: Returns the content of a generated report file
+4. `health`: Checks if the tool is running correctly
+5. `mcp:list-tools`: Returns available tools (used by Claude Desktop)
 ### Method Details
@@ -393,7 +405,7 @@ npm test
 #### get-report-url
-**Description:** Get a clickable URL for a generated report file
+**Description:** Get information about a generated report file including a clickable URL and file statistics
 **Parameters:**
 - `filePath` (string): Full path to the report file
@@ -402,12 +414,48 @@ npm test
 ```json
 {
   "success": true,
+  "message": "Report file information retrieved successfully",
+  "filePath": "/absolute/path/to/report.html",
+  "relativePath": "report.html",
   "fileUrl": "file:///absolute/path/to/report.html",
-  "message": "Click the URL to open the report",
+  "fileStats": {
+    "size": 12345,
+    "created": "2023-01-01T00:00:00.000Z",
+    "modified": "2023-01-01T00:00:00.000Z"
+  }
+}
+```
+**Note:** This method only returns metadata about the file, not the file content itself. Use `get-report-file` to retrieve the actual file content.
+#### get-report-file
+**Description:** Get the content of a generated report file
+**Parameters:**
+- `filePath` (string): Full path to the report file
+**Response:**
+```json
+{
+  "success": true,
+  "message": "Report file content retrieved successfully",
   "filePath": "/absolute/path/to/report.html"
 }
 ```
+The file content is returned as a resource attachment in the response with the following structure:
+```json
+{
+  "type": "resource",
+  "resource": {
+    "uri": "file:///absolute/path/to/report.html",
+    "mimeType": "text/html",
+    "text": "<!DOCTYPE html><html>...</html>"
+  }
+}
+```
 #### health
 **Response:**

package/dist/charts/bar.js CHANGED Viewed

@@ -1,23 +1,19 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.barSchema = void 0;
-exports.renderBarChart = renderBarChart;
-const zod_1 = require("zod");
-const chartjs_node_canvas_1 = require("chartjs-node-canvas");
-exports.barSchema = zod_1.z.object({
-    labels: zod_1.z.array(zod_1.z.string()),
-    datasets: zod_1.z.array(zod_1.z.object({
-        label: zod_1.z.string(),
-        data: zod_1.z.array(zod_1.z.number()),
-        backgroundColor: zod_1.z.array(zod_1.z.string()).optional(),
-        borderColor: zod_1.z.array(zod_1.z.string()).optional(),
+import { z } from 'zod';
+import { ChartJSNodeCanvas } from 'chartjs-node-canvas';
+export const barSchema = z.object({
+    labels: z.array(z.string()),
+    datasets: z.array(z.object({
+        label: z.string(),
+        data: z.array(z.number()),
+        backgroundColor: z.array(z.string()).optional(),
+        borderColor: z.array(z.string()).optional(),
     })),
-    options: zod_1.z.object({
-        title: zod_1.z.string().optional(),
+    options: z.object({
+        title: z.string().optional(),
         // Add more Chart.js options as needed
     }).optional(),
 });
-async function renderBarChart(config) {
+export async function renderBarChart(config) {
     const chartConfig = {
         type: 'bar',
         data: {
@@ -36,7 +32,7 @@ async function renderBarChart(config) {
     };
     const width = 800;
     const height = 600;
-    const chartJSNodeCanvas = new chartjs_node_canvas_1.ChartJSNodeCanvas({ width, height });
+    const chartJSNodeCanvas = new ChartJSNodeCanvas({ width, height });
     const buffer = await chartJSNodeCanvas.renderToBuffer(chartConfig);
     const base64Image = buffer.toString('base64');
     return `<img src="data:image/png;base64,${base64Image}" alt="Chart" />`;

package/dist/charts/line.js CHANGED Viewed

@@ -1,23 +1,19 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.lineSchema = void 0;
-exports.renderLineChart = renderLineChart;
-const zod_1 = require("zod");
-const chartjs_node_canvas_1 = require("chartjs-node-canvas");
-exports.lineSchema = zod_1.z.object({
-    labels: zod_1.z.array(zod_1.z.string()),
-    datasets: zod_1.z.array(zod_1.z.object({
-        label: zod_1.z.string(),
-        data: zod_1.z.array(zod_1.z.number()),
-        borderColor: zod_1.z.array(zod_1.z.string()).optional(),
-        fill: zod_1.z.boolean().optional(),
+import { z } from 'zod';
+import { ChartJSNodeCanvas } from 'chartjs-node-canvas';
+export const lineSchema = z.object({
+    labels: z.array(z.string()),
+    datasets: z.array(z.object({
+        label: z.string(),
+        data: z.array(z.number()),
+        borderColor: z.array(z.string()).optional(),
+        fill: z.boolean().optional(),
     })),
-    options: zod_1.z.object({
-        title: zod_1.z.string().optional(),
+    options: z.object({
+        title: z.string().optional(),
         // Add more Chart.js options as needed
     }).optional(),
 });
-async function renderLineChart(config) {
+export async function renderLineChart(config) {
     const chartConfig = {
         type: 'line',
         data: {
@@ -36,7 +32,7 @@ async function renderLineChart(config) {
     };
     const width = 800;
     const height = 600;
-    const chartJSNodeCanvas = new chartjs_node_canvas_1.ChartJSNodeCanvas({ width, height });
+    const chartJSNodeCanvas = new ChartJSNodeCanvas({ width, height });
     const buffer = await chartJSNodeCanvas.renderToBuffer(chartConfig);
     const base64Image = buffer.toString('base64');
     return `<img src="data:image/png;base64,${base64Image}" alt="Chart" />`;

package/dist/charts/pie.js CHANGED Viewed

@@ -1,22 +1,18 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.pieSchema = void 0;
-exports.renderPieChart = renderPieChart;
-const zod_1 = require("zod");
-const chartjs_node_canvas_1 = require("chartjs-node-canvas");
-exports.pieSchema = zod_1.z.object({
-    labels: zod_1.z.array(zod_1.z.string()),
-    datasets: zod_1.z.array(zod_1.z.object({
-        data: zod_1.z.array(zod_1.z.number()),
-        backgroundColor: zod_1.z.array(zod_1.z.string()).optional(),
-        borderColor: zod_1.z.array(zod_1.z.string()).optional(),
+import { z } from 'zod';
+import { ChartJSNodeCanvas } from 'chartjs-node-canvas';
+export const pieSchema = z.object({
+    labels: z.array(z.string()),
+    datasets: z.array(z.object({
+        data: z.array(z.number()),
+        backgroundColor: z.array(z.string()).optional(),
+        borderColor: z.array(z.string()).optional(),
     })),
-    options: zod_1.z.object({
-        title: zod_1.z.string().optional(),
+    options: z.object({
+        title: z.string().optional(),
         // Add more Chart.js options as needed
     }).optional(),
 });
-async function renderPieChart(config) {
+export async function renderPieChart(config) {
     const chartConfig = {
         type: 'pie',
         data: {
@@ -35,7 +31,7 @@ async function renderPieChart(config) {
     };
     const width = 800;
     const height = 600;
-    const chartJSNodeCanvas = new chartjs_node_canvas_1.ChartJSNodeCanvas({ width, height });
+    const chartJSNodeCanvas = new ChartJSNodeCanvas({ width, height });
     const buffer = await chartJSNodeCanvas.renderToBuffer(chartConfig);
     const base64Image = buffer.toString('base64');
     return `<img src="data:image/png;base64,${base64Image}" alt="Chart" />`;

package/dist/index.js CHANGED Viewed

@@ -1,19 +1,14 @@
 #!/usr/bin/env node
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const express_1 = __importDefault(require("express"));
-const commander_1 = require("commander");
-const reportGenerator_1 = require("./utils/reportGenerator");
-const path_1 = __importDefault(require("path"));
-const fs_extra_1 = __importDefault(require("fs-extra"));
-const os_1 = __importDefault(require("os"));
-const mcp_js_1 = require("@modelcontextprotocol/sdk/server/mcp.js");
-const stdio_js_1 = require("@modelcontextprotocol/sdk/server/stdio.js");
-const zod_1 = require("zod");
-const url_1 = require("url");
+import express from 'express';
+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';
 // 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
@@ -31,7 +26,7 @@ if (!isStdioMode) {
     }
     // Ensure the reports directory exists
     try {
-        fs_extra_1.default.ensureDirSync(reportsDir);
+        fs.ensureDirSync(reportsDir);
     }
     catch (error) {
         console.error(`Error: Cannot create or access the reports directory: ${reportsDir}`);
@@ -39,18 +34,18 @@ if (!isStdioMode) {
         process.exit(1);
     }
 }
-const app = (0, express_1.default)();
+const app = express();
 const port = 3000;
-app.use(express_1.default.json());
+app.use(express.json());
 app.post('/generate-report', async (req, res) => {
     // For HTTP API mode, use the REPORTS_DIR environment variable
     // This endpoint only runs in non-stdio mode where reportsDir is guaranteed to be defined
     const { document, charts, outputFile = 'report.html' } = req.body;
-    const outputPath = path_1.default.resolve(reportsDir, outputFile);
+    const outputPath = path.resolve(reportsDir, outputFile);
     try {
-        const result = await (0, reportGenerator_1.generateReport)(document, charts, outputPath);
+        const result = await generateReport(document, charts, outputPath);
         // Send the file content back to the client
-        const fileContent = await fs_extra_1.default.readFile(outputPath, 'utf8');
+        const fileContent = await fs.readFile(outputPath, 'utf8');
         res.json({
             ...result,
             fileContent: fileContent
@@ -60,7 +55,7 @@ app.post('/generate-report', async (req, res) => {
         res.status(500).json({ error: error.message });
     }
 });
-commander_1.program
+program
     .command('start-server')
     .description('Start the MCP report generation server')
     .action(() => {
@@ -68,7 +63,7 @@ commander_1.program
         console.log(`Server running at http://localhost:${port}`);
     });
 });
-commander_1.program
+program
     .command('generate')
     .option('--document <md>', 'Markdown document with placeholders [[chart:id]]')
     .option('--charts <json>', 'JSON string of charts {id: {type: "bar", config: {...}}}')
@@ -78,13 +73,13 @@ commander_1.program
     const charts = JSON.parse(opts.charts);
     // Read the document file content if a file path is provided
     let documentContent = opts.document;
-    if (opts.document && fs_extra_1.default.existsSync(opts.document)) {
-        documentContent = await fs_extra_1.default.readFile(opts.document, 'utf8');
+    if (opts.document && fs.existsSync(opts.document)) {
+        documentContent = await fs.readFile(opts.document, 'utf8');
     }
     // This command only runs in non-stdio mode where reportsDir is guaranteed to be defined
-    const result = await (0, reportGenerator_1.generateReport)(documentContent, charts, path_1.default.resolve(reportsDir, opts.output));
+    const result = await generateReport(documentContent, charts, path.resolve(reportsDir, opts.output));
     // Generate proper file URL for CLI mode
-    const fileUrl = (0, url_1.pathToFileURL)(result.filePath).href;
+    const fileUrl = pathToFileURL(result.filePath).href;
     const resultWithUrl = {
         ...result,
         fileUrl: fileUrl
@@ -94,7 +89,7 @@ commander_1.program
 // Handle stdio mode for Claude Desktop integration
 if (process.argv.length === 2) {
     // No command specified, run in stdio mode using MCP SDK
-    const mcpServer = new mcp_js_1.McpServer({
+    const mcpServer = new McpServer({
         name: "report_gen_mcp",
         version: "1.0.31",
     }, {
@@ -107,25 +102,25 @@ if (process.argv.length === 2) {
     mcpServer.registerTool("generate-report", {
         description: "Generate an HTML report with embedded charts",
         inputSchema: {
-            document: zod_1.z.string().describe("Markdown document with chart placeholders [[chart:id]]"),
-            charts: zod_1.z.record(zod_1.z.object({
-                type: zod_1.z.enum(["bar", "line", "pie"]),
-                config: zod_1.z.object({
-                    labels: zod_1.z.array(zod_1.z.string()),
-                    datasets: zod_1.z.array(zod_1.z.object({
-                        label: zod_1.z.string().optional(),
-                        data: zod_1.z.array(zod_1.z.number()),
-                        backgroundColor: zod_1.z.array(zod_1.z.string()).optional(),
-                        borderColor: zod_1.z.array(zod_1.z.string()).optional(),
-                        fill: zod_1.z.boolean().optional(),
+            document: z.string().describe("Markdown document with chart placeholders [[chart:id]]"),
+            charts: z.record(z.object({
+                type: z.enum(["bar", "line", "pie"]),
+                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: zod_1.z.object({
-                        title: zod_1.z.string().optional(),
+                    options: z.object({
+                        title: z.string().optional(),
                     }).optional(),
                 }),
             })).describe("Chart configurations mapped by ID"),
-            outputFile: zod_1.z.string().optional().describe("Output HTML file path"),
-            tempDirectory: zod_1.z.string().optional().describe("Temporary directory for file storage (optional, will use REPORTS_DIR environment variable if set)"),
+            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)"),
         },
     }, async (params) => {
         // Handle case where arguments might be sent as a JSON string by Claude desktop
@@ -151,7 +146,7 @@ if (process.argv.length === 2) {
             outputDir = process.env.REPORTS_DIR;
             // Ensure the reports directory exists
             try {
-                fs_extra_1.default.ensureDirSync(outputDir);
+                fs.ensureDirSync(outputDir);
             }
             catch (error) {
                 throw new Error(`Cannot create or access the reports directory: ${outputDir}`);
@@ -161,13 +156,13 @@ if (process.argv.length === 2) {
             outputDir = tempDirectory;
         }
         else {
-            outputDir = os_1.default.tmpdir();
+            outputDir = os.tmpdir();
         }
-        const outputPath = path_1.default.resolve(outputDir, outputFile);
+        const outputPath = path.resolve(outputDir, outputFile);
         try {
-            const result = await (0, reportGenerator_1.generateReport)(document, charts, outputPath);
+            const result = await generateReport(document, charts, outputPath);
             // Generate proper file URL
-            const fileUrl = (0, url_1.pathToFileURL)(outputPath).href;
+            const fileUrl = pathToFileURL(outputPath).href;
             return {
                 content: [
                     {
@@ -190,15 +185,15 @@ if (process.argv.length === 2) {
     mcpServer.registerTool("get-report-url", {
         description: "Get a clickable URL for a generated report file",
         inputSchema: {
-            filePath: zod_1.z.string().describe("Full path to the report file")
+            filePath: z.string().describe("Full path to the report file")
         },
     }, async (params) => {
         const { filePath } = params;
         try {
             // Check if file exists
-            await fs_extra_1.default.access(filePath);
+            await fs.access(filePath);
             // Generate proper file URL
-            const fileUrl = (0, url_1.pathToFileURL)(filePath).href;
+            const fileUrl = pathToFileURL(filePath).href;
             return {
                 content: [
                     {
@@ -218,7 +213,7 @@ if (process.argv.length === 2) {
         }
     });
     async function main() {
-        const transport = new stdio_js_1.StdioServerTransport();
+        const transport = new StdioServerTransport();
         await mcpServer.connect(transport);
         console.log("MCP server is running...");
     }
@@ -229,5 +224,5 @@ if (process.argv.length === 2) {
 }
 else {
     // Run commander program when arguments are provided
-    commander_1.program.parse();
+    program.parse();
 }

package/dist/utils/reportGenerator.js CHANGED Viewed

@@ -1,23 +1,17 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateReport = generateReport;
-const fs_extra_1 = __importDefault(require("fs-extra"));
-const ejs_1 = __importDefault(require("ejs"));
-const marked_1 = require("marked");
-const bar_1 = require("../charts/bar");
-const line_1 = require("../charts/line");
-const pie_1 = require("../charts/pie");
+import fs from 'fs-extra';
+import ejs from 'ejs';
+import { marked } from 'marked';
+import { barSchema, renderBarChart } from '../charts/bar.js';
+import { lineSchema, renderLineChart } from '../charts/line.js';
+import { pieSchema, renderPieChart } from '../charts/pie.js';
 // Add more imports for other chart types as needed
 const chartRenderers = {
-    bar: { schema: bar_1.barSchema, renderer: bar_1.renderBarChart },
-    line: { schema: line_1.lineSchema, renderer: line_1.renderLineChart },
-    pie: { schema: pie_1.pieSchema, renderer: pie_1.renderPieChart },
+    bar: { schema: barSchema, renderer: renderBarChart },
+    line: { schema: lineSchema, renderer: renderLineChart },
+    pie: { schema: pieSchema, renderer: renderPieChart },
     // Add more chart types here
 };
-async function generateReport(document, charts, outputFile) {
+export async function generateReport(document, charts, outputFile) {
     // Validate charts
     for (const [id, { type, config }] of Object.entries(charts)) {
         const { schema } = chartRenderers[type];
@@ -37,7 +31,7 @@ async function generateReport(document, charts, outputFile) {
         mdWithCharts = mdWithCharts.replace(new RegExp(`\\[\\[chart:${id}\\]\\]`, 'g'), htmlImg);
     }
     // Convert Markdown to HTML
-    const htmlContent = await (0, marked_1.marked)(mdWithCharts);
+    const htmlContent = await marked(mdWithCharts);
     // Wrap in full HTML template
     const template = `
   <!DOCTYPE html>
@@ -52,8 +46,8 @@ async function generateReport(document, charts, outputFile) {
   </body>
   </html>
   `;
-    const fullHtml = ejs_1.default.render(template, { htmlContent }, { escape: (str) => str });
+    const fullHtml = ejs.render(template, { htmlContent }, { escape: (str) => str });
     // Save to file
-    await fs_extra_1.default.writeFile(outputFile, fullHtml);
+    await fs.writeFile(outputFile, fullHtml);
     return { success: true, filePath: outputFile };
 }

package/package.json CHANGED Viewed

@@ -1,33 +1,33 @@
 {
   "name": "@vint.tri/report_gen_mcp",
-  "version": "1.0.46",
+  "version": "1.1.0",
   "description": "CLI tool for generating HTML reports with embedded charts",
   "main": "dist/index.js",
   "bin": {
     "report_gen_mcp": "dist/index.js"
   },
+  "type": "module",
   "scripts": {
     "build": "tsc",
     "start": "node dist/index.js",
     "test": "echo \"No tests yet\""
   },
   "dependencies": {
-    "@modelcontextprotocol/sdk": "^1.17.4",
-    "@vint.tri/report_gen_mcp": "^1.0.46",
-    "chart.js": "^4.5.0",
+    "@modelcontextprotocol/sdk": "^1.0.0",
+    "chart.js": "^3.9.1",
     "chartjs-node-canvas": "^4.1.6",
-    "commander": "^14.0.0",
+    "commander": "^12.1.0",
     "ejs": "^3.1.10",
-    "express": "^5.1.0",
+    "express": "^4.19.2",
     "fs-extra": "^11.2.0",
-    "marked": "^16.2.0",
-    "zod": "^4.0.17"
+    "marked": "^13.0.2",
+    "zod": "^3.23.8"
   },
   "devDependencies": {
     "@types/ejs": "^3.1.5",
-    "@types/express": "^5.0.3",
+    "@types/express": "^4.17.21",
     "@types/fs-extra": "^11.0.4",
-    "@types/node": "^24.3.0",
+    "@types/node": "^22.4.1",
     "typescript": "^5.5.4"
   },
   "license": "MIT",