Skip to content

Commit 08857e2

Browse files
felixweinbergerclaude
felixweinberger
and
claude
committed
feat: Auto-detect transport type from config files
When launching the inspector with --config, automatically set the transport dropdown and server URL based on the config file contents. This eliminates the need to manually switch between stdio/sse/streamable-http in the UI. - Use discriminated union for ServerConfig to properly type different transports - Detect transport type and URL from config, pass via query params - Maintain backwards compatibility for configs without explicit 'type' field - Add comprehensive tests for the new functionality Improves UX by making the config file the single source of truth for server settings. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
1 parent fd0b962 commit 08857e2

File tree

5 files changed

+313
-84
lines changed

5 files changed

+313
-84
lines changed

‎README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -236,6 +236,8 @@ Example server configuration file:
236236

237237
> **Tip:** You can easily generate this configuration format using the **Server Entry** and **Servers File** buttons in the Inspector UI, as described in the Servers File Export section above.
238238
239+
When using `--config`, the inspector automatically detects the transport type from your configuration and sets the UI accordingly. For stdio servers, it sets the transport dropdown to "STDIO". For SSE or streamable-http servers (those with a `type` field), it sets both the transport dropdown and server URL field appropriately.
240+
239241
You can also set the initial `transport` type, `serverUrl`, `serverCommand`, and `serverArgs` via query params, for example:
240242

