refactor(completions): improve completion handling and error states
- Move completion logic from App.tsx to useConnection hook - Replace useCompletion with simpler useCompletionState hook - Add graceful fallback for servers without completion support - Improve error handling and state management - Update PromptsTab and ResourcesTab to use new completion API - Add type safety improvements across completion interfaces
This commit is contained in:
76
client/src/lib/hooks/useCompletionState.ts
Normal file
76
client/src/lib/hooks/useCompletionState.ts
Normal file
@@ -0,0 +1,76 @@
|
||||
import { useState, useCallback, useEffect } from "react";
|
||||
import { ResourceReference, PromptReference } from "@modelcontextprotocol/sdk/types.js";
|
||||
|
||||
interface CompletionState {
|
||||
completions: Record<string, string[]>;
|
||||
loading: Record<string, boolean>;
|
||||
error: Record<string, string | null>;
|
||||
}
|
||||
|
||||
export function useCompletionState(
|
||||
handleCompletion: (
|
||||
ref: ResourceReference | PromptReference,
|
||||
argName: string,
|
||||
value: string,
|
||||
) => Promise<string[]>,
|
||||
completionsSupported: boolean = true,
|
||||
) {
|
||||
const [state, setState] = useState<CompletionState>({
|
||||
completions: {},
|
||||
loading: {},
|
||||
error: {},
|
||||
});
|
||||
|
||||
const clearCompletions = useCallback(() => {
|
||||
setState({
|
||||
completions: {},
|
||||
loading: {},
|
||||
error: {},
|
||||
});
|
||||
}, []);
|
||||
|
||||
const requestCompletions = useCallback(
|
||||
async (ref: ResourceReference | PromptReference, argName: string, value: string) => {
|
||||
if (!completionsSupported) {
|
||||
return;
|
||||
}
|
||||
|
||||
setState((prev) => ({
|
||||
...prev,
|
||||
loading: { ...prev.loading, [argName]: true },
|
||||
error: { ...prev.error, [argName]: null },
|
||||
}));
|
||||
|
||||
try {
|
||||
const values = await handleCompletion(ref, argName, value);
|
||||
setState((prev) => ({
|
||||
...prev,
|
||||
completions: { ...prev.completions, [argName]: values },
|
||||
loading: { ...prev.loading, [argName]: false },
|
||||
}));
|
||||
} catch (err) {
|
||||
const error = err instanceof Error ? err.message : String(err);
|
||||
setState((prev) => ({
|
||||
...prev,
|
||||
loading: { ...prev.loading, [argName]: false },
|
||||
error: { ...prev.error, [argName]: error },
|
||||
}));
|
||||
}
|
||||
},
|
||||
[handleCompletion, completionsSupported],
|
||||
);
|
||||
|
||||
// Clear completions when support status changes
|
||||
useEffect(() => {
|
||||
if (!completionsSupported) {
|
||||
clearCompletions();
|
||||
}
|
||||
}, [completionsSupported, clearCompletions]);
|
||||
|
||||
return {
|
||||
...state,
|
||||
clearCompletions,
|
||||
requestCompletions,
|
||||
completionsSupported,
|
||||
};
|
||||
}
|
||||
@@ -12,6 +12,10 @@ import {
|
||||
Request,
|
||||
Result,
|
||||
ServerCapabilities,
|
||||
PromptReference,
|
||||
ResourceReference,
|
||||
McpError,
|
||||
CompleteResultSchema,
|
||||
} from "@modelcontextprotocol/sdk/types.js";
|
||||
import { useState } from "react";
|
||||
import { toast } from "react-toastify";
|
||||
@@ -36,6 +40,11 @@ interface UseConnectionOptions {
|
||||
getRoots?: () => any[];
|
||||
}
|
||||
|
||||
interface RequestOptions {
|
||||
signal?: AbortSignal;
|
||||
timeout?: number;
|
||||
}
|
||||
|
||||
export function useConnection({
|
||||
transportType,
|
||||
command,
|
||||
@@ -58,6 +67,7 @@ export function useConnection({
|
||||
const [requestHistory, setRequestHistory] = useState<
|
||||
{ request: string; response?: string }[]
|
||||
>([]);
|
||||
const [completionsSupported, setCompletionsSupported] = useState(true);
|
||||
|
||||
const pushHistory = (request: object, response?: object) => {
|
||||
setRequestHistory((prev) => [
|
||||
@@ -72,7 +82,8 @@ export function useConnection({
|
||||
const makeRequest = async <T extends z.ZodType>(
|
||||
request: ClientRequest,
|
||||
schema: T,
|
||||
) => {
|
||||
options?: RequestOptions,
|
||||
): Promise<z.output<T>> => {
|
||||
if (!mcpClient) {
|
||||
throw new Error("MCP client not connected");
|
||||
}
|
||||
@@ -81,12 +92,12 @@ export function useConnection({
|
||||
const abortController = new AbortController();
|
||||
const timeoutId = setTimeout(() => {
|
||||
abortController.abort("Request timed out");
|
||||
}, requestTimeout);
|
||||
}, options?.timeout ?? requestTimeout);
|
||||
|
||||
let response;
|
||||
try {
|
||||
response = await mcpClient.request(request, schema, {
|
||||
signal: abortController.signal,
|
||||
signal: options?.signal ?? abortController.signal,
|
||||
});
|
||||
pushHistory(request, response);
|
||||
} catch (error) {
|
||||
@@ -100,9 +111,58 @@ export function useConnection({
|
||||
|
||||
return response;
|
||||
} catch (e: unknown) {
|
||||
// Check for Method not found error specifically for completions
|
||||
if (
|
||||
request.method === "completion/complete" &&
|
||||
e instanceof McpError &&
|
||||
e.code === -32601
|
||||
) {
|
||||
setCompletionsSupported(false);
|
||||
return { completion: { values: [] } } as z.output<T>;
|
||||
}
|
||||
|
||||
const errorString = (e as Error).message ?? String(e);
|
||||
toast.error(errorString);
|
||||
throw e;
|
||||
}
|
||||
};
|
||||
|
||||
const handleCompletion = async (
|
||||
ref: ResourceReference | PromptReference,
|
||||
argName: string,
|
||||
value: string,
|
||||
signal?: AbortSignal,
|
||||
): Promise<string[]> => {
|
||||
if (!mcpClient || !completionsSupported) {
|
||||
return [];
|
||||
}
|
||||
|
||||
const request: ClientRequest = {
|
||||
method: "completion/complete",
|
||||
params: {
|
||||
argument: {
|
||||
name: argName,
|
||||
value,
|
||||
},
|
||||
ref,
|
||||
},
|
||||
};
|
||||
|
||||
try {
|
||||
const response = await makeRequest(request, CompleteResultSchema, {
|
||||
signal,
|
||||
});
|
||||
return response?.completion.values || [];
|
||||
} catch (e: unknown) {
|
||||
const errorMessage = e instanceof Error ? e.message : String(e);
|
||||
pushHistory(request, { error: errorMessage });
|
||||
|
||||
if (e instanceof McpError && e.code === -32601) {
|
||||
setCompletionsSupported(false);
|
||||
return [];
|
||||
}
|
||||
|
||||
toast.error(errorMessage);
|
||||
throw e;
|
||||
}
|
||||
};
|
||||
@@ -238,6 +298,7 @@ export function useConnection({
|
||||
|
||||
const capabilities = client.getServerCapabilities();
|
||||
setServerCapabilities(capabilities ?? null);
|
||||
setCompletionsSupported(true); // Reset completions support on new connection
|
||||
|
||||
if (onPendingRequest) {
|
||||
client.setRequestHandler(CreateMessageRequestSchema, (request) => {
|
||||
@@ -268,6 +329,8 @@ export function useConnection({
|
||||
requestHistory,
|
||||
makeRequest,
|
||||
sendNotification,
|
||||
handleCompletion,
|
||||
completionsSupported,
|
||||
connect,
|
||||
};
|
||||
}
|
||||
|
||||
@@ -1,126 +0,0 @@
|
||||
import { useState, useCallback, useRef, useEffect } from "react";
|
||||
import {
|
||||
ResourceReference,
|
||||
PromptReference,
|
||||
} from "@modelcontextprotocol/sdk/types.js";
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
function debounce<T extends (...args: any[]) => PromiseLike<void>>(
|
||||
func: T,
|
||||
wait: number,
|
||||
): (...args: Parameters<T>) => void {
|
||||
let timeout: ReturnType<typeof setTimeout>;
|
||||
return function (...args: Parameters<T>) {
|
||||
clearTimeout(timeout);
|
||||
timeout = setTimeout(() => func(...args), wait);
|
||||
};
|
||||
}
|
||||
|
||||
interface UseCompletionsOptions<T extends ResourceReference | PromptReference> {
|
||||
onComplete: (
|
||||
ref: T,
|
||||
argName: string,
|
||||
value: string,
|
||||
signal?: AbortSignal,
|
||||
) => Promise<string[]>;
|
||||
debounceMs?: number;
|
||||
}
|
||||
|
||||
interface CompletionState {
|
||||
completions: Record<string, string[]>;
|
||||
loading: Record<string, boolean>;
|
||||
error: Record<string, string | null>;
|
||||
}
|
||||
|
||||
export function useCompletions<T extends ResourceReference | PromptReference>({
|
||||
onComplete,
|
||||
debounceMs = 300,
|
||||
}: UseCompletionsOptions<T>) {
|
||||
const [state, setState] = useState<CompletionState>({
|
||||
completions: {},
|
||||
loading: {},
|
||||
error: {},
|
||||
});
|
||||
|
||||
const completeRef = useRef(onComplete);
|
||||
completeRef.current = onComplete;
|
||||
|
||||
const abortControllerRef = useRef<AbortController | null>(null);
|
||||
|
||||
const cleanup = useCallback(() => {
|
||||
if (abortControllerRef.current) {
|
||||
abortControllerRef.current.abort();
|
||||
abortControllerRef.current = null;
|
||||
}
|
||||
}, []);
|
||||
|
||||
// Cleanup on unmount
|
||||
useEffect(() => {
|
||||
return cleanup;
|
||||
}, [cleanup]);
|
||||
|
||||
const requestCompletions = useCallback(
|
||||
debounce(async (ref: T, argName: string, value: string) => {
|
||||
// Abort any pending request
|
||||
cleanup();
|
||||
|
||||
const abortController = new AbortController();
|
||||
abortControllerRef.current = abortController;
|
||||
|
||||
setState((prev) => ({
|
||||
...prev,
|
||||
loading: { ...prev.loading, [argName]: true },
|
||||
error: { ...prev.error, [argName]: null },
|
||||
}));
|
||||
|
||||
try {
|
||||
const values = await completeRef.current(
|
||||
ref,
|
||||
argName,
|
||||
value,
|
||||
abortController.signal,
|
||||
);
|
||||
|
||||
// Check if this request was aborted
|
||||
if (!abortController.signal.aborted) {
|
||||
setState((prev) => ({
|
||||
...prev,
|
||||
completions: { ...prev.completions, [argName]: values },
|
||||
loading: { ...prev.loading, [argName]: false },
|
||||
}));
|
||||
}
|
||||
} catch (err) {
|
||||
// Only update state if the request wasn't aborted
|
||||
if (!abortController.signal.aborted) {
|
||||
const error = err instanceof Error ? err.message : String(err);
|
||||
setState((prev) => ({
|
||||
...prev,
|
||||
loading: { ...prev.loading, [argName]: false },
|
||||
error: { ...prev.error, [argName]: error },
|
||||
}));
|
||||
}
|
||||
} finally {
|
||||
// Clear the abort controller if it's still the current one
|
||||
if (abortControllerRef.current === abortController) {
|
||||
abortControllerRef.current = null;
|
||||
}
|
||||
}
|
||||
}, debounceMs),
|
||||
[cleanup, debounceMs],
|
||||
);
|
||||
|
||||
const clearCompletions = useCallback(() => {
|
||||
cleanup();
|
||||
setState({
|
||||
completions: {},
|
||||
loading: {},
|
||||
error: {},
|
||||
});
|
||||
}, [cleanup]);
|
||||
|
||||
return {
|
||||
requestCompletions,
|
||||
clearCompletions,
|
||||
...state,
|
||||
};
|
||||
}
|
||||
Reference in New Issue
Block a user