mcp-prompt-optimizer 3.1.0 → 3.1.2

package/CHANGELOG.md

@@ -5,6 +5,25 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [3.1.2] - 2026-04-12
+
+### Added
+- 🛡️ **Security Policy**: Added `SECURITY.md` for coordinated vulnerability disclosure.
+- 🤝 **Community Guidelines**: Added `CONTRIBUTING.md` and `CODE_OF_CONDUCT.md` to foster open-source participation.
+- 🤖 **CI/CD Automation**: Integrated GitHub Actions (`ci.yml`) for automated build and test validation.
+- 🏷️ **Snyk Health Badges**: Added professional health and status badges to `README.md`.
+
+### Changed
+- 📝 **Metadata Optimization**: Standardized `package.json` keywords and license strings for better registry visibility.
+- 📂 **Package Distribution**: Updated included files list to include new community and security documentation.
+- 📄 **Documentation Refresh**: Centralized resource links in README for better developer experience.
+
+## [3.1.1] - 2026-04-10
+
+### Changed
+- 💰 **Pricing Alignment**: Updated README to reflect current subscription tiers and optimization quotas.
+- 📦 **Version Bump**: Incremented version to v3.1.1 to resolve npm publishing conflict with existing v3.1.0 on the registry.
+
 ## [3.0.1] - 2025-12-09
 
 ### Fixed

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at support@promptoptimizer.xyz. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4

package/CONTRIBUTING.md

