Package Exports
- xor-iqassist-appservice
- xor-iqassist-appservice/server.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (xor-iqassist-appservice) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
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
# Run automated setup (Windows)
npx xor-iqassist-setupConfigure 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-DeliveryDone! ๐ 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
โ One-Command Setup
- Automated installation on Windows
- Auto-starts on system boot
- Managed by PM2 process manager
โ 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-DeliveryOutput: 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:\MyProjectOutput: code_summary.json with:
- File structure
- Technologies detected
- Dependencies analysis
- Code patterns
3. Test Generation
Initialize comprehensive testing:
@iqassist Initialize testing for D:\MyWebAppOutput:
- 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 reportOutput:
- 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-setupThis 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 startOption 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-DeliveryAll 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_keyCursor IDE Configuration
- Open Cursor Settings (
Ctrl + ,) - Search for "MCP"
- Click "Edit in settings.json"
- Add MCP server configuration:
{
"mcpServers": {
"xor-iqassist-appservice": {
"transport": "http",
"url": "http://localhost:8080/mcp"
}
}
}- Save and restart Cursor IDE
๐ ๏ธ Server Management
Check Status
npx pm2 statusView Logs
# Real-time logs
npx pm2 logs iqassist-mcp
# Error logs only
npx pm2 logs iqassist-mcp --errRestart Server
npx pm2 restart iqassist-mcpStop Server
npx pm2 stop iqassist-mcpStart 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-DeliveryBenefits:
- โ No upload required
- โ Results stored locally
- โ Fast analysis
- โ Works offline (after setup)
2. Web Upload (Team Collaboration)
Upload projects via Web UI:
- Visit: https://xor-iqassist-appservice.azurewebsites.net
- Upload project ZIP
- Download comprehensive results
- 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-DeliveryOutput: prd.json
iqassist_generate_code_summary
Analyze codebase and generate summary
Input:
@iqassist Generate code summary for D:\MyProjectOutput: code_summary.json
iqassist_init
Initialize testing infrastructure
Input:
@iqassist Initialize testing for D:\MyWebAppOutput: Test configurations and templates
iqassist_bootstrap_tests
Bootstrap comprehensive test suite
Input:
@iqassist Bootstrap tests for D:\MyProjectOutput: Full test scaffold
iqassist_analyze_frontend
Frontend-specific analysis
Input:
@iqassist Analyze frontend at D:\MyApp\frontendOutput: Frontend architecture analysis
iqassist_analyze_backend
Backend-specific analysis
Input:
@iqassist Analyze backend at D:\MyApp\backendOutput: Backend services analysis
iqassist_execute_tests
Execute test suite
Input:
@iqassist Execute tests for D:\MyProjectOutput: Test results and reports
iqassist_generate_report
Generate comprehensive testing report
Input:
@iqassist Generate report for D:\MyProjectOutput: HTML report with coverage
๐ Troubleshooting
Server Not Starting
Check if port 8080 is in use:
netstat -ano | findstr :8080Kill the process:
taskkill /PID <PID> /FRestart server:
npx pm2 restart iqassist-mcpTools Don't Appear in Cursor
Verify server is running:
npx pm2 status
Should show
onlineRestart Cursor IDE completely
Check MCP configuration in Cursor settings
Verify server is accessible: Open http://localhost:8080 in browser
"xor-iqassist-server" Not Recognized
Use npx:
npx xor-iqassist-server startOr restart terminal (Windows PATH update)
PM2 Commands Not Working
Use npx:
npx pm2 statusOr restart terminal
๐ Documentation
Getting Started
- QUICK_START.md - 2-minute setup guide
- ONE_COMMAND_SETUP.md - Automated setup details
- COMPLETE_USER_WORKFLOW.md - End-to-end workflow
Using the Tools
- CURSOR_CHAT_COMMANDS_GUIDE.md - All 26 tools explained
- QUICK_REFERENCE_CARD.md - One-page cheat sheet
Advanced
- SERVER_RUNNING_GUIDE.md - Server management
- TROUBLESHOOTING.md - Common issues
- BEFORE_AFTER_COMPARISON.md - v1.2.1 improvements
๐ 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!
- Fork the repository
- Create feature branch:
git checkout -b feature/amazing-feature - Commit changes:
git commit -m 'Add amazing feature' - Push to branch:
git push origin feature/amazing-feature - 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!