Document configuration in Readme and add TSDoc for the same.
This commit is contained in:
@@ -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;
|
||||
};
|
||||
};
|
||||
|
||||
@@ -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;
|
||||
|
||||
Reference in New Issue
Block a user