@mcpjam/inspector 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Anthropic, PBC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,258 @@
+# MCPJam Inspector
+
+The MCPJam inspector is a dev tool for testing and debugging MCP servers. The MCPJam inspector is a fork of the mcp-inspector with additional improvements. 
+
+## 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`:
+
+```bash
+npx @mcpjam/inspector node build/index.js
+```
+
+You can pass both arguments and environment variables to your MCP server. Arguments are passed directly to your server, while environment variables can be set using the `-e` flag:
+
+```bash
+# Pass arguments only
+npx @mcpjam/inspector node build/index.js arg1 arg2
+
+# Pass environment variables only
+npx @mcpjam/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
+
+# Use -- to separate inspector flags from server arguments
+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:
+
+```bash
+CLIENT_PORT=8080 SERVER_PORT=9000 npx @modelcontextprotocol/inspector node build/index.js
+```
+
+For more details on ways to use the inspector, see the [Inspector section of the MCP docs site](https://modelcontextprotocol.io/docs/tools/inspector). For help with debugging, see the [Debugging guide](https://modelcontextprotocol.io/docs/tools/debugging).
+
+### Servers File Export
+
+The MCP Inspector provides convenient buttons to export server launch configurations for use in clients such as Cursor, Claude Code, or the Inspector's CLI. The file is usually called `mcp.json`.
+
+- **Server Entry** - Copies a single server configuration entry to your clipboard. This can be added to your `mcp.json` file inside the `mcpServers` object with your preferred server name.
+
+  **STDIO transport example:**
+
+  ```json
+  {
+    "command": "node",
+    "args": ["build/index.js", "--debug"],
+    "env": {
+      "API_KEY": "your-api-key",
+      "DEBUG": "true"
+    }
+  }
+  ```
+
+  **SSE transport example:**
+
+  ```json
+  {
+    "type": "sse",
+    "url": "http://localhost:3000/events",
+    "note": "For SSE connections, add this URL directly in Client"
+  }
+  ```
+
+- **Servers File** - Copies a complete MCP configuration file structure to your clipboard, with your current server configuration added as `default-server`. This can be saved directly as `mcp.json`.
+
+  **STDIO transport example:**
+
+  ```json
+  {
+    "mcpServers": {
+      "default-server": {
+        "command": "node",
+        "args": ["build/index.js", "--debug"],
+        "env": {
+          "API_KEY": "your-api-key",
+          "DEBUG": "true"
+        }
+      }
+    }
+  }
+  ```
+
+  **SSE transport example:**
+
+  ```json
+  {
+    "mcpServers": {
+      "default-server": {
+        "type": "sse",
+        "url": "http://localhost:3000/events",
+        "note": "For SSE connections, add this URL directly in Client"
+      }
+    }
+  }
+  ```
+
+These buttons appear in the Inspector UI after you've configured your server settings, making it easy to save and reuse your configurations.
+
+For SSE transport connections, the Inspector provides similar functionality for both buttons. The "Server Entry" button copies the SSE URL configuration that can be added to your existing configuration file, while the "Servers File" button creates a complete configuration file containing the SSE URL for direct use in clients.
+
+You can paste the Server Entry into your existing `mcp.json` file under your chosen server name, or use the complete Servers File payload to create a new configuration file.
+
+### 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. You can override the header name using the input field in the sidebar.
+
+### Security Considerations
+
+The MCP Inspector includes a proxy server that can run and communicate with local MCP processes. The proxy server should not be exposed to untrusted networks as it has permissions to spawn local processes and can connect to any specified MCP server.
+
+### Configuration
+
+The MCP Inspector supports the following configuration settings. To change them, click on the `Configuration` button in the MCP Inspector UI:
+
+| Setting                                 | Description                                                                                                   | Default |
+| --------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------- |
+| `MCP_SERVER_REQUEST_TIMEOUT`            | Timeout for requests to the MCP server (ms)                                                                   | 10000   |
+| `MCP_REQUEST_TIMEOUT_RESET_ON_PROGRESS` | Reset timeout on progress notifications                                                                       | true    |
+| `MCP_REQUEST_MAX_TOTAL_TIMEOUT`         | Maximum total timeout for requests sent to the MCP server (ms) (Use with progress notifications)              | 60000   |
+| `MCP_PROXY_FULL_ADDRESS`                | Set this if you are running the MCP Inspector Proxy on a non-default address. Example: http://10.1.1.22:5577  | ""      |
+| `MCP_AUTO_OPEN_ENABLED`                 | Enable automatic browser opening when inspector starts. Only as environment var, not configurable in browser. | true    |
+
+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"
+      }
+    }
+  }
+}
+```
+
+> **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.
+
+You can also set the initial `transport` type, `serverUrl`, `serverCommand`, and `serverArgs` via query params, for example:
+
+```
+http://localhost:6274/?transport=sse&serverUrl=http://localhost:8787/sse
+http://localhost:6274/?transport=streamable-http&serverUrl=http://localhost:8787/mcp
+http://localhost:6274/?transport=stdio&serverCommand=npx&serverArgs=arg1%20arg2
+```
+
+You can also set initial config settings via query params, for example:
+
+```
+http://localhost:6274/?MCP_SERVER_REQUEST_TIMEOUT=10000&MCP_REQUEST_TIMEOUT_RESET_ON_PROGRESS=false&MCP_PROXY_FULL_ADDRESS=http://10.1.1.22:5577
+```
+
+Note that if both the query param and the corresponding localStorage item are set, the query param will take precedence.
+
+### From this repository
+
+If you're working on the inspector itself:
+
+Development mode:
+
+```bash
+npm run dev
+```
+
+> **Note for Windows users:**
+> On Windows, use the following command instead:
+>
+> ```bash
+> npm run dev:windows
+> ```
+
+Production mode:
+
+```bash
+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.

package/cli/build/cli.js

@@ -0,0 +1,195 @@
+#!/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));
+function handleError(error) {
+    let message;
+    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) {
+    return new Promise((resolve) => setTimeout(resolve, ms, true));
+}
+async function runWebClient(args) {
+    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 = process.env.CLIENT_PORT ?? "6274";
+    const SERVER_PORT = process.env.SERVER_PORT ?? "6277";
+    console.log("Starting MCP inspector...");
+    const abort = new AbortController();
+    let cancelled = false;
+    process.on("SIGINT", () => {
+        cancelled = true;
+        abort.abort();
+    });
+    let server;
+    let serverOk;
+    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) {
+    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, serverName) {
+    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) {
+        if (err instanceof SyntaxError) {
+            throw new Error(`Invalid JSON in config file: ${err.message}`);
+        }
+        throw err;
+    }
+}
+function parseKeyValuePair(value, previous = {}) {
+    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]: val };
+}
+function parseArgs() {
+    const program = new Command();
+    const argSeparatorIndex = process.argv.indexOf("--");
+    let preArgs = process.argv;
+    let postArgs = [];
+    if (argSeparatorIndex !== -1) {
+        preArgs = process.argv.slice(0, argSeparatorIndex);
+        postArgs = process.argv.slice(argSeparatorIndex + 1);
+    }
+    program
+        .name("inspector-bin")
+        .allowExcessArguments()
+        .allowUnknownOption()
+        .option("-e <env>", "environment variables in KEY=VALUE format", parseKeyValuePair, {})
+        .option("--config <path>", "config file path")
+        .option("--server <n>", "server name from config file")
+        .option("--cli", "enable CLI mode");
+    // Parse only the arguments before --
+    program.parse(preArgs);
+    const options = program.opts();
+    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() {
+    process.on("uncaughtException", (error) => {
+        handleError(error);
+    });
+    try {
+        const args = parseArgs();
+        if (args.cli) {
+            runCli(args);
+        }
+        else {
+            await runWebClient(args);
+        }
+    }
+    catch (error) {
+        handleError(error);
+    }
+}
+main();

package/cli/build/client/connection.js

@@ -0,0 +1,33 @@
+export const validLogLevels = [
+    "trace",
+    "debug",
+    "info",
+    "warn",
+    "error",
+];
+export async function connect(client, transport) {
+    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) {
+    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, level) {
+    try {
+        const response = await client.setLoggingLevel(level);
+        return response;
+    }
+    catch (error) {
+        throw new Error(`Failed to set logging level: ${error instanceof Error ? error.message : String(error)}`);
+    }
+}

package/cli/build/client/index.js

@@ -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";

package/cli/build/client/prompts.js

@@ -0,0 +1,23 @@
+// List available prompts
+export async function listPrompts(client) {
+    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, name, args) {
+    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)}`);
+    }
+}

