Skip to content

πŸ™Œ OpenHands: AI-Driven Development

fix(mcp): show one error toast when an MCP server change fails (#18182)

Engel Nystb6026d74d2d6
diff --git a/__tests__/hooks/mutation/use-mcp-server-mutations-error-toast.test.ts b/__tests__/hooks/mutation/use-mcp-server-mutations-error-toast.test.ts
new file mode 100644
index 0000000000..7d7dfeaa4d
--- /dev/null
+++ b/__tests__/hooks/mutation/use-mcp-server-mutations-error-toast.test.ts
@@ -0,0 +1,98 @@
+import React from "react";
+import { QueryClientProvider } from "@tanstack/react-query";
+import { renderHook, waitFor } from "@testing-library/react";
+import { AxiosError } from "axios";
+import { beforeEach, describe, expect, it, vi } from "vitest";
+import SettingsService from "#/api/settings-service/settings-service.api";
+import { useDeleteMcpServer } from "#/hooks/mutation/use-delete-mcp-server";
+import { useUpdateMcpServer } from "#/hooks/mutation/use-update-mcp-server";
+import { createAgentServerQueryClient } from "#/query-client-config";
+import type { MCPServerConfig } from "#/types/mcp-server";
+import { displayErrorToast } from "#/utils/custom-toast-handlers";
+import { retrieveAxiosErrorMessage } from "#/utils/retrieve-axios-error-message";
+
+const { toastMock } = vi.hoisted(() => ({
+ toastMock: Object.assign(vi.fn(), { success: vi.fn() }),
+}));
+vi.mock("react-hot-toast", () => ({ default: toastMock }));
+
+/** The messages of every error toast shown, in order. */
+const errorToastMessages = () =>
+ toastMock.mock.calls.map(
+ ([content]) =>
+ (content as React.ReactElement<{ message: string }>).props.message,
+ );
+
+// The app's query client, so its global mutation error toast is in play too.
+const createWrapper = () => {
+ const client = createAgentServerQueryClient();
+ return function Wrapper({ children }: { children: React.ReactNode }) {
+ return React.createElement(QueryClientProvider, { client }, children);
+ };
+};
+
+const server: MCPServerConfig = {
+ id: "qa_stale",
+ type: "stdio",
+ name: "qa_stale",
+ command: "python3",
+};
+
+/** The shape the shared TypeScript client throws for a failed request. */
+class HttpError extends Error {
+ status: number;
+
+ response: unknown;
+
+ constructor(status: number, detail: string) {
+ super(`HTTP request failed (${status}): ${JSON.stringify({ detail })}`);
+ this.name = "HttpError";
+ this.status = status;
+ this.response = { detail };
+ }
+}
+
+const notFound = () =>
+ new HttpError(404, "MCP server 'qa_stale' was not found");
+
+// Every caller of these hooks toasts or shows the failure itself, as below.
+const reportError = (error: unknown) =>
+ displayErrorToast(retrieveAxiosErrorMessage(error as AxiosError));
+
+describe("MCP server mutations on failure", () => {
+ beforeEach(() => {
+ vi.restoreAllMocks();
+ toastMock.mockClear();
+ });
+
+ it("shows one error toast when deleting a server fails", async () => {
+ vi.spyOn(SettingsService, "deleteMcpServer").mockRejectedValue(notFound());
+ const { result } = renderHook(() => useDeleteMcpServer(), {
+ wrapper: createWrapper(),
+ });
+
+ result.current.mutate(server, { onError: reportError });
+
+ await waitFor(() => expect(result.current.isError).toBe(true));
+ expect(errorToastMessages()).toEqual([
+ "MCP server 'qa_stale' was not found",
+ ]);
+ });
+
+ it("shows one error toast when updating a server fails", async () => {
+ vi.spyOn(SettingsService, "patchMcpServer").mockRejectedValue(notFound());
+ const { result } = renderHook(() => useUpdateMcpServer(), {
+ wrapper: createWrapper(),
+ });
+
+ result.current.mutate(
+ { serverId: server.id, server: { ...server, enabled: false } },
+ { onError: reportError },
+ );
+
+ await waitFor(() => expect(result.current.isError).toBe(true));
+ expect(errorToastMessages()).toEqual([
+ 'MCP server "qa_stale" no longer exists.',
+ ]);
+ });
+});
diff --git a/src/components/features/conversation/conversation-overview-mcp-panel.tsx b/src/components/features/conversation/conversation-overview-mcp-panel.tsx
index 3b26e3949f..829dcfb84e 100644
--- a/src/components/features/conversation/conversation-overview-mcp-panel.tsx
+++ b/src/components/features/conversation/conversation-overview-mcp-panel.tsx
@@ -86,7 +86,16 @@ export function ConversationOverviewMcpPanel({
);
const handleToggleEnabled = (server: MCPServerConfig, enabled: boolean) => {
- updateMcpServer({ serverId: server.id, server: { ...server, enabled } });
+ updateMcpServer(
+ { serverId: server.id, server: { ...server, enabled } },
+ {
+ onError: (error) =>
+ displayErrorToast(
+ retrieveAxiosErrorMessage(error as AxiosError) ||
+ t(I18nKey.ERROR$GENERIC),
+ ),
+ },
+ );
};
const handleConfirmDelete = () => {
diff --git a/src/hooks/mutation/use-add-mcp-server.ts b/src/hooks/mutation/use-add-mcp-server.ts
index c23550539c..2962316e9a 100644
--- a/src/hooks/mutation/use-add-mcp-server.ts
+++ b/src/hooks/mutation/use-add-mcp-server.ts
@@ -19,6 +19,8 @@ export function useAddMcpServer() {
const { data: settings } = useSettings();
return useMutation({
+ // Every caller reports a failure itself; skip the global error toast.
+ meta: { disableToast: true },
mutationFn: async (server: MCPServerConfig): Promise<void> => {
if (!settings) {
throw new Error("MCP settings are still loading. Please try again.");
diff --git a/src/hooks/mutation/use-delete-mcp-server.ts b/src/hooks/mutation/use-delete-mcp-server.ts
index 6910b70866..3c62dee839 100644
--- a/src/hooks/mutation/use-delete-mcp-server.ts
+++ b/src/hooks/mutation/use-delete-mcp-server.ts
@@ -17,6 +17,8 @@ export function useDeleteMcpServer() {
const queryClient = useQueryClient();
return useMutation({
+ // Every caller reports a failure itself; skip the global error toast.
+ meta: { disableToast: true },
mutationFn: async (target: MCPServerConfig): Promise<void> => {
await SettingsService.deleteMcpServer(target.id);
},
diff --git a/src/hooks/mutation/use-update-mcp-server.ts b/src/hooks/mutation/use-update-mcp-server.ts
index 785f92cb93..508db10ec6 100644
--- a/src/hooks/mutation/use-update-mcp-server.ts
+++ b/src/hooks/mutation/use-update-mcp-server.ts
@@ -18,6 +18,8 @@ export function useUpdateMcpServer() {
const { data: settings } = useSettings();
return useMutation({
+ // Every caller reports a failure itself; skip the global error toast.
+ meta: { disableToast: true },
mutationFn: async ({
serverId,
server,