UNPKG

@simonecoelhosfo/optimizely-mcp-server

Version:

Optimizely MCP Server for AI assistants with integrated CLI tools

94 lines (71 loc) 3.08 kB
# 📋 Complete User Documentation Index ## 🚀 **SETUP & INSTALLATION** ### **📦 [Installation & Configuration Guide](INSTALLATION-GUIDE.md)** **START HERE!** Complete setup instructions for installing the npm package and configuring your AI assistant. - NPM package installation - API token setup - AI assistant configuration (Claude Desktop, Cursor) - Environment variables explained - Troubleshooting common issues ### **⚡ [Quick Start Guide](QUICK-START.md)** **Your first 5 minutes** - Basic queries to get you started immediately. - First 3 essential queries - Understanding structured queries - Most common questions - Pro tips for success --- ## 📊 **CORE FUNCTIONALITY** ### **📈 [Analytics Guide](ANALYTICS-GUIDE.md)** **Query your data** - Complete guide to asking questions and getting insights. - Natural language to structured queries - All 14 analytics views - Filtering and sorting - Aggregation and grouping ### **🎯 [Workflows Guide](WORKFLOWS-GUIDE.md)** **Real-world examples** - Step-by-step workflows for common tasks. - Complete feature flag creation - A/B test setup and management - Audience building and targeting - Cross-project analysis ### **📤 [Export Guide](EXPORT-GUIDE.md)** **Get your data out** - Export results in multiple formats. - CSV exports for spreadsheets - JSON for applications - YAML for configuration - Bulk data operations --- ## 📖 **REFERENCE** ### **🔍 [Query Reference](QUERY-REFERENCE.md)** **Technical reference** - All available data views, fields, and operations. - Complete field listings - Data relationship maps - Query syntax examples - Performance considerations --- ## 🎯 **READING ORDER** ### **New to the System?** 1. **[Installation Guide](INSTALLATION-GUIDE.md)** - Set up everything properly 2. **[Quick Start Guide](QUICK-START.md)** - Your first queries 3. **[Analytics Guide](ANALYTICS-GUIDE.md)** - Learn to query effectively ### **Ready to Build Things?** 4. **[Workflows Guide](WORKFLOWS-GUIDE.md)** - Complete real examples 5. **[Export Guide](EXPORT-GUIDE.md)** - Get data for external use ### **Need Specific Information?** 6. **[Query Reference](QUERY-REFERENCE.md)** - Complete technical reference --- ## ⏱️ **Time Investment** | Document | Reading Time | Use Case | |----------|--------------|----------| | **Installation Guide** | 10 minutes | First-time setup | | **Quick Start Guide** | 5 minutes | Getting oriented | | **Analytics Guide** | 15 minutes | Learning to query | | **Workflows Guide** | 20 minutes | Building expertise | | **Export Guide** | 5 minutes | Data extraction | | **Query Reference** | 5 minutes | Looking up specifics | --- ## 🎯 **Success Path** **Day 1**: Installation Guide + Quick Start Guide (15 minutes) **Day 2**: Analytics Guide (15 minutes practicing) **Week 1**: Workflows Guide (try real examples) **Ongoing**: Query Reference (as needed) **Result**: Expert-level Optimizely data access through your AI assistant!