copilot-instructions.md•2.49 kB
# Debug-MCP Development Guidelines
Auto-generated from all feature plans. Last updated: 2025-10-23
## Active Technologies
- Python 3.11 (tool + debug runner) + Standard library (bdb/pdb, subprocess, multiprocessing), typer/click for local CLI (optional), pydantic for schemas, pytest for tests (001-python-debug-tool)
## Project Structure
```text
src/
tests/
```
## Commands
cd src [ONLY COMMANDS FOR ACTIVE TECHNOLOGIES][ONLY COMMANDS FOR ACTIVE TECHNOLOGIES] pytest [ONLY COMMANDS FOR ACTIVE TECHNOLOGIES][ONLY COMMANDS FOR ACTIVE TECHNOLOGIES] ruff check .
## Code Style
Python 3.11 (tool + debug runner): Follow standard conventions
## Recent Changes
- 001-python-debug-tool: Added Python 3.11 (tool + debug runner) + Standard library (bdb/pdb, subprocess, multiprocessing), typer/click for local CLI (optional), pydantic for schemas, pytest for tests
<!-- MANUAL ADDITIONS START -->
## Python Execution Instructions
### Using uv (Recommended)
**Run Python files directly**:
```bash
# Run a Python script
uv run python my_script.py
# Run a module
uv run python -m my_module
# Run tests
uv run pytest
# Run the MCP server
uv run mcp-debug --workspace .
# Run with coverage
uv run pytest --cov=src/mcp_debug_tool --cov-report=html
```
### Using venv (Traditional)
**Activate environment first**:
```bash
# macOS/Linux
source .venv/bin/activate
# Windows
.venv\Scripts\activate
```
**Then run normally**:
```bash
python my_script.py
python -m my_module
pytest
mcp-debug --workspace .
```
### Why uv run is better
- **No activation needed**: Works immediately without sourcing scripts
- **Consistent environment**: Always uses the correct Python and dependencies
- **Cross-shell compatibility**: Works the same in bash, zsh, fish, PowerShell
- **Faster startup**: No shell initialization overhead
- **Reliable**: Prevents "wrong Python" errors
### Quick Reference
```bash
# Environment setup
uv venv # Create virtual environment
uv pip install -e ".[dev]" # Install project with dev deps
# Common commands
uv run pytest # Run all tests
uv run pytest tests/unit/ -v # Run unit tests verbose
uv run ruff check . # Lint code
uv run ruff check --fix . # Auto-fix lint issues
uv run ruff format . # Format code
uv run python -m mcp_debug_tool.server # Run MCP server
uv run mcp-debug --workspace . # Run MCP server (CLI)
```
<!-- MANUAL ADDITIONS END -->