@vint.tri/report_gen_mcp 1.3.4 → 1.3.6

package/IMAGE_TOOLS_CONFIG.md

@@ -0,0 +1,143 @@
+# Image Tools Configuration
+
+This document explains how to configure and use the image generation and editing tools in the Report Generator MCP.
+
+## Prerequisites
+
+1. Python 3.7 or higher
+2. Required Python packages:
+   - `mcp` (Model Context Protocol SDK)
+   - `aiohttp`
+
+Install the required packages:
+```bash
+pip install -r src/python/requirements.txt
+```
+
+Or use the npm script:
+```bash
+npm run install-python-deps
+```
+
+## Environment Variables
+
+The following environment variables are required for the image tools to work:
+
+- `CHUTES_API_TOKEN`: Your API token for Chutes AI services
+- `IMG_SAVE_BASE_DIR`: Base directory for saving generated/edited images (optional)
+
+Optional environment variables for image generation:
+- `SD_MODEL`: Default model for image generation (default: "JuggernautXL")
+- `SD_WIDTH`: Default width for generated images (default: 1024)
+- `SD_HEIGHT`: Default height for generated images (default: 1024)
+- `SD_GUIDANCE_SCALE`: Default guidance scale (default: 7.5)
+- `SD_NEGATIVE_PROMPT`: Default negative prompt (default: "")
+- `SD_NUM_INFERENCE_STEPS`: Default number of inference steps (default: 25)
+- `SD_SEED`: Default seed (default: 0)
+
+Optional environment variables for image editing:
+- `EDIT_WIDTH`: Default width for edited images (default: 1024)
+- `EDIT_HEIGHT`: Default height for edited images (default: 1024)
+- `EDIT_CFG_SCALE`: Default CFG scale (default: 4.0)
+- `EDIT_NEGATIVE_PROMPT`: Default negative prompt (default: "")
+- `EDIT_INFERENCE_STEPS`: Default number of inference steps (default: 50)
+
+## Image Generation Tool
+
+### Tool Name
+`generate-image`
+
+### Description
+Generate an image using AI based on a text prompt.
+
+### Parameters
+- `prompt` (string, required): Text prompt for image generation (must be in English)
+- `width` (number, optional): Width of the image in pixels (128-2048, default: 1024)
+- `height` (number, optional): Height of the image in pixels (128-2048, default: 1024)
+- `model` (string, optional): Model to use for image generation (default: "JuggernautXL")
+- `guidanceScale` (number, optional): Guidance scale for image generation (1.0-20.0, default: 7.5)
+- `negativePrompt` (string, optional): Negative prompt for things to exclude from the image (default: "")
+- `numInferenceSteps` (number, optional): Number of inference steps (1-50, default: 25)
+- `seed` (number, optional): Seed for reproducibility (0 = random, default: 0)
+- `outputFile` (string, optional): Output file path for saving the image
+
+### Example Usage
+```json
+{
+  "name": "generate-image",
+  "arguments": {
+    "prompt": "A beautiful landscape with mountains and lakes",
+    "width": 1024,
+    "height": 768,
+    "model": "JuggernautXL",
+    "guidanceScale": 7.5,
+    "negativePrompt": "blurry, low quality",
+    "numInferenceSteps": 30,
+    "seed": 12345
+  }
+}
+```
+
+## Image Editing Tool
+
+### Tool Name
+`edit-image`
+
+### Description
+Edit an existing image using AI based on a text prompt.
+
+### Parameters
+- `prompt` (string, required): Text prompt for image editing (must be in English)
+- `imagePath` (string, required): Path to the input image file
+- `output_path` (string, required): Path for the output edited image file
+- `width` (number, optional): Width of the edited image in pixels (512-2048, default: 1024)
+- `height` (number, optional): Height of the edited image in pixels (512-2048, default: 1024)
+- `cfgScale` (number, optional): CFG scale for image editing (1.0-10.0, default: 4.0)
+- `negativePrompt` (string, optional): Negative prompt for things to exclude from the edited image (default: "")
+- `numInferenceSteps` (number, optional): Number of inference steps (10-100, default: 50)
+- `seed` (number, optional): Seed for reproducibility (leave empty for random)
+
+### Example Usage
+```json
+{
+  "name": "edit-image",
+  "arguments": {
+    "prompt": "Add a sunset to this landscape",
+    "imagePath": "/path/to/input/image.jpg",
+    "output_path": "/path/to/output/edited_image.jpg",
+    "width": 1024,
+    "height": 768,
+    "cfgScale": 4.0,
+    "negativePrompt": "blurry, low quality",
+    "numInferenceSteps": 50,
+    "seed": 12345
+  }
+}
+```
+
+## Integration with Report Generation
+
+The image tools can be used independently or integrated with the report generation tool. When used with the report generator, you can embed generated or edited images directly into your reports using the `[[image:id]]` placeholder syntax.
+
+### Example Report with Generated Image
+```markdown
+# My Report
+
+This is a sample report with an AI-generated image.
+
+[[image:landscape]]
+```
+
+With corresponding elements:
+```json
+{
+  "landscape": {
+    "type": "pollinations",
+    "config": {
+      "prompt": "A beautiful landscape with mountains and lakes"
+    }
+  }
+}
+```
+
+Note: Currently, the integration uses Pollinations.ai for image generation within reports. The standalone image tools use Chutes AI for more advanced generation and editing capabilities.

