UNPKG

@simonecoelhosfo/optimizely-mcp-server

Version:

Optimizely MCP Server for AI assistants with integrated CLI tools

90 lines (63 loc) 3.28 kB
# 🎯 Optimizely MCP Server - User Documentation **Welcome!** This is your complete guide to using the Optimizely MCP Server with AI assistants like Claude Desktop, Cursor, and more. ## 🚀 **START HERE: Quick Setup (5 Minutes)** ### **📦 [Installation & Configuration Guide](INSTALLATION-GUIDE.md)** **Complete setup instructions** - Install the npm package and configure your AI assistant with proper MCP settings. ### **⚡ [Quick Start Guide](QUICK-START.md)** **Your first queries** - Get up and running with simple questions to explore your Optimizely data. --- ## 📖 **Complete Documentation** ### **For New Users** - **[Installation & Configuration Guide](INSTALLATION-GUIDE.md)** - Step-by-step setup - **[Quick Start Guide](QUICK-START.md)** - Your first 5 minutes with the system ### **For Regular Users** - **[Analytics Guide](ANALYTICS-GUIDE.md)** - Query your data with natural language - **[Workflows Guide](WORKFLOWS-GUIDE.md)** - Complete real-world examples - **[Export Guide](EXPORT-GUIDE.md)** - Export data to CSV, JSON, YAML ### **For Power Users** - **[Query Reference](QUERY-REFERENCE.md)** - All available data views and fields --- ## 🎯 **What You Can Do** ### **📊 Analytics & Reporting** - Query feature flags, experiments, and A/B tests - Get insights on performance and adoption - Export data for external analysis - Generate reports across projects ### **🔧 Management & Operations** - Create and configure feature flags - Set up A/B tests and experiments - Manage audiences and targeting - Monitor flag rollouts and experiment results ### **🤖 AI-Powered Insights** - Ask questions in natural language - Get recommendations for optimization - Understand complex data relationships - Automate routine data tasks --- ## 🔧 **System Requirements** - **Node.js**: Version 16 or higher - **npm**: For package installation - **AI Assistant**: Claude Desktop, Cursor, or MCP-compatible tool - **Optimizely Account**: With API access and project permissions --- ## 📋 **What's Included** -**MCP server** for AI assistant integration -**CLI tools** for direct command-line usage -**Analytics engine** with 14 data views -**Export functionality** (CSV, JSON, YAML) -**Template system** for creating entities -**Cache synchronization** for real-time data -**Comprehensive documentation** and examples --- ## 🆘 **Need Help?** 1. **Start with**: [Installation Guide](INSTALLATION-GUIDE.md) for setup 2. **Try the**: [Quick Start Guide](QUICK-START.md) for first queries 3. **Check**: [Analytics Guide](ANALYTICS-GUIDE.md) for advanced usage 4. **Review**: [Query Reference](QUERY-REFERENCE.md) for complete capabilities **💡 Pro Tip**: Begin with `"Show me all my Optimizely projects"` to verify everything is working correctly. --- ## 📦 **Package Information** - **NPM Package**: `@simonecoelhosfo/optimizely-mcp-server` - **Installation**: `npm install -g @simonecoelhosfo/optimizely-mcp-server` - **Configuration**: Uses MCP (Model Context Protocol) for AI assistant integration - **Compatibility**: Works with Claude Desktop, Cursor, and other MCP-compatible tools