# 🌍 MCP Prompt Optimizer Local - Cross-Platform Edition

> **Final release - this package is deprecated.** It is a rules-based prompt formatter with no LLM tier. Frontier models rewrite prompts better on their own, so we are no longer developing it. Existing keys keep working; any end date will be announced in advance. For templates, evaluation and Context Engineering use the cloud package: `npm install -g mcp-prompt-optimizer`.

Advanced Local Prompt Intelligence Engine with complete privacy and sophisticated content analysis. Now with **universal cross-platform support** for Windows, macOS, and Linux.

## 🎬 Demo Video

See the MCP Prompt Optimizer Local in action! Watch our comprehensive demo:

**[🎥 Watch on YouTube](https://www.youtube.com/watch?v=6DA6niJR8Es)**

*Complete installation and usage demonstration showing:*
- ⚡ Quick cross-platform installation
- 🔑 License setup (Basic FREE + Pro $79 one-time)  
- 🔧 MCP client configuration
- 🧠 Live prompt optimization examples
- 🤖 Rules-based optimization showcase

---

## 🚀 Quick Start

### 1. Get Your Local License Key
Visit [https://promptoptimizer.xyz/local-license](https://promptoptimizer.xyz/local-license) to get your local license key.

### 2. Set Your License Key
```bash
# Option 1: Environment variable (recommended)
export OPTIMIZER_API_KEY="sk-local-basic-your-key-here"

# Option 2: Add to shell profile
echo 'export OPTIMIZER_API_KEY="sk-local-basic-your-key-here"' >> ~/.bashrc
source ~/.bashrc
```

### 3. Install Globally
```bash
npm install -g mcp-prompt-optimizer-local
```

### 4. Verify Installation
```bash
mcp-prompt-optimizer-local --version
mcp-prompt-optimizer-local check-license
```

## 🎯 MCP Client Configuration

### **Claude Desktop** (`~/.claude/claude_desktop_config.json`)

**Basic Configuration (Rules-based optimization only):**
```json
{
  "mcpServers": {
    "prompt-optimizer-local": {
      "command": "mcp-prompt-optimizer-local",
      "env": {
        "OPTIMIZER_API_KEY": "sk-local-basic-your-key-here"
      }
    }
  }
}
```

**Pro configuration:**
```json
{
  "mcpServers": {
    "prompt-optimizer-local": {
      "command": "mcp-prompt-optimizer-local",
      "env": {
        "OPTIMIZER_API_KEY": "sk-local-pro-your-key-here"
      }
    }
  }
}
```

### **Cursor** (Settings → Extensions → MCP)

```json
{
  "mcpServers": {
    "prompt-optimizer-local": {
      "command": "mcp-prompt-optimizer-local",
      "env": {
        "OPTIMIZER_API_KEY": "sk-local-pro-your-key-here"
      }
    }
  }
}
```

### **Windsurf** (MCP Settings)

```json
{
  "mcpServers": {
    "prompt-optimizer-local": {
      "command": "mcp-prompt-optimizer-local",
      "env": {
        "OPTIMIZER_API_KEY": "sk-local-pro-your-key-here"
      }
    }
  }
}
```

## 🌍 Platform Support

| Platform | Architecture | Status | Auto-Install |
|----------|-------------|--------|--------------|
| 🪟 **Windows** | x64 | ✅ Production Ready | ✅ |
| 🍎 **macOS** | Intel (x64) | ✅ Full Support | ✅ |
| 🍎 **macOS** | Apple Silicon (M1/M2/M3+) | ✅ Full Support | ✅ |
| 🐧 **Linux** | x64 | ✅ Full Support | ✅ |
| 🐧 **Linux** | ARM64 | ✅ Full Support | ✅ |

**Single command works everywhere!** The installer automatically:
- Detects your platform and architecture
- Downloads the correct native binary
- Verifies integrity with SHA256 checksums
- Sets proper permissions and validates installation

## 🛡️ Security Features

- **🔑 License Key Authentication** - Prevents unauthorized usage
- **🔍 Binary Integrity Verification** - SHA256 hash validation
- **🚪 Multi-Gate Installation** - Four-layer security validation
- **🏠 Local Processing** - Prompts are optimized on your machine and never sent to the backend. The free tier needs no key and makes no network calls; a license key is validated with the backend
- **🛡️ Tamper Detection** - Detects modified or corrupted binaries

## 🎯 Key Features

- **🧠 Intelligent Content Analysis** - Advanced prompt optimization
- **🔧 Technical Parameter Preservation** - Maintains code and technical details
- **🐛 Debugging Scenario Detection** - Context-aware optimization
- **📝 Template Management** - Save and reuse optimization patterns
- **🤖 Rules-based optimization**: AI-aware, runs entirely on your machine; no LLM calls and no OpenAI key needed
- **⚡ Performance Optimized** - fast local startup, sub-second optimization on typical prompts

## 💰 Licensing Options

### **Basic License** - FREE
- ✅ **5 optimizations/day** - Perfect for trying the platform
- ✅ **Complete privacy** - No data transmission
- ✅ **Rules-based optimization** - Sophisticated AI-aware engine
- ✅ **Local processing** - Runs entirely on your machine

### **Pro License** - $79 One-Time
- ✅ **Unlimited optimizations** - No daily limits
- ✅ **Enhanced algorithms** - Advanced optimization techniques
- ✅ **Priority binary updates** - Latest optimization improvements
- ✅ **License validation cached for 1 hour** - a keyed license needs to reach the backend to re-validate

## 📖 Usage Examples

### Basic Optimization
```bash
# Start MCP server
mcp-prompt-optimizer-local

# Check license status
mcp-prompt-optimizer-local check-license

# Show help
mcp-prompt-optimizer-local help
```

### Configuration Options

#### License Key Sources (Priority Order)
1. **Environment Variable**: `OPTIMIZER_API_KEY`
2. **User Config File**: `~/.mcp_optimizer/config.json`
3. **Project .env File**: `.env` in current directory

#### Example Config File
```json
{
  "apiKey": "sk-local-pro-your-key-here",
  "features_enabled": [
    "local_processing",
    "template_management",
    "cross_platform_support"
  ]
}
```

## 🔧 Platform-Specific Notes

### 🍎 macOS
- **Security**: First run may show security dialog - click "Allow"
- **Architectures**: Automatic detection of Intel vs Apple Silicon
- **Permissions**: Installer sets executable permissions automatically

### 🐧 Linux
- **Distributions**: Tested on Ubuntu, Debian, CentOS, Fedora, Arch
- **ARM64**: Full support for Raspberry Pi and ARM servers
- **Permissions**: Automatic `chmod +x` during installation

### 🪟 Windows
- **Versions**: Windows 10, 11, Server 2019/2022
- **Architecture**: x64 support with native binary
- **Antivirus**: May require approval for new binary execution

## 🚨 Troubleshooting

### Installation Issues
```bash
# Clear npm cache
npm cache clean --force

# Reinstall package
npm uninstall -g mcp-prompt-optimizer-local
npm install -g mcp-prompt-optimizer-local

# Check platform detection
node -e "console.log('Platform:', process.platform, 'Arch:', process.arch)"
```

### Binary Issues
```bash
# Verify security components
npm run verify-security

# Check binary integrity
npm run validate-manifest

# Manual download (if automatic fails)
# Binaries available at: https://github.com/nivlewd1/mcp-prompt-optimizer-local/releases
```

### Permission Issues (macOS/Linux)
```bash
# Fix permissions manually
chmod +x ~/.npm-global/lib/node_modules/mcp-prompt-optimizer-local/bin/mcp-optimizer-*
```

## 🏢 Enterprise Deployment

### Docker Support
```dockerfile
FROM node:18-alpine
RUN npm install -g mcp-prompt-optimizer-local
ENV OPTIMIZER_API_KEY="sk-local-pro-your-key-here"
RUN mcp-prompt-optimizer-local check-license
```

### Kubernetes Deployment
```yaml
apiVersion: v1
kind: Secret
metadata:
  name: mcp-optimizer-keys
type: Opaque
stringData:
  OPTIMIZER_API_KEY: "sk-local-pro-your-key-here"
```

### CI/CD Integration
```yaml
- name: Install MCP Optimizer
  run: |
    export OPTIMIZER_API_KEY="${{ secrets.OPTIMIZER_API_KEY }}"
    npm install -g mcp-prompt-optimizer-local
    mcp-prompt-optimizer-local check-license
```

## 🔄 Upgrading

```bash
npm update -g mcp-prompt-optimizer-local
mcp-prompt-optimizer-local --version
```

See [CHANGELOG.md](./CHANGELOG.md) for breaking changes between versions.

## 📚 Documentation

- **📖 Full Documentation**: [https://promptoptimizer.xyz/docs](https://promptoptimizer.xyz/docs)
- **🌍 Cross-Platform Guide**: [CROSS-PLATFORM.md](./CROSS-PLATFORM.md)
- **📝 Changelog**: [CHANGELOG.md](./CHANGELOG.md)
- **🏗️ Implementation Details**: [IMPLEMENTATION-SUMMARY.md](./IMPLEMENTATION-SUMMARY.md)

## 🆘 Support

- **🐛 Issues**: [GitHub Issues](https://github.com/nivlewd1/mcp-prompt-optimizer-local/issues)
- **📧 Email**: support@promptoptimizer.xyz
- **💬 Discussions**: [GitHub Discussions](https://github.com/nivlewd1/mcp-prompt-optimizer-local/discussions)

## 🏆 What's New

See [CHANGELOG.md](./CHANGELOG.md) for the full, version-by-version release history.

## 📊 Technical Specifications

- **Node.js**: >=16.0.0
- **npm**: >=8.0.0
- **Binary Size**: ~15-20MB per platform
- **Memory Usage**: <100MB typical
- **Startup Time**: <2 seconds
- **Optimization Speed**: <500ms per request

**Ready to optimize prompts on any platform? Install now and experience the future of cross-platform prompt intelligence!** 🚀

## 🏷️ License

Commercial License - see [LICENSE](./LICENSE) for details.

---

<div align="center">

**⭐ Star this repo if you find it useful!**

[🚀 Install Now](https://www.npmjs.com/package/mcp-prompt-optimizer-local) • [📖 Documentation](https://promptoptimizer.xyz/docs) • [🌍 Cross-Platform Guide](./CROSS-PLATFORM.md)

</div>