chore: release version 1.2.4 with configurable settings

Author: vrknetha

CHANGELOG.md

@@ -1,5 +1,31 @@
 # Changelog
 
+## [1.2.4] - 2024-02-05
+
+### Added
+
+- Environment variable support for all configuration options
+- Detailed configuration documentation in README
+
+### Changed
+
+- Made retry and credit monitoring settings configurable via environment variables:
+  - `FIRE_CRAWL_RETRY_MAX_ATTEMPTS`
+  - `FIRE_CRAWL_RETRY_INITIAL_DELAY`
+  - `FIRE_CRAWL_RETRY_MAX_DELAY`
+  - `FIRE_CRAWL_RETRY_BACKOFF_FACTOR`
+  - `FIRE_CRAWL_CREDIT_WARNING_THRESHOLD`
+  - `FIRE_CRAWL_CREDIT_CRITICAL_THRESHOLD`
+- Enhanced configuration examples with detailed comments and use cases
+- Improved documentation for retry behavior and credit monitoring
+
+### Documentation
+
+- Added comprehensive configuration examples for both cloud and self-hosted setups
+- Added detailed explanations of retry behavior with timing examples
+- Added credit monitoring threshold explanations
+- Updated Claude Desktop configuration documentation
+
 ## [1.2.3] - 2024-02-05
 
 ### Changed

README.md

@@ -39,32 +39,60 @@ npm install -g mcp-server-firecrawl
 
 ### Environment Variables
 
+#### Required for Cloud API
+
 - `FIRE_CRAWL_API_KEY`: Your FireCrawl API key
   - Required when using cloud API (default)
   - Optional when using self-hosted instance with `FIRE_CRAWL_API_URL`
 - `FIRE_CRAWL_API_URL` (Optional): Custom API endpoint for self-hosted instances
   - Example: `https://firecrawl.your-domain.com`
   - If not provided, the cloud API will be used (requires API key)
 
+#### Optional Configuration
+
+##### Retry Configuration
+
+- `FIRE_CRAWL_RETRY_MAX_ATTEMPTS`: Maximum number of retry attempts (default: 3)
+- `FIRE_CRAWL_RETRY_INITIAL_DELAY`: Initial delay in milliseconds before first retry (default: 1000)
+- `FIRE_CRAWL_RETRY_MAX_DELAY`: Maximum delay in milliseconds between retries (default: 10000)
+- `FIRE_CRAWL_RETRY_BACKOFF_FACTOR`: Exponential backoff multiplier (default: 2)
+
+##### Credit Usage Monitoring
+
+- `FIRE_CRAWL_CREDIT_WARNING_THRESHOLD`: Credit usage warning threshold (default: 1000)
+- `FIRE_CRAWL_CREDIT_CRITICAL_THRESHOLD`: Credit usage critical threshold (default: 100)
+
 ### Configuration Examples
 
-For cloud API usage (default):
+For cloud API usage with custom retry and credit monitoring:
 
 ```bash
+# Required for cloud API
 export FIRE_CRAWL_API_KEY=your-api-key
-```
 
-For self-hosted instance without authentication:
+# Optional retry configuration
+export FIRE_CRAWL_RETRY_MAX_ATTEMPTS=5        # Increase max retry attempts
+export FIRE_CRAWL_RETRY_INITIAL_DELAY=2000    # Start with 2s delay
+export FIRE_CRAWL_RETRY_MAX_DELAY=30000       # Maximum 30s delay
+export FIRE_CRAWL_RETRY_BACKOFF_FACTOR=3      # More aggressive backoff
 
-```bash
-export FIRE_CRAWL_API_URL=https://firecrawl.your-domain.com
+# Optional credit monitoring
+export FIRE_CRAWL_CREDIT_WARNING_THRESHOLD=2000    # Warning at 2000 credits
+export FIRE_CRAWL_CREDIT_CRITICAL_THRESHOLD=500    # Critical at 500 credits
 ```
 
