mcp-prompt-optimizer 1.0.1

package/CHANGELOG.md

@@ -0,0 +1,117 @@
+# Changelog
+
+All notable changes to the MCP Prompt Optimizer package 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).
+
+## [1.0.1] - 2025-06-05
+
+### Changed
+- **CRITICAL**: Updated default backend URL from placeholder to production deployment
+  - Changed from `https://your-app.code.run` to `https://p01--project-optimizer--fvrdk8m9k9j.code.run`
+  - Ensures out-of-the-box functionality without manual configuration
+- Updated package repository information to proper GitHub URLs
+- Enhanced error handling in API client for server errors (500 status)
+- Improved documentation with backend infrastructure details
+
+### Added
+- Added comprehensive backend connectivity documentation
+- Added troubleshooting section for backend connection issues
+- Added environment variable documentation for debugging
+- Added changelog file for version tracking
+- Enhanced test suite with backend URL validation
+- Added npm test script for package validation
+
+### Fixed
+- Fixed default backend URL configuration in `lib/config.js`
+- Ensured consistency between API client and config defaults
+- Improved package metadata and author information
+
+### Documentation
+- Updated README.md with production backend information
+- Enhanced client configuration guide with backend details
+- Added backend health check endpoints
+- Improved troubleshooting documentation
+
+## [1.0.0] - 2025-05-XX
+
+### Added
+- Initial release of MCP Prompt Optimizer package
+- Support for Claude Desktop, Cursor, and Windsurf MCP clients
+- API key authentication system with secure local storage
+- Complete optimization goal support (10 different goals)
+- MCP Protocol 2024-11-05 compliance
+- Real-time quota tracking and usage monitoring
+- Comprehensive error handling and validation
+- Interactive setup command for API key configuration
+- Global npm package installation support
+- Cross-platform compatibility (Windows, macOS, Linux)
+
+### Features
+- **optimize_prompt** tool with advanced goal selection
+- Secure API key management with local storage
+- Base64 configuration encoding for MCP protocol compliance
+- Automatic retry logic and rate limiting handling
+- Health check and connectivity validation
+- Development and production environment support
+
+### Security
+- HTTPS-only communication with backend
+- Local-only API key storage
+- No persistent data storage on servers
+- Enterprise-grade security compliance
+
+---
+
+## Backend Compatibility
+
+| Package Version | Backend API Version | Deployment URL |
+|-----------------|--------------------|--------------------|
+| 1.0.1 | v0.2.2+ | https://p01--project-optimizer--fvrdk8m9k9j.code.run |
+| 1.0.0 | v0.2.0+ | Placeholder URL (manual configuration required) |
+
+## Migration Guide
+
+### From 1.0.0 to 1.0.1
+
+No breaking changes. The update automatically configures the correct backend URL.
+
+**If you previously configured a custom backend URL:**
+- Your configuration will be preserved
+- To use the new default: delete `~/.prompt-optimizer/config.json` and run `mcp-prompt-optimizer --setup`
+
+**For existing installations:**
+```bash
+# Update the package
+npm update -g mcp-prompt-optimizer
+
+# Verify new version
+mcp-prompt-optimizer --version
+
+# Test connectivity (optional)
+npm test
+```
+
+## Known Issues
+
+### 1.0.1
+- None known at release time
+
+### 1.0.0
+- Required manual backend URL configuration
+- Placeholder URLs in documentation
+
+## Support
+
+For version-specific support:
+- [GitHub Issues](https://github.com/prompt-optimizer/mcp-prompt-optimizer/issues)
+- [Support Portal](https://promptoptimizer-blog.vercel.app/support)
+- [Documentation](https://promptoptimizer-blog.vercel.app/docs)
+
+When reporting issues, please include:
+- Package version (`mcp-prompt-optimizer --version`)
+- Node.js version (`node --version`)
+- Operating system
+- MCP client type and version
+- Error messages and logs

package/LICENSE

@@ -0,0 +1,63 @@
+COMMERCIAL SOFTWARE LICENSE
+
+Copyright (c) 2025 Prompt Optimizer Team
+
+TERMS AND CONDITIONS
+
+1. GRANT OF LICENSE
+   Subject to the terms of this license, the Licensor grants you a non-exclusive, 
+   non-transferable license to use this software in accordance with the terms below.
+
+2. PERMITTED USES
+   a) Personal Use: You may use this software for personal, non-commercial purposes
+   b) Educational Use: Educational institutions may use this software for teaching purposes
+   c) Evaluation: You may evaluate this software for up to 30 days for potential commercial use
+
+3. COMMERCIAL USE
+   Commercial use of this software requires a separate commercial license.
+   Contact support@promptoptimizer.com for commercial licensing terms.
+
+4. RESTRICTIONS
+   You may NOT:
+   a) Distribute, sublicense, or sell copies of this software
+   b) Create derivative works for commercial distribution
+   c) Use this software to provide competing services
+   d) Reverse engineer, decompile, or disassemble this software
+   e) Remove or modify any copyright notices
+
+5. INTELLECTUAL PROPERTY
+   a) Your Content: You retain all intellectual property rights in prompts, templates, 
+      and content you create using this software
+   b) Software: This software and its original code remain the property of the Licensor
+   c) Templates: Optimization templates you create remain your intellectual property
+
+6. DATA AND PRIVACY
+   a) Template Storage: Your optimization templates are stored securely and remain private
+   b) API Keys: Stored locally on your device and transmitted securely
+   c) Usage Data: Anonymous usage statistics may be collected for service improvement
+
+7. DISCLAIMER OF WARRANTIES
+   THIS SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+   INCLUDING BUT NOT LIMITED TO WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
+   PURPOSE, AND NON-INFRINGEMENT.
+
+8. LIMITATION OF LIABILITY
+   IN NO EVENT SHALL THE LICENSOR BE LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER LIABILITY,
+   WHETHER IN AN ACTION OF CONTRACT, TORT, OR OTHERWISE, ARISING FROM, OUT OF, OR IN
+   CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+9. TERMINATION
+   This license is effective until terminated. Your rights under this license will
+   terminate automatically without notice if you fail to comply with any term of this license.
+
+10. UPDATES AND SUPPORT
+    Updates and support are provided through the official distribution channels.
+    Support is available at: https://promptoptimizer-blog.vercel.app/support
+
+For questions about this license or to obtain a commercial license, contact:
+Prompt Optimizer Team
+Email: support@promptoptimizer.com
+Website: https://promptoptimizer-blog.vercel.app
+
+This license governs the use of the MCP Prompt Optimizer client software.
+The backend API service is governed by separate terms of service.

