Smart Code Search MCP Server

# Voice Assistant Commands Reference Complete guide to all voice commands available in the SCS-MCP Voice Assistant with media capture capabilities. ## Command Categories 1. [Search & Navigation](#search--navigation) 2. [Code Analysis](#code-analysis) 3. [Media Capture](#media-capture) 4. [Code Generation](#code-generation) 5. [Project Management](#project-management) 6. [System Control](#system-control) ## Search & Navigation ### Code Search Commands | Command | Action | Example | |---------|--------|---------| | "Find [topic]" | Semantic code search | "Find authentication logic" | | "Search for [pattern]" | Pattern-based search | "Search for TODO comments" | | "Show me [symbol]" | Navigate to symbol | "Show me the User class" | | "Where is [function]" | Locate function | "Where is handleLogin defined?" | | "Find similar to this" | Find similar code | "Find code similar to this function" | | "Search git history for [term]" | Search commits | "Search git history for bug fixes" | ### Navigation Commands | Command | Action | Example | |---------|--------|---------| | "Go to [location]" | Navigate to file/line | "Go to line 42" | | "Open [file]" | Open specific file | "Open package.json" | | "Show dependencies" | Display import graph | "Show dependencies for this file" | | "Next/Previous" | Navigate results | "Next result" | ## Code Analysis ### Review Commands | Command | Action | Example | |---------|--------|---------| | "Review this" | Instant code review | "Review this function" | | "Check for issues" | Run quality checks | "Check for security issues" | | "Analyze complexity" | Complexity metrics | "Analyze complexity of this class" | | "Find bugs" | Bug detection | "Find potential bugs here" | | "Check performance" | Performance analysis | "Check performance of this loop" | ### Understanding Commands | Command | Action | Example | |---------|--------|---------| | "Explain this" | Explain code | "Explain this algorithm" | | "What does this do?" | Describe functionality | "What does this function do?" | | "How does this work?" | Detailed explanation | "How does this authentication work?" | | "Summarize this file" | File overview | "Summarize this module" | ## Media Capture ### Screenshot Commands | Command | Action | Notes | |---------|--------|-------| | "Take a screenshot" | Capture current screen | Saves to media history | | "Screenshot this" | Capture visible area | Context-aware capture | | "Capture the error" | Screenshot with error tag | Auto-tagged as 'error' | | "Save this view" | Capture current state | Includes metadata | | "Screenshot and annotate" | Capture + annotation mode | Opens annotation tools | ### Recording Commands | Command | Action | Notes | |---------|--------|-------| | "Start recording" | Begin screen recording | WebM format | | "Stop recording" | End and save recording | Auto-saves with timestamp | | "Pause recording" | Temporarily pause | Resume with "Continue recording" | | "Record debugging session" | Tagged recording | Auto-tagged as 'debugging' | | "Record next [N] minutes" | Timed recording | "Record next 5 minutes" | ### Media Management | Command | Action | Example | |---------|--------|---------| | "Show screenshots" | Open media gallery | Opens in new tab | | "Show today's captures" | Filter by date | Time-based filtering | | "Delete last screenshot" | Remove recent media | Confirmation required | | "Export media" | Create download bundle | "Export this week's screenshots" | | "Annotate last screenshot" | Open annotation tools | Drawing and text tools | | "Tag screenshot as [tag]" | Add metadata tag | "Tag screenshot as bug" | ## Code Generation ### Generation Commands | Command | Action | Example | |---------|--------|---------| | "Generate tests" | Create test cases | "Generate tests for this function" | | "Create documentation" | Generate docs | "Create documentation for this API" | | "Add comments" | Insert code comments | "Add comments to explain this" | | "Generate types" | Create type definitions | "Generate TypeScript types" | | "Create example" | Generate usage example | "Create example usage" | ### Refactoring Commands | Command | Action | Example | |---------|--------|---------| | "Refactor this" | Suggest refactoring | "Refactor this for better performance" | | "Extract function" | Extract to new function | "Extract this logic to a function" | | "Rename to [name]" | Rename refactoring | "Rename this to getUserData" | | "Simplify this" | Simplify complex code | "Simplify this conditional" | ## Project Management ### Task Commands | Command | Action | Example | |---------|--------|---------| | "What needs work?" | Show technical debt | Lists priority issues | | "Find TODOs" | List TODO comments | Searches entire project | | "Check test coverage" | Analyze test gaps | "Check test coverage for this module" | | "Show recent changes" | Display git changes | "Show changes from today" | ### Documentation Commands | Command | Action | Example | |---------|--------|---------| | "Document this" | Add documentation | "Document this function" | | "Update README" | Modify README.md | "Update README with new feature" | | "Generate API docs" | Create API documentation | Full API reference | | "Create architecture diagram" | Generate graph | "Create dependency diagram" | ## System Control ### Voice Assistant Control | Command | Action | Notes | |---------|--------|-------| | "Hey Assistant" | Wake word activation | When in wake mode | | "Start listening" | Enable continuous mode | Always listening | | "Stop listening" | Disable voice input | Manual activation only | | "Pause assistant" | Temporary pause | Resume with "Continue" | | "Change voice" | Switch TTS voice | "Change voice to British" | | "Speak faster/slower" | Adjust speech rate | Modifies TTS speed | ### Settings Commands | Command | Action | Example | |---------|--------|---------| | "Enable [feature]" | Turn on feature | "Enable debug mode" | | "Disable [feature]" | Turn off feature | "Disable notifications" | | "Set [setting] to [value]" | Change setting | "Set volume to 50%" | | "Show settings" | Display current config | Opens settings panel | ### Workflow Commands | Command | Action | Notes | |---------|--------|-------| | "Start work session" | Begin tracking | Starts recording + context | | "End work session" | Stop tracking | Saves session summary | | "Save checkpoint" | Create restore point | Screenshot + state | | "Show my history" | Display activity log | Recent commands and actions | ## Special Commands ### Contextual Commands These commands work based on current context: | Command | Context | Action | |---------|---------|--------| | "Fix this" | Error visible | Suggests fix for error | | "Test this" | Function selected | Generates test for function | | "Commit this" | Changes staged | Creates commit message | | "Deploy this" | Build ready | Initiates deployment | ### Chained Commands You can chain multiple commands: | Command | Result | |---------|--------| | "Review this and take a screenshot" | Review + capture | | "Find bugs, fix them, and test" | Multi-step workflow | | "Document this and update README" | Doc generation + update | ### Quick Actions Single-word commands for common tasks: | Command | Action | |---------|--------| | "Screenshot" | Quick capture | | "Review" | Review current selection | | "Test" | Run tests | | "Build" | Start build process | | "Help" | Show command help | ## Advanced Features ### Natural Language Processing The assistant understands variations and natural phrasing: - "Can you..." → "Can you explain this function?" - "Please..." → "Please review this code" - "I need..." → "I need to find the login logic" - "Show me how..." → "Show me how to use this API" ### Context Awareness Commands adapt based on: - Current file type - Selected code - Visible errors - Recent actions - Project type ### Batch Operations | Command | Action | |---------|--------| | "Review all files in [folder]" | Batch review | | "Screenshot each error" | Multiple captures | | "Test all functions" | Batch testing | | "Document all APIs" | Bulk documentation | ## Tips and Tricks ### Efficiency Tips 1. **Use wake word mode** for hands-free operation 2. **Set up shortcuts** for frequent commands 3. **Use context** - select code before commands 4. **Chain commands** for complex workflows 5. **Tag captures** for better organization ### Best Practices 1. **Be specific** - "Review the authentication function" vs "Review this" 2. **Use descriptions** - "Screenshot the error dialog" for context 3. **Organize media** - Tag and annotate captures immediately 4. **Regular exports** - Export media weekly for backup 5. **Clean up** - Delete unnecessary captures regularly ### Troubleshooting Commands | Issue | Command | Solution | |-------|---------|----------| | Not responding | "Test microphone" | Checks audio input | | Wrong context | "Refresh context" | Updates file state | | Missed command | "Repeat last" | Repeats previous command | | Error in response | "Try again" | Retries with different approach | ## Customization ### Custom Commands Add custom commands in `voice-assistant/config.json`: ```json { "customCommands": { "my command": { "action": "search", "params": { "query": "specific search" } } } } ``` ### Command Aliases Create aliases for frequently used commands: ```json { "aliases": { "snap": "take a screenshot", "rec": "start recording", "stop": "stop recording" } } ``` ## Integration with VS Code When VS Code extension is active, additional commands become available: | Command | Action | |---------|--------| | "Format this" | Format current file | | "Run this" | Execute current file | | "Debug this" | Start debugger | | "Git commit" | Open commit dialog | | "Open terminal" | Focus terminal | ## Language Support Commands work in multiple languages when configured: - English (default) - Spanish: "Buscar", "Capturar pantalla" - French: "Rechercher", "Capture d'écran" - German: "Suchen", "Bildschirmfoto" - Japanese: "検索", "スクリーンショット" Configure in settings: ```json { "language": "es", "recognitionLanguage": "es-ES" } ``` ## Keyboard Shortcuts Combined keyboard + voice workflows: | Shortcut | Then Say | Result | |----------|----------|---------| | Ctrl+Shift+A | [question] | Quick ask | | Ctrl+Shift+S | "annotate" | Screenshot + annotate | | Ctrl+Shift+R | "for [time]" | Timed recording | | Ctrl+Shift+H | "from [date]" | Filtered history | ## Related Documentation - [Media Server Guide](../MEDIA_SERVER.md) - [Voice Assistant Setup](README.md) - [VS Code Integration](VSCODE.md) - [API Reference](../API.md)