Document configuration in Readme and add TSDoc for the same.

This commit is contained in:
Pulkit Sharma
2025-03-29 09:40:13 +05:30
parent 81c0ef29ab
commit 9e1186f5ac
4 changed files with 22 additions and 5 deletions

View File

@@ -294,7 +294,7 @@ const Sidebar = ({
{/* Configuration */}
<div className="space-y-2">
<Button
variant="secondary"
variant="outline"
onClick={() => setShowConfig(!showConfig)}
className="flex items-center w-full"
>

View File

@@ -1,8 +1,18 @@
export type ConfigItem = {
description: string;
value: string | number | boolean;
}
};
/**
* Configuration interface for the MCP Inspector, including settings for the MCP Client,
* Proxy Server, and Inspector UI/UX.
*
* Note: Configuration related to which MCP Server to use or any other MCP Server
* specific settings are outside the scope of this interface as of now.
*/
export type InspectorConfig = {
/**
* Maximum time in milliseconds to wait for a response from the MCP server before timing out.
*/
MCP_SERVER_REQUEST_TIMEOUT: ConfigItem;
};
};

View File

@@ -1,6 +1,5 @@
import { InspectorConfig } from "./configurationTypes";
// OAuth-related session storage keys
export const SESSION_KEYS = {
CODE_VERIFIER: "mcp_code_verifier",
@@ -14,4 +13,4 @@ export const DEFAULT_INSPECTOR_CONFIG: InspectorConfig = {
description: "Timeout for requests to the MCP server (ms)",
value: 10000,
},
} as const;
} as const;