package/README.md

@@ -0,0 +1,392 @@
+# MCP Prompt Optimizer
+
+Local MCP server for accessing the Prompt Optimizer API from Claude Desktop, Cursor, Windsurf, and other MCP-compatible clients.
+
+## Features
+
+- 🤖 **Universal MCP Support** - Works with Claude Desktop, Cursor, Windsurf, and any MCP-compatible client
+- 🔐 **Secure API Key Authentication** - Uses your personal API key for secure access
+- 🎯 **Advanced Optimization Goals** - Support for clarity, conciseness, technical accuracy, and more
+- 📊 **Real-time Quota Tracking** - See your usage and remaining quota
+- 💾 **Automatic Template Saving** - All optimizations saved with rich metadata for future reference
+- 🚀 **Easy Setup** - Simple configuration process
+- ⚡ **Production Backend** - Powered by enterprise-grade FastAPI deployment on Northflank
+
+## Installation
+
+### Global Installation (Recommended)
+
+```bash
+npm install -g mcp-prompt-optimizer
+```
+
+### Local Installation
+
+```bash
+npm install mcp-prompt-optimizer
+```
+
+## Quick Start
+
+### 1. Get Your API Key
+
+1. Visit [Prompt Optimizer Dashboard](https://promptoptimizer-blog.vercel.app/dashboard)
+2. Subscribe to Creator ($12.99/month) or Innovator ($24.99/month) plan
+3. Generate your API key from the dashboard
+
+### 2. Setup
+
+```bash
+mcp-prompt-optimizer --setup
+```
+
+Enter your API key when prompted. The package will automatically connect to the production backend at `https://p01--project-optimizer--fvrdk8m9k9j.code.run`.
+
+### 3. Configure Your MCP Client
+
+#### Claude Desktop
+
+Add to `~/.claude/claude_desktop_config.json`:
+
+```json
+{
+  "mcpServers": {
+    "prompt-optimizer": {
+      "command": "npx",
+      "args": ["mcp-prompt-optimizer"]
+    }
+  }
+}
+```
+
+#### Cursor
+
+Add to `~/.cursor/mcp.json`:
+
+```json
+{
+  "mcpServers": {
+    "prompt-optimizer": {
+      "command": "npx",
+      "args": ["mcp-prompt-optimizer"]
+    }
+  }
+}
+```
+
+#### Windsurf
+
+Add via Windsurf settings or configuration file:
+
+```json
+{
+  "mcpServers": {
+    "prompt-optimizer": {
+      "command": "npx",
+      "args": ["mcp-prompt-optimizer"]
+    }
+  }
+}
+```
+
+### 4. Use the Tool
+
+Once configured, the `optimize_prompt` tool will be available in your MCP client. You can:
+
+- **prompt** (required): The prompt you want to optimize
+- **goals** (optional): Array of optimization goals
+
+## Template Saving & History
+
+Your optimizations are automatically saved as templates for comprehensive tracking and future reference:
+
+### Automatic Template Saving
+- **Every Optimization Saved**: All successful optimizations are automatically saved as structured templates
+- **Rich Metadata**: Templates include timestamps, optimization goals, confidence scores, and model information
+- **Request Tracking**: Each optimization includes unique request IDs for audit trails
+- **User Association**: Templates are linked to your account for privacy and organization
+
+### Template Structure
+Each saved template contains:
+```json
+{
+  "saved_at_utc": "2025-06-05T12:00:00.000Z",
+  "optimization_tier": "LLM",
+  "confidence_score": 0.95,
+  "original_prompt": "Your original prompt",
+  "optimized_prompt": "The improved version",
+  "optimization_goals": ["clarity", "technical_accuracy"],
+  "context_snapshot": {
+    "domain": "General",
+    "target_audience": "Default"
+  },
+  "request_id": "unique-request-identifier",
+  "request_metadata": {
+    "api_request_type": "POST_non_streaming",
+    "user_id": "your-user-id"
+  },
+  "model_optimized_with": "openai/gpt-4o-mini"
+}
+```
+
+### Template Access
+- **Dashboard Access**: View your optimization history at [the dashboard](https://promptoptimizer-blog.vercel.app/dashboard)
+- **Server-Side Storage**: Templates are securely stored on the backend infrastructure
+- **Privacy Protected**: Only you can access your templates through authenticated sessions
+- **Export Capability**: Templates can be exported through the web dashboard
+
+### Template Benefits
+- **Learning Tool**: Review how different goals affect optimization outcomes
+- **Consistency**: Maintain consistent optimization approaches across projects
+- **Analytics**: Track your optimization patterns and improvement over time
+- **Audit Trail**: Complete history of optimization requests for compliance and review
+
+## Optimization Goals
+
+Choose from these optimization strategies:
+
+- **clarity** - Make the prompt clearer and more understandable
+- **conciseness** - Remove unnecessary words while preserving meaning
+- **technical_accuracy** - Improve technical precision and correctness
+- **contextual_relevance** - Better alignment with context and purpose
+- **specificity** - Add specific details and reduce ambiguity
+- **actionability** - Make the prompt more actionable and directive
+- **structure** - Improve organization and logical flow
+- **technical_precision** - Enhance exactness of technical terms
+- **linguistic_precision** - Refine language for exact meaning
+- **holistic_effectiveness** - Overall optimization for best results
+
+## Example Usage
+
+In Claude Desktop, you might ask:
+
+```
+Please optimize this prompt using the optimize_prompt tool:
+"Write me some code for a login system"
+
+Use goals: ["clarity", "specificity", "technical_accuracy"]
+```
+
+The tool will return an optimized version like:
+
+```
+Create a secure user authentication system with the following specifications:
+
+## Requirements:
+- Implement login functionality with username/email and password
+- Include proper input validation and sanitization  
+- Add password hashing using bcrypt or similar
+- Implement session management
+- Include error handling for invalid credentials
+- Add rate limiting to prevent brute force attacks
+
+## Deliverables:
+- Backend authentication logic
+- Frontend login form
+- Database schema for user accounts
+- Security best practices implementation
+
+Confidence Score: 0.87
+Quota Remaining: 195/200
+```
+
+## Subscription Tiers
+
+- **Explorer** ($5.99/month): 20 optimizations via Web UI only
+- **Creator** ($12.99/month): 200 optimizations + 1 API key + Template history
+- **Innovator** ($24.99/month): 450 optimizations + up to 10 API keys + Advanced analytics
+
+## Backend Infrastructure
+
+This package connects to a production-grade backend infrastructure:
+
+- **FastAPI Backend** - High-performance Python API server with async processing
+- **Northflank Hosting** - Enterprise cloud deployment platform with 99.9% uptime
+- **Supabase Database** - PostgreSQL database with real-time features and automatic backups
+- **Stripe Integration** - Secure payment processing and subscription management
+- **Template Storage System** - Automatic optimization history with rich metadata
+- **Advanced Analytics** - Usage tracking, performance monitoring, and optimization insights
+
+### Backend Endpoints
+- **Production API**: `https://p01--project-optimizer--fvrdk8m9k9j.code.run`
+- **Health Check**: `https://p01--project-optimizer--fvrdk8m9k9j.code.run/health`
+- **API Documentation**: Available through the web dashboard
+
+### Server Features
+- **Real-time Quota Tracking** - Live usage monitoring and limits
+- **Template Persistence** - Automatic saving with comprehensive metadata
+- **Rate Limiting** - Intelligent throttling to prevent abuse
+- **Security Monitoring** - Advanced threat detection and prevention
+- **Performance Optimization** - Sub-second response times for most requests
+
+## Commands
+
+```bash
+# Start the MCP server (usually called by MCP client)
+mcp-prompt-optimizer
+
+# Configure API key
+mcp-prompt-optimizer --setup
+
+# Show help
+mcp-prompt-optimizer --help
+
+# Show version
+mcp-prompt-optimizer --version
+
+# Test package functionality
+npm test
+```
+
+## Troubleshooting
+
+### API Key Issues
+
+```bash
+# Reconfigure your API key
+mcp-prompt-optimizer --setup
+```
+
+### Connection Issues
+
+1. Verify your internet connection
+2. Check that your API key is valid at [the dashboard](https://promptoptimizer-blog.vercel.app/dashboard)
+3. Ensure your subscription is active
+4. Try regenerating your API key from the dashboard
+5. Check backend status: `curl https://p01--project-optimizer--fvrdk8m9k9j.code.run/health`
+
+### MCP Client Configuration
+
+1. Make sure the configuration file path is correct
+2. Restart your MCP client after configuration changes
+3. Check that Node.js is installed and accessible
+4. Verify the package is installed globally: `npm list -g mcp-prompt-optimizer`
+
+### Backend Connection
+
+If you experience backend connectivity issues:
+
+```bash
+# Test backend directly
+curl -X GET "https://p01--project-optimizer--fvrdk8m9k9j.code.run/health"
+
+# Test with your API key
+curl -X POST "https://p01--project-optimizer--fvrdk8m9k9j.code.run/api/v1/validate-key" \
+     -H "X-API-Key: your-api-key-here"
+```
+
+## Configuration File Location
+
+Your API key is stored securely at:
+- **Windows**: `%USERPROFILE%\.prompt-optimizer\config.json`
+- **macOS/Linux**: `~/.prompt-optimizer/config.json`
+
+The configuration includes:
+```json
+{
+  "apiKey": "sk-opt-your-key-here",
+  "backendUrl": "https://p01--project-optimizer--fvrdk8m9k9j.code.run",
+  "updatedAt": "2025-06-05T12:00:00.000Z"
+}
+```
+
+## Environment Variables
+
+Override configuration with environment variables:
+
+- `PROMPT_OPTIMIZER_API_KEY`: Override stored API key
+- `PROMPT_OPTIMIZER_BACKEND_URL`: Override backend URL
+- `NODE_ENV`: Set to 'development' for debug logging
+
+Example:
+```bash
+PROMPT_OPTIMIZER_API_KEY=sk-opt-your-key mcp-prompt-optimizer
+```
+
+## API Compatibility
+
+This package is compatible with the FastAPI backend API version 0.2.2+ and supports:
+
+- ✅ **MCP Protocol 2024-11-05** - Latest MCP specification
+- ✅ **API Key Authentication** - Secure `sk-opt-` format keys
+- ✅ **Base64 Config Encoding** - MCP protocol compliance
+- ✅ **Real-time Quota Tracking** - Usage monitoring with template saving
+- ✅ **Error Handling** - Comprehensive error responses
+- ✅ **Rate Limiting** - Automatic retry logic
+- ✅ **Template Persistence** - Automatic optimization history
+
+## Intellectual Property
+
+- **Your Prompts, Your IP**: You retain full intellectual property rights over all prompts you create and optimize
+- **Service Provision**: We provide optimization as a service - we do not claim ownership over your content
+- **Template Storage**: Saved templates are for your reference and remain your intellectual property
+- **Privacy Protected**: Your prompts and templates are private and accessible only to your account
+- **Data Export**: You can export your optimization history and templates at any time
+
+## Support
+
+- 📚 [Documentation](https://promptoptimizer-blog.vercel.app/docs)
+- 🎫 [Support Portal](https://promptoptimizer-blog.vercel.app/support)
+- 🐛 [Report Issues](https://github.com/prompt-optimizer/mcp-prompt-optimizer/issues)
+- 💬 [Community Discord](https://discord.gg/prompt-optimizer)
+
+## Security
+
+- API keys are stored locally and never shared
+- All communication uses HTTPS encryption with the backend
+- No prompt data is stored permanently beyond template history (which you control)
+- Full audit trail of API usage available in dashboard
+- Compliance with enterprise security standards
+- Template data encrypted at rest and in transit
+
+## Development
+
+### Testing
+
+```bash
+# Run package tests
+npm test
+
+# Manual server test
+node test-package.js
+```
+
+### Local Development
+
+```bash
+# Clone the repository
+git clone https://github.com/prompt-optimizer/mcp-prompt-optimizer
+cd mcp-prompt-optimizer
+
+# Install dependencies
+npm install
+
+# Test locally
+npm test
+```
+
+## Changelog
+
+### v1.0.1
+- ✅ Updated backend URL to production deployment
+- ✅ Enhanced error handling for server responses
+- ✅ Improved repository information
+- ✅ Added comprehensive backend infrastructure documentation
+- ✅ Added template saving feature documentation
+
+### v1.0.0
+- 🎉 Initial release with MCP protocol support
+- ✅ Claude Desktop, Cursor, and Windsurf compatibility
+- ✅ API key authentication system
+- ✅ Complete optimization goal support
+
+## License
+
+**Commercial License** - This software is licensed for commercial use. See LICENSE file for details.
+
+**Your Content**: You retain full intellectual property rights over all prompts, templates, and content you create using this service.
+
+---
+
+**Made with ❤️ by the Prompt Optimizer Team**  
+*Empowering better AI interactions through optimized prompts*

package/bin/start-server

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+require('../index.js');