Skip to content

Commit 3834123

Browse files
committed
docs: enhance Reloaderoo guide with comprehensive CLI and proxy mode coverage
- Add detailed command structure and usage examples for both CLI and proxy modes - Include comprehensive troubleshooting sections for both operational modes - Document advanced configuration options and environment variables - Improve workflow explanations with step-by-step development processes - Add MCP inspection server mode documentation - Enhance formatting with clear mode distinctions and emojis for better navigation
1 parent 856fa26 commit 3834123

3 files changed

Lines changed: 568 additions & 4 deletions

File tree

CLAUDE.md

Lines changed: 86 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,90 @@ npm run inspect # Run interactive MCP protocol inspector
2222
npm run diagnostic # Diagnostic CLI
2323
```
2424

25+
### Development with Reloaderoo
26+
27+
**Reloaderoo** provides CLI-based testing and hot-reload capabilities for XcodeBuildMCP without requiring MCP client configuration.
28+
29+
#### Quick Start
30+
31+
**CLI Mode (Testing & Development):**
32+
```bash
33+
# List all tools
34+
npx reloaderoo inspect list-tools -- node build/index.js
35+
36+
# Call any tool
37+
npx reloaderoo inspect call-tool list_devices --params '{}' -- node build/index.js
38+
39+
# Get server information
40+
npx reloaderoo inspect server-info -- node build/index.js
41+
42+
# List and read resources
43+
npx reloaderoo inspect list-resources -- node build/index.js
44+
npx reloaderoo inspect read-resource "xcodebuildmcp://devices" -- node build/index.js
45+
```
46+
47+
**Proxy Mode (MCP Client Integration):**
48+
```bash
49+
# Start persistent server for MCP clients
50+
npx reloaderoo proxy -- node build/index.js
51+
52+
# With debug logging
53+
npx reloaderoo proxy --log-level debug -- node build/index.js
54+
55+
# Then ask AI: "Please restart the MCP server to load my changes"
56+
```
57+
58+
#### All CLI Inspect Commands
59+
60+
Reloaderoo provides 8 inspect subcommands for comprehensive MCP server testing:
61+
62+
```bash
63+
# Server capabilities and information
64+
npx reloaderoo inspect server-info -- node build/index.js
65+
66+
# Tool management
67+
npx reloaderoo inspect list-tools -- node build/index.js
68+
npx reloaderoo inspect call-tool <tool_name> --params '<json>' -- node build/index.js
69+
70+
# Resource access
71+
npx reloaderoo inspect list-resources -- node build/index.js
72+
npx reloaderoo inspect read-resource "<uri>" -- node build/index.js
73+
74+
# Prompt management
75+
npx reloaderoo inspect list-prompts -- node build/index.js
76+
npx reloaderoo inspect get-prompt <name> --args '<json>' -- node build/index.js
77+
78+
# Connectivity testing
79+
npx reloaderoo inspect ping -- node build/index.js
80+
```
81+
82+
#### Advanced Options
83+
84+
```bash
85+
# Custom working directory
86+
npx reloaderoo inspect list-tools --working-dir /custom/path -- node build/index.js
87+
88+
# Timeout configuration
89+
npx reloaderoo inspect call-tool slow_tool --timeout 60000 --params '{}' -- node build/index.js
90+
91+
# Raw JSON output (no formatting)
92+
npx reloaderoo inspect server-info --raw -- node build/index.js
93+
94+
# Debug logging
95+
npx reloaderoo inspect list-tools --log-level debug -- node build/index.js
96+
```
97+
98+
#### Key Benefits
99+
100+
-**No MCP Client Setup**: Direct CLI access to all 84+ tools
101+
-**Raw JSON Output**: Perfect for AI agents and programmatic use
102+
-**Hot-Reload Support**: `restart_server` tool for MCP client development
103+
-**Claude Code Compatible**: Automatic content block consolidation
104+
-**8 Inspect Commands**: Complete MCP protocol testing capabilities
105+
-**Universal Compatibility**: Works on any system via npx
106+
107+
For complete documentation, examples, and troubleshooting, see @docs/RELOADEROO.md
108+
25109
## Architecture Overview
26110

27111
### Plugin-Based MCP architecture
@@ -53,9 +137,9 @@ XcodeBuildMCP has two modes to manage its extensive toolset, controlled by the `
53137
- **Behavior**: Only the `discover_tools` tool is available initially. You can use this tool by providing a natural language task description. The server then uses an LLM call (via MCP Sampling) to identify the most relevant workflow group and dynamically loads only those tools. This conserves context window space.
54138

55139
#### Claude Code Compatibility Workaround
56-
- **Environment**: `XCODEBUILDMCP_CLAUDE_CODE_WORKAROUND=true`.
140+
- **Detection**: Automatic detection when running under Claude Code.
57141
- **Purpose**: Workaround for Claude Code's MCP specification violation where it only displays the first content block in tool responses.
58-
- **Behavior**: When enabled, multiple content blocks are consolidated into a single text response, separated by `---` dividers. This ensures all information (including test results and stderr warnings) is visible to Claude Code users.
142+
- **Behavior**: When Claude Code is detected, multiple content blocks are automatically consolidated into a single text response, separated by `---` dividers. This ensures all information (including test results and stderr warnings) is visible to Claude Code users.
59143

60144
### Core Architecture Layers
61145
1. **MCP Transport**: stdio protocol communication

0 commit comments

Comments
 (0)