241243
```

‎cli/scripts/cli-tests.js‎

Lines changed: 230 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,91 @@ try {
120120
const invalidConfigPath = path.join(TEMP_DIR, "invalid-config.json");
121121
fs.writeFileSync(invalidConfigPath, '{\n "mcpServers": {\n "invalid": {');
122122

123+
// Function to run a UI mode test (without --cli flag)
124+
async function runUITest(testName, ...args) {
125+
const outputFile = path.join(
126+
OUTPUT_DIR,
127+
`${testName.replace(/\//g, "_")}.log`,
128+
);
129+
130+
console.log(`\n${colors.YELLOW}Testing UI mode: ${testName}${colors.NC}`);
131+
TOTAL_TESTS++;
132+
133+
// Run the command and capture output
134+
console.log(
135+
`${colors.BLUE}Command: node ${BUILD_DIR}/cli.js ${args.join(" ")}${colors.NC}`,
136+
);
137+
138+
try {
139+
// Create a write stream for the output file
140+
const outputStream = fs.createWriteStream(outputFile);
141+
142+
// Spawn the process
143+
return new Promise((resolve) => {
144+
const child = spawn("node", [path.join(BUILD_DIR, "cli.js"), ...args], {
145+
stdio: ["ignore", "pipe", "pipe"],
146+
env: {
147+
...process.env,
148+
DANGEROUSLY_OMIT_AUTH: "true",
149+
MCP_AUTO_OPEN_ENABLED: "false",
150+
},
151+
});
152+
153+
const timeout = setTimeout(() => {
154+
console.log(
155+
`${colors.GREEN}✓ UI test started successfully: ${testName}${colors.NC}`,
156+
);
157+
child.kill();
158+
PASSED_TESTS++;
159+
resolve(true);
160+
}, 3000); // Give it 3 seconds to start
161+
162+
// Pipe stdout and stderr to the output file
163+
child.stdout.pipe(outputStream);
164+
child.stderr.pipe(outputStream);
165+
166+
// Also capture output for display
167+
let output = "";
168+
child.stdout.on("data", (data) => {
169+
output += data.toString();
170+
// Check if the expected URL parameters are present
171+
if (testName.includes("ui_config")) {
172+
console.log(
173+
`${colors.BLUE}Output includes: ${data.toString().slice(0, 200)}${colors.NC}`,
174+
);
175+
}
176+
});
177+
child.stderr.on("data", (data) => {
178+
output += data.toString();
179+
});
180+
181+
child.on("close", (code) => {
182+
clearTimeout(timeout);
183+
outputStream.end();
184+
185+
if (code !== 0) {
186+
console.log(`${colors.RED}✗ UI test failed: ${testName}${colors.NC}`);
187+
console.log(`${colors.RED}Error output:${colors.NC}`);
188+
console.log(
189+
output
190+
.split("\n")
191+
.map((line) => ` ${line}`)
192+
.join("\n"),
193+
);
194+
FAILED_TESTS++;
195+
resolve(false);
196+
}
197+
});
198+
});
199+
} catch (error) {
200+
console.error(
201+
`${colors.RED}Error running UI test: ${error.message}${colors.NC}`,
202+
);
203+
FAILED_TESTS++;
204+
return false;
205+
}
206+
}
207+
123208
// Function to run a basic test
124209
async function runBasicTest(testName, ...args) {
125210
const outputFile = path.join(
@@ -742,6 +827,151 @@ async function runTests() {
742827
);
743828
}
744829

830+
console.log(
831+
`\n${colors.YELLOW}=== Running Config Transport Type Tests ===${colors.NC}`,
832+
);
833+
834+
// Create test config files with different transport types
835+
const stdioConfigPath = path.join(TEMP_DIR, "stdio-config.json");
836+
const sseConfigPath = path.join(TEMP_DIR, "sse-config.json");
837+
const httpConfigPath = path.join(TEMP_DIR, "http-config.json");
838+
const legacyConfigPath = path.join(TEMP_DIR, "legacy-config.json");
839+
840+
// STDIO config with explicit type
841+
fs.writeFileSync(
842+
stdioConfigPath,
843+
JSON.stringify({
844+
mcpServers: {
845+
"stdio-server": {
846+
type: "stdio",
847+
command: "npx",
848+
args: ["@modelcontextprotocol/server-everything"],
849+
env: { TEST_MODE: "stdio" },
850+
},
851+
},
852+
}),
853+
);
854+
855+
// SSE config
856+
fs.writeFileSync(
857+
sseConfigPath,
858+
JSON.stringify({
859+
mcpServers: {
860+
"sse-server": {
861+
type: "sse",
862+
url: "http://localhost:3000/events",
863+
note: "Test SSE server",
864+
},
865+
},
866+
}),
867+
);
868+
869+
// Streamable HTTP config
870+
fs.writeFileSync(
871+
httpConfigPath,
872+
JSON.stringify({
873+
mcpServers: {
874+
"http-server": {
875+
type: "streamable-http",
876+
url: "http://localhost:3001/mcp",
877+
},
878+
},
879+
}),
880+
);
881+
882+
// Legacy config without type field (should default to stdio)
883+
fs.writeFileSync(
884+
legacyConfigPath,
885+
JSON.stringify({
886+
mcpServers: {
887+
"legacy-server": {
888+
command: "npx",
889+
args: ["@modelcontextprotocol/server-everything"],
890+
env: { TEST_MODE: "legacy" },
891+
},
892+
},
893+
}),
894+
);
895+
896+
// Test 31: Config with explicit stdio type
897+
await runBasicTest(
898+
"config_stdio_type",
899+
"--config",
900+
stdioConfigPath,
901+
"--server",
902+
"stdio-server",
903+
"--cli",
904+
"--method",
905+
"tools/list",
906+
);
907+
908+
// Test 32: Config with SSE type (should fail in CLI mode but config should parse)
909+
await runErrorTest(
910+
"config_sse_type",
911+
"--config",
912+
sseConfigPath,
913+
"--server",
914+
"sse-server",
915+
"--cli",
916+
"--method",
917+
"tools/list",
918+
);
919+
920+
// Test 33: Config with streamable-http type (should fail in CLI mode but config should parse)
921+
await runErrorTest(
922+
"config_http_type",
923+
"--config",
924+
httpConfigPath,
925+
"--server",
926+
"http-server",
927+
"--cli",
928+
"--method",
929+
"tools/list",
930+
);
931+
932+
// Test 34: Legacy config without type field
933+
await runBasicTest(
934+
"config_legacy_no_type",
935+
"--config",
936+
legacyConfigPath,
937+
"--server",
938+
"legacy-server",
939+
"--cli",
940+
"--method",
941+
"tools/list",
942+
);
943+
944+
console.log(
945+
`\n${colors.YELLOW}=== Running UI Mode Transport Tests ===${colors.NC}`,
946+
);
947+
948+
// Test 35: UI mode with SSE config should pass transport parameters
949+
await runUITest(
950+
"ui_config_sse_transport",
951+
"--config",
952+
sseConfigPath,
953+
"--server",
954+
"sse-server",
955+
);
956+
957+
// Test 36: UI mode with HTTP config should pass transport parameters
958+
await runUITest(
959+
"ui_config_http_transport",
960+
"--config",
961+
httpConfigPath,
962+
"--server",
963+
"http-server",
964+
);
965+
966+
// Test 37: UI mode with STDIO config should pass transport parameters
967+
await runUITest(
968+
"ui_config_stdio_transport",
969+
"--config",
970+
stdioConfigPath,
971+
"--server",
972+
"stdio-server",
973+
);
974+
745975
// Print test summary
746976
console.log(`\n${colors.YELLOW}=== Test Summary ===${colors.NC}`);
747977
console.log(`${colors.GREEN}Passed: ${PASSED_TESTS}${colors.NC}`);

‎cli/src/cli.ts‎

Lines changed: 51 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ type Args = {
1414
args: string[];
1515
envArgs: Record<string, string>;
1616
cli: boolean;
17+
transport?: "stdio" | "sse" | "streamable-http";
18+
serverUrl?: string;
1719
};
1820

1921
type CliOptions = {
@@ -23,11 +25,18 @@ type CliOptions = {
2325
cli?: boolean;
2426
};
2527

26-
type ServerConfig = {
27-
command: string;
28-
args?: string[];
29-
env?: Record<string, string>;
30-
};
28+
type ServerConfig =
29+
| {
30+
type: "stdio";
31+
command: string;
32+
args?: string[];
33+
env?: Record<string, string>;
34+
}
35+
| {
36+
type: "sse" | "streamable-http";
37+
url: string;
38+
note?: string;
39+
};
3140

3241
function handleError(error: unknown): never {
3342
let message: string;
@@ -74,6 +83,16 @@ async function runWebClient(args: Args): Promise<void> {
7483
startArgs.push("-e", `${key}=${value}`);
7584
}
7685

86+
// Pass transport type if specified
87+
if (args.transport) {
88+
startArgs.push("--transport", args.transport);
89+
}
90+
91+
// Pass server URL if specified
92+
if (args.serverUrl) {
93+
startArgs.push("--server-url", args.serverUrl);
94+
}
95+
7796
// Pass command and args (using -- to separate them)
7897
if (args.command) {
7998
startArgs.push("--", args.command, ...args.args);
@@ -217,12 +236,33 @@ function parseArgs(): Args {
217236
if (options.config && options.server) {
218237
const config = loadConfigFile(options.config, options.server);
219238

220-
return {
221-
command: config.command,
222-
args: [...(config.args || []), ...finalArgs],
223-
envArgs: { ...(config.env || {}), ...(options.e || {}) },
224-
cli: options.cli || false,
225-
};
239+
if (config.type === "stdio") {
240+
return {
241+
command: config.command,
242+
args: [...(config.args || []), ...finalArgs],
243+
envArgs: { ...(config.env || {}), ...(options.e || {}) },
244+
cli: options.cli || false,
245+
transport: "stdio",
246+
};
247+
} else if (config.type === "sse" || config.type === "streamable-http") {
248+
return {
249+
command: "",
250+
args: finalArgs,
251+
envArgs: options.e || {},
252+
cli: options.cli || false,
253+
transport: config.type,
254+
serverUrl: config.url,
255+
};
256+
} else {
257+
// Backwards compatibility: if no type field, assume stdio
258+
return {
259+
command: (config as any).command || "",
260+
args: [...((config as any).args || []), ...finalArgs],
261+
envArgs: { ...((config as any).env || {}), ...(options.e || {}) },
262+
cli: options.cli || false,
263+
transport: "stdio",
264+
};
265+
}
226266
}
227267

228268
// Otherwise use command line arguments

0 commit comments

Comments
 (0)