Skip to content

Commit 6dddeec

Browse files
committed
Update README documentation for new --quiet option in inspect commands
## Changes Made ### Documentation Updates - Added "Common Options" section to CLI Mode Commands with --quiet flag - Updated all CLI examples to showcase quiet mode for clean JSON output - Enhanced automation/testing script example to demonstrate practical usage - Added note about quiet flag in Transparent Debugging section ### Key Documentation Highlights - Explains --quiet suppresses child process stderr for clean JSON output - Shows before/after examples in automation scripts - Demonstrates how quiet mode improves JSON parsing reliability - Provides practical CI/CD testing examples using the quiet flag ## Examples Added - Basic quiet usage: `reloaderoo inspect list-tools --quiet -- node server.js` - Tool calling with quiet: `reloaderoo inspect call-tool echo --quiet --params '{"message":"test"}' -- node server.js` - Enhanced shell script showing clean JSON parsing without server logs ## Impact Users and AI agents can now easily discover and understand the quiet option through comprehensive documentation with practical examples for automation and scripting use cases.
1 parent 449f039 commit 6dddeec

File tree

1 file changed

+27
-6
lines changed

1 file changed

+27
-6
lines changed

README.md

Lines changed: 27 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -190,11 +190,20 @@ Subcommands:
190190
ping [options] Check server connectivity
191191
mcp [options] Start MCP inspection server (exposes debug tools as MCP server)
192192

193+
Common Options (available for all subcommands):
194+
-w, --working-dir <dir> Working directory for the child process
195+
-t, --timeout <ms> Operation timeout in milliseconds (default: 30000)
196+
-q, --quiet Suppress child process stderr output (get clean JSON)
197+
193198
Examples:
194199
reloaderoo inspect list-tools -- node server.js
195200
reloaderoo inspect call-tool get_weather --params '{"location": "London"}' -- node server.js
196201
reloaderoo inspect server-info -- node server.js
197202
reloaderoo inspect mcp -- node server.js # Start MCP inspection server
203+
204+
# Get clean JSON output without server logs
205+
reloaderoo inspect list-tools --quiet -- node server.js
206+
reloaderoo inspect call-tool echo --quiet --params '{"message":"test"}' -- node server.js
198207
```
199208

200209
### **Info Command (Diagnostics)**
@@ -245,6 +254,7 @@ CLI mode provides direct command-line access to MCP servers without requiring cl
245254
- Raw JSON output shows exact MCP protocol requests/responses
246255
- No proxy layer or client interpretation
247256
- Perfect for understanding what's actually happening at the protocol level
257+
- Use `--quiet` flag to suppress server logs and get clean JSON for scripting
248258

249259
### 📝 **Direct CLI Commands** (One-shot execution)
250260
Execute single commands and get immediate results:
@@ -261,6 +271,10 @@ reloaderoo inspect server-info -- node my-server.js
261271

262272
# Check server connectivity
263273
reloaderoo inspect ping -- node my-server.js
274+
275+
# Get clean JSON output without server logs (perfect for scripting)
276+
reloaderoo inspect list-tools --quiet -- node my-server.js
277+
reloaderoo inspect call-tool echo --quiet --params '{"message":"hello"}' -- node my-server.js
264278
```
265279

266280
### 🔧 **MCP Inspection Server** (Persistent CLI mode for MCP clients)
@@ -373,25 +387,32 @@ Perfect for CI/CD, testing scripts, and automation workflows:
373387
#!/bin/bash
374388
# Example: Test script for your MCP server
375389

376-
# Check if server is healthy
377-
if reloaderoo inspect ping -- node my-server.js; then
390+
# Check if server is healthy (use --quiet for clean output)
391+
if reloaderoo inspect ping --quiet -- node my-server.js >/dev/null 2>&1; then
378392
echo "✅ Server is healthy"
379393
else
380394
echo "❌ Server health check failed"
381395
exit 1
382396
fi
383397

384-
# Test specific functionality
398+
# Test specific functionality with clean JSON output
385399
echo "Testing echo tool..."
386-
result=$(reloaderoo inspect call-tool echo --params '{"message":"test"}' -- node my-server.js)
400+
result=$(reloaderoo inspect call-tool echo --quiet --params '{"message":"test"}' -- node my-server.js)
387401

388-
# Parse and validate JSON response
389-
if echo "$result" | jq -e '.success' >/dev/null; then
402+
# Parse and validate JSON response (no server logs to interfere)
403+
if echo "$result" | jq -e '.content[0].text' >/dev/null; then
390404
echo "✅ Echo tool test passed"
405+
echo "Response: $(echo "$result" | jq -r '.content[0].text')"
391406
else
392407
echo "❌ Echo tool test failed"
408+
echo "Raw response: $result"
393409
exit 1
394410
fi
411+
412+
# List tools and count them
413+
echo "Checking available tools..."
414+
tools_count=$(reloaderoo inspect list-tools --quiet -- node my-server.js | jq '.tools | length')
415+
echo "✅ Found $tools_count tools available"
395416
```
396417

397418
## 🚨 Troubleshooting

0 commit comments

Comments
 (0)