Don't use zod to parse Assistant API responses

Author: nlarew

src/tools/assistant/listKnowledgeSources.ts

@@ -4,22 +4,21 @@ import { OperationType } from "../tool.js";
 import { AssistantToolBase } from "./assistantTool.js";
 import { LogId } from "../../common/logger.js";
 
-export const dataSourceMetadataSchema = z.object({
-    id: z.string().describe("The name of the data source"),
-    type: z.string().optional().describe("The type of the data source"),
-    versions: z
-        .array(
-            z.object({
-                label: z.string().describe("The version label of the data source"),
-                isCurrent: z.boolean().describe("Whether this version is current active version"),
-            })
-        )
-        .describe("A list of available versions for this data source"),
-});
-
-export const listDataSourcesResponseSchema = z.object({
-    dataSources: z.array(dataSourceMetadataSchema).describe("A list of data sources"),
-});
+export type ListKnowledgeSourcesResponse = {
+    dataSources: {
+        /** The name of the data source */
+        id: string;
+        /** The type of the data source */
+        type: string;
+        /** A list of available versions for this data source */
+        versions: {
+            /** The version label of the data source */
+            label: string;
+            /** Whether this version is the current/default version */
+            isCurrent: boolean;
+        }[];
+    }[];
+};
 
 export class ListKnowledgeSourcesTool extends AssistantToolBase {
     public name = "list-knowledge-sources";
@@ -49,7 +48,7 @@ export class ListKnowledgeSourcesTool extends AssistantToolBase {
                 isError: true,
             };
         }
-        const { dataSources } = listDataSourcesResponseSchema.parse(await response.json());
+        const { dataSources } = (await response.json()) as ListKnowledgeSourcesResponse;
 
         return {
             content: dataSources.map(({ id, type, versions }) => ({

src/tools/assistant/searchKnowledge.ts

@@ -20,22 +20,24 @@ export const SearchKnowledgeToolArgs = {
         ),
 };
 
-export const knowledgeChunkSchema = z
-    .object({
-        url: z.string().describe("The URL of the search result"),
-        title: z.string().describe("Title of the search result"),
-        text: z.string().describe("Chunk text"),
-        metadata: z
-            .object({
-                tags: z.array(z.string()).describe("The tags of the source"),
-            })
-            .passthrough(),
-    })
-    .passthrough();
-
-export const searchResponseSchema = z.object({
-    results: z.array(knowledgeChunkSchema).describe("A list of search results"),
-});
+export type SearchKnowledgeResponse = {
+    /** A list of search results */
+    results: {
+        /** The URL of the search result */
+        url: string;
+        /** The page title of the search result */
+        title: string;
+        /** The text of the page chunk returned from the search */
+        text: string;
+        /** Metadata for the search result */
+        metadata: {
+            /** A list of tags that describe the page */
+            tags: string[];
+            /** Additional metadata */
+            [key: string]: unknown;
+        };
+    }[];
+};
 
 export class SearchKnowledgeTool extends AssistantToolBase {
     public name = "search-knowledge";
@@ -68,7 +70,7 @@ export class SearchKnowledgeTool extends AssistantToolBase {
                 isError: true,
             };
         }
-        const { results } = searchResponseSchema.parse(await response.json());
+        const { results } = (await response.json()) as SearchKnowledgeResponse;
         return {
             content: results.map(({ text, metadata }) => ({
                 type: "text",

tests/integration/tools/assistant/listKnowledgeSources.test.ts

@@ -106,20 +106,5 @@ describeWithAssistant("list-knowledge-sources", (integration) => {
             expect(response.content[0]).toHaveProperty("text");
             expect(response.content[0]?.text).toContain("Network connection failed");
         });
-
-        it("handles malformed API response", async () => {
-            // Mock a response that doesn't match the expected schema
-            mockListSources(["invalid-response"]);
-
-            const response = (await integration
-                .mcpClient()
-                .callTool({ name: "list-knowledge-sources", arguments: {} })) as CallToolResult;
-
-            expect(response.isError).toBe(true);
-            expectDefined(response.content);
-            expect(response.content[0]).toHaveProperty("text");
-            // Should contain some indication of a parsing/validation error
-            expect(response.content[0]?.text).toMatch(/error/i);
-        });
     });
 });

tests/integration/tools/assistant/searchKnowledge.test.ts

@@ -198,20 +198,5 @@ describeWithAssistant("search-knowledge", (integration) => {
             expect(response.content[0]).toHaveProperty("text");
             expect(response.content[0]?.text).toContain("Connection timeout");
         });
-
-        it("handles malformed API response", async () => {
-            // Mock a response that doesn't match the expected schema
-            mockSearchResults(["invalid-response"]);
-
-            const response = (await integration
-                .mcpClient()
-                .callTool({ name: "search-knowledge", arguments: { query: "test query" } })) as CallToolResult;
-
-            expect(response.isError).toBe(true);
-            expectDefined(response.content);
-            expect(response.content[0]).toHaveProperty("text");
-            // Should contain some indication of a parsing/validation error
-            expect(response.content[0]?.text).toMatch(/error/i);
-        });
     });
 });