VS Code extension for MAID (Manifest-driven AI Development) with comprehensive IDE integration for manifest validation, exploration, and test execution.
- ✅ Manifest Explorer Sidebar - Browse all manifests in your workspace with expandable sections
- ✅ Tracked Files View - See all files tracked by the selected manifest
- ✅ Knowledge Graph View - Visualize entity relationships defined in manifests
- ✅ Run Tests - Execute tests directly from the manifest explorer
- ✅ Per-Manifest Testing - Run tests for specific manifests via context menu
- ✅ Watch Mode - Continuous test execution during development
- ✅ Real-time Validation - Instant feedback as you edit
.manifest.jsonfiles via LSP - ✅ Auto-install Detection - Automatically detects if
maid-lspis installed and guides you through installation - ✅ Code Actions - Quick fixes for common validation errors
- ✅ Hover Information - Detailed artifact information on hover
- ✅ Diagnostics - Validation errors and warnings in Problems panel
- ✅ Debounced Updates - Efficient 100ms debouncing for smooth editing experience
- Python 3.10+ (for
maid-lspserver) maid-lspPython package (will be prompted to install if missing)
- Open VS Code or Cursor
- Go to Extensions (
Ctrl+Shift+X/Cmd+Shift+X) - Search for "MAID" or "MAID for VS Code"
- Click Install
- Download the
.vsixfile from Releases - Open VS Code/Cursor
- Go to Extensions → "..." → "Install from VSIX..."
- Select the downloaded file
When you first open a .manifest.json file, the extension will:
- Check if
maid-lspis installed - If not found, show a prompt with installation options:
- Install via pip -
pip install --user maid-lsp - Install via pipx -
pipx install maid-lsp(recommended) - Install via uv -
uv tool install maid-lsp - Manual installation - Instructions provided
- Install via pip -
After installation, restart VS Code/Cursor and the extension will activate automatically.
- Open any
.manifest.jsonfile - The extension activates automatically
- Validation errors appear in the Problems panel
- Hover over manifest elements for detailed information
- Use Quick Fix (
Ctrl+./Cmd+.) for code actions
The extension can be configured in VS Code settings:
{
"maid-lsp.path": "maid-lsp",
"maid-lsp.args": ["--stdio"]
}If maid-lsp is not in your PATH, specify the full path:
{
"maid-lsp.path": "/home/user/.local/bin/maid-lsp"
}On Windows:
{
"maid-lsp.path": "C:\\Users\\YourName\\AppData\\Local\\Programs\\Python\\Python310\\Scripts\\maid-lsp.exe"
}- MAID: Check MAID LSP Installation - Verify installation status and get help if needed
Access via Command Palette (Ctrl+Shift+P / Cmd+Shift+P).
- Check that
maid-lspis installed: Runmaid-lsp --versionin terminal - If not installed, use the command "MAID: Check MAID LSP Installation"
- Verify Python is in PATH:
python --version
- Check Output panel → Select "MAID LSP" for errors
- Verify
maid-runneris installed:maid --version - Ensure you're editing a file ending with
.manifest.json - Restart VS Code/Cursor after installing
maid-lsp
- pip not found: Install Python from python.org
- Permission errors: Use
--userflag with pip or install via pipx - Command not found after install: Restart VS Code/Cursor or add Python Scripts to PATH
# Clone repository
git clone https://github.com/mamertofabian/vscode-maid.git
cd vscode-maid
# Install dependencies
npm install
# Compile TypeScript
npm run compile
# Package extension
npm install -g @vscode/vsce
vsce package- Open the
vscode-maidfolder in VS Code - Press
F5to launch Extension Development Host - In the new window, open a workspace with
.manifest.jsonfiles - Test validation and features
- maid-lsp - Python LSP server implementation
- maid-runner - MAID CLI validation tool
Contributions are welcome! Please see CONTRIBUTING.md for guidelines.
MIT License - see LICENSE for details.