commit
f2aaa8d668
4 changed files with 182 additions and 10 deletions
|
|
@ -299,9 +299,12 @@ npx @modelcontextprotocol/inspector --cli node build/index.js --method resources
|
||||||
# List available prompts
|
# List available prompts
|
||||||
npx @modelcontextprotocol/inspector --cli node build/index.js --method prompts/list
|
npx @modelcontextprotocol/inspector --cli node build/index.js --method prompts/list
|
||||||
|
|
||||||
# Connect to a remote MCP server
|
# Connect to a remote MCP server (default is SSE transport)
|
||||||
npx @modelcontextprotocol/inspector --cli https://my-mcp-server.example.com
|
npx @modelcontextprotocol/inspector --cli https://my-mcp-server.example.com
|
||||||
|
|
||||||
|
# Connect to a remote MCP server (with Streamable HTTP transport)
|
||||||
|
npx @modelcontextprotocol/inspector --cli https://my-mcp-server.example.com --transport http
|
||||||
|
|
||||||
# Call a tool on a remote server
|
# Call a tool on a remote server
|
||||||
npx @modelcontextprotocol/inspector --cli https://my-mcp-server.example.com --method tools/call --tool-name remotetool --tool-arg param=value
|
npx @modelcontextprotocol/inspector --cli https://my-mcp-server.example.com --method tools/call --tool-name remotetool --tool-arg param=value
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -44,7 +44,14 @@ console.log(`${colors.BLUE}- Resource-related options (--uri)${colors.NC}`);
|
||||||
console.log(
|
console.log(
|
||||||
`${colors.BLUE}- Prompt-related options (--prompt-name, --prompt-args)${colors.NC}`,
|
`${colors.BLUE}- Prompt-related options (--prompt-name, --prompt-args)${colors.NC}`,
|
||||||
);
|
);
|
||||||
console.log(`${colors.BLUE}- Logging options (--log-level)${colors.NC}\n`);
|
console.log(`${colors.BLUE}- Logging options (--log-level)${colors.NC}`);
|
||||||
|
console.log(
|
||||||
|
`${colors.BLUE}- Transport types (--transport http/sse/stdio)${colors.NC}`,
|
||||||
|
);
|
||||||
|
console.log(
|
||||||
|
`${colors.BLUE}- Transport inference from URL suffixes (/mcp, /sse)${colors.NC}`,
|
||||||
|
);
|
||||||
|
console.log(`\n`);
|
||||||
|
|
||||||
// Get directory paths
|
// Get directory paths
|
||||||
const SCRIPTS_DIR = __dirname;
|
const SCRIPTS_DIR = __dirname;
|
||||||
|
|
@ -62,9 +69,11 @@ if (!fs.existsSync(OUTPUT_DIR)) {
|
||||||
}
|
}
|
||||||
|
|
||||||
// Create a temporary directory for test files
|
// Create a temporary directory for test files
|
||||||
const TEMP_DIR = fs.mkdirSync(path.join(os.tmpdir(), "mcp-inspector-tests"), {
|
const TEMP_DIR = path.join(os.tmpdir(), "mcp-inspector-tests");
|
||||||
recursive: true,
|
fs.mkdirSync(TEMP_DIR, { recursive: true });
|
||||||
});
|
|
||||||
|
// Track servers for cleanup
|
||||||
|
let runningServers = [];
|
||||||
|
|
||||||
process.on("exit", () => {
|
process.on("exit", () => {
|
||||||
try {
|
try {
|
||||||
|
|
@ -74,6 +83,21 @@ process.on("exit", () => {
|
||||||
`${colors.RED}Failed to remove temp directory: ${err.message}${colors.NC}`,
|
`${colors.RED}Failed to remove temp directory: ${err.message}${colors.NC}`,
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
runningServers.forEach((server) => {
|
||||||
|
try {
|
||||||
|
process.kill(-server.pid);
|
||||||
|
} catch (e) {}
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
process.on("SIGINT", () => {
|
||||||
|
runningServers.forEach((server) => {
|
||||||
|
try {
|
||||||
|
process.kill(-server.pid);
|
||||||
|
} catch (e) {}
|
||||||
|
});
|
||||||
|
process.exit(1);
|
||||||
});
|
});
|
||||||
|
|
||||||
// Use the existing sample config file
|
// Use the existing sample config file
|
||||||
|
|
@ -121,6 +145,11 @@ async function runBasicTest(testName, ...args) {
|
||||||
stdio: ["ignore", "pipe", "pipe"],
|
stdio: ["ignore", "pipe", "pipe"],
|
||||||
});
|
});
|
||||||
|
|
||||||
|
const timeout = setTimeout(() => {
|
||||||
|
console.log(`${colors.YELLOW}Test timed out: ${testName}${colors.NC}`);
|
||||||
|
child.kill();
|
||||||
|
}, 10000);
|
||||||
|
|
||||||
// Pipe stdout and stderr to the output file
|
// Pipe stdout and stderr to the output file
|
||||||
child.stdout.pipe(outputStream);
|
child.stdout.pipe(outputStream);
|
||||||
child.stderr.pipe(outputStream);
|
child.stderr.pipe(outputStream);
|
||||||
|
|
@ -135,6 +164,7 @@ async function runBasicTest(testName, ...args) {
|
||||||
});
|
});
|
||||||
|
|
||||||
child.on("close", (code) => {
|
child.on("close", (code) => {
|
||||||
|
clearTimeout(timeout);
|
||||||
outputStream.end();
|
outputStream.end();
|
||||||
|
|
||||||
if (code === 0) {
|
if (code === 0) {
|
||||||
|
|
@ -201,6 +231,13 @@ async function runErrorTest(testName, ...args) {
|
||||||
stdio: ["ignore", "pipe", "pipe"],
|
stdio: ["ignore", "pipe", "pipe"],
|
||||||
});
|
});
|
||||||
|
|
||||||
|
const timeout = setTimeout(() => {
|
||||||
|
console.log(
|
||||||
|
`${colors.YELLOW}Error test timed out: ${testName}${colors.NC}`,
|
||||||
|
);
|
||||||
|
child.kill();
|
||||||
|
}, 10000);
|
||||||
|
|
||||||
// Pipe stdout and stderr to the output file
|
// Pipe stdout and stderr to the output file
|
||||||
child.stdout.pipe(outputStream);
|
child.stdout.pipe(outputStream);
|
||||||
child.stderr.pipe(outputStream);
|
child.stderr.pipe(outputStream);
|
||||||
|
|
@ -215,6 +252,7 @@ async function runErrorTest(testName, ...args) {
|
||||||
});
|
});
|
||||||
|
|
||||||
child.on("close", (code) => {
|
child.on("close", (code) => {
|
||||||
|
clearTimeout(timeout);
|
||||||
outputStream.end();
|
outputStream.end();
|
||||||
|
|
||||||
// For error tests, we expect a non-zero exit code
|
// For error tests, we expect a non-zero exit code
|
||||||
|
|
@ -611,6 +649,79 @@ async function runTests() {
|
||||||
"debug",
|
"debug",
|
||||||
);
|
);
|
||||||
|
|
||||||
|
console.log(
|
||||||
|
`\n${colors.YELLOW}=== Running HTTP Transport Tests ===${colors.NC}`,
|
||||||
|
);
|
||||||
|
|
||||||
|
console.log(
|
||||||
|
`${colors.BLUE}Starting server-everything in streamableHttp mode.${colors.NC}`,
|
||||||
|
);
|
||||||
|
const httpServer = spawn(
|
||||||
|
"npx",
|
||||||
|
["@modelcontextprotocol/server-everything", "streamableHttp"],
|
||||||
|
{
|
||||||
|
detached: true,
|
||||||
|
stdio: "ignore",
|
||||||
|
},
|
||||||
|
);
|
||||||
|
runningServers.push(httpServer);
|
||||||
|
|
||||||
|
await new Promise((resolve) => setTimeout(resolve, 3000));
|
||||||
|
|
||||||
|
// Test 25: HTTP transport inferred from URL ending with /mcp
|
||||||
|
await runBasicTest(
|
||||||
|
"http_transport_inferred",
|
||||||
|
"http://127.0.0.1:3001/mcp",
|
||||||
|
"--cli",
|
||||||
|
"--method",
|
||||||
|
"tools/list",
|
||||||
|
);
|
||||||
|
|
||||||
|
// Test 26: HTTP transport with explicit --transport http flag
|
||||||
|
await runBasicTest(
|
||||||
|
"http_transport_with_explicit_flag",
|
||||||
|
"http://127.0.0.1:3001",
|
||||||
|
"--transport",
|
||||||
|
"http",
|
||||||
|
"--cli",
|
||||||
|
"--method",
|
||||||
|
"tools/list",
|
||||||
|
);
|
||||||
|
|
||||||
|
// Test 27: HTTP transport with suffix and --transport http flag
|
||||||
|
await runBasicTest(
|
||||||
|
"http_transport_with_explicit_flag_and_suffix",
|
||||||
|
"http://127.0.0.1:3001/mcp",
|
||||||
|
"--transport",
|
||||||
|
"http",
|
||||||
|
"--cli",
|
||||||
|
"--method",
|
||||||
|
"tools/list",
|
||||||
|
);
|
||||||
|
|
||||||
|
// Test 28: SSE transport given to HTTP server (should fail)
|
||||||
|
await runErrorTest(
|
||||||
|
"sse_transport_given_to_http_server",
|
||||||
|
"http://127.0.0.1:3001",
|
||||||
|
"--transport",
|
||||||
|
"sse",
|
||||||
|
"--cli",
|
||||||
|
"--method",
|
||||||
|
"tools/list",
|
||||||
|
);
|
||||||
|
|
||||||
|
// Kill HTTP server
|
||||||
|
try {
|
||||||
|
process.kill(-httpServer.pid);
|
||||||
|
console.log(
|
||||||
|
`${colors.BLUE}HTTP server killed, waiting for port to be released...${colors.NC}`,
|
||||||
|
);
|
||||||
|
} catch (e) {
|
||||||
|
console.log(
|
||||||
|
`${colors.RED}Error killing HTTP server: ${e.message}${colors.NC}`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
// Print test summary
|
// Print test summary
|
||||||
console.log(`\n${colors.YELLOW}=== Test Summary ===${colors.NC}`);
|
console.log(`\n${colors.YELLOW}=== Test Summary ===${colors.NC}`);
|
||||||
console.log(`${colors.GREEN}Passed: ${PASSED_TESTS}${colors.NC}`);
|
console.log(`${colors.GREEN}Passed: ${PASSED_TESTS}${colors.NC}`);
|
||||||
|
|
|
||||||
|
|
@ -29,9 +29,13 @@ type Args = {
|
||||||
logLevel?: LogLevel;
|
logLevel?: LogLevel;
|
||||||
toolName?: string;
|
toolName?: string;
|
||||||
toolArg?: Record<string, string>;
|
toolArg?: Record<string, string>;
|
||||||
|
transport?: "sse" | "stdio" | "http";
|
||||||
};
|
};
|
||||||
|
|
||||||
function createTransportOptions(target: string[]): TransportOptions {
|
function createTransportOptions(
|
||||||
|
target: string[],
|
||||||
|
transport?: "sse" | "stdio" | "http",
|
||||||
|
): TransportOptions {
|
||||||
if (target.length === 0) {
|
if (target.length === 0) {
|
||||||
throw new Error(
|
throw new Error(
|
||||||
"Target is required. Specify a URL or a command to execute.",
|
"Target is required. Specify a URL or a command to execute.",
|
||||||
|
|
@ -50,8 +54,30 @@ function createTransportOptions(target: string[]): TransportOptions {
|
||||||
throw new Error("Arguments cannot be passed to a URL-based MCP server.");
|
throw new Error("Arguments cannot be passed to a URL-based MCP server.");
|
||||||
}
|
}
|
||||||
|
|
||||||
|
let transportType: "sse" | "stdio" | "http";
|
||||||
|
if (transport) {
|
||||||
|
if (!isUrl && transport !== "stdio") {
|
||||||
|
throw new Error("Only stdio transport can be used with local commands.");
|
||||||
|
}
|
||||||
|
if (isUrl && transport === "stdio") {
|
||||||
|
throw new Error("stdio transport cannot be used with URLs.");
|
||||||
|
}
|
||||||
|
transportType = transport;
|
||||||
|
} else if (isUrl) {
|
||||||
|
const url = new URL(command);
|
||||||
|
if (url.pathname.endsWith("/mcp")) {
|
||||||
|
transportType = "http";
|
||||||
|
} else if (url.pathname.endsWith("/sse")) {
|
||||||
|
transportType = "sse";
|
||||||
|
} else {
|
||||||
|
transportType = "sse";
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
transportType = "stdio";
|
||||||
|
}
|
||||||
|
|
||||||
return {
|
return {
|
||||||
transportType: isUrl ? "sse" : "stdio",
|
transportType,
|
||||||
command: isUrl ? undefined : command,
|
command: isUrl ? undefined : command,
|
||||||
args: isUrl ? undefined : commandArgs,
|
args: isUrl ? undefined : commandArgs,
|
||||||
url: isUrl ? command : undefined,
|
url: isUrl ? command : undefined,
|
||||||
|
|
@ -59,7 +85,7 @@ function createTransportOptions(target: string[]): TransportOptions {
|
||||||
}
|
}
|
||||||
|
|
||||||
async function callMethod(args: Args): Promise<void> {
|
async function callMethod(args: Args): Promise<void> {
|
||||||
const transportOptions = createTransportOptions(args.target);
|
const transportOptions = createTransportOptions(args.target, args.transport);
|
||||||
const transport = createTransport(transportOptions);
|
const transport = createTransport(transportOptions);
|
||||||
const client = new Client({
|
const client = new Client({
|
||||||
name: "inspector-cli",
|
name: "inspector-cli",
|
||||||
|
|
@ -214,6 +240,22 @@ function parseArgs(): Args {
|
||||||
|
|
||||||
return value as LogLevel;
|
return value as LogLevel;
|
||||||
},
|
},
|
||||||
|
)
|
||||||
|
//
|
||||||
|
// Transport options
|
||||||
|
//
|
||||||
|
.option(
|
||||||
|
"--transport <type>",
|
||||||
|
"Transport type (sse, http, or stdio). Auto-detected from URL: /mcp → http, /sse → sse, commands → stdio",
|
||||||
|
(value: string) => {
|
||||||
|
const validTransports = ["sse", "http", "stdio"];
|
||||||
|
if (!validTransports.includes(value)) {
|
||||||
|
throw new Error(
|
||||||
|
`Invalid transport type: ${value}. Valid types are: ${validTransports.join(", ")}`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
return value as "sse" | "http" | "stdio";
|
||||||
|
},
|
||||||
);
|
);
|
||||||
|
|
||||||
// Parse only the arguments before --
|
// Parse only the arguments before --
|
||||||
|
|
|
||||||
|
|
@ -3,11 +3,12 @@ import {
|
||||||
getDefaultEnvironment,
|
getDefaultEnvironment,
|
||||||
StdioClientTransport,
|
StdioClientTransport,
|
||||||
} from "@modelcontextprotocol/sdk/client/stdio.js";
|
} from "@modelcontextprotocol/sdk/client/stdio.js";
|
||||||
|
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js";
|
||||||
import type { Transport } from "@modelcontextprotocol/sdk/shared/transport.js";
|
import type { Transport } from "@modelcontextprotocol/sdk/shared/transport.js";
|
||||||
import { findActualExecutable } from "spawn-rx";
|
import { findActualExecutable } from "spawn-rx";
|
||||||
|
|
||||||
export type TransportOptions = {
|
export type TransportOptions = {
|
||||||
transportType: "sse" | "stdio";
|
transportType: "sse" | "stdio" | "http";
|
||||||
command?: string;
|
command?: string;
|
||||||
args?: string[];
|
args?: string[];
|
||||||
url?: string;
|
url?: string;
|
||||||
|
|
@ -15,11 +16,22 @@ export type TransportOptions = {
|
||||||
|
|
||||||
function createSSETransport(options: TransportOptions): Transport {
|
function createSSETransport(options: TransportOptions): Transport {
|
||||||
const baseUrl = new URL(options.url ?? "");
|
const baseUrl = new URL(options.url ?? "");
|
||||||
const sseUrl = new URL("/sse", baseUrl);
|
const sseUrl = baseUrl.pathname.endsWith("/sse")
|
||||||
|
? baseUrl
|
||||||
|
: new URL("/sse", baseUrl);
|
||||||
|
|
||||||
return new SSEClientTransport(sseUrl);
|
return new SSEClientTransport(sseUrl);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function createHTTPTransport(options: TransportOptions): Transport {
|
||||||
|
const baseUrl = new URL(options.url ?? "");
|
||||||
|
const mcpUrl = baseUrl.pathname.endsWith("/mcp")
|
||||||
|
? baseUrl
|
||||||
|
: new URL("/mcp", baseUrl);
|
||||||
|
|
||||||
|
return new StreamableHTTPClientTransport(mcpUrl);
|
||||||
|
}
|
||||||
|
|
||||||
function createStdioTransport(options: TransportOptions): Transport {
|
function createStdioTransport(options: TransportOptions): Transport {
|
||||||
let args: string[] = [];
|
let args: string[] = [];
|
||||||
|
|
||||||
|
|
@ -67,6 +79,10 @@ export function createTransport(options: TransportOptions): Transport {
|
||||||
return createSSETransport(options);
|
return createSSETransport(options);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if (transportType === "http") {
|
||||||
|
return createHTTPTransport(options);
|
||||||
|
}
|
||||||
|
|
||||||
throw new Error(`Unsupported transport type: ${transportType}`);
|
throw new Error(`Unsupported transport type: ${transportType}`);
|
||||||
} catch (error) {
|
} catch (error) {
|
||||||
throw new Error(
|
throw new Error(
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue