Skip to content

Commit 9e1186f

Browse files
Document configuration in Readme and add TSDoc for the same.
1 parent 81c0ef2 commit 9e1186f

File tree

4 files changed

+22
-5
lines changed

4 files changed

+22
-5
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,14 @@ The inspector supports bearer token authentication for SSE connections. Enter yo
4646

4747
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.
4848

49+
### Configuration
50+
51+
The MCP Inspector supports the following configuration settings. To change them click on the `Configuration` button in the MCP Inspector UI :
52+
53+
| Name | Purpose | Default Value |
54+
| -------------------------- | ----------------------------------------------------------------------------------------- | ------------- |
55+
| MCP_SERVER_REQUEST_TIMEOUT | Maximum time in milliseconds to wait for a response from the MCP server before timing out | 10000 |
56+
4957
### From this repository
5058

5159
If you're working on the inspector itself:

client/src/components/Sidebar.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -294,7 +294,7 @@ const Sidebar = ({
294294
{/* Configuration */}
295295
<div className="space-y-2">
296296
<Button
297-
variant="secondary"
297+
variant="outline"
298298
onClick={() => setShowConfig(!showConfig)}
299299
className="flex items-center w-full"
300300
>

client/src/lib/configurationTypes.ts

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,18 @@
11
export type ConfigItem = {
22
description: string;
33
value: string | number | boolean;
4-
}
4+
};
55

6+
/**
7+
* Configuration interface for the MCP Inspector, including settings for the MCP Client,
8+
* Proxy Server, and Inspector UI/UX.
9+
*
10+
* Note: Configuration related to which MCP Server to use or any other MCP Server
11+
* specific settings are outside the scope of this interface as of now.
12+
*/
613
export type InspectorConfig = {
14+
/**
15+
* Maximum time in milliseconds to wait for a response from the MCP server before timing out.
16+
*/
717
MCP_SERVER_REQUEST_TIMEOUT: ConfigItem;
8-
};
18+
};

client/src/lib/constants.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
import { InspectorConfig } from "./configurationTypes";
22

3-
43
// OAuth-related session storage keys
54
export const SESSION_KEYS = {
65
CODE_VERIFIER: "mcp_code_verifier",
@@ -14,4 +13,4 @@ export const DEFAULT_INSPECTOR_CONFIG: InspectorConfig = {
1413
description: "Timeout for requests to the MCP server (ms)",
1514
value: 10000,
1615
},
17-
} as const;
16+
} as const;

0 commit comments

Comments
 (0)