xor-iqassist-appservice

AI-powered MCP server for comprehensive project testing with dual-path support

🚀 Quick Start (2 Minutes)

Installation

# Install globally
npm install -g xor-iqassist-appservice

# Option 1: Windows Service (Recommended for Windows)
# Run as Administrator
npx xor-iqassist-server install-service

# Option 2: PM2 (Cross-platform)
npx xor-iqassist-setup

Configure Cursor IDE

Add to Cursor MCP settings:

{
  "mcpServers": {
    "xor-iqassist-appservice": {
      "transport": "http",
      "url": "http://localhost:8080/mcp"
    }
  }
}

Use in Cursor

@iqassist Generate PRD for D:\Food-Delivery

Done! 🎉 Results will be saved to D:\Food-Delivery\.iqassist\results\

📋 What is xor-iqassist?

xor-iqassist is a Model Context Protocol (MCP) server that provides AI-powered code analysis and testing tools directly in your IDE.

Key Features

✅ Dual-Path Support

• Use with local projects in Cursor IDE
• Upload projects via Web UI for team sharing
• Results stored in your project directory

✅ Comprehensive Analysis

• Product Requirements Document (PRD) generation
• Code summary and architecture analysis
• Test generation (Jest, Playwright)
• User story extraction and testing

✅ Professional Deployment

• Windows Service - Native Windows integration, runs 24/7
• PM2 Option - Cross-platform process management
• Auto-starts on system boot
• One-command setup

✅ IDE Integration

• Works seamlessly with Cursor IDE
• MCP protocol support
• Real-time analysis in chat

🎯 Use Cases

1. Generate Product Requirements Document

Analyze your codebase and generate comprehensive PRD:

@iqassist Generate PRD for D:\Food-Delivery

Output: prd.json with:

• Product overview
• Feature specifications
• User stories
• Technical architecture
• API documentation

2. Code Analysis & Summary

Get detailed code insights:

@iqassist Generate code summary for D:\MyProject

Output: code_summary.json with:

• File structure
• Technologies detected
• Dependencies analysis
• Code patterns

3. Test Generation

Initialize comprehensive testing:

@iqassist Initialize testing for D:\MyWebApp

Output:

• Jest configuration
• Playwright setup
• Unit test templates
• E2E test templates

4. Full Analysis

Run all tools at once:

@iqassist Analyze D:\Food-Delivery and generate comprehensive report

Output:

• PRD
• Code Summary
• Test Configurations
• Architecture Diagram
• Recommendations

📦 Installation Options

Option 1: Automated Setup (Recommended for Windows)

# Install package
npm install -g xor-iqassist-appservice

# Run one-command setup
npx xor-iqassist-setup

This will:

• ✅ Install PM2 and dependencies
• ✅ Start server automatically
• ✅ Configure Windows auto-start
• ✅ Verify port 8080 is free

Option 2: Manual Setup

# Install package
npm install -g xor-iqassist-appservice

# Install PM2 (optional, for background service)
npm install -g pm2 pm2-windows-startup

# Start server manually
xor-iqassist-server start

Option 3: Development Setup

# Clone repository
git clone https://github.com/xor-iqassist/xor-iqassist-appservice.git
cd xor-iqassist-appservice

# Install dependencies
npm install

# Start server
npm start

💬 Using All 26 Tools in Cursor IDE

After setup, you have access to 26 powerful MCP tools in Cursor chat!

Quick Examples

@iqassist Generate PRD for D:\Food-Delivery
@iqassist Generate code summary for D:\Food-Delivery
@iqassist Initialize testing for D:\Food-Delivery
@iqassist Generate all tests for D:\Food-Delivery
@iqassist Execute tests for D:\Food-Delivery
@iqassist Generate report for D:\Food-Delivery

All Available Tools

See CURSOR_CHAT_COMMANDS_GUIDE.md for:

• Complete list of all 26 tools
• Detailed command examples
• Natural language usage
• Common workflows
• Pro tips

Quick Reference

See QUICK_REFERENCE_CARD.md for:

• One-page cheat sheet
• Most common commands
• Troubleshooting tips
• Quick start checklist

🔧 Configuration

Environment Variables

Create a .env file or set environment variables:

# Enable local project support (default: true)
ENABLE_LOCAL_PROJECTS=true

# Allowed drives (Windows)
ALLOWED_DRIVES=C:,D:,E:,F:

# Maximum path depth for security
MAX_PATH_DEPTH=10

# Server port
PORT=8080

# OpenAI API Key (for AI analysis)
OPENAI_API_KEY=your_api_key_here

# Encryption key (for secure data handling)
ENCRYPTION_KEY=your_encryption_key

Cursor IDE Configuration

1. Open Cursor Settings (Ctrl + ,)
2. Search for "MCP"
3. Click "Edit in settings.json"
4. Add MCP server configuration:

{
  "mcpServers": {
    "xor-iqassist-appservice": {
      "transport": "http",
      "url": "http://localhost:8080/mcp"
    }
  }
}

5. Save and restart Cursor IDE

🛠️ Server Management

Check Status

npx pm2 status

View Logs

# Real-time logs
npx pm2 logs iqassist-mcp

# Error logs only
npx pm2 logs iqassist-mcp --err

