MLCopilot - MarkLogic AI Assistant

Your intelligent companion for MarkLogic development 🚀

MLCopilot brings AI-powered assistance to MarkLogic developers working with XQuery and XSLT, combining syntax highlighting, static analysis, and intelligent code generation.

✨ Features

🎨 Syntax Highlighting

• Full XQuery syntax support with proper tokenization
• XSLT syntax highlighting
• MarkLogic-specific functions and keywords

🔍 Static Error Detection

• Real-time XQuery syntax error detection
• LSP (Language Server Protocol) integration
• Instant error feedback as you type
• No need to deploy to MarkLogic server for basic validation

🤖 AI-Powered Error Explanation

• Get detailed explanations of XQuery errors
• Context-aware suggestions for fixes
• Powered by Claude AI (API key required)

💡 Natural Language to XQuery

• Write queries in plain English
• AI generates optimized XQuery code
• Perfect for learning or rapid prototyping

📦 Installation

1. Open VS Code
2. Go to Extensions (Ctrl+Shift+X)
3. Search for "MLCopilot"
4. Click Install

🚀 Getting Started

Basic Usage

1. Open any .xqy or .xsl file
2. Syntax highlighting works automatically
3. Errors appear in the Problems panel

AI Features (Optional)

To use AI-powered features:

1. Get an API key from console.anthropic.com
2. Open VS Code Settings (Ctrl+,)
3. Search for "MLCopilot"
4. Add your Anthropic API key

Commands:

• Explain Error: Right-click on error → "MLCopilot: Explain Error"
• Generate from Natural Language: Command Palette → "MLCopilot: Generate XQuery"

🎯 Use Cases

• MarkLogic Developers: Write XQuery/XSLT with better tooling
• Learning XQuery: Get AI explanations of errors and syntax
• Rapid Prototyping: Generate queries from natural language
• Code Quality: Catch errors before deploying to server

⚙️ Requirements

• VS Code 1.115.0 or higher
• (Optional) Anthropic API key for AI features

🔧 Extension Settings

This extension contributes the following settings:

• mlcopilot.anthropicApiKey: Your Anthropic API key for AI features
• mlcopilot.enableStaticAnalysis: Enable/disable static error detection

📝 Known Issues

• Static analysis currently supports XQuery 1.0-ml
• XSLT error detection is limited to syntax validation

🗺️ Roadmap

• [ ] Enhanced XSLT support
• [ ] Code completion for MarkLogic functions
• [ ] Integration with MarkLogic server for live validation
• [ ] Snippet library for common patterns

🤝 Contributing

Found a bug or have a feature request? Open an issue on GitHub.

📄 License

MIT License - see LICENSE file for details

👨‍💻 Author

Akbar Ali
Senior MarkLogic Developer | MarkLogic Certified (v10, v12)

Enjoy coding with MLCopilot! 🎉