# π οΈ Boring MCP Tool Manual
This manual explains how to use Boring MCP tools in real development.
---
## π Quick Reference
### Most Used Tools (Top 10)
| Tool | Purpose | Example |
|------|---------|---------|
| `boring` | π― Universal router | `"review my code"` β auto routes |
| `boring_rag_search` | π Search code | `query="authentication"` |
| `boring_code_review` | π Code review | `file_path="src/api.py"` |
| `boring_vibe_check` | β
Health check | `target_path="src/"` |
| `boring_verify` | π§ͺ Run verification | `level="FULL"` |
| `boring_test_gen` | π§ͺ Generate tests | `file_path="src/utils.py"` |
| `boring_commit` | π¦ Smart commit | Auto-generates commit message |
| `boring_security_scan` | π Security scan | `scan_type="full"` |
| `boring_impact_check` | π₯ Impact analysis | `target_path="src/core.py"` |
| `boring_suggest_next` | π‘ Next step suggestion | Based on project state |
---
## π Code Search (RAG)
### Basic Search
```
boring_rag_search query="user authentication logic"
boring_rag_search query="database connection"
boring_rag_search query="error handling"
```
### Advanced Search
```
# Limit search scope
boring_rag_search query="login" file_filter="auth"
# Adjust result count
boring_rag_search query="API endpoints" max_results=20
# Expand dependency graph
boring_rag_expand chunk_id="chunk_123" depth=3
```
### First Use - Build Index
```
boring_rag_index project_path="."
boring_rag_status # Check index status
```
---
## π Code Review
### Single File Review
```
boring_code_review file_path="src/api/auth.py"
boring_code_review file_path="src/components/Login.tsx"
```
### Specify Review Focus
```
# Focus options: all, naming, error_handling, performance, security
boring_code_review file_path="src/api.py" focus="security"
boring_code_review file_path="src/utils.py" focus="performance"
```
---
## β
Health Check (Vibe Check)
### Quick Check
```
# Check single file
boring_vibe_check target_path="src/main.py"
# Check entire directory
boring_vibe_check target_path="src/"
# Check entire project
boring_vibe_check target_path="."
```
### Output Includes
- π― Vibe Score (0-100)
- π Lint issues list
- π Security issues
- π Documentation coverage
- π§ One-click fix prompt
---
## π§ͺ Test Generation
### Auto-generate Unit Tests
```
# Python files
boring_test_gen file_path="src/utils.py"
# TypeScript files
boring_test_gen file_path="src/services/auth.ts"
# Specify output directory
boring_test_gen file_path="src/api.py" output_dir="tests/"
```
### Supported Languages
- β
Python (pytest)
- β
JavaScript/TypeScript (jest)
---
## π Security Scanning
### Full Scan
```
boring_security_scan scan_type="full"
```
### Specific Scan Types
```
# Secrets only
boring_security_scan scan_type="secrets"
# Vulnerabilities only
boring_security_scan scan_type="vulnerabilities"
# Dependencies only
boring_security_scan scan_type="dependencies"
```
---
## π¦ Git Operations
### Smart Commit
```
# Auto-analyze changes and generate semantic commit message
boring_commit
boring_commit commit_type="feat" scope="auth"
```
### Git Hooks
```
# Install hooks (auto-verify before commit)
boring_hooks_install
# Check hooks status
boring_hooks_status
# Remove hooks
boring_hooks_uninstall
```
---
## π₯ Impact Analysis
### Pre-modification Analysis
```
# See what modules would be affected by modifying this file
boring_impact_check target_path="src/core/database.py"
boring_impact_check target_path="src/utils/helpers.ts" max_depth=3
```
### Output Includes
- π List of modules depending on this file
- β οΈ Risk level
- π§ͺ Tests that need verification
---
## π‘οΈ Shadow Mode (Safety Mode)
### Check Status
```
boring_shadow_status
```
### Switch Modes
```
# Normal mode (low-risk auto-executes)
boring_shadow_mode mode="ENABLED"
# Strict mode (all writes need approval)
boring_shadow_mode mode="STRICT"
# Disabled (not recommended)
boring_shadow_mode mode="DISABLED"
```
### Review Operations
```
boring_shadow_approve operation_id="xxx"
boring_shadow_reject operation_id="xxx"
```
---
## π Architecture Analysis
### Generate Dependency Graph
```
boring_arch_check target_path="src/"
boring_visualize scope="module"
```
### Output Formats
```
# Mermaid diagram
boring_arch_check output_format="mermaid"
# JSON
boring_arch_check output_format="json"
```
---
## π‘ Smart Suggestions
### Get Next Step Suggestions
```
boring_suggest_next
boring_suggest_next limit=5
```
### Output Includes
- π― Recommended next actions
- π Project state analysis
- β οΈ Potential issues
---
## π Workflow Examples
### New Feature Development
```
1. boring_rag_search query="related feature" # Search existing code
2. boring_impact_check target_path="..." # Analyze modification impact
3. [Develop code]
4. boring_code_review file_path="..." # Review code
5. boring_test_gen file_path="..." # Generate tests
6. boring_vibe_check target_path="..." # Health check
7. boring_verify level="FULL" # Run verification
8. boring_commit # Smart commit
```
### Bug Fix
```
1. boring_rag_search query="error message" # Search related code
2. [Fix code]
3. boring_security_scan # Ensure no security issues
4. boring_vibe_check # Health check
5. boring_commit commit_type="fix" # Commit fix
```
### Code Review
```
1. boring_code_review file_path="..." focus="all"
2. boring_security_scan scan_type="secrets"
3. boring_arch_check target_path="..."
```
---
## βοΈ Environment Variables
| Variable | Values | Description |
|----------|--------|-------------|
| `BORING_MCP_MODE` | `1` | Enable MCP mode (required) |
| `BORING_MCP_PROFILE` | `lite`/`standard`/`full` | Tool level |
| `PROJECT_ROOT_DEFAULT` | `.` | Default project path |
---
## π Further Reading
- [MCP Configuration Guide](./mcp-configuration_en.md)
- [Usage Modes](./usage-modes_en.md)
- [YOLO Mode Integration](./yolo-boring-integration_en.md)