Restart Server

npx pm2 restart iqassist-mcp

Stop Server

npx pm2 stop iqassist-mcp

Start Server

npx pm2 start iqassist-mcp

📂 Project Structure

After analysis, results are saved in your project:

YourProject/
├── .iqassist/
│   └── results/
│       ├── prd.json
│       ├── code_summary.json
│       ├── comprehensive_report.json
│       ├── jest.config.json
│       ├── jest.setup.js
│       ├── playwright.config.js
│       └── test-files/
│           ├── Component.test.jsx
│           └── api.test.js
├── src/
├── package.json
└── ...

Key Points:

• Results stored in your project, not remotely
• .iqassist/ folder created automatically
• Each analysis updates files in results/
• Gitignore .iqassist/ if you don't want to commit results

🌐 Dual-Path Support

xor-iqassist supports two workflows:

1. Local Projects (Cursor IDE)

Use directly in Cursor with local file paths:

@iqassist Generate PRD for D:\Food-Delivery

Benefits:

• ✅ No upload required
• ✅ Results stored locally
• ✅ Fast analysis
• ✅ Works offline (after setup)

2. Web Upload (Team Collaboration)

Upload projects via Web UI:

1. Visit: https://xor-iqassist-appservice.azurewebsites.net
2. Upload project ZIP
3. Download comprehensive results
4. Share with team

Benefits:

• ✅ Team collaboration
• ✅ Centralized results
• ✅ Web dashboard
• ✅ Historical tracking

🧪 Available MCP Tools

iqassist_generate_prd

Generate Product Requirements Document

Input:

@iqassist Generate PRD for D:\Food-Delivery

Output: prd.json

iqassist_generate_code_summary

Analyze codebase and generate summary

Input:

@iqassist Generate code summary for D:\MyProject

Output: code_summary.json

iqassist_init

Initialize testing infrastructure

Input:

@iqassist Initialize testing for D:\MyWebApp

Output: Test configurations and templates

iqassist_bootstrap_tests

Bootstrap comprehensive test suite

Input:

@iqassist Bootstrap tests for D:\MyProject

Output: Full test scaffold

iqassist_analyze_frontend

Frontend-specific analysis

Input:

@iqassist Analyze frontend at D:\MyApp\frontend

Output: Frontend architecture analysis

iqassist_analyze_backend

Backend-specific analysis

Input:

@iqassist Analyze backend at D:\MyApp\backend

Output: Backend services analysis

iqassist_execute_tests

Execute test suite

Input:

@iqassist Execute tests for D:\MyProject

Output: Test results and reports

iqassist_generate_report

Generate comprehensive testing report

Input:

@iqassist Generate report for D:\MyProject

Output: HTML report with coverage

🆘 Troubleshooting

Server Not Starting

Check if port 8080 is in use:

netstat -ano | findstr :8080

Kill the process:

taskkill /PID <PID> /F

Restart server:

npx pm2 restart iqassist-mcp

Tools Don't Appear in Cursor

1. Verify server is running:

   npx pm2 status

   Should show online

2. Restart Cursor IDE completely

3. Check MCP configuration in Cursor settings

4. Verify server is accessible: Open http://localhost:8080 in browser

"xor-iqassist-server" Not Recognized

Use npx:

npx xor-iqassist-server start

Or restart terminal (Windows PATH update)

PM2 Commands Not Working

Use npx:

npx pm2 status

Or restart terminal

📚 Documentation

Getting Started

• QUICK_START.md - 2-minute setup guide
• WINDOWS_SERVICE_GUIDE.md - 🆕 Windows Service installation
• ONE_COMMAND_SETUP.md - PM2 automated setup
• COMPLETE_USER_WORKFLOW.md - End-to-end workflow

Using the Tools

• CURSOR_CHAT_COMMANDS_GUIDE.md - All 27 tools explained
• QUICK_REFERENCE_CARD.md - One-page cheat sheet

Advanced

• SERVER_RUNNING_GUIDE.md - Server management
• TROUBLESHOOTING.md - Common issues
• V1.5.0_RELEASE_NOTES.md - 🆕 Latest features

🔐 Security

• Local-first: Analysis happens on your machine
• No data upload: Local projects never leave your system
• Encryption: Secure data handling with AES-256-GCM
• Path validation: Security checks for file access
• Environment isolation: Sandboxed execution

🤝 Contributing

Contributions are welcome!

1. Fork the repository
2. Create feature branch: git checkout -b feature/amazing-feature
3. Commit changes: git commit -m 'Add amazing feature'
4. Push to branch: git push origin feature/amazing-feature
5. Open Pull Request

📄 License

MIT License - see LICENSE file for details

🙏 Support

• Issues: https://github.com/xor-iqassist/xor-iqassist-appservice/issues
• Documentation: See documentation/ folder
• Help Command: xor-iqassist-server help

🎉 Acknowledgments

Built with:

• Model Context Protocol (MCP)
• PM2 - Process Manager
• Express.js - Web Framework
• OpenAI - AI Analysis
• Jest - Testing Framework
• Playwright - E2E Testing

Made with ❤️ by the xor-iqassist team

Star ⭐ us on GitHub if you find this useful!