-For self-hosted instance with authentication:
+For self-hosted instance:
 
 ```bash
+# Required for self-hosted
 export FIRE_CRAWL_API_URL=https://firecrawl.your-domain.com
-export FIRE_CRAWL_API_KEY=your-api-key  # Optional for authenticated self-hosted instances
+
+# Optional authentication for self-hosted
+export FIRE_CRAWL_API_KEY=your-api-key  # If your instance requires auth
+
+# Custom retry configuration
+export FIRE_CRAWL_RETRY_MAX_ATTEMPTS=10
+export FIRE_CRAWL_RETRY_INITIAL_DELAY=500     # Start with faster retries
 ```
 
 ### Usage with Claude Desktop
@@ -78,7 +106,15 @@ Add this to your `claude_desktop_config.json`:
       "command": "npx",
       "args": ["-y", "mcp-server-firecrawl"],
       "env": {
-        "FIRE_CRAWL_API_KEY": "YOUR_API_KEY_HERE"
+        "FIRE_CRAWL_API_KEY": "YOUR_API_KEY_HERE",
+
+        "FIRE_CRAWL_RETRY_MAX_ATTEMPTS": "5",
+        "FIRE_CRAWL_RETRY_INITIAL_DELAY": "2000",
+        "FIRE_CRAWL_RETRY_MAX_DELAY": "30000",
+        "FIRE_CRAWL_RETRY_BACKOFF_FACTOR": "3",
+
+        "FIRE_CRAWL_CREDIT_WARNING_THRESHOLD": "2000",
+        "FIRE_CRAWL_CREDIT_CRITICAL_THRESHOLD": "500"
       }
     }
   }
@@ -87,23 +123,42 @@ Add this to your `claude_desktop_config.json`:
 
 ### System Configuration
 
-The server includes several configurable parameters:
+The server includes several configurable parameters that can be set via environment variables. Here are the default values if not configured:
 
 ```typescript
 const CONFIG = {
   retry: {
-    maxAttempts: 3,
-    initialDelay: 1000, // 1 second
-    maxDelay: 10000, // 10 seconds
-    backoffFactor: 2,
+    maxAttempts: 3, // Number of retry attempts for rate-limited requests
+    initialDelay: 1000, // Initial delay before first retry (in milliseconds)
+    maxDelay: 10000, // Maximum delay between retries (in milliseconds)
+    backoffFactor: 2, // Multiplier for exponential backoff
   },
   credit: {
-    warningThreshold: 1000,
-    criticalThreshold: 100,
+    warningThreshold: 1000, // Warn when credit usage reaches this level
+    criticalThreshold: 100, // Critical alert when credit usage reaches this level
   },
 };
 ```
 
+These configurations control:
+
+1. **Retry Behavior**
+
+   - Automatically retries failed requests due to rate limits
+   - Uses exponential backoff to avoid overwhelming the API
+   - Example: With default settings, retries will be attempted at:
+     - 1st retry: 1 second delay
+     - 2nd retry: 2 seconds delay
+     - 3rd retry: 4 seconds delay (capped at maxDelay)
+
+2. **Credit Usage Monitoring**
+   - Tracks API credit consumption for cloud API usage
+   - Provides warnings at specified thresholds
+   - Helps prevent unexpected service interruption
+   - Example: With default settings:
+     - Warning at 1000 credits remaining
+     - Critical alert at 100 credits remaining
+
 ### Rate Limiting and Batch Processing
 
 The server utilizes FireCrawl's built-in rate limiting and batch processing capabilities:

package.json

@@ -1,6 +1,6 @@
 {
   "name": "mcp-server-firecrawl",
-  "version": "1.2.3",
+  "version": "1.2.4",
   "description": "MCP server for FireCrawl web scraping integration. Supports both cloud and self-hosted instances. Features include web scraping, batch processing, structured data extraction, and LLM-powered content analysis.",
   "type": "module",
   "bin": "dist/src/index.js",