Skip to content

Commit d8b3d95

Browse files
committed
docs: update Reloaderoo documentation to reflect v1.1.2+ changes
- Add version reference (v1.1.2+) to both documentation files - Update command structure documentation to match latest CLI interface - Fix info command options to use -v, --verbose instead of --verbose - Preserve debug logging capabilities which are important for development - Remove outdated --raw and per-command --log-level options from inspect commands - Update examples to show correct proxy mode debug logging options
1 parent 3d7319a commit d8b3d95

2 files changed

Lines changed: 24 additions & 19 deletions

File tree

CLAUDE.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ npm run diagnostic # Diagnostic CLI
2424

2525
### Development with Reloaderoo
2626

27-
**Reloaderoo** provides CLI-based testing and hot-reload capabilities for XcodeBuildMCP without requiring MCP client configuration.
27+
**Reloaderoo** (v1.1.2+) provides CLI-based testing and hot-reload capabilities for XcodeBuildMCP without requiring MCP client configuration.
2828

2929
#### Quick Start
3030

@@ -88,11 +88,11 @@ npx reloaderoo inspect list-tools --working-dir /custom/path -- node build/index
8888
# Timeout configuration
8989
npx reloaderoo inspect call-tool slow_tool --timeout 60000 --params '{}' -- node build/index.js
9090

91-
# Raw JSON output (no formatting)
92-
npx reloaderoo inspect server-info --raw -- node build/index.js
91+
# Use timeout configuration if needed
92+
npx reloaderoo inspect server-info --timeout 60000 -- node build/index.js
9393

94-
# Debug logging
95-
npx reloaderoo inspect list-tools --log-level debug -- node build/index.js
94+
# Debug logging (use proxy mode for detailed logging)
95+
npx reloaderoo proxy --log-level debug -- node build/index.js
9696
```
9797

9898
#### Key Benefits

docs/RELOADEROO.md

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Reloaderoo Integration Guide
22

3-
This guide explains how to use Reloaderoo for testing and developing XcodeBuildMCP with both CLI inspection tools and transparent proxy capabilities.
3+
This guide explains how to use Reloaderoo v1.1.2+ for testing and developing XcodeBuildMCP with both CLI inspection tools and transparent proxy capabilities.
44

55
## Overview
66

@@ -139,15 +139,19 @@ When running under Claude Code, XcodeBuildMCP automatically detects the environm
139139
```bash
140140
npx reloaderoo [options] [command]
141141

142+
Two modes, one tool:
143+
• Proxy MCP server that adds support for hot-reloading MCP servers.
144+
• CLI tool for inspecting MCP servers.
145+
142146
Global Options:
143-
-V, --version Output the version number
144-
-h, --help Display help for command
147+
-V, --version Output the version number
148+
-h, --help Display help for command
145149

146150
Commands:
147-
proxy [options] -- <command> 🔄 Run as MCP proxy server (hot-reload mode)
148-
inspect [subcommand] 🔍 Inspect and debug MCP servers (CLI mode)
149-
info [options] 📊 Display version and configuration information
150-
help [command] ❓ Display help for command
151+
proxy [options] 🔄 Run as MCP proxy server (default behavior)
152+
inspect 🔍 Inspect and debug MCP servers
153+
info [options] 📊 Display version and configuration information
154+
help [command] ❓ Display help for command
151155
```
152156

153157
### 🔄 **Proxy Mode Commands**
@@ -200,7 +204,8 @@ Examples:
200204
npx reloaderoo info [options]
201205

202206
Options:
203-
--verbose Show detailed system information
207+
-v, --verbose Show detailed information
208+
-h, --help Display help for command
204209

205210
Examples:
206211
npx reloaderoo info # Show basic system information
@@ -344,14 +349,14 @@ npx reloaderoo proxy --max-restarts 5 -- node build/index.js
344349
# Test basic connectivity first
345350
npx reloaderoo inspect ping -- node build/index.js
346351

347-
# Enable debug logging for CLI commands
348-
npx reloaderoo inspect list-tools --log-level debug -- node build/index.js
352+
# Enable debug logging for CLI commands (via proxy debug mode)
353+
npx reloaderoo proxy --log-level debug -- node build/index.js
349354
```
350355

351356
**JSON parsing errors:**
352357
```bash
353-
# Use --raw flag to see unformatted output (if available)
354-
npx reloaderoo inspect server-info --raw -- node build/index.js
358+
# Check server information for diagnostics
359+
npx reloaderoo inspect server-info -- node build/index.js
355360

356361
# Ensure your server outputs valid JSON
357362
node build/index.js | head -10
@@ -379,7 +384,7 @@ npx reloaderoo inspect call-tool list_devices --params '{}' -- node build/index.
379384
```bash
380385
# Get detailed information about what's happening
381386
npx reloaderoo proxy --debug -- node build/index.js # For proxy mode
382-
npx reloaderoo inspect list-tools --log-level debug -- node build/index.js # For CLI mode
387+
npx reloaderoo proxy --log-level debug -- node build/index.js # For detailed proxy logging
383388

384389
# View system diagnostics
385390
npx reloaderoo info --verbose
@@ -390,7 +395,7 @@ npx reloaderoo info --verbose
390395
1. **Always build first**: Run `npm run build` before testing
391396
2. **Check tool names**: Use `inspect list-tools` to see exact tool names
392397
3. **Validate JSON**: Ensure parameters are valid JSON strings
393-
4. **Enable debug logging**: Use `--log-level debug` for verbose output
398+
4. **Enable debug logging**: Use `--log-level debug` or `--debug` for verbose output
394399
5. **Test connectivity**: Use `inspect ping` to verify server communication
395400

396401
## Advanced Usage

0 commit comments

Comments
 (0)