Merge branch 'main' into pcarleton/auth-debugger-draft
This commit is contained in:
commit
0f4a289a4d
12 changed files with 271 additions and 89 deletions
19
README.md
19
README.md
|
|
@ -4,12 +4,31 @@ The MCP inspector is a developer tool for testing and debugging MCP servers.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
## Architecture Overview
|
||||||
|
|
||||||
|
The MCP Inspector consists of two main components that work together:
|
||||||
|
|
||||||
|
- **MCP Inspector Client (MCPI)**: A React-based web UI that provides an interactive interface for testing and debugging MCP servers
|
||||||
|
- **MCP Proxy (MCPP)**: A Node.js server that acts as a protocol bridge, connecting the web UI to MCP servers via various transport methods (stdio, SSE, streamable-http)
|
||||||
|
|
||||||
|
Note that the proxy is not a network proxy for intercepting traffic. Instead, it functions as both an MCP client (connecting to your MCP server) and an HTTP server (serving the web UI), enabling browser-based interaction with MCP servers that use different transport protocols.
|
||||||
|
|
||||||
## Running the Inspector
|
## Running the Inspector
|
||||||
|
|
||||||
### Requirements
|
### Requirements
|
||||||
|
|
||||||
- Node.js: ^22.7.5
|
- Node.js: ^22.7.5
|
||||||
|
|
||||||
|
### Quick Start (UI mode)
|
||||||
|
|
||||||
|
To get up and running right away with the UI, just execute the following:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npx @modelcontextprotocol/inspector
|
||||||
|
```
|
||||||
|
|
||||||
|
The server will start up and the UI will be accessible at `http://localhost:6274`.
|
||||||
|
|
||||||
### From an MCP server repository
|
### 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`:
|
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`:
|
||||||
|
|
|
||||||
|
|
@ -653,7 +653,7 @@ const App = () => {
|
||||||
className="w-full p-4"
|
className="w-full p-4"
|
||||||
onValueChange={(value) => (window.location.hash = value)}
|
onValueChange={(value) => (window.location.hash = value)}
|
||||||
>
|
>
|
||||||
<TabsList className="mb-4 p-0">
|
<TabsList className="mb-4 py-0">
|
||||||
<TabsTrigger
|
<TabsTrigger
|
||||||
value="resources"
|
value="resources"
|
||||||
disabled={!serverCapabilities?.resources}
|
disabled={!serverCapabilities?.resources}
|
||||||
|
|
@ -704,7 +704,7 @@ const App = () => {
|
||||||
!serverCapabilities?.tools ? (
|
!serverCapabilities?.tools ? (
|
||||||
<>
|
<>
|
||||||
<div className="flex items-center justify-center p-4">
|
<div className="flex items-center justify-center p-4">
|
||||||
<p className="text-lg text-gray-500">
|
<p className="text-lg text-gray-500 dark:text-gray-400">
|
||||||
The connected server does not support any MCP
|
The connected server does not support any MCP
|
||||||
capabilities
|
capabilities
|
||||||
</p>
|
</p>
|
||||||
|
|
@ -858,7 +858,7 @@ const App = () => {
|
||||||
</Tabs>
|
</Tabs>
|
||||||
) : (
|
) : (
|
||||||
<div className="flex flex-col items-center justify-center h-full gap-4">
|
<div className="flex flex-col items-center justify-center h-full gap-4">
|
||||||
<p className="text-lg text-gray-500">
|
<p className="text-lg text-gray-500 dark:text-gray-400">
|
||||||
Connect to an MCP server to start inspecting
|
Connect to an MCP server to start inspecting
|
||||||
</p>
|
</p>
|
||||||
<div className="flex items-center gap-2">
|
<div className="flex items-center gap-2">
|
||||||
|
|
@ -883,7 +883,7 @@ const App = () => {
|
||||||
}}
|
}}
|
||||||
>
|
>
|
||||||
<div
|
<div
|
||||||
className="absolute w-full h-4 -top-2 cursor-row-resize flex items-center justify-center hover:bg-accent/50"
|
className="absolute w-full h-4 -top-2 cursor-row-resize flex items-center justify-center hover:bg-accent/50 dark:hover:bg-input/40"
|
||||||
onMouseDown={handleDragStart}
|
onMouseDown={handleDragStart}
|
||||||
>
|
>
|
||||||
<div className="w-8 h-1 rounded-full bg-border" />
|
<div className="w-8 h-1 rounded-full bg-border" />
|
||||||
|
|
|
||||||
|
|
@ -29,7 +29,9 @@ const HistoryAndNotifications = ({
|
||||||
<div className="flex-1 overflow-y-auto p-4 border-r">
|
<div className="flex-1 overflow-y-auto p-4 border-r">
|
||||||
<h2 className="text-lg font-semibold mb-4">History</h2>
|
<h2 className="text-lg font-semibold mb-4">History</h2>
|
||||||
{requestHistory.length === 0 ? (
|
{requestHistory.length === 0 ? (
|
||||||
<p className="text-sm text-gray-500 italic">No history yet</p>
|
<p className="text-sm text-gray-500 dark:text-gray-400 italic">
|
||||||
|
No history yet
|
||||||
|
</p>
|
||||||
) : (
|
) : (
|
||||||
<ul className="space-y-3">
|
<ul className="space-y-3">
|
||||||
{requestHistory
|
{requestHistory
|
||||||
|
|
@ -38,7 +40,7 @@ const HistoryAndNotifications = ({
|
||||||
.map((request, index) => (
|
.map((request, index) => (
|
||||||
<li
|
<li
|
||||||
key={index}
|
key={index}
|
||||||
className="text-sm text-foreground bg-secondary p-2 rounded"
|
className="text-sm text-foreground bg-secondary py-2 px-3 rounded"
|
||||||
>
|
>
|
||||||
<div
|
<div
|
||||||
className="flex justify-between items-center cursor-pointer"
|
className="flex justify-between items-center cursor-pointer"
|
||||||
|
|
@ -93,7 +95,9 @@ const HistoryAndNotifications = ({
|
||||||
<div className="flex-1 overflow-y-auto p-4">
|
<div className="flex-1 overflow-y-auto p-4">
|
||||||
<h2 className="text-lg font-semibold mb-4">Server Notifications</h2>
|
<h2 className="text-lg font-semibold mb-4">Server Notifications</h2>
|
||||||
{serverNotifications.length === 0 ? (
|
{serverNotifications.length === 0 ? (
|
||||||
<p className="text-sm text-gray-500 italic">No notifications yet</p>
|
<p className="text-sm text-gray-500 dark:text-gray-400 italic">
|
||||||
|
No notifications yet
|
||||||
|
</p>
|
||||||
) : (
|
) : (
|
||||||
<ul className="space-y-3">
|
<ul className="space-y-3">
|
||||||
{serverNotifications
|
{serverNotifications
|
||||||
|
|
@ -102,7 +106,7 @@ const HistoryAndNotifications = ({
|
||||||
.map((notification, index) => (
|
.map((notification, index) => (
|
||||||
<li
|
<li
|
||||||
key={index}
|
key={index}
|
||||||
className="text-sm text-foreground bg-secondary p-2 rounded"
|
className="text-sm text-foreground bg-secondary py-2 px-3 rounded"
|
||||||
>
|
>
|
||||||
<div
|
<div
|
||||||
className="flex justify-between items-center cursor-pointer"
|
className="flex justify-between items-center cursor-pointer"
|
||||||
|
|
|
||||||
|
|
@ -21,8 +21,8 @@ const ListPane = <T extends object>({
|
||||||
buttonText,
|
buttonText,
|
||||||
isButtonDisabled,
|
isButtonDisabled,
|
||||||
}: ListPaneProps<T>) => (
|
}: ListPaneProps<T>) => (
|
||||||
<div className="bg-card rounded-lg shadow">
|
<div className="bg-card border border-border rounded-lg shadow">
|
||||||
<div className="p-4 border-b border-gray-200 dark:border-gray-800">
|
<div className="p-4 border-b border-gray-200 dark:border-border">
|
||||||
<h3 className="font-semibold dark:text-white">{title}</h3>
|
<h3 className="font-semibold dark:text-white">{title}</h3>
|
||||||
</div>
|
</div>
|
||||||
<div className="p-4">
|
<div className="p-4">
|
||||||
|
|
@ -46,7 +46,7 @@ const ListPane = <T extends object>({
|
||||||
{items.map((item, index) => (
|
{items.map((item, index) => (
|
||||||
<div
|
<div
|
||||||
key={index}
|
key={index}
|
||||||
className="flex items-center p-2 rounded hover:bg-gray-50 dark:hover:bg-gray-700 cursor-pointer"
|
className="flex items-center py-2 px-4 rounded hover:bg-gray-50 dark:hover:bg-secondary cursor-pointer"
|
||||||
onClick={() => setSelectedItem(item)}
|
onClick={() => setSelectedItem(item)}
|
||||||
>
|
>
|
||||||
{renderItem(item)}
|
{renderItem(item)}
|
||||||
|
|
|
||||||
|
|
@ -110,8 +110,8 @@ const PromptsTab = ({
|
||||||
isButtonDisabled={!nextCursor && prompts.length > 0}
|
isButtonDisabled={!nextCursor && prompts.length > 0}
|
||||||
/>
|
/>
|
||||||
|
|
||||||
<div className="bg-card rounded-lg shadow">
|
<div className="bg-card border border-border rounded-lg shadow">
|
||||||
<div className="p-4 border-b border-gray-200 dark:border-gray-800">
|
<div className="p-4 border-b border-gray-200 dark:border-border">
|
||||||
<h3 className="font-semibold">
|
<h3 className="font-semibold">
|
||||||
{selectedPrompt ? selectedPrompt.name : "Select a prompt"}
|
{selectedPrompt ? selectedPrompt.name : "Select a prompt"}
|
||||||
</h3>
|
</h3>
|
||||||
|
|
@ -126,7 +126,7 @@ const PromptsTab = ({
|
||||||
) : selectedPrompt ? (
|
) : selectedPrompt ? (
|
||||||
<div className="space-y-4">
|
<div className="space-y-4">
|
||||||
{selectedPrompt.description && (
|
{selectedPrompt.description && (
|
||||||
<p className="text-sm text-gray-600">
|
<p className="text-sm text-gray-600 dark:text-gray-400">
|
||||||
{selectedPrompt.description}
|
{selectedPrompt.description}
|
||||||
</p>
|
</p>
|
||||||
)}
|
)}
|
||||||
|
|
|
||||||
|
|
@ -173,8 +173,8 @@ const ResourcesTab = ({
|
||||||
isButtonDisabled={!nextTemplateCursor && resourceTemplates.length > 0}
|
isButtonDisabled={!nextTemplateCursor && resourceTemplates.length > 0}
|
||||||
/>
|
/>
|
||||||
|
|
||||||
<div className="bg-card rounded-lg shadow">
|
<div className="bg-card border border-border rounded-lg shadow">
|
||||||
<div className="p-4 border-b border-gray-200 dark:border-gray-800 flex justify-between items-center">
|
<div className="p-4 border-b border-gray-200 dark:border-border flex justify-between items-center">
|
||||||
<h3
|
<h3
|
||||||
className="font-semibold truncate"
|
className="font-semibold truncate"
|
||||||
title={selectedResource?.name || selectedTemplate?.name}
|
title={selectedResource?.name || selectedTemplate?.name}
|
||||||
|
|
@ -234,7 +234,7 @@ const ResourcesTab = ({
|
||||||
/>
|
/>
|
||||||
) : selectedTemplate ? (
|
) : selectedTemplate ? (
|
||||||
<div className="space-y-4">
|
<div className="space-y-4">
|
||||||
<p className="text-sm text-gray-600">
|
<p className="text-sm text-gray-600 dark:text-gray-400">
|
||||||
{selectedTemplate.description}
|
{selectedTemplate.description}
|
||||||
</p>
|
</p>
|
||||||
{selectedTemplate.uriTemplate
|
{selectedTemplate.uriTemplate
|
||||||
|
|
|
||||||
|
|
@ -215,7 +215,7 @@ const Sidebar = ({
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<div className="w-80 bg-card border-r border-border flex flex-col h-full">
|
<div className="w-80 bg-card border-r border-border flex flex-col h-full">
|
||||||
<div className="flex items-center justify-between p-4 border-b border-gray-200 dark:border-gray-800">
|
<div className="flex items-center justify-between p-4 border-b border-gray-200 dark:border-border">
|
||||||
<div className="flex items-center">
|
<div className="flex items-center">
|
||||||
<h1 className="ml-2 text-lg font-semibold">
|
<h1 className="ml-2 text-lg font-semibold">
|
||||||
MCP Inspector v{version}
|
MCP Inspector v{version}
|
||||||
|
|
@ -646,7 +646,7 @@ const Sidebar = ({
|
||||||
}
|
}
|
||||||
})()}`}
|
})()}`}
|
||||||
/>
|
/>
|
||||||
<span className="text-sm text-gray-600">
|
<span className="text-sm text-gray-600 dark:text-gray-400">
|
||||||
{(() => {
|
{(() => {
|
||||||
switch (connectionStatus) {
|
switch (connectionStatus) {
|
||||||
case "connected":
|
case "connected":
|
||||||
|
|
|
||||||
|
|
@ -77,8 +77,8 @@ const ToolsTab = ({
|
||||||
isButtonDisabled={!nextCursor && tools.length > 0}
|
isButtonDisabled={!nextCursor && tools.length > 0}
|
||||||
/>
|
/>
|
||||||
|
|
||||||
<div className="bg-card rounded-lg shadow">
|
<div className="bg-card border border-border rounded-lg shadow">
|
||||||
<div className="p-4 border-b border-gray-200 dark:border-gray-800">
|
<div className="p-4 border-b border-gray-200 dark:border-border">
|
||||||
<h3 className="font-semibold">
|
<h3 className="font-semibold">
|
||||||
{selectedTool ? selectedTool.name : "Select a tool"}
|
{selectedTool ? selectedTool.name : "Select a tool"}
|
||||||
</h3>
|
</h3>
|
||||||
|
|
@ -86,7 +86,7 @@ const ToolsTab = ({
|
||||||
<div className="p-4">
|
<div className="p-4">
|
||||||
{selectedTool ? (
|
{selectedTool ? (
|
||||||
<div className="space-y-4">
|
<div className="space-y-4">
|
||||||
<p className="text-sm text-gray-600">
|
<p className="text-sm text-gray-600 dark:text-gray-400">
|
||||||
{selectedTool.description}
|
{selectedTool.description}
|
||||||
</p>
|
</p>
|
||||||
{Object.entries(selectedTool.inputSchema.properties ?? []).map(
|
{Object.entries(selectedTool.inputSchema.properties ?? []).map(
|
||||||
|
|
@ -96,7 +96,7 @@ const ToolsTab = ({
|
||||||
<div key={key}>
|
<div key={key}>
|
||||||
<Label
|
<Label
|
||||||
htmlFor={key}
|
htmlFor={key}
|
||||||
className="block text-sm font-medium text-gray-700"
|
className="block text-sm font-medium text-gray-700 dark:text-gray-300"
|
||||||
>
|
>
|
||||||
{key}
|
{key}
|
||||||
</Label>
|
</Label>
|
||||||
|
|
|
||||||
|
|
@ -93,8 +93,8 @@ h1 {
|
||||||
--accent-foreground: 210 40% 98%;
|
--accent-foreground: 210 40% 98%;
|
||||||
--destructive: 0 62.8% 30.6%;
|
--destructive: 0 62.8% 30.6%;
|
||||||
--destructive-foreground: 210 40% 98%;
|
--destructive-foreground: 210 40% 98%;
|
||||||
--border: 217.2 32.6% 17.5%;
|
--border: 217.2 24% 24%;
|
||||||
--input: 217.2 32.6% 17.5%;
|
--input: 217.2 24% 24%;
|
||||||
--ring: 212.7 26.8% 83.9%;
|
--ring: 212.7 26.8% 83.9%;
|
||||||
--chart-1: 220 70% 50%;
|
--chart-1: 220 70% 50%;
|
||||||
--chart-2: 160 60% 45%;
|
--chart-2: 160 60% 45%;
|
||||||
|
|
|
||||||
|
|
@ -28,10 +28,18 @@ jest.mock("@modelcontextprotocol/sdk/client/index.js", () => ({
|
||||||
}));
|
}));
|
||||||
|
|
||||||
jest.mock("@modelcontextprotocol/sdk/client/sse.js", () => ({
|
jest.mock("@modelcontextprotocol/sdk/client/sse.js", () => ({
|
||||||
SSEClientTransport: jest.fn(),
|
SSEClientTransport: jest.fn((url) => ({
|
||||||
|
toString: () => url,
|
||||||
|
})),
|
||||||
SseError: jest.fn(),
|
SseError: jest.fn(),
|
||||||
}));
|
}));
|
||||||
|
|
||||||
|
jest.mock("@modelcontextprotocol/sdk/client/streamableHttp.js", () => ({
|
||||||
|
StreamableHTTPClientTransport: jest.fn((url) => ({
|
||||||
|
toString: () => url,
|
||||||
|
})),
|
||||||
|
}));
|
||||||
|
|
||||||
jest.mock("@modelcontextprotocol/sdk/client/auth.js", () => ({
|
jest.mock("@modelcontextprotocol/sdk/client/auth.js", () => ({
|
||||||
auth: jest.fn().mockResolvedValue("AUTHORIZED"),
|
auth: jest.fn().mockResolvedValue("AUTHORIZED"),
|
||||||
}));
|
}));
|
||||||
|
|
@ -163,4 +171,92 @@ describe("useConnection", () => {
|
||||||
result.current.makeRequest(mockRequest, mockSchema),
|
result.current.makeRequest(mockRequest, mockSchema),
|
||||||
).rejects.toThrow("MCP client not connected");
|
).rejects.toThrow("MCP client not connected");
|
||||||
});
|
});
|
||||||
|
|
||||||
|
describe("URL Port Handling", () => {
|
||||||
|
const SSEClientTransport = jest.requireMock(
|
||||||
|
"@modelcontextprotocol/sdk/client/sse.js",
|
||||||
|
).SSEClientTransport;
|
||||||
|
const StreamableHTTPClientTransport = jest.requireMock(
|
||||||
|
"@modelcontextprotocol/sdk/client/streamableHttp.js",
|
||||||
|
).StreamableHTTPClientTransport;
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
jest.clearAllMocks();
|
||||||
|
});
|
||||||
|
|
||||||
|
test("preserves HTTPS port number when connecting", async () => {
|
||||||
|
const props = {
|
||||||
|
...defaultProps,
|
||||||
|
sseUrl: "https://example.com:8443/api",
|
||||||
|
transportType: "sse" as const,
|
||||||
|
};
|
||||||
|
|
||||||
|
const { result } = renderHook(() => useConnection(props));
|
||||||
|
|
||||||
|
await act(async () => {
|
||||||
|
await result.current.connect();
|
||||||
|
});
|
||||||
|
|
||||||
|
const call = SSEClientTransport.mock.calls[0][0];
|
||||||
|
expect(call.toString()).toContain(
|
||||||
|
"url=https%3A%2F%2Fexample.com%3A8443%2Fapi",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("preserves HTTP port number when connecting", async () => {
|
||||||
|
const props = {
|
||||||
|
...defaultProps,
|
||||||
|
sseUrl: "http://localhost:3000/api",
|
||||||
|
transportType: "sse" as const,
|
||||||
|
};
|
||||||
|
|
||||||
|
const { result } = renderHook(() => useConnection(props));
|
||||||
|
|
||||||
|
await act(async () => {
|
||||||
|
await result.current.connect();
|
||||||
|
});
|
||||||
|
|
||||||
|
const call = SSEClientTransport.mock.calls[0][0];
|
||||||
|
expect(call.toString()).toContain(
|
||||||
|
"url=http%3A%2F%2Flocalhost%3A3000%2Fapi",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("uses default port for HTTPS when not specified", async () => {
|
||||||
|
const props = {
|
||||||
|
...defaultProps,
|
||||||
|
sseUrl: "https://example.com/api",
|
||||||
|
transportType: "sse" as const,
|
||||||
|
};
|
||||||
|
|
||||||
|
const { result } = renderHook(() => useConnection(props));
|
||||||
|
|
||||||
|
await act(async () => {
|
||||||
|
await result.current.connect();
|
||||||
|
});
|
||||||
|
|
||||||
|
const call = SSEClientTransport.mock.calls[0][0];
|
||||||
|
expect(call.toString()).toContain("url=https%3A%2F%2Fexample.com%2Fapi");
|
||||||
|
expect(call.toString()).not.toContain("%3A443");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("preserves port number in streamable-http transport", async () => {
|
||||||
|
const props = {
|
||||||
|
...defaultProps,
|
||||||
|
sseUrl: "https://example.com:8443/api",
|
||||||
|
transportType: "streamable-http" as const,
|
||||||
|
};
|
||||||
|
|
||||||
|
const { result } = renderHook(() => useConnection(props));
|
||||||
|
|
||||||
|
await act(async () => {
|
||||||
|
await result.current.connect();
|
||||||
|
});
|
||||||
|
|
||||||
|
const call = StreamableHTTPClientTransport.mock.calls[0][0];
|
||||||
|
expect(call.toString()).toContain(
|
||||||
|
"url=https%3A%2F%2Fexample.com%3A8443%2Fapi",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
});
|
});
|
||||||
|
|
|
||||||
|
|
@ -45,6 +45,7 @@ import {
|
||||||
} from "@/utils/configUtils";
|
} from "@/utils/configUtils";
|
||||||
import { getMCPServerRequestTimeout } from "@/utils/configUtils";
|
import { getMCPServerRequestTimeout } from "@/utils/configUtils";
|
||||||
import { InspectorConfig } from "../configurationTypes";
|
import { InspectorConfig } from "../configurationTypes";
|
||||||
|
import { Transport } from "@modelcontextprotocol/sdk/shared/transport.js";
|
||||||
|
|
||||||
interface UseConnectionOptions {
|
interface UseConnectionOptions {
|
||||||
transportType: "stdio" | "sse" | "streamable-http";
|
transportType: "stdio" | "sse" | "streamable-http";
|
||||||
|
|
@ -83,6 +84,9 @@ export function useConnection({
|
||||||
const [serverCapabilities, setServerCapabilities] =
|
const [serverCapabilities, setServerCapabilities] =
|
||||||
useState<ServerCapabilities | null>(null);
|
useState<ServerCapabilities | null>(null);
|
||||||
const [mcpClient, setMcpClient] = useState<Client | null>(null);
|
const [mcpClient, setMcpClient] = useState<Client | null>(null);
|
||||||
|
const [clientTransport, setClientTransport] = useState<Transport | null>(
|
||||||
|
null,
|
||||||
|
);
|
||||||
const [requestHistory, setRequestHistory] = useState<
|
const [requestHistory, setRequestHistory] = useState<
|
||||||
{ request: string; response?: string }[]
|
{ request: string; response?: string }[]
|
||||||
>([]);
|
>([]);
|
||||||
|
|
@ -304,7 +308,14 @@ export function useConnection({
|
||||||
bearerToken || (await serverAuthProvider.tokens())?.access_token;
|
bearerToken || (await serverAuthProvider.tokens())?.access_token;
|
||||||
if (token) {
|
if (token) {
|
||||||
const authHeaderName = headerName || "Authorization";
|
const authHeaderName = headerName || "Authorization";
|
||||||
headers[authHeaderName] = `Bearer ${token}`;
|
|
||||||
|
// Add custom header name as a special request header to let the server know which header to pass through
|
||||||
|
if (authHeaderName.toLowerCase() !== "authorization") {
|
||||||
|
headers[authHeaderName] = token;
|
||||||
|
headers["x-custom-auth-header"] = authHeaderName;
|
||||||
|
} else {
|
||||||
|
headers[authHeaderName] = `Bearer ${token}`;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Create appropriate transport
|
// Create appropriate transport
|
||||||
|
|
@ -377,14 +388,6 @@ export function useConnection({
|
||||||
transportType,
|
transportType,
|
||||||
);
|
);
|
||||||
|
|
||||||
const clientTransport =
|
|
||||||
transportType === "streamable-http"
|
|
||||||
? new StreamableHTTPClientTransport(mcpProxyServerUrl as URL, {
|
|
||||||
sessionId: undefined,
|
|
||||||
...transportOptions,
|
|
||||||
})
|
|
||||||
: new SSEClientTransport(mcpProxyServerUrl as URL, transportOptions);
|
|
||||||
|
|
||||||
if (onNotification) {
|
if (onNotification) {
|
||||||
[
|
[
|
||||||
CancelledNotificationSchema,
|
CancelledNotificationSchema,
|
||||||
|
|
@ -414,7 +417,20 @@ export function useConnection({
|
||||||
|
|
||||||
let capabilities;
|
let capabilities;
|
||||||
try {
|
try {
|
||||||
await client.connect(clientTransport);
|
const transport =
|
||||||
|
transportType === "streamable-http"
|
||||||
|
? new StreamableHTTPClientTransport(mcpProxyServerUrl as URL, {
|
||||||
|
sessionId: undefined,
|
||||||
|
...transportOptions,
|
||||||
|
})
|
||||||
|
: new SSEClientTransport(
|
||||||
|
mcpProxyServerUrl as URL,
|
||||||
|
transportOptions,
|
||||||
|
);
|
||||||
|
|
||||||
|
await client.connect(transport as Transport);
|
||||||
|
|
||||||
|
setClientTransport(transport);
|
||||||
|
|
||||||
capabilities = client.getServerCapabilities();
|
capabilities = client.getServerCapabilities();
|
||||||
const initializeRequest = {
|
const initializeRequest = {
|
||||||
|
|
@ -468,10 +484,15 @@ export function useConnection({
|
||||||
};
|
};
|
||||||
|
|
||||||
const disconnect = async () => {
|
const disconnect = async () => {
|
||||||
|
if (transportType === "streamable-http")
|
||||||
|
await (
|
||||||
|
clientTransport as StreamableHTTPClientTransport
|
||||||
|
).terminateSession();
|
||||||
await mcpClient?.close();
|
await mcpClient?.close();
|
||||||
const authProvider = new InspectorOAuthClientProvider(sseUrl);
|
const authProvider = new InspectorOAuthClientProvider(sseUrl);
|
||||||
authProvider.clear();
|
authProvider.clear();
|
||||||
setMcpClient(null);
|
setMcpClient(null);
|
||||||
|
setClientTransport(null);
|
||||||
setConnectionStatus("disconnected");
|
setConnectionStatus("disconnected");
|
||||||
setCompletionsSupported(false);
|
setCompletionsSupported(false);
|
||||||
setServerCapabilities(null);
|
setServerCapabilities(null);
|
||||||
|
|
|
||||||
|
|
@ -41,6 +41,44 @@ const { values } = parseArgs({
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
|
|
||||||
|
// Function to get HTTP headers.
|
||||||
|
// Supports only "sse" and "streamable-http" transport types.
|
||||||
|
const getHttpHeaders = (
|
||||||
|
req: express.Request,
|
||||||
|
transportType: string,
|
||||||
|
): HeadersInit => {
|
||||||
|
const headers: HeadersInit = {
|
||||||
|
Accept:
|
||||||
|
transportType === "sse"
|
||||||
|
? "text/event-stream"
|
||||||
|
: "text/event-stream, application/json",
|
||||||
|
};
|
||||||
|
const defaultHeaders =
|
||||||
|
transportType === "sse"
|
||||||
|
? SSE_HEADERS_PASSTHROUGH
|
||||||
|
: STREAMABLE_HTTP_HEADERS_PASSTHROUGH;
|
||||||
|
|
||||||
|
for (const key of defaultHeaders) {
|
||||||
|
if (req.headers[key] === undefined) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
const value = req.headers[key];
|
||||||
|
headers[key] = Array.isArray(value) ? value[value.length - 1] : value;
|
||||||
|
}
|
||||||
|
|
||||||
|
// If the header "x-custom-auth-header" is present, use its value as the custom header name.
|
||||||
|
if (req.headers["x-custom-auth-header"] !== undefined) {
|
||||||
|
const customHeaderName = req.headers["x-custom-auth-header"] as string;
|
||||||
|
const lowerCaseHeaderName = customHeaderName.toLowerCase();
|
||||||
|
if (req.headers[lowerCaseHeaderName] !== undefined) {
|
||||||
|
const value = req.headers[lowerCaseHeaderName];
|
||||||
|
headers[customHeaderName] = value as string;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return headers;
|
||||||
|
};
|
||||||
|
|
||||||
const app = express();
|
const app = express();
|
||||||
app.use(cors());
|
app.use(cors());
|
||||||
app.use((req, res, next) => {
|
app.use((req, res, next) => {
|
||||||
|
|
@ -48,7 +86,8 @@ app.use((req, res, next) => {
|
||||||
next();
|
next();
|
||||||
});
|
});
|
||||||
|
|
||||||
const webAppTransports: Map<string, Transport> = new Map<string, Transport>(); // Transports by sessionId
|
const webAppTransports: Map<string, Transport> = new Map<string, Transport>(); // Web app transports by web app sessionId
|
||||||
|
const serverTransports: Map<string, Transport> = new Map<string, Transport>(); // Server Transports by web app sessionId
|
||||||
|
|
||||||
const createTransport = async (req: express.Request): Promise<Transport> => {
|
const createTransport = async (req: express.Request): Promise<Transport> => {
|
||||||
const query = req.query;
|
const query = req.query;
|
||||||
|
|
@ -79,18 +118,8 @@ const createTransport = async (req: express.Request): Promise<Transport> => {
|
||||||
return transport;
|
return transport;
|
||||||
} else if (transportType === "sse") {
|
} else if (transportType === "sse") {
|
||||||
const url = query.url as string;
|
const url = query.url as string;
|
||||||
const headers: HeadersInit = {
|
|
||||||
Accept: "text/event-stream",
|
|
||||||
};
|
|
||||||
|
|
||||||
for (const key of SSE_HEADERS_PASSTHROUGH) {
|
const headers = getHttpHeaders(req, transportType);
|
||||||
if (req.headers[key] === undefined) {
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
|
|
||||||
const value = req.headers[key];
|
|
||||||
headers[key] = Array.isArray(value) ? value[value.length - 1] : value;
|
|
||||||
}
|
|
||||||
|
|
||||||
console.log(`SSE transport: url=${url}, headers=${Object.keys(headers)}`);
|
console.log(`SSE transport: url=${url}, headers=${Object.keys(headers)}`);
|
||||||
|
|
||||||
|
|
@ -107,18 +136,7 @@ const createTransport = async (req: express.Request): Promise<Transport> => {
|
||||||
console.log("Connected to SSE transport");
|
console.log("Connected to SSE transport");
|
||||||
return transport;
|
return transport;
|
||||||
} else if (transportType === "streamable-http") {
|
} else if (transportType === "streamable-http") {
|
||||||
const headers: HeadersInit = {
|
const headers = getHttpHeaders(req, transportType);
|
||||||
Accept: "text/event-stream, application/json",
|
|
||||||
};
|
|
||||||
|
|
||||||
for (const key of STREAMABLE_HTTP_HEADERS_PASSTHROUGH) {
|
|
||||||
if (req.headers[key] === undefined) {
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
|
|
||||||
const value = req.headers[key];
|
|
||||||
headers[key] = Array.isArray(value) ? value[value.length - 1] : value;
|
|
||||||
}
|
|
||||||
|
|
||||||
const transport = new StreamableHTTPClientTransport(
|
const transport = new StreamableHTTPClientTransport(
|
||||||
new URL(query.url as string),
|
new URL(query.url as string),
|
||||||
|
|
@ -137,8 +155,6 @@ const createTransport = async (req: express.Request): Promise<Transport> => {
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
let backingServerTransport: Transport | undefined;
|
|
||||||
|
|
||||||
app.get("/mcp", async (req, res) => {
|
app.get("/mcp", async (req, res) => {
|
||||||
const sessionId = req.headers["mcp-session-id"] as string;
|
const sessionId = req.headers["mcp-session-id"] as string;
|
||||||
console.log(`Received GET message for sessionId ${sessionId}`);
|
console.log(`Received GET message for sessionId ${sessionId}`);
|
||||||
|
|
@ -161,12 +177,12 @@ app.get("/mcp", async (req, res) => {
|
||||||
app.post("/mcp", async (req, res) => {
|
app.post("/mcp", async (req, res) => {
|
||||||
const sessionId = req.headers["mcp-session-id"] as string | undefined;
|
const sessionId = req.headers["mcp-session-id"] as string | undefined;
|
||||||
console.log(`Received POST message for sessionId ${sessionId}`);
|
console.log(`Received POST message for sessionId ${sessionId}`);
|
||||||
|
let serverTransport: Transport | undefined;
|
||||||
if (!sessionId) {
|
if (!sessionId) {
|
||||||
try {
|
try {
|
||||||
console.log("New streamable-http connection");
|
console.log("New streamable-http connection");
|
||||||
try {
|
try {
|
||||||
await backingServerTransport?.close();
|
serverTransport = await createTransport(req);
|
||||||
backingServerTransport = await createTransport(req);
|
|
||||||
} catch (error) {
|
} catch (error) {
|
||||||
if (error instanceof SseError && error.code === 401) {
|
if (error instanceof SseError && error.code === 401) {
|
||||||
console.error(
|
console.error(
|
||||||
|
|
@ -180,12 +196,13 @@ app.post("/mcp", async (req, res) => {
|
||||||
throw error;
|
throw error;
|
||||||
}
|
}
|
||||||
|
|
||||||
console.log("Connected MCP client to backing server transport");
|
console.log("Connected MCP client to server transport");
|
||||||
|
|
||||||
const webAppTransport = new StreamableHTTPServerTransport({
|
const webAppTransport = new StreamableHTTPServerTransport({
|
||||||
sessionIdGenerator: randomUUID,
|
sessionIdGenerator: randomUUID,
|
||||||
onsessioninitialized: (sessionId) => {
|
onsessioninitialized: (sessionId) => {
|
||||||
webAppTransports.set(sessionId, webAppTransport);
|
webAppTransports.set(sessionId, webAppTransport);
|
||||||
|
serverTransports.set(sessionId, serverTransport!);
|
||||||
console.log("Created streamable web app transport " + sessionId);
|
console.log("Created streamable web app transport " + sessionId);
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
|
|
@ -194,7 +211,7 @@ app.post("/mcp", async (req, res) => {
|
||||||
|
|
||||||
mcpProxy({
|
mcpProxy({
|
||||||
transportToClient: webAppTransport,
|
transportToClient: webAppTransport,
|
||||||
transportToServer: backingServerTransport,
|
transportToServer: serverTransport,
|
||||||
});
|
});
|
||||||
|
|
||||||
await (webAppTransport as StreamableHTTPServerTransport).handleRequest(
|
await (webAppTransport as StreamableHTTPServerTransport).handleRequest(
|
||||||
|
|
@ -226,13 +243,39 @@ app.post("/mcp", async (req, res) => {
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
|
app.delete("/mcp", async (req, res) => {
|
||||||
|
const sessionId = req.headers["mcp-session-id"] as string | undefined;
|
||||||
|
console.log(`Received DELETE message for sessionId ${sessionId}`);
|
||||||
|
let serverTransport: Transport | undefined;
|
||||||
|
if (sessionId) {
|
||||||
|
try {
|
||||||
|
serverTransport = serverTransports.get(
|
||||||
|
sessionId,
|
||||||
|
) as StreamableHTTPClientTransport;
|
||||||
|
if (!serverTransport) {
|
||||||
|
res.status(404).end("Transport not found for sessionId " + sessionId);
|
||||||
|
} else {
|
||||||
|
await (
|
||||||
|
serverTransport as StreamableHTTPClientTransport
|
||||||
|
).terminateSession();
|
||||||
|
webAppTransports.delete(sessionId);
|
||||||
|
serverTransports.delete(sessionId);
|
||||||
|
console.log(`Transports removed for sessionId ${sessionId}`);
|
||||||
|
}
|
||||||
|
res.status(200).end();
|
||||||
|
} catch (error) {
|
||||||
|
console.error("Error in /mcp route:", error);
|
||||||
|
res.status(500).json(error);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
app.get("/stdio", async (req, res) => {
|
app.get("/stdio", async (req, res) => {
|
||||||
try {
|
try {
|
||||||
console.log("New connection");
|
console.log("New connection");
|
||||||
|
let serverTransport: Transport | undefined;
|
||||||
try {
|
try {
|
||||||
await backingServerTransport?.close();
|
serverTransport = await createTransport(req);
|
||||||
backingServerTransport = await createTransport(req);
|
|
||||||
} catch (error) {
|
} catch (error) {
|
||||||
if (error instanceof SseError && error.code === 401) {
|
if (error instanceof SseError && error.code === 401) {
|
||||||
console.error(
|
console.error(
|
||||||
|
|
@ -250,26 +293,24 @@ app.get("/stdio", async (req, res) => {
|
||||||
|
|
||||||
const webAppTransport = new SSEServerTransport("/message", res);
|
const webAppTransport = new SSEServerTransport("/message", res);
|
||||||
webAppTransports.set(webAppTransport.sessionId, webAppTransport);
|
webAppTransports.set(webAppTransport.sessionId, webAppTransport);
|
||||||
|
serverTransports.set(webAppTransport.sessionId, serverTransport);
|
||||||
console.log("Created web app transport");
|
console.log("Created client/server transports");
|
||||||
|
|
||||||
await webAppTransport.start();
|
await webAppTransport.start();
|
||||||
(backingServerTransport as StdioClientTransport).stderr!.on(
|
|
||||||
"data",
|
(serverTransport as StdioClientTransport).stderr!.on("data", (chunk) => {
|
||||||
(chunk) => {
|
webAppTransport.send({
|
||||||
webAppTransport.send({
|
jsonrpc: "2.0",
|
||||||
jsonrpc: "2.0",
|
method: "notifications/stderr",
|
||||||
method: "notifications/stderr",
|
params: {
|
||||||
params: {
|
content: chunk.toString(),
|
||||||
content: chunk.toString(),
|
},
|
||||||
},
|
});
|
||||||
});
|
});
|
||||||
},
|
|
||||||
);
|
|
||||||
|
|
||||||
mcpProxy({
|
mcpProxy({
|
||||||
transportToClient: webAppTransport,
|
transportToClient: webAppTransport,
|
||||||
transportToServer: backingServerTransport,
|
transportToServer: serverTransport,
|
||||||
});
|
});
|
||||||
|
|
||||||
console.log("Set up MCP proxy");
|
console.log("Set up MCP proxy");
|
||||||
|
|
@ -284,10 +325,9 @@ app.get("/sse", async (req, res) => {
|
||||||
console.log(
|
console.log(
|
||||||
"New SSE connection. NOTE: The sse transport is deprecated and has been replaced by streamable-http",
|
"New SSE connection. NOTE: The sse transport is deprecated and has been replaced by streamable-http",
|
||||||
);
|
);
|
||||||
|
let serverTransport: Transport | undefined;
|
||||||
try {
|
try {
|
||||||
await backingServerTransport?.close();
|
serverTransport = await createTransport(req);
|
||||||
backingServerTransport = await createTransport(req);
|
|
||||||
} catch (error) {
|
} catch (error) {
|
||||||
if (error instanceof SseError && error.code === 401) {
|
if (error instanceof SseError && error.code === 401) {
|
||||||
console.error(
|
console.error(
|
||||||
|
|
@ -305,13 +345,15 @@ app.get("/sse", async (req, res) => {
|
||||||
|
|
||||||
const webAppTransport = new SSEServerTransport("/message", res);
|
const webAppTransport = new SSEServerTransport("/message", res);
|
||||||
webAppTransports.set(webAppTransport.sessionId, webAppTransport);
|
webAppTransports.set(webAppTransport.sessionId, webAppTransport);
|
||||||
console.log("Created web app transport");
|
console.log("Created client transport");
|
||||||
|
serverTransports.set(webAppTransport.sessionId, serverTransport);
|
||||||
|
console.log("Created server transport");
|
||||||
|
|
||||||
await webAppTransport.start();
|
await webAppTransport.start();
|
||||||
|
|
||||||
mcpProxy({
|
mcpProxy({
|
||||||
transportToClient: webAppTransport,
|
transportToClient: webAppTransport,
|
||||||
transportToServer: backingServerTransport,
|
transportToServer: serverTransport,
|
||||||
});
|
});
|
||||||
|
|
||||||
console.log("Set up MCP proxy");
|
console.log("Set up MCP proxy");
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue