diff --git a/.gitignore b/.gitignore index 9f1d63b..60faf65 100644 --- a/.gitignore +++ b/.gitignore @@ -1,7 +1,11 @@ .DS_Store -node_modules +.vscode +.idea +node_modules/ +*-workspace/ server/build client/dist client/tsconfig.app.tsbuildinfo client/tsconfig.node.tsbuildinfo -.vscode +cli/build +test-output diff --git a/README.md b/README.md index 0db92bf..b312f71 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,10 @@ The MCP inspector is a developer tool for testing and debugging MCP servers. ## Running the Inspector +### Requirements + +- Node.js: ^22.7.5 + ### From an MCP server repository To inspect an MCP server implementation, there's no need to clone this repo. Instead, use `npx`. For example, if your server is built at `build/index.js`: @@ -18,16 +22,16 @@ You can pass both arguments and environment variables to your MCP server. Argume ```bash # Pass arguments only -npx @modelcontextprotocol/inspector build/index.js arg1 arg2 +npx @modelcontextprotocol/inspector node build/index.js arg1 arg2 # Pass environment variables only -npx @modelcontextprotocol/inspector -e KEY=value -e KEY2=$VALUE2 node build/index.js +npx @modelcontextprotocol/inspector -e key=value -e key2=$VALUE2 node build/index.js # Pass both environment variables and arguments -npx @modelcontextprotocol/inspector -e KEY=value -e KEY2=$VALUE2 node build/index.js arg1 arg2 +npx @modelcontextprotocol/inspector -e key=value -e key2=$VALUE2 node build/index.js arg1 arg2 # Use -- to separate inspector flags from server arguments -npx @modelcontextprotocol/inspector -e KEY=$VALUE -- node build/index.js -e server-flag +npx @modelcontextprotocol/inspector -e key=$VALUE -- node build/index.js -e server-flag ``` The inspector runs both an MCP Inspector (MCPI) client UI (default port 6274) and an MCP Proxy (MCPP) server (default port 6277). Open the MCPI client UI in your browser to use the inspector. (These ports are derived from the T9 dialpad mapping of MCPI and MCPP respectively, as a mnemonic). You can customize the ports if needed: @@ -40,7 +44,7 @@ For more details on ways to use the inspector, see the [Inspector section of the ### Authentication -The inspector supports bearer token authentication for SSE connections. Enter your token in the UI when connecting to an MCP server, and it will be sent in the Authorization header. +The inspector supports bearer token authentication for SSE connections. Enter your token in the UI when connecting to an MCP server, and it will be sent in the Authorization header. You can override the header name using the input field in the sidebar. ### Security Considerations @@ -59,6 +63,36 @@ The MCP Inspector supports the following configuration settings. To change them, These settings can be adjusted in real-time through the UI and will persist across sessions. +The inspector also supports configuration files to store settings for different MCP servers. This is useful when working with multiple servers or complex configurations: + +```bash +npx @modelcontextprotocol/inspector --config path/to/config.json --server everything +``` + +Example server configuration file: + +```json +{ + "mcpServers": { + "everything": { + "command": "npx", + "args": ["@modelcontextprotocol/server-everything"], + "env": { + "hello": "Hello MCP!" + } + }, + "my-server": { + "command": "node", + "args": ["build/index.js", "arg1", "arg2"], + "env": { + "key": "value", + "key2": "value2" + } + } + } +} +``` + ### From this repository If you're working on the inspector itself: @@ -69,7 +103,7 @@ Development mode: npm run dev ``` -> **Note for Windows users:** +> **Note for Windows users:** > On Windows, use the following command instead: > > ```bash @@ -83,6 +117,57 @@ npm run build npm start ``` +### CLI Mode + +CLI mode enables programmatic interaction with MCP servers from the command line, ideal for scripting, automation, and integration with coding assistants. This creates an efficient feedback loop for MCP server development. + +```bash +npx @modelcontextprotocol/inspector --cli node build/index.js +``` + +The CLI mode supports most operations across tools, resources, and prompts. A few examples: + +```bash +# Basic usage +npx @modelcontextprotocol/inspector --cli node build/index.js + +# With config file +npx @modelcontextprotocol/inspector --cli --config path/to/config.json --server myserver + +# List available tools +npx @modelcontextprotocol/inspector --cli node build/index.js --method tools/list + +# Call a specific tool +npx @modelcontextprotocol/inspector --cli node build/index.js --method tools/call --tool-name mytool --tool-arg key=value --tool-arg another=value2 + +# List available resources +npx @modelcontextprotocol/inspector --cli node build/index.js --method resources/list + +# List available prompts +npx @modelcontextprotocol/inspector --cli node build/index.js --method prompts/list + +# Connect to a remote MCP server +npx @modelcontextprotocol/inspector --cli https://my-mcp-server.example.com + +# 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 + +# List resources from a remote server +npx @modelcontextprotocol/inspector --cli https://my-mcp-server.example.com --method resources/list +``` + +### UI Mode vs CLI Mode: When to Use Each + +| Use Case | UI Mode | CLI Mode | +| ------------------------ | ------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | +| **Server Development** | Visual interface for interactive testing and debugging during development | Scriptable commands for quick testing and continuous integration; creates feedback loops with AI coding assistants like Cursor for rapid development | +| **Resource Exploration** | Interactive browser with hierarchical navigation and JSON visualization | Programmatic listing and reading for automation and scripting | +| **Tool Testing** | Form-based parameter input with real-time response visualization | Command-line tool execution with JSON output for scripting | +| **Prompt Engineering** | Interactive sampling with streaming responses and visual comparison | Batch processing of prompts with machine-readable output | +| **Debugging** | Request history, visualized errors, and real-time notifications | Direct JSON output for log analysis and integration with other tools | +| **Automation** | N/A | Ideal for CI/CD pipelines, batch processing, and integration with coding assistants | +| **Learning MCP** | Rich visual interface helps new users understand server capabilities | Simplified commands for focused learning of specific endpoints | + ## License This project is licensed under the MIT License—see the [LICENSE](LICENSE) file for details. diff --git a/cli/package.json b/cli/package.json new file mode 100644 index 0000000..48c5f64 --- /dev/null +++ b/cli/package.json @@ -0,0 +1,28 @@ +{ + "name": "@modelcontextprotocol/inspector-cli", + "version": "0.10.0", + "description": "CLI for the Model Context Protocol inspector", + "license": "MIT", + "author": "Anthropic, PBC (https://anthropic.com)", + "homepage": "https://modelcontextprotocol.io", + "bugs": "https://github.com/modelcontextprotocol/inspector/issues", + "main": "build/cli.js", + "type": "module", + "bin": { + "mcp-inspector-cli": "build/cli.js" + }, + "files": [ + "build" + ], + "scripts": { + "build": "tsc", + "postbuild": "node scripts/make-executable.js", + "test": "node scripts/cli-tests.js" + }, + "devDependencies": {}, + "dependencies": { + "@modelcontextprotocol/sdk": "^1.10.0", + "commander": "^13.1.0", + "spawn-rx": "^5.1.2" + } +} diff --git a/cli/scripts/cli-tests.js b/cli/scripts/cli-tests.js new file mode 100755 index 0000000..6e6b56f --- /dev/null +++ b/cli/scripts/cli-tests.js @@ -0,0 +1,633 @@ +#!/usr/bin/env node + +// Colors for output +const colors = { + GREEN: "\x1b[32m", + YELLOW: "\x1b[33m", + RED: "\x1b[31m", + BLUE: "\x1b[34m", + ORANGE: "\x1b[33m", + NC: "\x1b[0m", // No Color +}; + +import fs from "fs"; +import path from "path"; +import { execSync, spawn } from "child_process"; +import os from "os"; +import { fileURLToPath } from "url"; + +// Get directory paths with ESM compatibility +const __filename = fileURLToPath(import.meta.url); +const __dirname = path.dirname(__filename); + +// Track test results +let PASSED_TESTS = 0; +let FAILED_TESTS = 0; +let SKIPPED_TESTS = 0; +let TOTAL_TESTS = 0; + +console.log( + `${colors.YELLOW}=== MCP Inspector CLI Test Script ===${colors.NC}`, +); +console.log( + `${colors.BLUE}This script tests the MCP Inspector CLI's ability to handle various command line options:${colors.NC}`, +); +console.log(`${colors.BLUE}- Basic CLI mode${colors.NC}`); +console.log(`${colors.BLUE}- Environment variables (-e)${colors.NC}`); +console.log(`${colors.BLUE}- Config file (--config)${colors.NC}`); +console.log(`${colors.BLUE}- Server selection (--server)${colors.NC}`); +console.log(`${colors.BLUE}- Method selection (--method)${colors.NC}`); +console.log( + `${colors.BLUE}- Tool-related options (--tool-name, --tool-arg)${colors.NC}`, +); +console.log(`${colors.BLUE}- Resource-related options (--uri)${colors.NC}`); +console.log( + `${colors.BLUE}- Prompt-related options (--prompt-name, --prompt-args)${colors.NC}`, +); +console.log(`${colors.BLUE}- Logging options (--log-level)${colors.NC}\n`); + +// Get directory paths +const SCRIPTS_DIR = __dirname; +const PROJECT_ROOT = path.join(SCRIPTS_DIR, "../../"); +const BUILD_DIR = path.resolve(SCRIPTS_DIR, "../build"); + +// Define the test server command using npx +const TEST_CMD = "npx"; +const TEST_ARGS = ["@modelcontextprotocol/server-everything"]; + +// Create output directory for test results +const OUTPUT_DIR = path.join(SCRIPTS_DIR, "test-output"); +if (!fs.existsSync(OUTPUT_DIR)) { + fs.mkdirSync(OUTPUT_DIR, { recursive: true }); +} + +// Create a temporary directory for test files +const TEMP_DIR = fs.mkdirSync(path.join(os.tmpdir(), "mcp-inspector-tests"), { + recursive: true, +}); + +process.on("exit", () => { + try { + fs.rmSync(TEMP_DIR, { recursive: true, force: true }); + } catch (err) { + console.error( + `${colors.RED}Failed to remove temp directory: ${err.message}${colors.NC}`, + ); + } +}); + +// Use the existing sample config file +console.log( + `${colors.BLUE}Using existing sample config file: ${PROJECT_ROOT}/sample-config.json${colors.NC}`, +); +try { + const sampleConfig = fs.readFileSync( + path.join(PROJECT_ROOT, "sample-config.json"), + "utf8", + ); + console.log(sampleConfig); +} catch (error) { + console.error( + `${colors.RED}Error reading sample config: ${error.message}${colors.NC}`, + ); +} + +// Create an invalid config file for testing +const invalidConfigPath = path.join(TEMP_DIR, "invalid-config.json"); +fs.writeFileSync(invalidConfigPath, '{\n "mcpServers": {\n "invalid": {'); + +// Function to run a basic test +async function runBasicTest(testName, ...args) { + const outputFile = path.join( + OUTPUT_DIR, + `${testName.replace(/\//g, "_")}.log`, + ); + + console.log(`\n${colors.YELLOW}Testing: ${testName}${colors.NC}`); + TOTAL_TESTS++; + + // Run the command and capture output + console.log( + `${colors.BLUE}Command: node ${BUILD_DIR}/cli.js ${args.join(" ")}${colors.NC}`, + ); + + try { + // Create a write stream for the output file + const outputStream = fs.createWriteStream(outputFile); + + // Spawn the process + return new Promise((resolve) => { + const child = spawn("node", [path.join(BUILD_DIR, "cli.js"), ...args], { + stdio: ["ignore", "pipe", "pipe"], + }); + + // Pipe stdout and stderr to the output file + child.stdout.pipe(outputStream); + child.stderr.pipe(outputStream); + + // Also capture output for display + let output = ""; + child.stdout.on("data", (data) => { + output += data.toString(); + }); + child.stderr.on("data", (data) => { + output += data.toString(); + }); + + child.on("close", (code) => { + outputStream.end(); + + if (code === 0) { + console.log(`${colors.GREEN}✓ Test passed: ${testName}${colors.NC}`); + console.log(`${colors.BLUE}First few lines of output:${colors.NC}`); + const firstFewLines = output + .split("\n") + .slice(0, 5) + .map((line) => ` ${line}`) + .join("\n"); + console.log(firstFewLines); + PASSED_TESTS++; + resolve(true); + } else { + console.log(`${colors.RED}✗ Test failed: ${testName}${colors.NC}`); + console.log(`${colors.RED}Error output:${colors.NC}`); + console.log( + output + .split("\n") + .map((line) => ` ${line}`) + .join("\n"), + ); + FAILED_TESTS++; + + // Stop after any error is encountered + console.log( + `${colors.YELLOW}Stopping tests due to error. Please validate and fix before continuing.${colors.NC}`, + ); + process.exit(1); + } + }); + }); + } catch (error) { + console.error( + `${colors.RED}Error running test: ${error.message}${colors.NC}`, + ); + FAILED_TESTS++; + process.exit(1); + } +} + +// Function to run an error test (expected to fail) +async function runErrorTest(testName, ...args) { + const outputFile = path.join( + OUTPUT_DIR, + `${testName.replace(/\//g, "_")}.log`, + ); + + console.log(`\n${colors.YELLOW}Testing error case: ${testName}${colors.NC}`); + TOTAL_TESTS++; + + // Run the command and capture output + console.log( + `${colors.BLUE}Command: node ${BUILD_DIR}/cli.js ${args.join(" ")}${colors.NC}`, + ); + + try { + // Create a write stream for the output file + const outputStream = fs.createWriteStream(outputFile); + + // Spawn the process + return new Promise((resolve) => { + const child = spawn("node", [path.join(BUILD_DIR, "cli.js"), ...args], { + stdio: ["ignore", "pipe", "pipe"], + }); + + // Pipe stdout and stderr to the output file + child.stdout.pipe(outputStream); + child.stderr.pipe(outputStream); + + // Also capture output for display + let output = ""; + child.stdout.on("data", (data) => { + output += data.toString(); + }); + child.stderr.on("data", (data) => { + output += data.toString(); + }); + + child.on("close", (code) => { + outputStream.end(); + + // For error tests, we expect a non-zero exit code + if (code !== 0) { + console.log( + `${colors.GREEN}✓ Error test passed: ${testName}${colors.NC}`, + ); + console.log(`${colors.BLUE}Error output (expected):${colors.NC}`); + const firstFewLines = output + .split("\n") + .slice(0, 5) + .map((line) => ` ${line}`) + .join("\n"); + console.log(firstFewLines); + PASSED_TESTS++; + resolve(true); + } else { + console.log( + `${colors.RED}✗ Error test failed: ${testName} (expected error but got success)${colors.NC}`, + ); + console.log(`${colors.RED}Output:${colors.NC}`); + console.log( + output + .split("\n") + .map((line) => ` ${line}`) + .join("\n"), + ); + FAILED_TESTS++; + + // Stop after any error is encountered + console.log( + `${colors.YELLOW}Stopping tests due to error. Please validate and fix before continuing.${colors.NC}`, + ); + process.exit(1); + } + }); + }); + } catch (error) { + console.error( + `${colors.RED}Error running test: ${error.message}${colors.NC}`, + ); + FAILED_TESTS++; + process.exit(1); + } +} + +// Run all tests +async function runTests() { + console.log( + `\n${colors.YELLOW}=== Running Basic CLI Mode Tests ===${colors.NC}`, + ); + + // Test 1: Basic CLI mode with method + await runBasicTest( + "basic_cli_mode", + TEST_CMD, + ...TEST_ARGS, + "--cli", + "--method", + "tools/list", + ); + + // Test 2: CLI mode with non-existent method (should fail) + await runErrorTest( + "nonexistent_method", + TEST_CMD, + ...TEST_ARGS, + "--cli", + "--method", + "nonexistent/method", + ); + + // Test 3: CLI mode without method (should fail) + await runErrorTest("missing_method", TEST_CMD, ...TEST_ARGS, "--cli"); + + console.log( + `\n${colors.YELLOW}=== Running Environment Variable Tests ===${colors.NC}`, + ); + + // Test 4: CLI mode with environment variables + await runBasicTest( + "env_variables", + TEST_CMD, + ...TEST_ARGS, + "-e", + "KEY1=value1", + "-e", + "KEY2=value2", + "--cli", + "--method", + "tools/list", + ); + + // Test 5: CLI mode with invalid environment variable format (should fail) + await runErrorTest( + "invalid_env_format", + TEST_CMD, + ...TEST_ARGS, + "-e", + "INVALID_FORMAT", + "--cli", + "--method", + "tools/list", + ); + + // Test 5b: CLI mode with environment variable containing equals sign in value + await runBasicTest( + "env_variable_with_equals", + TEST_CMD, + ...TEST_ARGS, + "-e", + "API_KEY=abc123=xyz789==", + "--cli", + "--method", + "tools/list", + ); + + // Test 5c: CLI mode with environment variable containing base64-encoded value + await runBasicTest( + "env_variable_with_base64", + TEST_CMD, + ...TEST_ARGS, + "-e", + "JWT_TOKEN=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIn0=", + "--cli", + "--method", + "tools/list", + ); + + console.log( + `\n${colors.YELLOW}=== Running Config File Tests ===${colors.NC}`, + ); + + // Test 6: Using config file with CLI mode + await runBasicTest( + "config_file", + "--config", + path.join(PROJECT_ROOT, "sample-config.json"), + "--server", + "everything", + "--cli", + "--method", + "tools/list", + ); + + // Test 7: Using config file without server name (should fail) + await runErrorTest( + "config_without_server", + "--config", + path.join(PROJECT_ROOT, "sample-config.json"), + "--cli", + "--method", + "tools/list", + ); + + // Test 8: Using server name without config file (should fail) + await runErrorTest( + "server_without_config", + "--server", + "everything", + "--cli", + "--method", + "tools/list", + ); + + // Test 9: Using non-existent config file (should fail) + await runErrorTest( + "nonexistent_config", + "--config", + "./nonexistent-config.json", + "--server", + "everything", + "--cli", + "--method", + "tools/list", + ); + + // Test 10: Using invalid config file format (should fail) + await runErrorTest( + "invalid_config", + "--config", + invalidConfigPath, + "--server", + "everything", + "--cli", + "--method", + "tools/list", + ); + + // Test 11: Using config file with non-existent server (should fail) + await runErrorTest( + "nonexistent_server", + "--config", + path.join(PROJECT_ROOT, "sample-config.json"), + "--server", + "nonexistent", + "--cli", + "--method", + "tools/list", + ); + + console.log( + `\n${colors.YELLOW}=== Running Tool-Related Tests ===${colors.NC}`, + ); + + // Test 12: CLI mode with tool call + await runBasicTest( + "tool_call", + TEST_CMD, + ...TEST_ARGS, + "--cli", + "--method", + "tools/call", + "--tool-name", + "echo", + "--tool-arg", + "message=Hello", + ); + + // Test 13: CLI mode with tool call but missing tool name (should fail) + await runErrorTest( + "missing_tool_name", + TEST_CMD, + ...TEST_ARGS, + "--cli", + "--method", + "tools/call", + "--tool-arg", + "message=Hello", + ); + + // Test 14: CLI mode with tool call but invalid tool args format (should fail) + await runErrorTest( + "invalid_tool_args", + TEST_CMD, + ...TEST_ARGS, + "--cli", + "--method", + "tools/call", + "--tool-name", + "echo", + "--tool-arg", + "invalid_format", + ); + + // Test 15: CLI mode with multiple tool args + await runBasicTest( + "multiple_tool_args", + TEST_CMD, + ...TEST_ARGS, + "--cli", + "--method", + "tools/call", + "--tool-name", + "add", + "--tool-arg", + "a=1", + "b=2", + ); + + console.log( + `\n${colors.YELLOW}=== Running Resource-Related Tests ===${colors.NC}`, + ); + + // Test 16: CLI mode with resource read + await runBasicTest( + "resource_read", + TEST_CMD, + ...TEST_ARGS, + "--cli", + "--method", + "resources/read", + "--uri", + "test://static/resource/1", + ); + + // Test 17: CLI mode with resource read but missing URI (should fail) + await runErrorTest( + "missing_uri", + TEST_CMD, + ...TEST_ARGS, + "--cli", + "--method", + "resources/read", + ); + + console.log( + `\n${colors.YELLOW}=== Running Prompt-Related Tests ===${colors.NC}`, + ); + + // Test 18: CLI mode with prompt get + await runBasicTest( + "prompt_get", + TEST_CMD, + ...TEST_ARGS, + "--cli", + "--method", + "prompts/get", + "--prompt-name", + "simple_prompt", + ); + + // Test 19: CLI mode with prompt get and args + await runBasicTest( + "prompt_get_with_args", + TEST_CMD, + ...TEST_ARGS, + "--cli", + "--method", + "prompts/get", + "--prompt-name", + "complex_prompt", + "--prompt-args", + "temperature=0.7", + "style=concise", + ); + + // Test 20: CLI mode with prompt get but missing prompt name (should fail) + await runErrorTest( + "missing_prompt_name", + TEST_CMD, + ...TEST_ARGS, + "--cli", + "--method", + "prompts/get", + ); + + console.log(`\n${colors.YELLOW}=== Running Logging Tests ===${colors.NC}`); + + // Test 21: CLI mode with log level + await runBasicTest( + "log_level", + TEST_CMD, + ...TEST_ARGS, + "--cli", + "--method", + "logging/setLevel", + "--log-level", + "debug", + ); + + // Test 22: CLI mode with invalid log level (should fail) + await runErrorTest( + "invalid_log_level", + TEST_CMD, + ...TEST_ARGS, + "--cli", + "--method", + "logging/setLevel", + "--log-level", + "invalid", + ); + + console.log( + `\n${colors.YELLOW}=== Running Combined Option Tests ===${colors.NC}`, + ); + + // Note about the combined options issue + console.log( + `${colors.BLUE}Testing combined options with environment variables and config file.${colors.NC}`, + ); + + // Test 23: CLI mode with config file, environment variables, and tool call + await runBasicTest( + "combined_options", + "--config", + path.join(PROJECT_ROOT, "sample-config.json"), + "--server", + "everything", + "-e", + "CLI_ENV_VAR=cli_value", + "--cli", + "--method", + "tools/list", + ); + + // Test 24: CLI mode with all possible options (that make sense together) + await runBasicTest( + "all_options", + "--config", + path.join(PROJECT_ROOT, "sample-config.json"), + "--server", + "everything", + "-e", + "CLI_ENV_VAR=cli_value", + "--cli", + "--method", + "tools/call", + "--tool-name", + "echo", + "--tool-arg", + "message=Hello", + "--log-level", + "debug", + ); + + // Print test summary + console.log(`\n${colors.YELLOW}=== Test Summary ===${colors.NC}`); + console.log(`${colors.GREEN}Passed: ${PASSED_TESTS}${colors.NC}`); + console.log(`${colors.RED}Failed: ${FAILED_TESTS}${colors.NC}`); + console.log(`${colors.ORANGE}Skipped: ${SKIPPED_TESTS}${colors.NC}`); + console.log(`Total: ${TOTAL_TESTS}`); + console.log( + `${colors.BLUE}Detailed logs saved to: ${OUTPUT_DIR}${colors.NC}`, + ); + + console.log(`\n${colors.GREEN}All tests completed!${colors.NC}`); +} + +// Run all tests +runTests().catch((error) => { + console.error( + `${colors.RED}Tests failed with error: ${error.message}${colors.NC}`, + ); + process.exit(1); +}); diff --git a/cli/scripts/make-executable.js b/cli/scripts/make-executable.js new file mode 100755 index 0000000..f3b8c90 --- /dev/null +++ b/cli/scripts/make-executable.js @@ -0,0 +1,29 @@ +/** + * Cross-platform script to make a file executable + */ +import { promises as fs } from "fs"; +import { platform } from "os"; +import { execSync } from "child_process"; +import path from "path"; + +const TARGET_FILE = path.resolve("build/cli.js"); + +async function makeExecutable() { + try { + // On Unix-like systems (Linux, macOS), use chmod + if (platform() !== "win32") { + execSync(`chmod +x "${TARGET_FILE}"`); + console.log("Made file executable with chmod"); + } else { + // On Windows, no need to make files "executable" in the Unix sense + // Just ensure the file exists + await fs.access(TARGET_FILE); + console.log("File exists and is accessible on Windows"); + } + } catch (error) { + console.error("Error making file executable:", error); + process.exit(1); + } +} + +makeExecutable(); diff --git a/cli/src/cli.ts b/cli/src/cli.ts new file mode 100644 index 0000000..1f87b51 --- /dev/null +++ b/cli/src/cli.ts @@ -0,0 +1,287 @@ +#!/usr/bin/env node + +import { Command } from "commander"; +import fs from "node:fs"; +import path from "node:path"; +import { dirname, resolve } from "path"; +import { spawnPromise } from "spawn-rx"; +import { fileURLToPath } from "url"; + +const __dirname = dirname(fileURLToPath(import.meta.url)); + +type Args = { + command: string; + args: string[]; + envArgs: Record; + cli: boolean; +}; + +type CliOptions = { + e?: Record; + config?: string; + server?: string; + cli?: boolean; +}; + +type ServerConfig = { + command: string; + args?: string[]; + env?: Record; +}; + +function handleError(error: unknown): never { + let message: string; + + if (error instanceof Error) { + message = error.message; + } else if (typeof error === "string") { + message = error; + } else { + message = "Unknown error"; + } + + console.error(message); + + process.exit(1); +} + +function delay(ms: number): Promise { + return new Promise((resolve) => setTimeout(resolve, ms, true)); +} + +async function runWebClient(args: Args): Promise { + const inspectorServerPath = resolve( + __dirname, + "../../", + "server", + "build", + "index.js", + ); + + // Path to the client entry point + const inspectorClientPath = resolve( + __dirname, + "../../", + "client", + "bin", + "client.js", + ); + + const CLIENT_PORT: string = process.env.CLIENT_PORT ?? "6274"; + const SERVER_PORT: string = process.env.SERVER_PORT ?? "6277"; + + console.log("Starting MCP inspector..."); + + const abort = new AbortController(); + let cancelled: boolean = false; + process.on("SIGINT", () => { + cancelled = true; + abort.abort(); + }); + + let server: ReturnType; + let serverOk: unknown; + + try { + server = spawnPromise( + "node", + [ + inspectorServerPath, + ...(args.command ? [`--env`, args.command] : []), + ...(args.args ? [`--args=${args.args.join(" ")}`] : []), + ], + { + env: { + ...process.env, + PORT: SERVER_PORT, + MCP_ENV_VARS: JSON.stringify(args.envArgs), + }, + signal: abort.signal, + echoOutput: true, + }, + ); + + // Make sure server started before starting client + serverOk = await Promise.race([server, delay(2 * 1000)]); + } catch (error) {} + + if (serverOk) { + try { + await spawnPromise("node", [inspectorClientPath], { + env: { ...process.env, PORT: CLIENT_PORT }, + signal: abort.signal, + echoOutput: true, + }); + } catch (e) { + if (!cancelled || process.env.DEBUG) throw e; + } + } +} + +async function runCli(args: Args): Promise { + const projectRoot = resolve(__dirname, ".."); + const cliPath = resolve(projectRoot, "build", "index.js"); + + const abort = new AbortController(); + + let cancelled = false; + + process.on("SIGINT", () => { + cancelled = true; + abort.abort(); + }); + + try { + await spawnPromise("node", [cliPath, args.command, ...args.args], { + env: { ...process.env, ...args.envArgs }, + signal: abort.signal, + echoOutput: true, + }); + } catch (e) { + if (!cancelled || process.env.DEBUG) { + throw e; + } + } +} + +function loadConfigFile(configPath: string, serverName: string): ServerConfig { + try { + const resolvedConfigPath = path.isAbsolute(configPath) + ? configPath + : path.resolve(process.cwd(), configPath); + + if (!fs.existsSync(resolvedConfigPath)) { + throw new Error(`Config file not found: ${resolvedConfigPath}`); + } + + const configContent = fs.readFileSync(resolvedConfigPath, "utf8"); + const parsedConfig = JSON.parse(configContent); + + if (!parsedConfig.mcpServers || !parsedConfig.mcpServers[serverName]) { + const availableServers = Object.keys(parsedConfig.mcpServers || {}).join( + ", ", + ); + throw new Error( + `Server '${serverName}' not found in config file. Available servers: ${availableServers}`, + ); + } + + const serverConfig = parsedConfig.mcpServers[serverName]; + + return serverConfig; + } catch (err: unknown) { + if (err instanceof SyntaxError) { + throw new Error(`Invalid JSON in config file: ${err.message}`); + } + + throw err; + } +} + +function parseKeyValuePair( + value: string, + previous: Record = {}, +): Record { + const parts = value.split("="); + const key = parts[0]; + const val = parts.slice(1).join("="); + + if (val === undefined || val === "") { + throw new Error( + `Invalid parameter format: ${value}. Use key=value format.`, + ); + } + + return { ...previous, [key as string]: val }; +} + +function parseArgs(): Args { + const program = new Command(); + + const argSeparatorIndex = process.argv.indexOf("--"); + let preArgs = process.argv; + let postArgs: string[] = []; + + if (argSeparatorIndex !== -1) { + preArgs = process.argv.slice(0, argSeparatorIndex); + postArgs = process.argv.slice(argSeparatorIndex + 1); + } + + program + .name("inspector-bin") + .allowExcessArguments() + .allowUnknownOption() + .option( + "-e ", + "environment variables in KEY=VALUE format", + parseKeyValuePair, + {}, + ) + .option("--config ", "config file path") + .option("--server ", "server name from config file") + .option("--cli", "enable CLI mode"); + + // Parse only the arguments before -- + program.parse(preArgs); + + const options = program.opts() as CliOptions; + const remainingArgs = program.args; + + // Add back any arguments that came after -- + const finalArgs = [...remainingArgs, ...postArgs]; + + // Validate that config and server are provided together + if ( + (options.config && !options.server) || + (!options.config && options.server) + ) { + throw new Error( + "Both --config and --server must be provided together. If you specify one, you must specify the other.", + ); + } + + // If config file is specified, load and use the options from the file. We must merge the args + // from the command line and the file together, or we will miss the method options (--method, + // etc.) + if (options.config && options.server) { + const config = loadConfigFile(options.config, options.server); + + return { + command: config.command, + args: [...(config.args || []), ...finalArgs], + envArgs: { ...(config.env || {}), ...(options.e || {}) }, + cli: options.cli || false, + }; + } + + // Otherwise use command line arguments + const command = finalArgs[0] || ""; + const args = finalArgs.slice(1); + + return { + command, + args, + envArgs: options.e || {}, + cli: options.cli || false, + }; +} + +async function main(): Promise { + process.on("uncaughtException", (error) => { + handleError(error); + }); + + try { + const args = parseArgs(); + + if (args.cli) { + runCli(args); + } else { + await runWebClient(args); + } + } catch (error) { + handleError(error); + } +} + +main(); diff --git a/cli/src/client/connection.ts b/cli/src/client/connection.ts new file mode 100644 index 0000000..931f803 --- /dev/null +++ b/cli/src/client/connection.ts @@ -0,0 +1,51 @@ +import { Client } from "@modelcontextprotocol/sdk/client/index.js"; +import type { Transport } from "@modelcontextprotocol/sdk/shared/transport.js"; +import { McpResponse } from "./types.js"; + +export const validLogLevels = [ + "trace", + "debug", + "info", + "warn", + "error", +] as const; + +export type LogLevel = (typeof validLogLevels)[number]; + +export async function connect( + client: Client, + transport: Transport, +): Promise { + try { + await client.connect(transport); + } catch (error) { + throw new Error( + `Failed to connect to MCP server: ${error instanceof Error ? error.message : String(error)}`, + ); + } +} + +export async function disconnect(transport: Transport): Promise { + try { + await transport.close(); + } catch (error) { + throw new Error( + `Failed to disconnect from MCP server: ${error instanceof Error ? error.message : String(error)}`, + ); + } +} + +// Set logging level +export async function setLoggingLevel( + client: Client, + level: LogLevel, +): Promise { + try { + const response = await client.setLoggingLevel(level as any); + return response; + } catch (error) { + throw new Error( + `Failed to set logging level: ${error instanceof Error ? error.message : String(error)}`, + ); + } +} diff --git a/cli/src/client/index.ts b/cli/src/client/index.ts new file mode 100644 index 0000000..095d716 --- /dev/null +++ b/cli/src/client/index.ts @@ -0,0 +1,6 @@ +// Re-export everything from the client modules +export * from "./connection.js"; +export * from "./prompts.js"; +export * from "./resources.js"; +export * from "./tools.js"; +export * from "./types.js"; diff --git a/cli/src/client/prompts.ts b/cli/src/client/prompts.ts new file mode 100644 index 0000000..0b23749 --- /dev/null +++ b/cli/src/client/prompts.ts @@ -0,0 +1,34 @@ +import { Client } from "@modelcontextprotocol/sdk/client/index.js"; +import { McpResponse } from "./types.js"; + +// List available prompts +export async function listPrompts(client: Client): Promise { + try { + const response = await client.listPrompts(); + return response; + } catch (error) { + throw new Error( + `Failed to list prompts: ${error instanceof Error ? error.message : String(error)}`, + ); + } +} + +// Get a prompt +export async function getPrompt( + client: Client, + name: string, + args?: Record, +): Promise { + try { + const response = await client.getPrompt({ + name, + arguments: args || {}, + }); + + return response; + } catch (error) { + throw new Error( + `Failed to get prompt: ${error instanceof Error ? error.message : String(error)}`, + ); + } +} diff --git a/cli/src/client/resources.ts b/cli/src/client/resources.ts new file mode 100644 index 0000000..bf33d64 --- /dev/null +++ b/cli/src/client/resources.ts @@ -0,0 +1,43 @@ +import { Client } from "@modelcontextprotocol/sdk/client/index.js"; +import { McpResponse } from "./types.js"; + +// List available resources +export async function listResources(client: Client): Promise { + try { + const response = await client.listResources(); + return response; + } catch (error) { + throw new Error( + `Failed to list resources: ${error instanceof Error ? error.message : String(error)}`, + ); + } +} + +// Read a resource +export async function readResource( + client: Client, + uri: string, +): Promise { + try { + const response = await client.readResource({ uri }); + return response; + } catch (error) { + throw new Error( + `Failed to read resource ${uri}: ${error instanceof Error ? error.message : String(error)}`, + ); + } +} + +// List resource templates +export async function listResourceTemplates( + client: Client, +): Promise { + try { + const response = await client.listResourceTemplates(); + return response; + } catch (error) { + throw new Error( + `Failed to list resource templates: ${error instanceof Error ? error.message : String(error)}`, + ); + } +} diff --git a/cli/src/client/tools.ts b/cli/src/client/tools.ts new file mode 100644 index 0000000..acdb487 --- /dev/null +++ b/cli/src/client/tools.ts @@ -0,0 +1,95 @@ +import { Client } from "@modelcontextprotocol/sdk/client/index.js"; +import { Tool } from "@modelcontextprotocol/sdk/types.js"; +import { McpResponse } from "./types.js"; + +type JsonSchemaType = { + type: "string" | "number" | "integer" | "boolean" | "array" | "object"; + description?: string; + properties?: Record; + items?: JsonSchemaType; +}; + +export async function listTools(client: Client): Promise { + try { + const response = await client.listTools(); + return response; + } catch (error) { + throw new Error( + `Failed to list tools: ${error instanceof Error ? error.message : String(error)}`, + ); + } +} + +function convertParameterValue(value: string, schema: JsonSchemaType): unknown { + if (!value) { + return value; + } + + if (schema.type === "number" || schema.type === "integer") { + return Number(value); + } + + if (schema.type === "boolean") { + return value.toLowerCase() === "true"; + } + + if (schema.type === "object" || schema.type === "array") { + try { + return JSON.parse(value); + } catch (error) { + return value; + } + } + + return value; +} + +function convertParameters( + tool: Tool, + params: Record, +): Record { + const result: Record = {}; + const properties = tool.inputSchema.properties || {}; + + for (const [key, value] of Object.entries(params)) { + const paramSchema = properties[key] as JsonSchemaType | undefined; + + if (paramSchema) { + result[key] = convertParameterValue(value, paramSchema); + } else { + // If no schema is found for this parameter, keep it as string + result[key] = value; + } + } + + return result; +} + +export async function callTool( + client: Client, + name: string, + args: Record, +): Promise { + try { + const toolsResponse = await listTools(client); + const tools = toolsResponse.tools as Tool[]; + const tool = tools.find((t) => t.name === name); + + let convertedArgs: Record = args; + + if (tool) { + // Convert parameters based on the tool's schema + convertedArgs = convertParameters(tool, args); + } + + const response = await client.callTool({ + name: name, + arguments: convertedArgs, + }); + return response; + } catch (error) { + throw new Error( + `Failed to call tool ${name}: ${error instanceof Error ? error.message : String(error)}`, + ); + } +} diff --git a/cli/src/client/types.ts b/cli/src/client/types.ts new file mode 100644 index 0000000..bbbe1bf --- /dev/null +++ b/cli/src/client/types.ts @@ -0,0 +1 @@ +export type McpResponse = Record; diff --git a/cli/src/error-handler.ts b/cli/src/error-handler.ts new file mode 100644 index 0000000..9725774 --- /dev/null +++ b/cli/src/error-handler.ts @@ -0,0 +1,20 @@ +function formatError(error: unknown): string { + let message: string; + + if (error instanceof Error) { + message = error.message; + } else if (typeof error === "string") { + message = error; + } else { + message = "Unknown error"; + } + + return message; +} + +export function handleError(error: unknown): never { + const errorMessage = formatError(error); + console.error(errorMessage); + + process.exit(1); +} diff --git a/cli/src/index.ts b/cli/src/index.ts new file mode 100644 index 0000000..bda1e8f --- /dev/null +++ b/cli/src/index.ts @@ -0,0 +1,253 @@ +#!/usr/bin/env node + +import { Client } from "@modelcontextprotocol/sdk/client/index.js"; +import { Command } from "commander"; +import { + callTool, + connect, + disconnect, + getPrompt, + listPrompts, + listResources, + listResourceTemplates, + listTools, + LogLevel, + McpResponse, + readResource, + setLoggingLevel, + validLogLevels, +} from "./client/index.js"; +import { handleError } from "./error-handler.js"; +import { createTransport, TransportOptions } from "./transport.js"; + +type Args = { + target: string[]; + method?: string; + promptName?: string; + promptArgs?: Record; + uri?: string; + logLevel?: LogLevel; + toolName?: string; + toolArg?: Record; +}; + +function createTransportOptions(target: string[]): TransportOptions { + if (target.length === 0) { + throw new Error( + "Target is required. Specify a URL or a command to execute.", + ); + } + + const [command, ...commandArgs] = target; + + if (!command) { + throw new Error("Command is required."); + } + + const isUrl = command.startsWith("http://") || command.startsWith("https://"); + + if (isUrl && commandArgs.length > 0) { + throw new Error("Arguments cannot be passed to a URL-based MCP server."); + } + + return { + transportType: isUrl ? "sse" : "stdio", + command: isUrl ? undefined : command, + args: isUrl ? undefined : commandArgs, + url: isUrl ? command : undefined, + }; +} + +async function callMethod(args: Args): Promise { + const transportOptions = createTransportOptions(args.target); + const transport = createTransport(transportOptions); + const client = new Client({ + name: "inspector-cli", + version: "0.5.1", + }); + + try { + await connect(client, transport); + + let result: McpResponse; + + // Tools methods + if (args.method === "tools/list") { + result = await listTools(client); + } else if (args.method === "tools/call") { + if (!args.toolName) { + throw new Error( + "Tool name is required for tools/call method. Use --tool-name to specify the tool name.", + ); + } + + result = await callTool(client, args.toolName, args.toolArg || {}); + } + // Resources methods + else if (args.method === "resources/list") { + result = await listResources(client); + } else if (args.method === "resources/read") { + if (!args.uri) { + throw new Error( + "URI is required for resources/read method. Use --uri to specify the resource URI.", + ); + } + + result = await readResource(client, args.uri); + } else if (args.method === "resources/templates/list") { + result = await listResourceTemplates(client); + } + // Prompts methods + else if (args.method === "prompts/list") { + result = await listPrompts(client); + } else if (args.method === "prompts/get") { + if (!args.promptName) { + throw new Error( + "Prompt name is required for prompts/get method. Use --prompt-name to specify the prompt name.", + ); + } + + result = await getPrompt(client, args.promptName, args.promptArgs || {}); + } + // Logging methods + else if (args.method === "logging/setLevel") { + if (!args.logLevel) { + throw new Error( + "Log level is required for logging/setLevel method. Use --log-level to specify the log level.", + ); + } + + result = await setLoggingLevel(client, args.logLevel); + } else { + throw new Error( + `Unsupported method: ${args.method}. Supported methods include: tools/list, tools/call, resources/list, resources/read, resources/templates/list, prompts/list, prompts/get, logging/setLevel`, + ); + } + + console.log(JSON.stringify(result, null, 2)); + } finally { + try { + await disconnect(transport); + } catch (disconnectError) { + throw disconnectError; + } + } +} + +function parseKeyValuePair( + value: string, + previous: Record = {}, +): Record { + const parts = value.split("="); + const key = parts[0]; + const val = parts.slice(1).join("="); + + if (val === undefined || val === "") { + throw new Error( + `Invalid parameter format: ${value}. Use key=value format.`, + ); + } + + return { ...previous, [key as string]: val }; +} + +function parseArgs(): Args { + const program = new Command(); + + // Find if there's a -- in the arguments and split them + const argSeparatorIndex = process.argv.indexOf("--"); + let preArgs = process.argv; + let postArgs: string[] = []; + + if (argSeparatorIndex !== -1) { + preArgs = process.argv.slice(0, argSeparatorIndex); + postArgs = process.argv.slice(argSeparatorIndex + 1); + } + + program + .name("inspector-cli") + .allowUnknownOption() + .argument("", "Command and arguments or URL of the MCP server") + // + // Method selection + // + .option("--method ", "Method to invoke") + // + // Tool-related options + // + .option("--tool-name ", "Tool name (for tools/call method)") + .option( + "--tool-arg ", + "Tool argument as key=value pair", + parseKeyValuePair, + {}, + ) + // + // Resource-related options + // + .option("--uri ", "URI of the resource (for resources/read method)") + // + // Prompt-related options + // + .option( + "--prompt-name ", + "Name of the prompt (for prompts/get method)", + ) + .option( + "--prompt-args ", + "Prompt arguments as key=value pairs", + parseKeyValuePair, + {}, + ) + // + // Logging options + // + .option( + "--log-level ", + "Logging level (for logging/setLevel method)", + (value: string) => { + if (!validLogLevels.includes(value as any)) { + throw new Error( + `Invalid log level: ${value}. Valid levels are: ${validLogLevels.join(", ")}`, + ); + } + + return value as LogLevel; + }, + ); + + // Parse only the arguments before -- + program.parse(preArgs); + + const options = program.opts() as Omit; + let remainingArgs = program.args; + + // Add back any arguments that came after -- + const finalArgs = [...remainingArgs, ...postArgs]; + + if (!options.method) { + throw new Error( + "Method is required. Use --method to specify the method to invoke.", + ); + } + + return { + target: finalArgs, + ...options, + }; +} + +async function main(): Promise { + process.on("uncaughtException", (error) => { + handleError(error); + }); + + try { + const args = parseArgs(); + await callMethod(args); + } catch (error) { + handleError(error); + } +} + +main(); diff --git a/cli/src/transport.ts b/cli/src/transport.ts new file mode 100644 index 0000000..e693f24 --- /dev/null +++ b/cli/src/transport.ts @@ -0,0 +1,76 @@ +import { SSEClientTransport } from "@modelcontextprotocol/sdk/client/sse.js"; +import { + getDefaultEnvironment, + StdioClientTransport, +} from "@modelcontextprotocol/sdk/client/stdio.js"; +import type { Transport } from "@modelcontextprotocol/sdk/shared/transport.js"; +import { findActualExecutable } from "spawn-rx"; + +export type TransportOptions = { + transportType: "sse" | "stdio"; + command?: string; + args?: string[]; + url?: string; +}; + +function createSSETransport(options: TransportOptions): Transport { + const baseUrl = new URL(options.url ?? ""); + const sseUrl = new URL("/sse", baseUrl); + + return new SSEClientTransport(sseUrl); +} + +function createStdioTransport(options: TransportOptions): Transport { + let args: string[] = []; + + if (options.args !== undefined) { + args = options.args; + } + + const processEnv: Record = {}; + + for (const [key, value] of Object.entries(process.env)) { + if (value !== undefined) { + processEnv[key] = value; + } + } + + const defaultEnv = getDefaultEnvironment(); + + const env: Record = { + ...processEnv, + ...defaultEnv, + }; + + const { cmd: actualCommand, args: actualArgs } = findActualExecutable( + options.command ?? "", + args, + ); + + return new StdioClientTransport({ + command: actualCommand, + args: actualArgs, + env, + stderr: "pipe", + }); +} + +export function createTransport(options: TransportOptions): Transport { + const { transportType } = options; + + try { + if (transportType === "stdio") { + return createStdioTransport(options); + } + + if (transportType === "sse") { + return createSSETransport(options); + } + + throw new Error(`Unsupported transport type: ${transportType}`); + } catch (error) { + throw new Error( + `Failed to create transport: ${error instanceof Error ? error.message : String(error)}`, + ); + } +} diff --git a/cli/tsconfig.json b/cli/tsconfig.json new file mode 100644 index 0000000..effa34f --- /dev/null +++ b/cli/tsconfig.json @@ -0,0 +1,17 @@ +{ + "compilerOptions": { + "target": "ES2022", + "module": "NodeNext", + "moduleResolution": "NodeNext", + "outDir": "./build", + "rootDir": "./src", + "strict": true, + "esModuleInterop": true, + "skipLibCheck": true, + "forceConsistentCasingInFileNames": true, + "resolveJsonModule": true, + "noUncheckedIndexedAccess": true + }, + "include": ["src/**/*"], + "exclude": ["node_modules", "packages", "**/*.spec.ts", "build"] +} diff --git a/client/bin/cli.js b/client/bin/client.js similarity index 100% rename from client/bin/cli.js rename to client/bin/client.js diff --git a/bin/cli.js b/client/bin/start.js similarity index 98% rename from bin/cli.js rename to client/bin/start.js index 35edf0e..e7a2495 100755 --- a/bin/cli.js +++ b/client/bin/start.js @@ -46,7 +46,7 @@ async function main() { const inspectorServerPath = resolve( __dirname, - "..", + "../..", "server", "build", "index.js", @@ -55,10 +55,10 @@ async function main() { // Path to the client entry point const inspectorClientPath = resolve( __dirname, - "..", + "../..", "client", "bin", - "cli.js", + "client.js", ); const CLIENT_PORT = process.env.CLIENT_PORT ?? "6274"; diff --git a/client/package.json b/client/package.json index 0734ea9..b2da038 100644 --- a/client/package.json +++ b/client/package.json @@ -1,6 +1,6 @@ { "name": "@modelcontextprotocol/inspector-client", - "version": "0.8.2", + "version": "0.10.0", "description": "Client-side application for the Model Context Protocol inspector", "license": "MIT", "author": "Anthropic, PBC (https://anthropic.com)", @@ -8,14 +8,14 @@ "bugs": "https://github.com/modelcontextprotocol/inspector/issues", "type": "module", "bin": { - "mcp-inspector-client": "./bin/cli.js" + "mcp-inspector-client": "./bin/start.js" }, "files": [ "bin", "dist" ], "scripts": { - "dev": "vite", + "dev": "vite --port 6274", "build": "tsc -b && vite build", "lint": "eslint .", "preview": "vite preview --port 6274", @@ -23,7 +23,7 @@ "test:watch": "jest --config jest.config.cjs --watch" }, "dependencies": { - "@modelcontextprotocol/sdk": "^1.9.0", + "@modelcontextprotocol/sdk": "^1.10.0", "@radix-ui/react-checkbox": "^1.1.4", "@radix-ui/react-dialog": "^1.1.3", "@radix-ui/react-icons": "^1.3.0", @@ -72,6 +72,6 @@ "ts-jest": "^29.2.6", "typescript": "^5.5.3", "typescript-eslint": "^8.7.0", - "vite": "^5.4.8" + "vite": "^6.3.0" } } diff --git a/client/src/App.tsx b/client/src/App.tsx index d85bb43..a2dc8f0 100644 --- a/client/src/App.tsx +++ b/client/src/App.tsx @@ -17,7 +17,13 @@ import { Tool, LoggingLevel, } from "@modelcontextprotocol/sdk/types.js"; -import React, { Suspense, useEffect, useRef, useState } from "react"; +import React, { + Suspense, + useCallback, + useEffect, + useRef, + useState, +} from "react"; import { useConnection } from "./lib/hooks/useConnection"; import { useDraggablePane } from "./lib/hooks/useDraggablePane"; import { StdErrNotification } from "./lib/notificationTypes"; @@ -46,14 +52,10 @@ import ToolsTab from "./components/ToolsTab"; import { DEFAULT_INSPECTOR_CONFIG } from "./lib/constants"; import { InspectorConfig } from "./lib/configurationTypes"; import { getMCPProxyAddress } from "./utils/configUtils"; -import { useToast } from "@/hooks/use-toast"; -const params = new URLSearchParams(window.location.search); const CONFIG_LOCAL_STORAGE_KEY = "inspectorConfig_v1"; const App = () => { - const { toast } = useToast(); - // Handle OAuth callback route const [resources, setResources] = useState([]); const [resourceTemplates, setResourceTemplates] = useState< ResourceTemplate[] @@ -122,6 +124,10 @@ const App = () => { return localStorage.getItem("lastBearerToken") || ""; }); + const [headerName, setHeaderName] = useState(() => { + return localStorage.getItem("lastHeaderName") || ""; + }); + const [pendingSampleRequests, setPendingSampleRequests] = useState< Array< PendingRequest & { @@ -174,6 +180,7 @@ const App = () => { sseUrl, env, bearerToken, + headerName, config, onNotification: (notification) => { setNotifications((prev) => [...prev, notification as ServerNotification]); @@ -213,35 +220,23 @@ const App = () => { localStorage.setItem("lastBearerToken", bearerToken); }, [bearerToken]); + useEffect(() => { + localStorage.setItem("lastHeaderName", headerName); + }, [headerName]); + useEffect(() => { localStorage.setItem(CONFIG_LOCAL_STORAGE_KEY, JSON.stringify(config)); }, [config]); - const hasProcessedRef = useRef(false); - // Auto-connect if serverUrl is provided in URL params (e.g. after OAuth callback) - useEffect(() => { - if (hasProcessedRef.current) { - // Only try to connect once - return; - } - const serverUrl = params.get("serverUrl"); - if (serverUrl) { + // Auto-connect to previously saved serverURL after OAuth callback + const onOAuthConnect = useCallback( + (serverUrl: string) => { setSseUrl(serverUrl); setTransportType("sse"); - // Remove serverUrl from URL without reloading the page - const newUrl = new URL(window.location.href); - newUrl.searchParams.delete("serverUrl"); - window.history.replaceState({}, "", newUrl.toString()); - // Show success toast for OAuth - toast({ - title: "Success", - description: "Successfully authenticated with OAuth", - }); - hasProcessedRef.current = true; - // Connect to the server - connectMcpServer(); - } - }, [connectMcpServer, toast]); + void connectMcpServer(); + }, + [connectMcpServer], + ); useEffect(() => { fetch(`${getMCPProxyAddress(config)}/config`) @@ -472,13 +467,17 @@ const App = () => { setLogLevel(level); }; + const clearStdErrNotifications = () => { + setStdErrNotifications([]); + }; + if (window.location.pathname === "/oauth/callback") { const OAuthCallback = React.lazy( () => import("./components/OAuthCallback"), ); return ( Loading...}> - + ); } @@ -501,12 +500,15 @@ const App = () => { setConfig={setConfig} bearerToken={bearerToken} setBearerToken={setBearerToken} + headerName={headerName} + setHeaderName={setHeaderName} onConnect={connectMcpServer} onDisconnect={disconnectMcpServer} stdErrNotifications={stdErrNotifications} logLevel={logLevel} sendLogLevelRequest={sendLogLevelRequest} loggingSupported={!!serverCapabilities?.logging || false} + clearStdErrNotifications={clearStdErrNotifications} />
diff --git a/client/src/components/DynamicJsonForm.tsx b/client/src/components/DynamicJsonForm.tsx index bd77639..fa04467 100644 --- a/client/src/components/DynamicJsonForm.tsx +++ b/client/src/components/DynamicJsonForm.tsx @@ -1,11 +1,10 @@ import { useState, useEffect, useCallback, useRef } from "react"; import { Button } from "@/components/ui/button"; import { Input } from "@/components/ui/input"; -import { Label } from "@/components/ui/label"; import JsonEditor from "./JsonEditor"; import { updateValueAtPath } from "@/utils/jsonUtils"; -import { generateDefaultValue, formatFieldLabel } from "@/utils/schemaUtils"; -import type { JsonValue, JsonSchemaType, JsonObject } from "@/utils/jsonUtils"; +import { generateDefaultValue } from "@/utils/schemaUtils"; +import type { JsonValue, JsonSchemaType } from "@/utils/jsonUtils"; interface DynamicJsonFormProps { schema: JsonSchemaType; @@ -14,13 +13,23 @@ interface DynamicJsonFormProps { maxDepth?: number; } +const isSimpleObject = (schema: JsonSchemaType): boolean => { + const supportedTypes = ["string", "number", "integer", "boolean", "null"]; + if (supportedTypes.includes(schema.type)) return true; + if (schema.type !== "object") return false; + return Object.values(schema.properties ?? {}).every((prop) => + supportedTypes.includes(prop.type), + ); +}; + const DynamicJsonForm = ({ schema, value, onChange, maxDepth = 3, }: DynamicJsonFormProps) => { - const [isJsonMode, setIsJsonMode] = useState(false); + const isOnlyJSON = !isSimpleObject(schema); + const [isJsonMode, setIsJsonMode] = useState(isOnlyJSON); const [jsonError, setJsonError] = useState(); // Store the raw JSON string to allow immediate feedback during typing // while deferring parsing until the user stops typing @@ -207,111 +216,6 @@ const DynamicJsonForm = ({ required={propSchema.required} /> ); - case "object": { - // Handle case where we have a value but no schema properties - const objectValue = (currentValue as JsonObject) || {}; - - // If we have schema properties, use them to render fields - if (propSchema.properties) { - return ( -
- {Object.entries(propSchema.properties).map(([key, prop]) => ( -
- - {renderFormFields( - prop, - objectValue[key], - [...path, key], - depth + 1, - )} -
- ))} -
- ); - } - // If we have a value but no schema properties, render fields based on the value - else if (Object.keys(objectValue).length > 0) { - return ( -
- {Object.entries(objectValue).map(([key, value]) => ( -
- - - handleFieldChange([...path, key], e.target.value) - } - /> -
- ))} -
- ); - } - // If we have neither schema properties nor value, return null - return null; - } - case "array": { - const arrayValue = Array.isArray(currentValue) ? currentValue : []; - if (!propSchema.items) return null; - return ( -
- {propSchema.description && ( -

{propSchema.description}

- )} - - {propSchema.items?.description && ( -

- Items: {propSchema.items.description} -

- )} - -
- {arrayValue.map((item, index) => ( -
- {renderFormFields( - propSchema.items as JsonSchemaType, - item, - [...path, index.toString()], - depth + 1, - )} - -
- ))} - -
-
- ); - } default: return null; } @@ -350,9 +254,11 @@ const DynamicJsonForm = ({ Format JSON )} - + {!isOnlyJSON && ( + + )}
{isJsonMode ? ( diff --git a/client/src/components/JsonView.tsx b/client/src/components/JsonView.tsx index 3fcbf8e..bd7ef64 100644 --- a/client/src/components/JsonView.tsx +++ b/client/src/components/JsonView.tsx @@ -227,7 +227,7 @@ const JsonNode = memo( )} 
diff --git a/client/src/components/ListPane.tsx b/client/src/components/ListPane.tsx
index 90693dd..6f9a8cf 100644
--- a/client/src/components/ListPane.tsx
+++ b/client/src/components/ListPane.tsx
@@ -22,7 +22,7 @@ const ListPane = ({
   isButtonDisabled,
 }: ListPaneProps) => (
   

-    

+    

       
{title}

     

     

diff --git a/client/src/components/OAuthCallback.tsx b/client/src/components/OAuthCallback.tsx
index cba38c3..6bfa8a3 100644
--- a/client/src/components/OAuthCallback.tsx
+++ b/client/src/components/OAuthCallback.tsx
@@ -1,9 +1,19 @@
 import { useEffect, useRef } from "react";
-import { authProvider } from "../lib/auth";
+import { InspectorOAuthClientProvider } from "../lib/auth";
 import { SESSION_KEYS } from "../lib/constants";
 import { auth } from "@modelcontextprotocol/sdk/client/auth.js";
+import { useToast } from "@/hooks/use-toast.ts";
+import {
+  generateOAuthErrorDescription,
+  parseOAuthCallbackParams,
+} from "@/utils/oauthUtils.ts";
 
-const OAuthCallback = () => {
+interface OAuthCallbackProps {
+  onConnect: (serverUrl: string) => void;
+}
+
+const OAuthCallback = ({ onConnect }: OAuthCallbackProps) => {
+  const { toast } = useToast();
   const hasProcessedRef = useRef(false);
 
   useEffect(() => {
@@ -14,37 +24,56 @@ const OAuthCallback = () => {
       }
       hasProcessedRef.current = true;
 
-      const params = new URLSearchParams(window.location.search);
-      const code = params.get("code");
-      const serverUrl = sessionStorage.getItem(SESSION_KEYS.SERVER_URL);
+      const notifyError = (description: string) =>
+        void toast({
+          title: "OAuth Authorization Error",
+          description,
+          variant: "destructive",
+        });
 
-      if (!code || !serverUrl) {
-        console.error("Missing code or server URL");
-        window.location.href = "/";
-        return;
+      const params = parseOAuthCallbackParams(window.location.search);
+      if (!params.successful) {
+        return notifyError(generateOAuthErrorDescription(params));
       }
 
-      try {
-        const result = await auth(authProvider, {
-          serverUrl,
-          authorizationCode: code,
-        });
-        if (result !== "AUTHORIZED") {
-          throw new Error(
-            `Expected to be authorized after providing auth code, got: ${result}`,
-          );
-        }
+      const serverUrl = sessionStorage.getItem(SESSION_KEYS.SERVER_URL);
+      if (!serverUrl) {
+        return notifyError("Missing Server URL");
+      }
 
-        // Redirect back to the main app with server URL to trigger auto-connect
-        window.location.href = `/?serverUrl=${encodeURIComponent(serverUrl)}`;
+      let result;
+      try {
+        // Create an auth provider with the current server URL
+        const serverAuthProvider = new InspectorOAuthClientProvider(serverUrl);
+
+        result = await auth(serverAuthProvider, {
+          serverUrl,
+          authorizationCode: params.code,
+        });
       } catch (error) {
         console.error("OAuth callback error:", error);
-        window.location.href = "/";
+        return notifyError(`Unexpected error occurred: ${error}`);
       }
+
+      if (result !== "AUTHORIZED") {
+        return notifyError(
+          `Expected to be authorized after providing auth code, got: ${result}`,
+        );
+      }
+
+      // Finally, trigger auto-connect
+      toast({
+        title: "Success",
+        description: "Successfully authenticated with OAuth",
+        variant: "default",
+      });
+      onConnect(serverUrl);
     };
 
-    void handleCallback();
-  }, []);
+    handleCallback().finally(() => {
+      window.history.replaceState({}, document.title, "/");
+    });
+  }, [toast, onConnect]);
 
   return (
     

diff --git a/client/src/components/PromptsTab.tsx b/client/src/components/PromptsTab.tsx
index 80e5fe6..5fdad82 100644
--- a/client/src/components/PromptsTab.tsx
+++ b/client/src/components/PromptsTab.tsx
@@ -43,7 +43,7 @@ const PromptsTab = ({
   clearPrompts: () => void;
   getPrompt: (name: string, args: Record) => void;
   selectedPrompt: Prompt | null;
-  setSelectedPrompt: (prompt: Prompt) => void;
+  setSelectedPrompt: (prompt: Prompt | null) => void;
   handleCompletion: (
     ref: PromptReference | ResourceReference,
     argName: string,
@@ -89,7 +89,10 @@ const PromptsTab = ({
          {
+            clearPrompts();
+            setSelectedPrompt(null);
+          }}
           setSelectedItem={(prompt) => {
             setSelectedPrompt(prompt);
             setPromptArgs({});
@@ -108,7 +111,7 @@ const PromptsTab = ({
         />
 
         

-          

+          

             

               {selectedPrompt ? selectedPrompt.name : "Select a prompt"}
             

diff --git a/client/src/components/ResourcesTab.tsx b/client/src/components/ResourcesTab.tsx
index 23cfbe7..c0f8203 100644
--- a/client/src/components/ResourcesTab.tsx
+++ b/client/src/components/ResourcesTab.tsx
@@ -104,7 +104,6 @@ const ResourcesTab = ({
     if (selectedTemplate) {
       const uri = fillTemplate(selectedTemplate.uriTemplate, templateValues);
       readResource(uri);
-      setSelectedTemplate(null);
       // We don't have the full Resource object here, so we create a partial one
       setSelectedResource({ uri, name: uri } as Resource);
     }
@@ -116,7 +115,13 @@ const ResourcesTab = ({
          {
+            clearResources();
+            // Condition to check if selected resource is not resource template's resource
+            if (!selectedTemplate) {
+              setSelectedResource(null);
+            }
+          }}
           setSelectedItem={(resource) => {
             setSelectedResource(resource);
             readResource(resource.uri);
@@ -139,7 +144,14 @@ const ResourcesTab = ({
          {
+            clearResourceTemplates();
+            // Condition to check if selected resource is resource template's resource
+            if (selectedTemplate) {
+              setSelectedResource(null);
+            }
+            setSelectedTemplate(null);
+          }}
           setSelectedItem={(template) => {
             setSelectedTemplate(template);
             setSelectedResource(null);
@@ -162,7 +174,7 @@ const ResourcesTab = ({
         />
 
         

-          

+          

             
) => void;
   bearerToken: string;
   setBearerToken: (token: string) => void;
+  headerName?: string;
+  setHeaderName?: (name: string) => void;
   onConnect: () => void;
   onDisconnect: () => void;
   stdErrNotifications: StdErrNotification[];
+  clearStdErrNotifications: () => void;
   logLevel: LoggingLevel;
   sendLogLevelRequest: (level: LoggingLevel) => void;
   loggingSupported: boolean;
@@ -75,9 +78,12 @@ const Sidebar = ({
   setEnv,
   bearerToken,
   setBearerToken,
+  headerName,
+  setHeaderName,
   onConnect,
   onDisconnect,
   stdErrNotifications,
+  clearStdErrNotifications,
   logLevel,
   sendLogLevelRequest,
   loggingSupported,
@@ -92,7 +98,7 @@ const Sidebar = ({
 
   return (
     

-      

+      

         

           

             MCP Inspector v{version}
@@ -175,6 +181,7 @@ const Sidebar = ({
                   variant="outline"
                   onClick={() => setShowBearerToken(!showBearerToken)}
                   className="flex items-center w-full"
+                  data-testid="auth-button"
                   aria-expanded={showBearerToken}
                 >
                   {showBearerToken ? (
@@ -186,6 +193,16 @@ const Sidebar = ({
                 
                 {showBearerToken && (
                   

+                    
+                    
+                        setHeaderName && setHeaderName(e.target.value)
+                      }
+                      data-testid="header-input"
+                      className="font-mono"
+                      value={headerName}
+                    />