# ALwrity SEO CopilotKit User Guide
## Complete Guide to AI-Powered SEO Optimization
---
## π **Table of Contents**
1. [Getting Started](#getting-started)
2. [Understanding CopilotKit](#understanding-copilotkit)
3. [SEO Analysis Actions](#seo-analysis-actions)
4. [Content Optimization Actions](#content-optimization-actions)
5. [Technical SEO Actions](#technical-seo-actions)
6. [Advanced SEO Actions](#advanced-seo-actions)
7. [Dashboard & Visualization Actions](#dashboard--visualization-actions)
8. [Best Practices](#best-practices)
9. [Troubleshooting](#troubleshooting)
10. [FAQ](#faq)
---
## π **Getting Started**
### **What is SEO CopilotKit?**
SEO CopilotKit is an AI-powered assistant that helps you optimize your website's search engine performance. It provides 16 specialized actions that cover all aspects of SEO, from technical analysis to content optimization.
### **How to Access SEO CopilotKit**
1. Navigate to the SEO Dashboard in ALwrity
2. Look for the CopilotKit sidebar (usually on the right side)
3. The AI assistant will be ready to help with SEO tasks
### **Basic Interaction**
- **Ask Questions**: Type natural language questions about SEO
- **Request Actions**: Ask the AI to perform specific SEO tasks
- **Get Explanations**: Ask for explanations of SEO concepts
- **Receive Recommendations**: Get personalized SEO advice
---
## π€ **Understanding CopilotKit**
### **How It Works**
CopilotKit uses AI to understand your SEO needs and execute the appropriate actions. It can:
- Analyze your website's SEO performance
- Generate optimized content
- Provide technical recommendations
- Explain SEO concepts in simple terms
- Customize your dashboard
### **Available Context**
The AI has access to:
- Your current SEO analysis data
- Website performance metrics
- User preferences and settings
- Dashboard layout and configuration
- Available actions and suggestions
### **Response Types**
- **Direct Answers**: Immediate responses to questions
- **Action Results**: Results from executed SEO tasks
- **Recommendations**: Personalized suggestions
- **Explanations**: Educational content about SEO
---
## π **SEO Analysis Actions**
### **1. Comprehensive SEO Analysis**
**Action**: `analyzeSEOComprehensive`
**What it does**: Performs a complete SEO analysis of your website, covering technical, on-page, and content aspects.
**How to use**:
```
"Analyze the SEO of my website https://example.com"
"Perform a comprehensive SEO audit for my site"
"Check my website's overall SEO health"
```
**Parameters**:
- `url` (required): Your website URL
- `focusAreas` (optional): Specific areas to focus on (performance, content, technical, mobile)
**Example Response**:
```
β
Comprehensive SEO Analysis Complete
π Overall SEO Score: 78/100
π Key Findings:
β’ Technical SEO: Good (85/100)
β’ On-Page SEO: Needs Improvement (65/100)
β’ Content Quality: Excellent (90/100)
β’ Mobile Optimization: Good (80/100)
π¨ Critical Issues Found:
1. Missing meta descriptions on 15 pages
2. Slow page load speed (3.2s average)
3. Broken internal links (8 found)
π‘ Recommendations:
1. Add meta descriptions to all pages
2. Optimize images and reduce page size
3. Fix broken internal links
4. Improve mobile responsiveness
```
### **2. SEO Health Check**
**Action**: `checkSEOHealth`
**What it does**: Quickly assesses your website's overall SEO health and identifies critical issues.
**How to use**:
```
"Check my website's SEO health"
"What's my site's SEO score?"
"Identify critical SEO issues"
```
**Parameters**:
- `url` (required): Your website URL
**Example Response**:
```
π₯ SEO Health Check Results
π Health Score: 72/100 (Good)
β
Strengths:
β’ Fast loading times
β’ Mobile-friendly design
β’ Good content quality
β οΈ Issues to Address:
β’ Missing alt text on images
β’ Duplicate meta descriptions
β’ Poor internal linking structure
π― Priority Actions:
1. Add alt text to all images
2. Create unique meta descriptions
3. Improve internal link structure
```
---
## π **Content Optimization Actions**
### **3. Meta Description Generation**
**Action**: `generateMetaDescriptions`
**What it does**: Creates optimized meta descriptions for your web pages to improve click-through rates.
**How to use**:
```
"Generate meta descriptions for my homepage"
"Create SEO-friendly meta descriptions for my blog posts"
"Optimize meta descriptions for my product pages"
```
**Parameters**:
- `url` (required): The page URL
- `keywords` (required): Target keywords to include
- `tone` (optional): Professional, casual, or technical
**Example Response**:
```
π Meta Description Generated
Page: https://example.com/services
Keywords: web design, digital marketing, SEO
Generated Meta Description:
"Transform your business with expert web design, digital marketing, and SEO services. Boost your online presence and drive results with our proven strategies."
π Optimization Score: 92/100
β
Includes target keywords
β
Optimal length (155 characters)
β
Compelling call-to-action
β
Clear value proposition
```
### **4. Image Alt Text Generation**
**Action**: `generateImageAltText`
**What it does**: Creates SEO-friendly alt text for images to improve accessibility and search rankings.
**How to use**:
```
"Generate alt text for my product images"
"Create descriptive alt text for my blog images"
"Optimize alt text for my website images"
```
**Parameters**:
- `imageUrl` (required): The image URL
- `context` (optional): Context about the image usage
- `keywords` (optional): Keywords to include
**Example Response**:
```
πΌοΈ Alt Text Generated
Image: /images/product-laptop.jpg
Context: Product page hero image
Generated Alt Text:
"Premium laptop with sleek design for professional use - perfect for business and productivity"
π Optimization Score: 88/100
β
Descriptive and informative
β
Includes relevant keywords
β
Appropriate length
β
Clear and concise
```
### **5. OpenGraph Tag Generation**
**Action**: `generateOpenGraphTags`
**What it does**: Creates OpenGraph tags for better social media sharing and appearance.
**How to use**:
```
"Generate OpenGraph tags for my homepage"
"Create social media tags for my blog posts"
"Optimize social sharing for my products"
```
**Parameters**:
- `url` (required): The page URL
- `title` (optional): Page title for OpenGraph
- `description` (optional): Page description for OpenGraph
**Example Response**:
```
π± OpenGraph Tags Generated
Page: https://example.com/blog/seo-tips
Generated Tags:
π Optimization Score: 95/100
β
Compelling title
β
Engaging description
β
High-quality image
β
Proper URL structure
```
### **6. Content Analysis**
**Action**: `analyzeContentComprehensive`
**What it does**: Analyzes your content for SEO optimization and provides improvement recommendations.
**How to use**:
```
"Analyze my blog post content"
"Check my product descriptions for SEO"
"Review my homepage content"
```
**Parameters**:
- `content` (required): The content to analyze
- `targetKeywords` (optional): Target keywords for the content
**Example Response**:
```
π Content Analysis Results
Content Length: 1,250 words
Target Keywords: "digital marketing services"
π Content Score: 78/100
β
Strengths:
β’ Good content length
β’ Well-structured headings
β’ Engaging writing style
β’ Relevant information
β οΈ Areas for Improvement:
β’ Keyword density too low (0.8%)
β’ Missing internal links
β’ No call-to-action
β’ Could use more subheadings
π‘ Recommendations:
1. Increase keyword usage naturally
2. Add 3-5 internal links
3. Include a clear call-to-action
4. Break content into more sections
```
---
## βοΈ **Technical SEO Actions**
### **7. Page Speed Analysis**
**Action**: `analyzePageSpeed`
**What it does**: Analyzes your website's loading speed and provides optimization recommendations.
**How to use**:
```
"Analyze my website's page speed"
"Check loading times for my homepage"
"Optimize my site's performance"
```
**Parameters**:
- `url` (required): The URL to analyze
- `device` (optional): Mobile, desktop, or tablet
**Example Response**:
```
β‘ Page Speed Analysis
URL: https://example.com
Device: Mobile
π Performance Score: 65/100
β±οΈ Loading Times:
β’ First Contentful Paint: 2.1s
β’ Largest Contentful Paint: 4.2s
β’ Cumulative Layout Shift: 0.15
β’ First Input Delay: 180ms
π¨ Issues Found:
β’ Large images not optimized
β’ Unused CSS and JavaScript
β’ No browser caching
β’ Missing compression
π‘ Optimization Recommendations:
1. Compress and resize images
2. Minify CSS and JavaScript
3. Enable browser caching
4. Enable GZIP compression
5. Use a CDN
π Expected Improvement: +25 points
```
### **8. Sitemap Analysis**
**Action**: `analyzeSitemap`
**What it does**: Analyzes your website's sitemap structure and provides optimization recommendations.
**How to use**:
```
"Analyze my website's sitemap"
"Check sitemap structure and optimization"
"Review sitemap for SEO issues"
```
**Parameters**:
- `url` (required): Your website URL
**Example Response**:
```
πΊοΈ Sitemap Analysis Results
Website: https://example.com
π Sitemap Score: 82/100
β
Strengths:
β’ Sitemap properly formatted
β’ All important pages included
β’ Regular updates
β’ Good URL structure
β οΈ Issues Found:
β’ Missing lastmod dates
β’ No image sitemap
β’ Missing priority values
β’ Some broken URLs
π‘ Recommendations:
1. Add lastmod dates to all URLs
2. Create an image sitemap
3. Set appropriate priority values
4. Remove or fix broken URLs
5. Submit sitemap to Google Search Console
π Pages Indexed: 45/50
```
### **9. Technical SEO Analysis**
**Action**: `analyzeTechnicalSEO`
**What it does**: Performs a comprehensive technical SEO audit and provides technical recommendations.
**How to use**:
```
"Perform technical SEO analysis"
"Check technical SEO issues"
"Audit my site's technical SEO"
```
**Parameters**:
- `url` (required): The URL to analyze
- `focusAreas` (optional): Core web vitals, mobile friendliness, security
**Example Response**:
```
π§ Technical SEO Analysis
URL: https://example.com
π Technical Score: 78/100
β
Technical Strengths:
β’ HTTPS enabled
β’ Mobile responsive
β’ Clean URL structure
β’ Fast loading times
β οΈ Technical Issues:
β’ Missing schema markup
β’ No XML sitemap
β’ Poor internal linking
β’ Missing robots.txt
π― Core Web Vitals:
β’ LCP: 2.8s (Good)
β’ FID: 120ms (Good)
β’ CLS: 0.12 (Needs Improvement)
π‘ Technical Recommendations:
1. Implement schema markup
2. Create and submit XML sitemap
3. Improve internal linking structure
4. Add robots.txt file
5. Optimize for Core Web Vitals
```
### **10. On-Page SEO Analysis**
**Action**: `analyzeOnPageSEO`
**What it does**: Analyzes on-page SEO elements and provides optimization recommendations.
**How to use**:
```
"Analyze on-page SEO for my homepage"
"Check on-page optimization"
"Review page-level SEO elements"
```
**Parameters**:
- `url` (required): The URL to analyze
- `targetKeywords` (optional): Target keywords to analyze
**Example Response**:
```
π On-Page SEO Analysis
URL: https://example.com
Target Keywords: "web design services"
π On-Page Score: 72/100
β
On-Page Strengths:
β’ Good title tag optimization
β’ Proper heading structure
β’ Meta description present
β’ Good content quality
β οΈ On-Page Issues:
β’ Keyword density too low
β’ Missing internal links
β’ No schema markup
β’ Poor URL structure
π Element Analysis:
β’ Title Tag: 85/100
β’ Meta Description: 78/100
β’ Headings: 82/100
β’ Content: 75/100
β’ Internal Links: 45/100
π‘ On-Page Recommendations:
1. Increase keyword usage naturally
2. Add more internal links
3. Implement schema markup
4. Optimize URL structure
5. Improve content quality
```
---
## π’ **Advanced SEO Actions**
### **11. Enterprise SEO Analysis**
**Action**: `analyzeEnterpriseSEO`
**What it does**: Performs enterprise-level SEO analysis with advanced insights and competitor comparison.
**How to use**:
```
"Perform enterprise SEO analysis"
"Compare my SEO with competitors"
"Get enterprise-level SEO insights"
```
**Parameters**:
- `url` (required): Your website URL
- `competitorUrls` (optional): Competitor URLs to compare against
**Example Response**:
```
π’ Enterprise SEO Analysis
Website: https://example.com
Competitors: 3 analyzed
π Enterprise Score: 76/100
π Competitive Analysis:
β’ Market Position: 3rd out of 5
β’ Content Quality: Above Average
β’ Technical SEO: Average
β’ User Experience: Good
π Performance vs Competitors:
β’ Organic Traffic: +15% vs average
β’ Keyword Rankings: +8% vs average
β’ Page Speed: -5% vs average
β’ Mobile Experience: +12% vs average
π― Enterprise Recommendations:
1. Invest in content marketing
2. Improve technical infrastructure
3. Enhance user experience
4. Implement advanced analytics
5. Develop competitive strategy
π° ROI Opportunities:
β’ Content optimization: +25% traffic potential
β’ Technical improvements: +15% conversions
β’ UX enhancements: +20% engagement
```
### **12. Content Strategy Analysis**
**Action**: `analyzeContentStrategy`
**What it does**: Analyzes your content strategy and provides recommendations for improvement.
**How to use**:
```
"Analyze my content strategy"
"Review content marketing approach"
"Get content strategy recommendations"
```
**Parameters**:
- `url` (required): Your website URL
- `contentType` (optional): Blog, product, or service content
**Example Response**:
```
π Content Strategy Analysis
Website: https://example.com
Content Type: Blog and Service Pages
π Content Strategy Score: 68/100
π Content Performance:
β’ Total Pages: 45
β’ Blog Posts: 23
β’ Service Pages: 8
β’ Product Pages: 14
β
Content Strengths:
β’ Regular blog updates
β’ Good content quality
β’ Relevant topics
β’ Proper formatting
β οΈ Content Issues:
β’ Content gaps identified
β’ Inconsistent publishing
β’ Missing content types
β’ Poor content distribution
π― Content Strategy Recommendations:
1. Fill content gaps with targeted articles
2. Establish consistent publishing schedule
3. Create more video and visual content
4. Improve content distribution strategy
5. Develop content calendar
π Content Opportunities:
β’ 15 new topic ideas identified
β’ 8 content gaps to fill
β’ 5 content types to add
β’ 12 distribution channels to explore
```
### **13. Website Audit**
**Action**: `performWebsiteAudit`
**What it does**: Performs a comprehensive website SEO audit covering all aspects.
**How to use**:
```
"Perform a complete website audit"
"Audit my entire website for SEO"
"Get comprehensive SEO audit report"
```
**Parameters**:
- `url` (required): Your website URL
- `auditType` (optional): Comprehensive, technical, or content audit
**Example Response**:
```
π Comprehensive Website Audit
Website: https://example.com
Audit Type: Comprehensive
π Overall Audit Score: 74/100
π Audit Summary:
β’ Pages Analyzed: 45
β’ Issues Found: 23
β’ Critical Issues: 5
β’ Warnings: 12
β’ Recommendations: 31
π¨ Critical Issues:
1. Missing SSL certificate
2. Broken internal links (8 found)
3. Duplicate content detected
4. Missing meta descriptions (12 pages)
5. Slow loading times
β οΈ Warnings:
1. Missing alt text on images
2. Poor internal linking
3. No XML sitemap
4. Missing schema markup
5. Inconsistent URL structure
β
Strengths:
1. Good content quality
2. Mobile responsive design
3. Clean URL structure
4. Fast loading on desktop
5. Good user experience
π‘ Priority Actions:
1. Fix critical issues first
2. Address warnings systematically
3. Implement recommendations
4. Monitor improvements
5. Schedule follow-up audit
```
---
## π **Dashboard & Visualization Actions**
### **14. Update SEO Charts**
**Action**: `updateSEOCharts`
**What it does**: Updates SEO performance charts and visualizations with latest data.
**How to use**:
```
"Update my SEO performance charts"
"Refresh my SEO dashboard data"
"Show latest SEO metrics"
```
**Parameters**:
- `chartType` (required): Performance, rankings, or traffic charts
- `timeRange` (optional): 7d, 30d, 90d, or 1y
**Example Response**:
```
π SEO Charts Updated
Chart Type: Performance Metrics
Time Range: Last 30 Days
π Updated Metrics:
β’ Organic Traffic: +12% (vs previous period)
β’ Keyword Rankings: +8% improvement
β’ Page Speed: +15% faster
β’ Mobile Experience: +20% better
π Chart Data:
β’ Traffic Growth: Steady upward trend
β’ Ranking Improvements: 15 keywords moved up
β’ Performance Gains: Consistent improvement
β’ User Experience: Enhanced engagement
π― Key Insights:
β’ Mobile optimization showing results
β’ Content strategy driving traffic growth
β’ Technical improvements boosting performance
β’ User engagement increasing steadily
```
### **15. Customize SEO Dashboard**
**Action**: `customizeSEODashboard`
**What it does**: Customizes your SEO dashboard layout and preferences.
**How to use**:
```
"Customize my SEO dashboard"
"Change dashboard layout"
"Add widgets to my dashboard"
```
**Parameters**:
- `layout` (required): Grid, list, or compact layout
- `widgets` (optional): Widgets to include
**Example Response**:
```
π¨ Dashboard Customized
Layout: Grid Layout
Widgets: Performance, Rankings, Traffic, Issues
β
Customization Applied:
β’ Layout changed to grid view
β’ Performance widget added
β’ Rankings widget configured
β’ Traffic widget enabled
β’ Issues widget displayed
π± Dashboard Features:
β’ Responsive grid layout
β’ Real-time data updates
β’ Interactive charts
β’ Quick action buttons
β’ Customizable widgets
π‘ Dashboard Tips:
β’ Click widgets to expand details
β’ Drag widgets to rearrange
β’ Use filters to focus on specific metrics
β’ Export data for reporting
β’ Set up alerts for important changes
```
### **16. SEO Concept Explanation**
**Action**: `explainSEOConcept`
**What it does**: Explains SEO concepts in simple, non-technical terms.
**How to use**:
```
"Explain what meta descriptions are"
"What is technical SEO?"
"Help me understand Core Web Vitals"
```
**Parameters**:
- `concept` (required): The SEO concept to explain
- `audience` (optional): Beginner, intermediate, or advanced
**Example Response**:
```
π SEO Concept: Meta Descriptions
π― What are Meta Descriptions?
Meta descriptions are short summaries (150-160 characters) that appear under your page title in search results. They tell users what your page is about and encourage them to click.
π Why They Matter:
β’ Improve click-through rates
β’ Help users understand your content
β’ Influence search rankings
β’ Provide context for search results
π‘ Best Practices:
β’ Keep them under 160 characters
β’ Include target keywords naturally
β’ Write compelling, action-oriented text
β’ Make them unique for each page
β’ Include a call-to-action when appropriate
π Example:
Good: "Learn proven SEO strategies to boost your website's search rankings and drive more organic traffic."
Bad: "SEO tips and tricks for better rankings."
π― Pro Tip: Think of meta descriptions as your page's "elevator pitch" - you have a few seconds to convince users to visit your site!
```
---
## π― **Best Practices**
### **Getting the Most from SEO CopilotKit**
1. **Be Specific**: The more specific your requests, the better the results
```
β
"Analyze the SEO of https://example.com focusing on mobile performance"
β "Check my website SEO"
```
2. **Use Natural Language**: Ask questions as you would to a human expert
```
β
"What's wrong with my website's loading speed?"
β "Run page speed analysis"
```
3. **Follow Up**: Ask for clarification or additional details
```
β
"Can you explain why my page speed is slow?"
β
"What specific actions should I take to fix this?"
```
4. **Combine Actions**: Use multiple actions for comprehensive analysis
```
β
"First analyze my SEO comprehensively, then generate meta descriptions for my main pages"
```
5. **Regular Monitoring**: Use the dashboard actions to track progress
```
β
"Update my SEO charts and show me the improvements over the last month"
```
### **Common Use Cases**
1. **New Website Setup**:
```
"Perform a comprehensive SEO analysis of my new website"
"Generate meta descriptions for all my main pages"
"Create a sitemap and optimize it"
```
2. **Content Optimization**:
```
"Analyze my blog post content for SEO"
"Generate alt text for my product images"
"Create OpenGraph tags for social sharing"
```
3. **Performance Improvement**:
```
"Analyze my website's page speed"
"Check technical SEO issues"
"Identify critical problems affecting my rankings"
```
4. **Competitive Analysis**:
```
"Perform enterprise SEO analysis comparing my site with competitors"
"Identify content gaps in my industry"
"Find opportunities to outperform competitors"
```
---
## π§ **Troubleshooting**
### **Common Issues and Solutions**
1. **Action Not Working**
- **Issue**: CopilotKit action fails to execute
- **Solution**: Check your internet connection and try again
- **Alternative**: Use a different action or rephrase your request
2. **Slow Response Times**
- **Issue**: Actions take too long to complete
- **Solution**: Wait for completion or try a simpler request
- **Alternative**: Use the dashboard for quick insights
3. **Incomplete Results**
- **Issue**: Action results are incomplete or unclear
- **Solution**: Ask for clarification or more details
- **Alternative**: Try a different action or rephrase your question
4. **Technical Errors**
- **Issue**: Error messages or technical problems
- **Solution**: Refresh the page and try again
- **Alternative**: Contact support if the issue persists
### **Getting Help**
1. **Ask for Clarification**: If you don't understand a result, ask the AI to explain
2. **Request Examples**: Ask for specific examples or step-by-step instructions
3. **Use Different Actions**: Try alternative actions to get the information you need
4. **Contact Support**: Reach out to the support team for technical issues
---
## β **FAQ**
### **General Questions**
**Q: How accurate are the SEO CopilotKit results?**
A: The results are based on industry-standard SEO best practices and real-time data analysis. However, SEO is complex, so always use the recommendations as guidance and test changes carefully.
**Q: How often should I use SEO CopilotKit?**
A: We recommend using it weekly for regular monitoring and monthly for comprehensive audits. Use it whenever you make significant changes to your website.
**Q: Can I use SEO CopilotKit for multiple websites?**
A: Yes, you can analyze multiple websites by providing different URLs for each action.
**Q: Are the recommendations actionable?**
A: Yes, all recommendations include specific, actionable steps you can take to improve your SEO.
### **Technical Questions**
**Q: What data does SEO CopilotKit use?**
A: It uses your website's public data, search engine data, and industry benchmarks to provide analysis and recommendations.
**Q: How secure is my data?**
A: Your data is processed securely and is not shared with third parties. We follow industry-standard security practices.
**Q: Can I export the results?**
A: Yes, you can export analysis results and reports for your records or to share with your team.
**Q: Does SEO CopilotKit integrate with other tools?**
A: Currently, it works within the ALwrity platform. Future integrations may be available.
### **SEO Questions**
**Q: How long does it take to see SEO improvements?**
A: SEO improvements typically take 3-6 months to show results, but some technical fixes can show immediate improvements.
**Q: Should I implement all recommendations at once?**
A: No, implement changes gradually and monitor the impact. Start with critical issues first.
**Q: How do I know if the changes are working?**
A: Use the dashboard actions to track your progress and monitor key metrics over time.
**Q: What if I disagree with a recommendation?**
A: SEO CopilotKit provides guidance based on best practices, but you should always consider your specific situation and consult with your team.
---
## π **Support**
### **Getting Help**
- **In-App Help**: Use the help feature within the CopilotKit interface
- **Documentation**: Refer to this user guide for detailed information
- **Support Team**: Contact our support team for technical issues
- **Community**: Join our user community for tips and best practices
### **Feedback**
We value your feedback! Please share your experience with SEO CopilotKit to help us improve the service.
---
**π Congratulations! You're now ready to use ALwrity SEO CopilotKit effectively. Start exploring the features and watch your SEO performance improve!**