package/PUBLICATION_CONFIRMATION.md

@@ -1,41 +1,27 @@
-# Publication Confirmation
+# Publication Confirmation - Version 1.3.5
 
-## Package Successfully Published
+The @vint.tri/report_gen_mcp package has been successfully published to npm as version 1.3.5.
 
-- **Package Name**: @vint.tri/report_gen_mcp
-- **Version**: 1.3.3
-- **Publication Date**: August 25, 2025
-- **Registry**: npmjs.org
+## Changes in Version 1.3.5
 
-## Changes Included in This Release
-
-1. **Updated Neural Network Instructions**:
-   - Added requirement to always return file link, file path, and file contents after report generation
-   - Emphasized that reports must be maximally beautiful and high-quality with images, graphs, conclusions, and reasoning
-   - Specified that reports must be strictly in HTML format
-   - Enhanced example response format with comprehensive report structure
-
-2. **Version Updates**:
-   - Updated package version from 1.3.2 to 1.3.3 in package.json
-   - Updated version in src/index.ts file (MCP server configuration)
+1. **Fixed Report Path Issue**: Resolved the problem with reports being saved in the wrong directory by using the `REPORTS_DIR` environment variable instead of the system temporary directory `/tmp/`.
+2. **Updated Claude Desktop Configuration**: Added the `env` section with the `REPORTS_DIR` variable to properly specify the report saving directory.
+3. **Version Updates**: Updated the package version to 1.3.5 in all relevant files (`package.json`, `src/index.ts`, `dist/index.js`).
+4. **Documentation**: Created detailed documentation explaining the issue and solution (`REPORT_PATH_FIX_EXPLANATION.md`).
+5. **Testing**: Added a test script to verify that reports are saved in the correct directory (`test-report-path-fix.js`).
 
 ## Verification
 
-The package has been successfully published and is available on npm registry:
-```bash
-npm install @vint.tri/report_gen_mcp@1.3.3
-```
-
-Or to install the latest version:
-```bash
-npm install @vint.tri/report_gen_mcp@latest
-```
+- ✅ Package successfully published to npm
+- ✅ Version 1.3.5 is now the latest version on npm
+- ✅ Report path functionality tested and working correctly
+- ✅ All existing functionality preserved
 
-## Post-Publication Steps
+## Testing
 
-- [x] Package built successfully
-- [x] Package published to npm registry
-- [x] Version verified on npm registry
-- [x] Publication documentation created
+The fix has been verified with a test script that confirms:
+- Reports are saved in the correct directory specified by `REPORTS_DIR`
+- The path in the result matches the expected path
+- The neural network can properly process the response and provide all necessary information to the user
 
-The updated package is now available for users and Claude Desktop integration.
+Users can now successfully save reports in the directory specified by the `REPORTS_DIR` environment variable.