feat: port CLI, TUI, and launcher from v1.5 into v2 (#1452)
Ports the CLI, TUI, and launcher from v1.5 into v2 behind a single `mcp-inspector` entrypoint (launcher → web/cli/tui). Includes the `mcp-inspector --web --dev` launcher fix (Vite alias resolution + prod-server double-start), the root `postinstall` install cascade with simplified CI, and spec/AGENTS docs (no-workspaces rationale, Development setup). Closes #1246. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
parent
53dc4549be
commit
2488ca5e38
1 changed files with 25594 additions and 236 deletions
198
clients/tui/tui.tsx
Normal file
198
clients/tui/tui.tsx
Normal file
|
|
@ -0,0 +1,198 @@
|
|||
#!/usr/bin/env node
|
||||
|
||||
import { Command } from "commander";
|
||||
import { render } from "ink";
|
||||
import {
|
||||
parseKeyValuePair,
|
||||
parseHeaderPair,
|
||||
} from "@inspector/core/mcp/node/index.js";
|
||||
import App from "./src/App.js";
|
||||
import { loadTuiServers } from "./src/tui-servers.js";
|
||||
|
||||
export async function runTui(args?: string[]): Promise<void> {
|
||||
const program = new Command();
|
||||
|
||||
program
|
||||
.name("mcp-inspector-tui")
|
||||
.description("Terminal UI for MCP Inspector")
|
||||
.option(
|
||||
"--config <path>",
|
||||
"Path to MCP servers config file (or use ad-hoc server options below)",
|
||||
)
|
||||
.option(
|
||||
"-e <key=value...>",
|
||||
"Environment variables for stdio servers",
|
||||
parseKeyValuePair,
|
||||
{},
|
||||
)
|
||||
.option("--cwd <path>", "Working directory for stdio servers")
|
||||
.option(
|
||||
"--header <header...>",
|
||||
'HTTP headers as "Name: Value"',
|
||||
parseHeaderPair,
|
||||
{},
|
||||
)
|
||||
.option(
|
||||
"--client-id <id>",
|
||||
"OAuth client ID (static client) for HTTP servers",
|
||||
)
|
||||
.option(
|
||||
"--client-secret <secret>",
|
||||
"OAuth client secret (for confidential clients)",
|
||||
)
|
||||
.option(
|
||||
"--client-metadata-url <url>",
|
||||
"OAuth Client ID Metadata Document URL (CIMD) for HTTP servers",
|
||||
)
|
||||
.option(
|
||||
"--callback-url <url>",
|
||||
"OAuth redirect/callback listener URL (default: http://127.0.0.1:0/oauth/callback)",
|
||||
)
|
||||
.argument(
|
||||
"[target...]",
|
||||
"Command and args or URL for a single ad-hoc server (when not using --config)",
|
||||
)
|
||||
.option(
|
||||
"--transport <type>",
|
||||
"Transport: stdio, sse, or http (ad-hoc only)",
|
||||
)
|
||||
.option("--server-url <url>", "Server URL (ad-hoc only)")
|
||||
.parse(args ?? process.argv);
|
||||
|
||||
const options = program.opts() as {
|
||||
config?: string;
|
||||
e?: Record<string, string>;
|
||||
cwd?: string;
|
||||
header?: Record<string, string>;
|
||||
clientId?: string;
|
||||
clientSecret?: string;
|
||||
clientMetadataUrl?: string;
|
||||
callbackUrl?: string;
|
||||
transport?: "stdio" | "sse" | "http";
|
||||
serverUrl?: string;
|
||||
};
|
||||
const targetArgs = program.args as string[];
|
||||
|
||||
const serverOptions = {
|
||||
configPath: options.config?.trim() || undefined,
|
||||
target: targetArgs.length > 0 ? targetArgs : undefined,
|
||||
cwd: options.cwd?.trim() || undefined,
|
||||
env: options.e,
|
||||
headers: options.header,
|
||||
transport: options.transport,
|
||||
serverUrl: options.serverUrl?.trim() || undefined,
|
||||
};
|
||||
|
||||
const mcpServers = loadTuiServers(serverOptions);
|
||||
|
||||
interface CallbackUrlConfig {
|
||||
hostname: string;
|
||||
port: number;
|
||||
pathname: string;
|
||||
}
|
||||
|
||||
function parseCallbackUrl(raw?: string): CallbackUrlConfig {
|
||||
if (!raw) {
|
||||
return { hostname: "127.0.0.1", port: 0, pathname: "/oauth/callback" };
|
||||
}
|
||||
let url: URL;
|
||||
try {
|
||||
url = new URL(raw);
|
||||
} catch (err) {
|
||||
throw new Error(
|
||||
`Invalid callback URL: ${(err as Error)?.message ?? String(err)}`,
|
||||
);
|
||||
}
|
||||
if (url.protocol !== "http:") {
|
||||
throw new Error("Callback URL must use http scheme");
|
||||
}
|
||||
const hostname = url.hostname;
|
||||
if (!hostname) {
|
||||
throw new Error("Callback URL must include a hostname");
|
||||
}
|
||||
const pathname = url.pathname || "/";
|
||||
let port: number;
|
||||
if (url.port === "") {
|
||||
port = 80;
|
||||
} else {
|
||||
port = Number(url.port);
|
||||
if (
|
||||
!Number.isFinite(port) ||
|
||||
!Number.isInteger(port) ||
|
||||
port < 0 ||
|
||||
port > 65535
|
||||
) {
|
||||
throw new Error("Callback URL port must be between 0 and 65535");
|
||||
}
|
||||
}
|
||||
return { hostname, port, pathname };
|
||||
}
|
||||
|
||||
const callbackUrlConfig = parseCallbackUrl(options.callbackUrl);
|
||||
|
||||
const ansiEraseSavedLines = new RegExp(
|
||||
String.fromCharCode(0x1b) + "\\[3J",
|
||||
"g",
|
||||
);
|
||||
const originalWrite = process.stdout.write.bind(process.stdout);
|
||||
process.stdout.write = function (
|
||||
chunk: string | Buffer,
|
||||
encoding?: BufferEncoding | ((err?: Error) => void),
|
||||
cb?: (err?: Error) => void,
|
||||
): boolean {
|
||||
if (typeof chunk === "string") {
|
||||
if (chunk.includes("\x1b[3J")) {
|
||||
chunk = chunk.replace(ansiEraseSavedLines, "");
|
||||
}
|
||||
} else if (Buffer.isBuffer(chunk)) {
|
||||
if (chunk.includes("\x1b[3J")) {
|
||||
let str = chunk.toString("utf8");
|
||||
str = str.replace(ansiEraseSavedLines, "");
|
||||
chunk = Buffer.from(str, "utf8");
|
||||
}
|
||||
}
|
||||
if (typeof encoding === "function") {
|
||||
return (
|
||||
originalWrite as (
|
||||
chunk: string | Buffer,
|
||||
cb?: (err?: Error) => void,
|
||||
) => boolean
|
||||
)(chunk, encoding);
|
||||
}
|
||||
return (
|
||||
originalWrite as (
|
||||
chunk: string | Buffer,
|
||||
encoding?: BufferEncoding,
|
||||
cb?: (err?: Error) => void,
|
||||
) => boolean
|
||||
)(chunk, encoding, cb);
|
||||
};
|
||||
|
||||
if (process.stdout.isTTY) {
|
||||
process.stdout.write("\x1b[?1049h");
|
||||
}
|
||||
|
||||
const instance = render(
|
||||
<App
|
||||
mcpServers={mcpServers}
|
||||
clientId={options.clientId}
|
||||
clientSecret={options.clientSecret}
|
||||
clientMetadataUrl={options.clientMetadataUrl}
|
||||
callbackUrlConfig={callbackUrlConfig}
|
||||
/>,
|
||||
);
|
||||
|
||||
try {
|
||||
await instance.waitUntilExit();
|
||||
if (process.stdout.isTTY) {
|
||||
process.stdout.write("\x1b[?1049l");
|
||||
}
|
||||
process.exit(0);
|
||||
} catch (error: unknown) {
|
||||
if (process.stdout.isTTY) {
|
||||
process.stdout.write("\x1b[?1049l");
|
||||
}
|
||||
console.error("TUI Error:", error);
|
||||
process.exit(1);
|
||||
}
|
||||
}
|
||||
Loading…
Reference in a new issue