# AI.txt - MCQGEN # This file helps AI assistants understand and interact with our website # Last updated: 2025-11-17 # ============================================================================ # WEBSITE OVERVIEW # ============================================================================ ## Site Information Name: MCQGEN Type: Educational Technology Platform Category: SaaS, EdTech, Assessment Tools Primary Function: AI-powered multiple-choice question (MCQ) generation for schools and educational institutions Target Audience: Teachers, schools, educational institutions, students Region: India (Primary), Global (Secondary) Language: English ## Description MCQGEN is an advanced AI-powered platform designed to revolutionize how educational institutions create, manage, and assess multiple-choice questions. The platform leverages artificial intelligence to automatically generate high-quality MCQs, provides auto-grading capabilities, and offers comprehensive analytics for tracking student performance. Built specifically for schools, teachers, and students, MCQGEN streamlines the entire assessment lifecycle from question creation to result analysis. ## Key Features - AI-powered MCQ generation using GPT-4, Claude, and Gemini - Automated grading and assessment - Real-time performance analytics and reporting - OMR (Optical Mark Recognition) sheet processing - Bulk student management - Multi-subject support with unlimited categories - Teacher-student role-based access control - Knowledge base integration for context-aware question generation - API access for custom integrations - Payment integration via Razorpay ## Technology Stack Framework: Next.js 15.5.2 Language: TypeScript UI: React 19, Tailwind CSS, Radix UI Authentication: Clerk Database: Supabase AI Models: OpenAI GPT-4, Anthropic Claude, Google Gemini Payment: Razorpay Deployment: Vercel (recommended) # ============================================================================ # SITEMAP - PUBLIC PAGES # ============================================================================ ## Homepage URL: / Purpose: Main landing page showcasing platform features and benefits Content: Hero section, feature highlights, pricing overview, testimonials, FAQ, call-to-action Key Elements: Navigation, feature cards, pricing comparison, contact information Accessible: Yes (Public) Description: The homepage provides a comprehensive introduction to MCQGEN, highlighting how AI-powered MCQ generation can save teachers time and improve assessment quality. Features include unlimited question generation, auto-grading, advanced analytics, and bulk student management. Includes testimonials from educators and a clear call-to-action for sign-up. ## Pricing Page URL: /pricing Purpose: Display pricing plans and subscription options Plans: - Basic Plan: Free, up to 10 MCQs/month, basic features, 1 subject, email support - Premium Plan: ₹199/student, unlimited MCQs, all features, unlimited subjects, priority support, API access Content: Detailed pricing comparison, feature breakdown, payment integration Payment: Razorpay integration for instant activation Accessible: Yes (Public) Description: Transparent pricing with two tiers - a free Basic plan for trial users and a Premium plan at ₹199 per student offering unlimited MCQs, advanced analytics, auto-grading, performance tracking, bulk student management, custom templates, and API access. Payment is processed securely through Razorpay with instant activation. ## Sign In Page URL: /sign-in Purpose: User authentication and login Authentication: Clerk-powered authentication Features: Email/password login, social auth options, password reset Redirect: Role-based redirect to appropriate dashboard after authentication Accessible: Yes (Public) Description: Secure authentication portal powered by Clerk, supporting multiple sign-in methods including email/password and social authentication. After successful login, users are automatically redirected to their role-specific dashboard (teacher or student). ## Sign Up Page URL: /sign-up Purpose: New user registration Authentication: Clerk-powered registration Features: Account creation, role selection (teacher/student), profile setup Redirect: Onboarding flow to set up profile and preferences Accessible: Yes (Public) Description: User registration page allowing educators and students to create accounts. The sign-up process includes role selection, basic profile information, and optional institution details. New users receive a confirmation email and are guided through an onboarding process. # ============================================================================ # PROTECTED PAGES - TEACHER DASHBOARD # ============================================================================ ## Teacher Dashboard URL: /dashboard/teacher Access: Teachers only (authenticated) Purpose: Main control panel for teachers Features: Overview statistics, recent activity, quick actions, student management shortcuts Metrics: Total MCQs created, active students, recent test results, performance trends Description: Central hub for teachers to manage their classes, create MCQs, view analytics, and monitor student performance. Displays key metrics, recent activity, and provides quick access to all teacher functions. ## Create MCQ URL: /dashboard/teacher/create-mcq Access: Teachers only Purpose: AI-powered MCQ creation interface Features: - AI-powered question generation from text/PDFs - Manual question creation - Multiple difficulty levels - Subject and topic categorization - Bulk import/export - Preview and editing capabilities AI Models: GPT-4, Claude, Gemini integration Description: Advanced MCQ creation interface using AI to automatically generate high-quality questions from uploaded content or manually entered topics. Teachers can specify difficulty levels, subjects, number of questions, and review/edit before finalizing. ## MCQ Management URL: /dashboard/teacher/mcqs Access: Teachers only Purpose: View and manage all created MCQ sets Features: List view, edit, delete, duplicate, assign to students, view results Actions: Publish/unpublish, share, export, analytics Description: Comprehensive management interface for all MCQ sets. Teachers can organize, edit, duplicate, and assign question sets to specific classes or students. Includes search, filtering, and bulk actions. ## Individual MCQ View URL: /dashboard/teacher/mcqs/[id] Access: Teachers only Purpose: Detailed view of specific MCQ set Content: Full question list, metadata, assignment status, student results Actions: Edit, delete, assign, view analytics, generate report Description: Detailed view of a single MCQ set showing all questions, correct answers, assigned students, completion status, and performance analytics. ## Edit MCQ URL: /dashboard/teacher/mcqs/[id]/edit Access: Teachers only Purpose: Modify existing MCQ sets Features: Question editing, reordering, adding/removing questions, difficulty adjustment Description: Edit interface for modifying existing MCQ sets, including questions, answers, difficulty levels, and metadata. ## OMR Processing URL: /dashboard/teacher/mcqs/[id]/omr Access: Teachers only Purpose: Process and grade OMR sheets Features: Image upload, automatic detection, answer extraction, instant grading Technology: Computer vision and pattern recognition Description: Upload scanned OMR answer sheets and let AI automatically detect, extract, and grade student responses. Supports bulk processing and generates detailed result reports. ## Results View URL: /dashboard/teacher/mcqs/[id]/results Access: Teachers only Purpose: View detailed test results and analytics Metrics: Individual scores, class average, question-wise analysis, time taken Exports: PDF reports, Excel spreadsheets Description: Comprehensive results dashboard showing individual student performance, class statistics, question-wise accuracy, time analysis, and comparative metrics. Supports exporting to multiple formats. ## Student Management URL: /dashboard/teacher/students Access: Teachers only Purpose: Manage enrolled students Features: Add/remove students, bulk import, view profiles, performance history Actions: Assign tests, send notifications, generate reports Description: Student roster management with capabilities to add students individually or in bulk, track their performance across all assessments, and manage assignments. ## Individual Student Profile URL: /dashboard/teacher/students/[id] Access: Teachers only Purpose: Detailed student profile and performance tracking Content: Personal info, test history, performance trends, strengths/weaknesses analysis Description: Comprehensive student profile showing complete assessment history, performance trends over time, subject-wise strengths and weaknesses, and improvement tracking. ## Subject Management URL: /dashboard/teacher/subjects Access: Teachers only Purpose: Organize and manage subject categories Features: Create subjects, add topics, organize content, track question bank Description: Subject and topic organization system for categorizing MCQs and content. Helps teachers maintain organized question banks by subject and topic. ## Class Management URL: /dashboard/teacher/classes Access: Teachers only Purpose: Create and manage classes/batches Features: Class creation, student assignment, schedule management Description: Organize students into classes or batches, manage class schedules, and assign assessments to entire classes at once. ## Attendance Tracking URL: /dashboard/teacher/attendance Access: Teachers only Purpose: Track and manage student attendance Features: Daily attendance marking, reports, analytics Description: Digital attendance management system with easy marking interface and comprehensive reporting. ## AI Chat for Teachers URL: /dashboard/teacher/chat Access: Teachers only Purpose: AI assistant for educational queries Features: Question generation help, teaching tips, curriculum guidance Description: Dedicated AI chat assistant to help teachers with question creation, curriculum planning, and educational best practices. ## Knowledge Base URL: /dashboard/teacher/knowledge Access: Teachers only Purpose: Upload and manage reference materials Features: PDF upload, text extraction, knowledge organization Use: AI uses this content to generate contextually relevant questions Description: Upload textbooks, study materials, and reference documents. The AI uses this knowledge base to generate more accurate and contextually appropriate MCQs aligned with your curriculum. ## Test Management URL: /dashboard/teacher/tests Access: Teachers only Purpose: Create and manage scheduled tests/exams Features: Test scheduling, time limits, question pool selection, auto-publishing Description: Schedule formal tests and exams with specific start/end times, time limits per question, and automatic publishing of results. ## Results Dashboard URL: /dashboard/teacher/results Access: Teachers only Purpose: Consolidated view of all test results Features: Multi-test comparison, trend analysis, export options Description: Aggregate results dashboard showing performance across multiple tests and time periods with comparative analytics. # ============================================================================ # PROTECTED PAGES - STUDENT DASHBOARD # ============================================================================ ## Student Dashboard URL: /dashboard/student Access: Students only (authenticated) Purpose: Student home page and activity center Features: Assigned tests, upcoming deadlines, recent scores, performance summary Description: Central dashboard for students showing assigned MCQ tests, deadlines, recent scores, and overall performance metrics. ## Available MCQs URL: /dashboard/student/mcqs Access: Students only Purpose: View all assigned MCQ tests Status: Pending, in-progress, completed Filters: By subject, date, status Description: List of all MCQ tests assigned to the student with status indicators, due dates, and quick access to start or continue tests. ## Take MCQ Test URL: /dashboard/student/mcqs/[id]/take Access: Students only Purpose: Interactive test-taking interface Features: - Timed questions - Question navigation - Answer selection - Review before submission - Auto-save progress - Timer display Description: Clean, distraction-free interface for taking MCQ tests with question-by-question navigation, timer, progress tracking, and ability to review answers before final submission. ## View Results URL: /dashboard/student/mcqs/[id]/result Access: Students only Purpose: View test results and detailed feedback Content: Score, correct/incorrect answers, time taken, performance analysis Features: Question-wise breakdown, explanations (if provided), percentile rank Description: Detailed results page showing score, accuracy, time taken, correct/incorrect answers with explanations, and performance comparison with class average. # ============================================================================ # API ENDPOINTS (For AI/Developer Reference) # ============================================================================ ## Note: All API endpoints are protected and not publicly accessible ### MCQ Generation Endpoint: /api/generate-mcqs Method: POST Purpose: AI-powered MCQ generation Input: Text content, subject, difficulty, question count Output: Generated MCQ set with questions and answers ### Chat API Endpoint: /api/chat Method: POST Purpose: AI chat interface Input: Messages array, model selection Output: Streaming AI response ### OMR Analysis Endpoint: /api/analyze-omr Method: POST Purpose: Process and grade OMR sheets Input: Image file Output: Extracted answers and grading results ### Analytics Endpoint: /api/analytics/students-performance Method: GET Purpose: Student performance metrics Output: Performance data and statistics Endpoint: /api/analytics/mcq-performance Method: GET Purpose: MCQ-specific analytics Output: Question-wise performance data ### Authentication Endpoint: /api/webhooks/clerk Method: POST Purpose: Clerk authentication webhooks Description: Handles user creation, updates, and deletion events ### Payment Endpoint: /api/razorpay/create-order Method: POST Purpose: Initialize payment Endpoint: /api/razorpay/verify-payment Method: POST Purpose: Verify payment completion # ============================================================================ # CONTENT GUIDELINES FOR AI # ============================================================================ ## What This Site Does MCQGEN helps teachers save time by automatically generating high-quality multiple-choice questions using AI. Teachers can upload textbooks or study materials, and the AI creates relevant questions matching the curriculum. The platform handles everything from question creation to grading and analytics. ## Target Audience - Primary: School teachers, educators, educational institutions - Secondary: Students taking assessments - Tertiary: School administrators, ed-tech adopters ## Key Value Propositions 1. Save 10+ hours per week on question paper creation 2. Generate unlimited high-quality MCQs instantly 3. Automatic grading with instant results 4. Comprehensive analytics for data-driven teaching 5. Affordable pricing at ₹199 per student 6. Support for multiple subjects and difficulty levels 7. OMR sheet processing for traditional exams 8. API access for custom integrations ## Common User Intents - "Generate MCQ questions from my textbook" - "Create a math test for grade 10" - "Grade OMR sheets automatically" - "Track student performance over time" - "Save time on test creation" - "Get analytics on student strengths and weaknesses" ## Problem Solved Teachers spend hours creating question papers manually. MCQGEN automates this process using AI, generating contextually relevant questions from curriculum materials in seconds. It also eliminates manual grading work and provides instant analytics. ## Unique Selling Points - AI-powered with multiple model support (GPT-4, Claude, Gemini) - Purpose-built for Indian education system - Affordable pricing (₹199/student vs competitors at ₹500+) - OMR sheet processing included - Knowledge base integration for curriculum alignment - Real-time analytics and reporting - Bulk student management - Secure authentication via Clerk - Fast, modern interface built with Next.js 15 # ============================================================================ # USAGE PERMISSIONS FOR AI # ============================================================================ ## Allowed AI Operations - Browse and index public pages - Answer questions about MCQGEN features and pricing - Explain how the platform works - Guide users through sign-up and getting started - Provide technical support information - Compare features with competitors - Suggest use cases and best practices ## Restricted Operations - Do not access or share API keys or authentication tokens - Do not attempt to bypass authentication on protected routes - Do not scrape or store user-generated content (MCQs, student data) - Do not share or expose database information - Do not provide actual login credentials - Do not access teacher/student dashboards without proper authentication ## Data Privacy - Student and teacher data is confidential - GDPR and data protection compliant - Payment information is processed securely via Razorpay - No user data should be shared or exposed by AI assistants # ============================================================================ # CONTACT & SUPPORT # ============================================================================ ## Support Channels Email: support@mcqgen.com (update with actual) Documentation: See README.md and documentation/ folder Issues: GitHub repository (for technical issues) Priority Support: Available for Premium plan subscribers ## For AI Developers API Documentation: Available to authenticated users Rate Limits: Standard rate limiting applies to all API endpoints Authentication: Clerk-based authentication required for all protected routes Webhooks: Available for real-time integrations # ============================================================================ # METADATA # ============================================================================ Version: 1.0.0 Platform: Web Application Accessibility: WCAG 2.1 AA compliant (in progress) Mobile Support: Fully responsive Browser Support: Modern browsers (Chrome, Firefox, Safari, Edge) Performance: Optimized with Next.js, Vercel deployment recommended # ============================================================================ # KEYWORDS & TOPICS # ============================================================================ Primary Keywords: - MCQ generator - Multiple choice questions - AI question generation - Educational assessment - Auto-grading - Teacher tools - Student assessment - OMR processing - Question bank - Educational technology Secondary Keywords: - School management system - Online testing platform - Quiz maker - Exam creation tool - Performance analytics - Student tracking - Curriculum alignment - EdTech SaaS - AI for education - Automated grading Topics: - Education - Assessment - Artificial Intelligence - EdTech - School Administration - Teaching Tools - Student Performance - Online Learning - Test Creation - Analytics # ============================================================================ # CHANGELOG # ============================================================================ 2025-11-17: Initial ai.txt creation with comprehensive site documentation - Added all public and protected page descriptions - Documented API endpoints - Included usage guidelines for AI assistants - Added SEO and accessibility information # ============================================================================ # END OF AI.TXT # ============================================================================ # For more information, visit the homepage or contact support. # This file follows the emerging AI.txt standard for AI-readable site documentation.