package/cli/build/client/resources.js

@@ -0,0 +1,30 @@
+// List available resources
+export async function listResources(client) {
+    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, uri) {
+    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) {
+    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)}`);
+    }
+}

package/cli/build/client/tools.js

@@ -0,0 +1,64 @@
+export async function listTools(client) {
+    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, schema) {
+    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, params) {
+    const result = {};
+    const properties = tool.inputSchema.properties || {};
+    for (const [key, value] of Object.entries(params)) {
+        const paramSchema = properties[key];
+        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, name, args) {
+    try {
+        const toolsResponse = await listTools(client);
+        const tools = toolsResponse.tools;
+        const tool = tools.find((t) => t.name === name);
+        let convertedArgs = 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)}`);
+    }
+}

package/cli/build/client/types.js

@@ -0,0 +1 @@
+export {};

package/cli/build/error-handler.js

@@ -0,0 +1,18 @@
+function formatError(error) {
+    let message;
+    if (error instanceof Error) {
+        message = error.message;
+    }
+    else if (typeof error === "string") {
+        message = error;
+    }
+    else {
+        message = "Unknown error";
+    }
+    return message;
+}
+export function handleError(error) {
+    const errorMessage = formatError(error);
+    console.error(errorMessage);
+    process.exit(1);
+}