Skip to main content

Documentation

Complete guide to integrating and using Prompt Optimizer's cloud platform and local MCP bridge

Direct API Access

Call our cloud API directly for web apps and custom integrations

curl -X POST api/v1/optimize
-H "X-API-Key: sk-opt-your-key"

MCP Bridge Setup

Install our NPM package for seamless AI client integration

npm install -g mcp-prompt-optimizer
mcp-prompt-optimizer --setup

Platform Overview

Prompt Optimizer is a hybrid AI prompt enhancement platform that combines cloud-hosted infrastructure with flexible deployment options:

• Cloud-hosted optimization engine with enterprise-grade performance

• Direct API access for custom integrations and web applications

• Local MCP bridge server for seamless AI client integration

• Support for 17+ AI development tools including Claude Desktop, Cursor, and Windsurf

• Automatic template saving with comprehensive optimization history

• Subscription-based access with usage quotas and API key management

Deployment Options

Option 1: Direct API Access

• Call our cloud API directly from your applications

• RESTful endpoints with JSON request/response format

• Authentication via API keys (sk-opt-* format)

• Real-time optimization responses under 50ms average

• Ideal for web applications, scripts, and custom integrations

Option 2: Local MCP Bridge

• Install our NPM package: npm install -g mcp-prompt-optimizer

• Local server acts as bridge between MCP clients and cloud API

• Zero configuration needed beyond API key setup

• Seamless integration with Claude Desktop, Cursor, Windsurf, and more

• Perfect for AI-assisted development workflows

API Reference

**Base URL:** https://p01--project-optimizer--fvrdk8m9k9j.code.run

Authentication:

• All requests require API key in X-API-Key header

• API keys format: sk-opt-[random-string]

• Generate keys from your dashboard after subscribing

Core Endpoints:

• POST /api/v1/optimize - Main optimization endpoint

• GET /api/v1/templates - Retrieve saved templates

• GET /api/v1/usage - Check quota and usage statistics

• GET /health - Service health check

Optimization Goals:

clarity, conciseness, technical_accuracy, contextual_relevance, specificity, actionability, structure, technical_precision, linguistic_precision, holistic_effectiveness

MCP Client Setup

Step 1: Install NPM Package

npm install -g mcp-prompt-optimizer

Step 2: Configure API Key

mcp-prompt-optimizer --setup

Enter your API key when prompted (get from dashboard)

Step 3: Configure Your MCP Client

**Claude Desktop** (~/.claude/claude_desktop_config.json):

{

"mcpServers": {

"prompt-optimizer": {

"command": "npx",

"args": ["mcp-prompt-optimizer"]

}

}

}

**Cursor IDE** (~/.cursor/mcp.json):

Same configuration as Claude Desktop

Windsurf:

Add via Windsurf settings or configuration file

Template Management

Automatic Template Saving:

• Every successful optimization is automatically saved as a template

• Rich metadata includes timestamps, goals, confidence scores, and request IDs

• Templates linked to your account for privacy and organization

• Full audit trail for compliance and review purposes

Template Structure:

• Original and optimized prompt text

• Optimization goals and confidence metrics

• Context snapshots and model information

• User ID and request metadata for tracking

Access Methods:

• View templates through the web dashboard

• Export capabilities for data portability

• API endpoints for programmatic access

• Privacy-protected - only accessible to template owner

Subscription Plans

Explorer ($5.99/month):

• 20 optimizations per month via web interface only

• Basic prompt analysis and feedback

• Community forum support

• No API access or template saving

Creator ($12.99/month):

• 200 optimizations per month (web + API)

• 1 API key for programmatic access

• Template saving with standard limits

• Full dashboard and detailed metrics

• Priority email support

Innovator ($24.99/month):

• 450 optimizations per month

• Up to 10 API keys for team usage

• Unlimited template saving and history

• Early access to new features

• Dedicated support channel

Technical Infrastructure

Backend Technology:

• FastAPI-based Python backend with async processing

• Hosted on Northflank enterprise cloud platform

• PostgreSQL database via Supabase with real-time features

• Redis caching for performance optimization

Security & Compliance:

• HTTPS encryption for all communications

• API keys hashed and encrypted at rest

• Role-based access control (RBAC)

• SOC 2 Type II compliant infrastructure

• GDPR and CCPA privacy compliance

Performance & Reliability:

• 99.9% uptime SLA with monitoring

• Sub-50ms average response times

• Auto-scaling based on demand

• Global CDN for optimal latency

Troubleshooting

Common Issues:

API Key Problems:

• Verify key format starts with "sk-opt-"

• Check subscription is active in dashboard

• Regenerate key if needed

MCP Connection Issues:

• Verify NPM package is installed globally

• Check client configuration file syntax

• Restart MCP client after configuration changes

• Test with: curl https://p01--project-optimizer--fvrdk8m9k9j.code.run/health

Quota Limits:

• Monitor usage in dashboard

• Upgrade plan for higher limits

• Quotas reset monthly on billing date

Contact Support:

• Email: support@promptoptimizer.com

• Dashboard: Live chat for subscribers

• Documentation: Full API reference available