Peekaboo MCP

# Peekaboo MCP - Human Testing & Output Visibility Review ## Overview This review examines the current state of human-testable features in the peekaboo-mcp module, focusing on ways to see and interact with its output. ## Current Testing Capabilities ### ✅ Existing Test Infrastructure 1. **Test Client Script (`test-client.ts`)** - Comprehensive end-to-end testing - Shows directory structure visually with indentation - Displays file contents preview - Tests security features - Run with: `npm test` or `tsx test-client.ts` 2. **Sample Test Files** - `test-files/sample.txt` - Basic text file - `test-files/nested/deep.json` - Nested structure testing 3. **NPM Scripts** - `npm test` - Runs the test client - `npm run dev` - Development server with hot reload - `npm start` - Production server ### ✅ Output Visibility Features 1. **Console Output** - Server initialization messages - Directory tree visualization in test client - File content previews (first 200 chars) - Connection status indicators 2. **Error Handling** - Clear error messages for path traversal attempts - Descriptive file not found errors - Connection failure reporting ## Actionable Checklist for Enhanced Human Testing ### 🔲 Add Interactive CLI Tool - Create `cli.ts` for interactive exploration - Add commands: `ls`, `cd`, `cat`, `tree` - Show real-time directory navigation - Display file contents with syntax highlighting ### 🔲 Create Visual Web Interface - Simple HTML page with file browser - Real-time WebSocket connection to MCP server - File preview pane with syntax highlighting - Directory tree visualization ### 🔲 Enhance Test Output - Add colored console output for better readability - Show file metadata (size, modified date, permissions) - Display MIME type detection results - Add progress indicators for large directories ### 🔲 Add Example Scripts - `examples/browse-directory.ts` - Navigate and display directory contents - `examples/search-files.ts` - Search for files by pattern - `examples/read-multiple.ts` - Batch read multiple files - `examples/watch-changes.ts` - Monitor directory changes ### 🔲 Improve Test Client Output - Add `--format` flag (json, tree, table) - Add `--depth` flag to control recursion depth - Add `--filter` flag for file type filtering - Show statistics (total files, directories, sizes) ### 🔲 Add Debug/Verbose Mode - Environment variable `PEEKABOO_DEBUG=true` - Log all MCP protocol messages - Show request/response timing - Display resource URI construction ### 🔲 Create Quick Start Demo - `demo.sh` script that: - Sets up test directory structure - Runs server with specific configuration - Executes test client with various scenarios - Shows output in formatted way ### 🔲 Add Output Formats - JSON output mode for programmatic use - Tree view similar to Unix `tree` command - Table view with sortable columns - Export to CSV/JSON file ## Quick MVP Testing Commands For immediate human testing: ```bash # 1. Run the existing test client npm test # 2. Run server with debug output PEEKABOO_DEBUG=true npm run dev # 3. Test with custom directory PEEKABOO_ROOT=/tmp/test-dir npm test # 4. Test with limited depth PEEKABOO_MAX_DEPTH=2 npm test ``` ## Summary The module already has basic human testing capabilities through the test client, but could benefit from: 1. More visual/interactive output formats 2. A dedicated CLI tool for exploration 3. Better formatting and colorization 4. Example scripts demonstrating various use cases The existing `test-client.ts` provides a solid foundation and shows that the core functionality works well for human observation of the module's behavior.