@@ -0,0 +1,61 @@
+# Contributing to MCP Prompt Optimizer
+
+Thank you for your interest in contributing to the MCP Prompt Optimizer! We welcome contributions from the community to help make this tool better for everyone.
+
+## Code of Conduct
+
+By participating in this project, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md).
+
+## How Can I Contribute?
+
+### Reporting Bugs
+
+If you find a bug, please search our [GitHub Issues](https://github.com/prompt-optimizer/mcp-prompt-optimizer/issues) to see if it has already been reported. If not, please open a new issue and include:
+
+- A clear and descriptive title.
+- Steps to reproduce the issue.
+- Expected vs. actual behavior.
+- Your environment (Node.js version, OS, MCP client).
+
+### Suggesting Enhancements
+
+We love hearing new ideas! Please open an issue with the "enhancement" label and describe:
+
+- The goal of the enhancement.
+- How it should work.
+- Why it would be useful.
+
+### Pull Requests
+
+1. **Fork the repository** and create your branch from `main`.
+2. **Install dependencies**: `npm install`
+3. **Make your changes**: Ensure your code follows the existing style.
+4. **Test your changes**: Run `npm test` to ensure everything is working correctly.
+5. **Update documentation**: If you've added new features, update the `README.md` or relevant docs.
+6. **Submit a Pull Request**: Provide a clear description of the changes and link to any related issues.
+
+## Development Setup
+
+The project uses Node.js (>=16). 
+
+```bash
+git clone https://github.com/prompt-optimizer/mcp-prompt-optimizer.git
+cd mcp-prompt-optimizer
+npm install
+```
+
+### Running Tests
+
+We have several test suites:
+
+- `npm run test:quick`: Fast verification of core logic.
+- `npm run test:integration`: Verification with the backend.
+- `npm run test:comprehensive`: Full system check.
+
+## Security
+
+If you discover a security vulnerability, please do NOT open a public issue. Instead, email us at support@promptoptimizer.xyz.
+
+## License
+
+By contributing, you agree that your contributions will be licensed under the project's [LICENSE](LICENSE).

package/README.md

@@ -1,6 +1,13 @@
-# MCP Prompt Optimizer v3.0.3
+# MCP Prompt Optimizer v3.1.2
+
+[![NPM Version](https://img.shields.io/npm/v/mcp-prompt-optimizer)](https://www.npmjs.com/package/mcp-prompt-optimizer)
+[![License](https://img.shields.io/badge/license-Commercial-blue.svg)](LICENSE)
+[![CI](https://github.com/prompt-optimizer/mcp-prompt-optimizer/actions/workflows/ci.yml/badge.svg)](https://github.com/prompt-optimizer/mcp-prompt-optimizer/actions)
+[![Snyk Health](https://snyk.io/advisor/npm-package/mcp-prompt-optimizer/badge.svg)](https://snyk.io/advisor/npm-package/mcp-prompt-optimizer)
+
+🚀 **Professional cloud-based MCP server** for AI-powered prompt optimization with intelligent context detection, template management, team collaboration, and enterprise-grade reliability. Starting at $0/month.
+
 
-🚀 **Professional cloud-based MCP server** for AI-powered prompt optimization with intelligent context detection, template management, team collaboration, and enterprise-grade reliability. Starting at $2.99/month.
 
 ## ✨ Key Features
 
@@ -120,7 +127,7 @@ To address this effectively:
 
 ## 🧠 AI Context Detection
 
-The server automatically detects your prompt type and routes it to the appropriate optimization template. You can also specify `ai_context` manually in the tool call.
+The server automatically detects your prompt type and routes it to the appropriate optimization template.
 
 | Context | `ai_context` value | Example patterns |
 |---|---|---|
@@ -133,6 +140,11 @@ The server automatically detects your prompt type and routes it to the appropria
 | Creative writing | `creative_writing` | `story`, `poem`, `script`, `blog`, `copywriting` |
 | Email & communication | `human_communication` | `email`, `letter`, `memo`, `formal`, `reply` |
 | Image generation | `image_generation` | `photorealistic`, `midjourney`, `dall-e`, `portrait` |
+| Business & Strategy | `business_strategy` | `market analysis`, `swot`, `business plan` |
+| Technical Strategy | `technical_strategy` | `architecture`, `system design`, `migration plan` |
+| Legal & Compliance | `legal_compliance` | `contract`, `gdpr`, `terms of service`, `audit` |
+| Medical & Health | `medical_healthcare` | `clinical`, `diagnosis`, `treatment`, `hipaa` |
+| Education | `educational_content` | `lesson plan`, `syllabus`, `curriculum`, `quiz` |
 | General | `general_assistant` | Everything else |
 
 ### Image Generation
@@ -308,11 +320,11 @@ Configure custom models in the WebUI and the MCP server uses them automatically.
 
 ## 💰 Subscription Plans
 
-| Plan | Price | Optimizations/month | Team members |
-|---|---|---|---|
-| 🎯 Explorer | $2.99/mo | 5,000 | 1 |
-| 🎨 Creator | $25.99/mo | 18,000 | 2 + 3 keys |
-| 🚀 Innovator | $69.99/mo | 75,000 | 5 + 10 keys |
+| Plan | Price | Optimizations/month | CE Credits | Team members |
+|---|---|---|---|---|
+| 🎯 Explorer | $2.99/mo | 20 | 5 | 1 |
+| 🎨 Creator | $29/mo | 18,000 | 30 | 2 + 1 key |
+| 🚀 Innovator | $99/mo | 75,000 | Unlimited | 5 + 10 keys |
 
 🆓 **Free trial:** 5 optimizations with full feature access.
 
@@ -415,14 +427,19 @@ Windsurf, Cline, VS Code, Zed, Replit, JetBrains IDEs, and Neovim are all suppor
 
 ---
 
-## 📞 Support & Resources
+## 🛠️ Support & Resources
+
+- 📖 **Documentation:** [promptoptimizer-blog.vercel.app/docs](https://promptoptimizer-blog.vercel.app/docs)
+- 📊 **Dashboard & model config:** [promptoptimizer-blog.vercel.app/dashboard](https://promptoptimizer-blog.vercel.app/dashboard)
+- 🚀 **Pricing & API Keys:** [promptoptimizer.xyz/pricing](https://promptoptimizer.xyz/pricing)
+- 🐛 **Issues:** [GitHub Issues](https://github.com/prompt-optimizer/mcp-prompt-optimizer/issues)
+- 📄 **License:** [Commercial License](LICENSE)
+- 🔒 **Security:** [Security Policy](SECURITY.md)
+- 🤝 **Contributing:** [Contributing Guide](CONTRIBUTING.md)
+- 📜 **Code of Conduct:** [Contributor Covenant](CODE_OF_CONDUCT.md)
+- 📝 **Changelog:** [Release History](CHANGELOG.md)
+- 📧 **Email support:** support@promptoptimizer.xyz
 
-- **Documentation:** https://promptoptimizer-blog.vercel.app/docs
-- **Dashboard & model config:** https://promptoptimizer-blog.vercel.app/dashboard
-- **Troubleshooting:** https://promptoptimizer-blog.vercel.app/docs/troubleshooting
-- **Community support:** GitHub Discussions
-- **Email support:** support@promptoptimizer.help (Creator/Innovator plans)
-- **Enterprise:** enterprise@promptoptimizer.help
 
 ---
 

package/SECURITY.md

@@ -0,0 +1,22 @@
+# Security Policy
+
+## Supported Versions
+
+We actively provide security updates for the following versions of `mcp-prompt-optimizer`:
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 3.1.x   | :white_check_mark: |
+| 3.0.x   | :x:                |
+| < 3.0   | :x:                |
+
+## Reporting a Vulnerability
+
+We take the security of our users seriously. If you discover a security vulnerability within this project, please do NOT open a public issue. Instead, follow these steps:
+
+1.  **Email us**: Send a detailed report to support@promptoptimizer.xyz.
+2.  **Include details**: Provide a description of the vulnerability, steps to reproduce, and potential impact.
+3.  **Response time**: We aim to acknowledge receipt of your report within 48 hours.
+4.  **Disclosure**: We will work with you to resolve the issue and coordinate a public disclosure once a fix is available.
+
+Thank you for helping keep our community safe!

package/index.js

@@ -114,7 +114,9 @@ class MCPPromptOptimizer {
                 type: "string",
                 enum: [
                   "human_communication", "llm_interaction", "image_generation", "technical_automation",
-                  "structured_output", "code_generation", "api_automation"
+                  "structured_output", "code_generation", "api_automation", "data_analysis",
+                  "creative_writing", "business_strategy", "technical_strategy", "academic_research",
+                  "legal_compliance", "medical_healthcare", "educational_content"
                 ],
                 description: "The context for the AI's task (auto-detected if not specified with enhanced detection)"
               },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mcp-prompt-optimizer",
-  "version": "3.1.0",
+  "version": "3.1.2",
   "description": "Professional cloud-based MCP server for AI-powered prompt optimization with intelligent context detection, Bayesian optimization, AG-UI real-time optimization, template auto-save, optimization insights, personal model configuration via WebUI, team collaboration, enterprise-grade features, production resilience, and startup validation. Universal compatibility with Claude Desktop, Cursor, Windsurf, and 17+ MCP clients.",
   "main": "index.js",
   "bin": {
@@ -55,52 +55,17 @@
     "ai",
     "claude",
     "anthropic",
-    "openrouter",
-    "model-configuration",
-    "personal-models",
+    "prompt-engineering",
+    "llm",
     "cursor",
     "windsurf",
     "cline",
+    "context-aware",
     "professional",
-    "subscription",
-    "cloud-based",
-    "context-detection",
-    "templates",
-    "template-auto-save",
-    "optimization-insights",
-    "analytics",
-    "team-collaboration",
-    "enterprise-grade",
-    "intelligent-routing",
-    "ai-context",
-    "api-key-management",
-    "startup-validation",
-    "caching",
-    "robust-error-handling",
-    "cli-commands",
-    "professional-tooling",
-    "network-resilience",
-    "production-ready",
-    "development-mode",
-    "fallback-support",
-    "cross-platform",
-    "windows",
-    "macos",
-    "linux",
-    "arm64",
-    "bayesian-optimization",
-    "ag-ui-real-time",
-    "streaming-optimization",
-    "websocket-support",
-    "performance-optimization",
-    "advanced-analytics",
-    "intelligent-context",
-    "ai-aware-rules",
-    "parameter-tuning",
-    "optimization-strategies"
+    "automation"
   ],
   "author": "Prompt Optimizer Team <support@promptoptimizer.xyz>",
-  "license": "SEE LICENSE IN LICENSE",
+  "license": "Proprietary",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/prompt-optimizer/mcp-prompt-optimizer.git"
@@ -114,7 +79,9 @@
     "lib/",
     "README.md",
     "CHANGELOG.md",
-    "CROSS-PLATFORM.md",
+    "CONTRIBUTING.md",
+    "CODE_OF_CONDUCT.md",
+    "SECURITY.md",
     "LICENSE"
   ],
   "config": {

package/CROSS-PLATFORM.md

@@ -1,272 +0,0 @@
-# Cross-Platform Compatibility Guide
-
-## MCP Prompt Optimizer - Universal Platform Support
-
-This package has been designed and tested to work seamlessly across all major operating systems and architectures.
-
-## ✅ Supported Platforms
-
-### Operating Systems
-- **Windows 10/11** (x64)
-- **macOS** (Intel x64 & Apple Silicon ARM64)  
-- **Linux** (Ubuntu, Debian, CentOS, RHEL, etc.) (x64, ARM64)
-
-### Node.js Versions
-- **Minimum:** Node.js 16.0.0
-- **Recommended:** Node.js 18.0.0 or higher
-- **Tested:** Node.js 16, 18, 20, 21
-
-## 🚀 Installation
-
-The package installs identically on all platforms:
-
-```bash
-# Global installation (recommended)
-npm install -g mcp-prompt-optimizer
-
-# Local installation
-npm install mcp-prompt-optimizer
-```
-
-## 🔧 Platform-Specific Setup
-
-### Windows
-
-```powershell
-# PowerShell
-$env:OPTIMIZER_API_KEY = "sk-opt-your-key-here"
-mcp-prompt-optimizer
-
-# Command Prompt
-set OPTIMIZER_API_KEY=sk-local-your-key-here
-mcp-prompt-optimizer
-
-# Or use the Windows-specific development script
-npm run dev:windows
-```
-
-### macOS & Linux
-
-```bash
-# Bash/Zsh
-export OPTIMIZER_API_KEY="sk-local-your-key-here"
-mcp-prompt-optimizer
-
-# Or use the Unix-specific development script
-npm run dev:unix
-```
-
-### Cross-Platform (Recommended)
-
-```bash
-# Works on all platforms with cross-env
-npm run dev
-npm run dev:mock
-```
-
-## 📁 File System Behavior
-
-### Cache & Config Files
-
-The package automatically creates platform-appropriate cache files:
-
-- **Windows:** `%USERPROFILE%\.mcp-cloud-api-cache.json`
-- **macOS:** `~/.mcp-cloud-api-cache.json`  
-- **Linux:** `~/.mcp-cloud-api-cache.json`
-
-### Path Handling
-
-All file paths are handled using Node.js built-in `path` module for cross-platform compatibility:
-- Uses `path.join()` for path construction
-- Uses `os.homedir()` for user directory location
-- Automatically handles Windows backslashes vs Unix forward slashes
-
-## 🛠 Development & Testing
-
-### Cross-Platform Development Scripts
-
-```bash
-# Universal development mode (works everywhere)
-npm run dev
-
-# Mock mode for testing (works everywhere)  
-npm run dev:mock
-
-# Platform-specific alternatives
-npm run dev:windows    # Windows only
-npm run dev:unix       # macOS/Linux only
-```
-
-### Testing Your Installation
-
-```bash
-# Health check (works on all platforms)
-npm run health-check
-
-# Diagnostic tool
-npm run diagnose
-
-# API key validation
-npm run validate-key
-```
-
-## 🔍 Environment Variables
-
-All environment variables work consistently across platforms:
-
-```bash
-# Core configuration
-OPTIMIZER_API_KEY=sk-local-your-key-here
-OPTIMIZER_BACKEND_URL=https://custom-backend.com
-OPTIMIZER_DEV_MODE=true
-NODE_ENV=development
-
-# Advanced options
-OPTIMIZER_REQUEST_TIMEOUT=30000
-OPTIMIZER_MAX_RETRIES=5
-```
-
-## 🧪 Platform-Specific Testing
-
-### Windows Testing
-
-```powershell
-# PowerShell
-$env:OPTIMIZER_API_KEY = "sk-dev-test-key"
-$env:OPTIMIZER_DEV_MODE = "true"
-node index.js
-
-# Command Prompt  
-set OPTIMIZER_API_KEY=sk-dev-test-key
-set OPTIMIZER_DEV_MODE=true
-node index.js
-```
-
-### Unix Testing (macOS/Linux)
-
-```bash
-# Direct environment variables
-OPTIMIZER_API_KEY=sk-dev-test-key OPTIMIZER_DEV_MODE=true node index.js
-
-# Or export first
-export OPTIMIZER_API_KEY=sk-dev-test-key
-export OPTIMIZER_DEV_MODE=true
-node index.js
-```
-
-## 🌐 MCP Client Compatibility
-
-The package works with MCP-compatible applications across all platforms:
-
-### Claude Desktop
-- **Windows:** Configure in `%APPDATA%\Claude\claude_desktop_config.json`
-- **macOS:** Configure in `~/Library/Application Support/Claude/claude_desktop_config.json`
-- **Linux:** Configure in `~/.config/Claude/claude_desktop_config.json`
-
-### Cursor IDE
-- **All Platforms:** Configure in `~/.cursor/mcp.json`
-
-### Windsurf
-- **All Platforms:** Add via settings or configuration file
-
-## 🚨 Troubleshooting
-
-### Common Platform Issues
-
-#### Windows
-- **Issue:** Scripts fail with "cannot be loaded because running scripts is disabled"
-- **Solution:** Run `Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser` in PowerShell
-
-#### macOS  
-- **Issue:** Permission denied when installing globally
-- **Solution:** Use `sudo npm install -g mcp-prompt-optimizer` or configure npm to use a different directory
-
-#### Linux
-- **Issue:** Node.js not found or wrong version
-- **Solution:** Use Node Version Manager: `curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash`
-
-### Universal Troubleshooting
-
-```bash
-# Check Node.js version (should be 16+)
-node --version
-
-# Check npm version  
-npm --version
-
-# Clear npm cache
-npm cache clean --force
-
-# Reinstall package
-npm uninstall -g mcp-prompt-optimizer
-npm install -g mcp-prompt-optimizer
-
-# Reset package cache
-npm run reset-cache
-```
-
-## 📊 Performance Notes
-
-### Platform Performance Characteristics
-
-- **Windows:** Slightly slower file I/O due to Windows Defender scanning
-- **macOS:** Excellent performance, especially on Apple Silicon
-- **Linux:** Generally fastest performance, especially for server deployments
-
-### Memory Usage
-
-- **Typical:** 15-25 MB RAM usage
-- **Peak:** Up to 50 MB during optimization
-- **Consistent across all platforms**
-
-## 🔒 Security Considerations
-
-### Platform-Specific Security
-
-- **Windows:** API keys stored in user profile (protected by Windows user permissions)
-- **macOS:** API keys stored in user home (protected by macOS file permissions)
-- **Linux:** API keys stored with 600 permissions (user-only access)
-
-### Network Security
-- All platforms use identical HTTPS connections
-- Certificate validation works uniformly across platforms
-- Network timeouts and retry logic identical
-
-## 📋 Platform Support Matrix
-
-| Feature | Windows | macOS | Linux | ARM64 | Notes |
-|---------|---------|--------|-------|-------|-------|
-| Installation | ✅ | ✅ | ✅ | ✅ | npm/yarn |
-| MCP Server | ✅ | ✅ | ✅ | ✅ | Full compatibility |
-| Claude Desktop | ✅ | ✅ | ✅ | ✅ | All versions |
-| Cursor IDE | ✅ | ✅ | ✅ | ✅ | Latest versions |
-| Development Mode | ✅ | ✅ | ✅ | ✅ | Mock responses |
-| Cache System | ✅ | ✅ | ✅ | ✅ | Platform-appropriate paths |
-| Error Handling | ✅ | ✅ | ✅ | ✅ | Identical behavior |
-| Network Resilience | ✅ | ✅ | ✅ | ✅ | Same retry logic |
-
-## 🎯 Best Practices
-
-### Universal Setup
-
-1. **Use cross-env for development:** Always prefer `npm run dev` over platform-specific commands
-2. **Environment variables:** Use `.env` files for consistent configuration
-3. **Path handling:** Never hardcode paths - the package handles this automatically
-4. **Testing:** Test on your target platform before deployment
-
-### Production Deployment
-
-- **Docker:** Package works excellently in containers (all Linux distros)
-- **Cloud:** Tested on AWS, Google Cloud, Azure, Railway, Vercel, Render
-- **Edge:** Works on edge computing platforms supporting Node.js 16+
-
-## 📞 Support
-
-If you encounter platform-specific issues:
-
-1. **Check this guide first**
-2. **Run diagnostics:** `npm run diagnose`
-3. **Contact support:** support@promptoptimizer.help
-4. **Include:** OS version, Node.js version, error messages
-
-The MCP Prompt Optimizer is committed to providing identical functionality and performance across all supported platforms.