UNPKG

yoda-mcp

Version:

Intelligent Planning MCP with Optional Dependencies and Graceful Fallbacks - wise planning through the Force of lean excellence

411 lines (312 loc) 15 kB
# Frequently Asked Questions (FAQ) ## General Questions ### What is Planner MCP? Planner MCP is an enterprise-grade planning platform that orchestrates multiple Model Context Protocol (MCP) servers to deliver world-class implementation plans. It combines AI-powered analysis, quality validation, and enterprise security to create comprehensive planning solutions. ### How does Planner MCP work? The system coordinates four specialized MCP servers: - **Serena MCP**: Project memory and context management - **Sequential MCP**: Step-by-step logical reasoning - **Context7 MCP**: Best practices and pattern recommendations - **TodoList MCP**: Task management and execution planning These servers work together through an intelligent orchestration engine that ensures high-quality, comprehensive plans. ### What makes a plan "world-class"? World-class plans (85+ quality score) demonstrate: - Complete requirement coverage with detailed implementation - Technical accuracy and feasibility assessment - Industry best practices integration - Comprehensive security and performance considerations - Innovation and creative problem-solving - Clear documentation and communication ### Who can use Planner MCP? Planner MCP serves various user types: - **Software Development Teams**: Architecture and implementation planning - **Product Managers**: Feature and roadmap planning - **Architects**: System design and technical planning - **Consultants**: Client solution planning - **Entrepreneurs**: Startup and product planning ## Technical Questions ### What technologies does Planner MCP support? Planner MCP supports a wide range of technologies: - **Frontend**: React, Vue, Angular, Svelte, vanilla JavaScript - **Backend**: Node.js, Python, Java, .NET, Go, Rust, PHP - **Databases**: PostgreSQL, MySQL, MongoDB, Redis, Elasticsearch - **Cloud Platforms**: AWS, Azure, Google Cloud, Digital Ocean - **DevOps**: Docker, Kubernetes, CI/CD pipelines - **Mobile**: React Native, Flutter, native iOS/Android ### How accurate are the implementation plans? Plan accuracy depends on several factors: - **Input Quality**: Clear, specific requirements improve accuracy - **Complexity Level**: Appropriate complexity selection ensures realistic plans - **Context Information**: More context leads to better recommendations - **Technology Familiarity**: Common tech stacks have higher accuracy Quality scores provide accuracy indicators: - **90-100**: Highly accurate, comprehensive plans - **80-89**: Very accurate with minor gaps - **70-79**: Generally accurate, may need refinement - **60-69**: Reasonably accurate, requires review - **<60**: May need significant enhancement ### Can I customize the planning process? Yes, Planner MCP offers several customization options: - **Custom Quality Requirements**: Specify domain-specific criteria - **Technology Preferences**: Indicate preferred technologies - **Compliance Requirements**: Include regulatory standards - **Team Constraints**: Account for team skills and resources - **Architectural Patterns**: Prefer specific design patterns ### How does the hybrid fallback system work? The system operates with 5 capability tiers: | Tier | MCPs Available | Capability | Use Case | |------|----------------|------------|----------| | Premium | 4/4 | 100% | Full functionality | | Enhanced | 3/4 | 80% | Minor service degradation | | Standard | 2/4 | 60% | Reduced capabilities | | Basic | 1/4 | 40% | Minimal functionality | | Emergency | 0/4 | 20% | Static responses only | The system automatically adjusts and notifies users when capability changes occur. ## Planning Process Questions ### How long does it take to create a plan? Plan creation time varies by complexity: - **Simple Plans**: 15-30 seconds - **Moderate Plans**: 30-60 seconds - **Complex Plans**: 1-2 minutes - **Enterprise Plans**: 2-5 minutes - **World-Class Plans**: 3-10 minutes (includes multiple validation passes) ### Can I modify a plan after it's created? Yes, you can modify plans through several methods: - **Update Requirements**: Add or modify requirements - **Request Enhancement**: Improve specific aspects - **Quality Upgrade**: Target higher quality tiers - **Technology Changes**: Switch technology preferences - **Timeline Adjustments**: Modify deadlines and milestones ### What if I'm not satisfied with my plan? If a plan doesn't meet your expectations: 1. **Request Enhancement**: Use the automatic enhancement feature 2. **Provide Feedback**: Help the system learn your preferences 3. **Adjust Requirements**: Clarify or expand requirements 4. **Try Different Complexity**: Experiment with complexity levels 5. **Contact Support**: Get help from our planning experts ### How do I write effective requirements? Follow these best practices: **Good Requirements:** ``` ✅ Specific and measurable ✅ Include functional and non-functional needs ✅ Provide context and constraints ✅ Specify success criteria ✅ Include user personas and use cases ``` **Poor Requirements:** ``` ❌ "Build a good app" ❌ "Make it user-friendly" ❌ "Add some features" ❌ "It should be fast" ``` **Example of Good Requirements:** ``` Create a task management web application with: - User registration and authentication (OAuth2 social login) - CRUD operations for tasks with categories and priorities - Real-time collaboration for shared task lists - Mobile-responsive design supporting tablets and phones - Search and filtering capabilities - Email notifications for due tasks - RESTful API for third-party integrations - Support for 1000+ concurrent users - < 2 second page load times - WCAG 2.1 AA accessibility compliance ``` ## Quality and Validation Questions ### What does the quality score mean? The quality score (0-100) represents overall plan quality across multiple dimensions: **Score Breakdown:** - **Completeness (20%)**: Requirement coverage - **Technical Accuracy (18%)**: Implementation feasibility - **Best Practices (15%)**: Industry standards - **Implementation Detail (12%)**: Actionable specificity - **Security (10%)**: Security considerations - **Other Factors (25%)**: Performance, scalability, maintainability **Quality Tiers:** - **81-100 (WORLD_CLASS)**: Exceptional, innovative solutions - **61-80 (ENTERPRISE)**: Scalable, production-ready plans - **41-60 (PROFESSIONAL)**: Complete, well-structured plans - **21-40 (STANDARD)**: Functional, basic requirements met - **0-20 (BASIC)**: Incomplete, needs improvement ### How can I improve my plan's quality score? To achieve higher quality scores: 1. **Enhance Requirements**: Provide comprehensive, specific requirements 2. **Add Context**: Include relevant constraints, preferences, and background 3. **Specify Non-Functional Requirements**: Performance, security, scalability needs 4. **Include Stakeholder Information**: User types, business goals, success metrics 5. **Provide Technical Context**: Existing systems, team skills, technology preferences 6. **Use Enhancement Features**: Request automatic plan improvements ### Can I request specific quality levels? Yes, you can target specific quality tiers: ```javascript const request = { requirements: ["..."], targetQuality: "enterprise", // or "world_class" qualityRequirements: { minimumScore: 85, focus: ["security", "scalability", "performance"] } }; ``` ## Security and Privacy Questions ### How secure is my data? Planner MCP implements enterprise-grade security: - **Encryption**: AES-256-GCM for data at rest, TLS 1.3 for transit - **Authentication**: OAuth2/JWT with multi-factor authentication - **Authorization**: Role-based access control (RBAC) - **Compliance**: SOC2 Type II, GDPR, HIPAA ready - **Audit Logging**: Comprehensive activity tracking - **Field-Level Encryption**: Automatic PII protection ### Who can see my plans? Plan visibility is controlled by access permissions: - **Private Plans**: Only visible to you and explicitly shared users - **Team Plans**: Visible to team members with appropriate roles - **Organization Plans**: Visible to organization members based on roles - **Public Plans**: Optional public sharing (disabled by default) ### How long is my data retained? Data retention follows configurable policies: - **Plan Data**: Retained based on subscription tier (1-7 years) - **Audit Logs**: 2-7 years for compliance requirements - **Personal Data**: Subject to GDPR data subject rights - **Analytics Data**: Anonymized and aggregated for service improvement ### Can I delete my data? Yes, you have full control over your data: - **Individual Plans**: Delete specific plans anytime - **Account Data**: Request complete account deletion - **Right to Erasure**: GDPR-compliant data removal - **Data Portability**: Export your data in standard formats ## Pricing and Billing Questions ### What pricing tiers are available? Planner MCP offers flexible pricing tiers: | Tier | Plans/Month | Quality Level | Features | Price | |------|-------------|---------------|----------|-------| | **Starter** | 10 | Professional | Basic features | $29/month | | **Professional** | 50 | Enterprise | Advanced features | $99/month | | **Team** | 200 | Enterprise | Team collaboration | $299/month | | **Enterprise** | Unlimited | World-Class | Custom features | Contact Sales | ### Are there usage limits? Usage limits vary by tier: - **API Requests**: Based on subscription level - **Plan Storage**: Unlimited for all tiers - **Team Members**: Limited on lower tiers - **Support Level**: Higher tiers get priority support ### Can I upgrade or downgrade my plan? Yes, you can change your subscription anytime: - **Upgrades**: Take effect immediately with prorated billing - **Downgrades**: Take effect at the next billing cycle - **Enterprise**: Contact sales for custom arrangements ### Is there a free trial? Yes, we offer a 14-day free trial: - **Full Feature Access**: Try all premium features - **No Credit Card Required**: Sign up with just an email - **10 Plans Included**: Create up to 10 plans during trial - **Support Access**: Full support during trial period ## Integration Questions ### What integrations are available? Planner MCP integrates with popular tools: - **Project Management**: Jira, Asana, Monday.com, Trello - **Communication**: Slack, Microsoft Teams, Discord - **Development**: GitHub, GitLab, Bitbucket - **Documentation**: Notion, Confluence, Google Docs - **Design**: Figma, Sketch, Adobe Creative Suite ### Can I use the API? Yes, we provide comprehensive APIs: - **RESTful API**: Standard HTTP API for all functionality - **GraphQL API**: Flexible querying for complex data needs - **Webhooks**: Real-time notifications for plan events - **SDKs**: Official libraries for popular programming languages ### How do I set up webhooks? Configure webhooks to receive real-time notifications: ```javascript await planner.webhooks.create({ url: 'https://your-app.com/planner-webhook', events: ['plan.completed', 'plan.quality_updated'], secret: 'your_webhook_secret_key' }); ``` Supported events: - `plan.created` - `plan.completed` - `plan.updated` - `plan.quality_updated` - `plan.shared` - `plan.deleted` ## Support Questions ### What support options are available? Support varies by subscription tier: | Tier | Email | Chat | Phone | SLA | |------|-------|------|-------|-----| | **Starter** | ✅ | ❌ | ❌ | 48 hours | | **Professional** | ✅ | ✅ | ❌ | 24 hours | | **Team** | ✅ | ✅ | ✅ | 12 hours | | **Enterprise** | ✅ | ✅ | ✅ | 4 hours | ### How do I get help? Multiple support channels are available: 1. **Self-Service**: Documentation, FAQ, video tutorials 2. **Community**: Forum discussion and peer help 3. **Direct Support**: Email, chat, or phone based on tier 4. **Emergency**: 24/7 emergency support for critical issues ### What's included in onboarding? New customers receive onboarding support: - **Getting Started Guide**: Step-by-step setup instructions - **Best Practices Training**: How to write effective requirements - **API Integration Help**: Technical integration assistance - **Custom Configuration**: Help setting up organization preferences ## Technical Support ### What if I encounter a bug? Report bugs through these channels: 1. **In-App Reporting**: Use the built-in bug report feature 2. **Email**: bugs@planner-mcp.example.com 3. **GitHub Issues**: For open-source components 4. **Support Tickets**: Through the dashboard ### How do I request new features? Feature requests are welcome: 1. **Feature Request Form**: In the dashboard 2. **Community Forum**: Discuss with other users 3. **Direct Feedback**: feature-requests@planner-mcp.example.com 4. **Roadmap Voting**: Vote on proposed features ### What's your uptime guarantee? Service Level Agreements (SLA) by tier: - **Starter**: 99.0% uptime - **Professional**: 99.5% uptime - **Team**: 99.9% uptime - **Enterprise**: 99.95% uptime with custom SLA options ### How do I monitor service status? Stay informed about service status: - **Status Page**: [status.planner-mcp.example.com](https://status.planner-mcp.example.com) - **Twitter Updates**: [@PlannerMCPStatus](https://twitter.com/PlannerMCPStatus) - **Email Notifications**: Subscribe to status updates - **Slack Notifications**: Add status bot to your workspace ## Getting Started ### How do I create my first plan? Follow these steps: 1. **Sign Up**: Create account at [dashboard.planner-mcp.example.com](https://dashboard.planner-mcp.example.com) 2. **Verify Email**: Check email and verify your account 3. **Choose Subscription**: Select appropriate tier or start free trial 4. **Create Plan**: Use the guided plan creation wizard 5. **Review Results**: Analyze your first plan and quality score ### What should my first plan be? Start with something familiar: - **Personal Project**: Something you've built before - **Simple Scope**: Basic web application or mobile app - **Known Technologies**: Use technologies you're familiar with - **Clear Requirements**: Well-defined, specific requirements ### How can I learn more? Educational resources: - **Video Tutorials**: [tutorials.planner-mcp.example.com](https://tutorials.planner-mcp.example.com) - **Webinars**: Monthly planning best practices sessions - **Documentation**: Comprehensive guides and API references - **Community**: Connect with other users and experts - **Blog**: Regular updates on features and best practices --- **Still have questions?** - **Search Documentation**: [docs.planner-mcp.example.com](https://docs.planner-mcp.example.com) - **Ask the Community**: [community.planner-mcp.example.com](https://community.planner-mcp.example.com) - **Contact Support**: support@planner-mcp.example.com - **Schedule Demo**: Book a personalized demonstration **Last Updated**: {current_date} **Version**: 2.0 **Feedback**: [faq-feedback@planner-mcp.example.com](mailto:faq-feedback@planner-mcp.example.com)