fix(knowledge): expose create document ID output

Author: Bill Leoutsakos

apps/sim/tools/knowledge/create_document.ts

@@ -124,6 +124,7 @@ export const knowledgeCreateDocumentTool: InternalToolConfig<any, KnowledgeCreat
       // Handle multiple documents response
       const uploadCount = documentsCreated.length
       const firstDocument = documentsCreated[0]
+      const documentId = firstDocument?.documentId || firstDocument?.id || ''
 
       return {
         success: true,
@@ -132,8 +133,9 @@ export const knowledgeCreateDocumentTool: InternalToolConfig<any, KnowledgeCreat
             uploadCount > 1
               ? `Successfully created ${uploadCount} documents in knowledge base`
               : `Successfully created document in knowledge base`,
+          documentId,
           data: {
-            documentId: firstDocument?.documentId || firstDocument?.id || '',
+            documentId,
             documentName:
               uploadCount > 1 ? `${uploadCount} documents` : firstDocument?.filename || 'Unknown',
             type: 'document',

apps/sim/tools/knowledge/knowledge.test.ts

@@ -157,6 +157,72 @@ describe('Knowledge Tools', () => {
     })
   })
 
+  describe('knowledgeCreateDocumentTool', () => {
+    describe('transformResponse', () => {
+      it('exposes the created document ID at both the top level and nested data path', async () => {
+        const result = await knowledgeCreateDocumentTool.transformResponse!(
+          createMockResponse({
+            data: {
+              documentsCreated: [{ documentId: 'doc-123', filename: 'document.txt' }],
+            },
+          })
+        )
+
+        expect(result.success).toBe(true)
+        expect(result.output.documentId).toBe('doc-123')
+        expect(result.output.data.documentId).toBe('doc-123')
+      })
+
+      it('uses the legacy document ID fallback for both output paths', async () => {
+        const result = await knowledgeCreateDocumentTool.transformResponse!(
+          createMockResponse({
+            documentsCreated: [{ id: 'legacy-doc-123', filename: 'document.txt' }],
+          })
+        )
+
+        expect(result.output.documentId).toBe('legacy-doc-123')
+        expect(result.output.data.documentId).toBe('legacy-doc-123')
+      })
+
+      it.each([
+        ['missing documentsCreated', { data: {} }],
+        ['null documentsCreated', { data: { documentsCreated: null } }],
+        ['empty documentsCreated', { data: { documentsCreated: [] } }],
+        ['created document without an ID', { data: { documentsCreated: [{}] } }],
+      ])('preserves empty IDs for %s', async (_label, responseBody) => {
+        const result = await knowledgeCreateDocumentTool.transformResponse!(
+          createMockResponse(responseBody)
+        )
+
+        expect(result.success).toBe(true)
+        expect(result.output.documentId).toBe('')
+        expect(result.output.data.documentId).toBe('')
+      })
+    })
+
+    it.each([
+      ['omitted tags', {}],
+      ['an empty tag array', { documentTags: [] }],
+      ['a serialized empty tag array', { documentTags: '[]' }],
+    ])('omits tag data and tag provenance for %s', (_label, tagParams) => {
+      const params = {
+        knowledgeBaseId: 'kb-1',
+        name: 'document.txt',
+        content: 'document content',
+        ...tagParams,
+      }
+      const body = knowledgeCreateDocumentTool.operation.input(params) as {
+        documents: Array<{ documentTagsData?: string }>
+      }
+
+      expect(body.documents[0]).not.toHaveProperty('documentTagsData')
+      expect(knowledgeCreateDocumentTool.operation.secretProvenance?.request?.(params)).toEqual([
+        { key: 'document-filename:0', inputPaths: [['name']] },
+        { key: 'document-content:0', inputPaths: [['content']] },
+      ])
+    })
+  })
+
   describe('knowledgeSearchTool', () => {
     describe('transformResponse', () => {
       it('should restructure cost information for logging', async () => {

apps/sim/tools/knowledge/types.ts

@@ -132,6 +132,7 @@ export interface KnowledgeCreateDocumentResponse {
   output: {
     data: KnowledgeCreateDocumentResult
     message: string
+    documentId: string
   }
   error?: string
 }

apps/sim/tools/schema-enrichers.test.ts

@@ -131,7 +131,7 @@ describe('enrichKBTagsSchema', () => {
   it('omits the executionId outside an active run', async () => {
     mockListKnowledgeTagsAsExecutor.mockResolvedValue([])
 
-    await enrichKBTagsSchema('kb-1', {
+    const result = await enrichKBTagsSchema('kb-1', {
       userId: 'user-1',
       workspaceId: 'workspace-1',
       workflowId: 'workflow-1',
@@ -148,6 +148,7 @@ describe('enrichKBTagsSchema', () => {
         executorDelegationOrigin: EXECUTOR_ORIGIN,
       },
     })
+    expect(result).toBeNull()
   })
 
   it.each([