From cc6dd5b57d857251c36260bc0f3a2cd64f64d51c Mon Sep 17 00:00:00 2001 From: Justin Blumencranz <96924014+j15z@users.noreply.github.com> Date: Thu, 13 Aug 2026 10:51:08 -0700 Subject: [PATCH 01/32] feat(copilot): identify current workspace in workspace list --- .../tools/handlers/workflow/queries.test.ts | 52 ++++++++++++++++++- .../tools/handlers/workflow/queries.ts | 5 +- 2 files changed, 54 insertions(+), 3 deletions(-) diff --git a/apps/sim/lib/copilot/tools/handlers/workflow/queries.test.ts b/apps/sim/lib/copilot/tools/handlers/workflow/queries.test.ts index f8f33c8289e..801372da6f1 100644 --- a/apps/sim/lib/copilot/tools/handlers/workflow/queries.test.ts +++ b/apps/sim/lib/copilot/tools/handlers/workflow/queries.test.ts @@ -2,8 +2,9 @@ import { getErrorMessage } from '@sim/utils/errors' import { beforeEach, describe, expect, it, vi } from 'vitest' import type { ExecutionContext } from '@/lib/copilot/request/types' -const { executeWorkflowUseCaseMock } = vi.hoisted(() => ({ +const { executeWorkflowUseCaseMock, listUserWorkspacesMock } = vi.hoisted(() => ({ executeWorkflowUseCaseMock: vi.fn(), + listUserWorkspacesMock: vi.fn(), })) vi.mock('@/lib/copilot/application/execute-workflow-use-case', () => ({ @@ -12,7 +13,54 @@ vi.mock('@/lib/copilot/application/execute-workflow-use-case', () => ({ getErrorMessage(error, 'Workflow operation failed'), })) -import { executeGetBlockOutputs } from './queries' +vi.mock('@/lib/workspaces/utils', () => ({ + listUserWorkspaces: listUserWorkspacesMock, +})) + +import { + executeGetBlockOutputs, + executeListUserWorkspaces, +} from '@/lib/copilot/tools/handlers/workflow/queries' + +describe('executeListUserWorkspaces', () => { + beforeEach(() => { + vi.clearAllMocks() + }) + + it('marks the current workspace in the accessible workspace list', async () => { + listUserWorkspacesMock.mockResolvedValue([ + { workspaceId: 'workspace-1', workspaceName: 'One', role: 'owner' }, + { workspaceId: 'workspace-2', workspaceName: 'Two', role: 'read' }, + ]) + + const result = await executeListUserWorkspaces({ + userId: 'user-1', + workflowId: 'workflow-1', + workspaceId: 'workspace-2', + }) + + expect(listUserWorkspacesMock).toHaveBeenCalledWith('user-1') + expect(result).toEqual({ + success: true, + output: { + workspaces: [ + { + workspaceId: 'workspace-1', + workspaceName: 'One', + role: 'owner', + isCurrent: false, + }, + { + workspaceId: 'workspace-2', + workspaceName: 'Two', + role: 'read', + isCurrent: true, + }, + ], + }, + }) + }) +}) describe('executeGetBlockOutputs', () => { beforeEach(() => { diff --git a/apps/sim/lib/copilot/tools/handlers/workflow/queries.ts b/apps/sim/lib/copilot/tools/handlers/workflow/queries.ts index 8861dbc98d6..0291fdee8fc 100644 --- a/apps/sim/lib/copilot/tools/handlers/workflow/queries.ts +++ b/apps/sim/lib/copilot/tools/handlers/workflow/queries.ts @@ -34,7 +34,10 @@ export async function executeListUserWorkspaces( context: ExecutionContext ): Promise { try { - const workspaces = await listUserWorkspaces(context.userId) + const workspaces = (await listUserWorkspaces(context.userId)).map((workspace) => ({ + ...workspace, + isCurrent: workspace.workspaceId === context.workspaceId, + })) return { success: true, output: { workspaces } } } catch (error) { From ea295e2b9fe15c92ceb60802f4b581992632d49d Mon Sep 17 00:00:00 2001 From: Justin Blumencranz <96924014+j15z@users.noreply.github.com> Date: Thu, 23 Jul 2026 19:03:22 -0700 Subject: [PATCH 02/32] feat(copilot): replace search_documentation with path-scoped search_docs; serve openapi.json publicly - search_docs server tool: same vector search over docs_embeddings plus an optional docs/documentation/... VFS path prefix mapped onto a source_document scope (covers both .mdx and /... layouts); unscoped searches exclude academy/ and api-reference/ rows so the scope is exactly the Documentation tab - @docs chat context repointed to the new tool; display label updated - apps/docs now serves /openapi.json so the mothership can build its docs/api-reference/.json VFS views from the deployed spec - generated tool catalog/schemas regenerated from the mothership contract Companion: simstudioai/mothership feat/enhance-search-agent Co-Authored-By: Claude Fable 5 --- apps/docs/app/openapi.json/route.ts | 23 ++++ apps/sim/lib/copilot/chat/process-contents.ts | 6 +- .../tools/server/docs/search-docs.test.ts | 42 +++++++ .../copilot/tools/server/docs/search-docs.ts | 110 ++++++++++++++++++ .../tools/server/docs/search-documentation.ts | 60 ---------- apps/sim/lib/copilot/tools/server/router.ts | 4 +- apps/sim/lib/copilot/tools/tool-display.ts | 2 +- 7 files changed, 181 insertions(+), 66 deletions(-) create mode 100644 apps/docs/app/openapi.json/route.ts create mode 100644 apps/sim/lib/copilot/tools/server/docs/search-docs.test.ts create mode 100644 apps/sim/lib/copilot/tools/server/docs/search-docs.ts delete mode 100644 apps/sim/lib/copilot/tools/server/docs/search-documentation.ts diff --git a/apps/docs/app/openapi.json/route.ts b/apps/docs/app/openapi.json/route.ts new file mode 100644 index 00000000000..a7d07ae3fa8 --- /dev/null +++ b/apps/docs/app/openapi.json/route.ts @@ -0,0 +1,23 @@ +import { readFile } from 'node:fs/promises' +import { join } from 'node:path' + +export const revalidate = false + +/** + * Serves the raw OpenAPI spec (apps/docs/openapi.json) publicly so external + * consumers — notably the Mothership search agent's docs/api-reference/ VFS — + * can build per-tag views from the same spec that renders the API Reference. + */ +export async function GET() { + try { + const spec = await readFile(join(process.cwd(), 'openapi.json'), 'utf-8') + return new Response(spec, { + headers: { + 'Content-Type': 'application/json; charset=utf-8', + }, + }) + } catch (error) { + console.error('Error serving openapi.json:', error) + return new Response('OpenAPI spec unavailable', { status: 500 }) + } +} diff --git a/apps/sim/lib/copilot/chat/process-contents.ts b/apps/sim/lib/copilot/chat/process-contents.ts index 689eaed8a02..2cfc17a68c0 100644 --- a/apps/sim/lib/copilot/chat/process-contents.ts +++ b/apps/sim/lib/copilot/chat/process-contents.ts @@ -314,12 +314,12 @@ export async function processContextsServer( } if (ctx.kind === 'docs') { try { - const { searchDocumentationServerTool } = await import( - '@/lib/copilot/tools/server/docs/search-documentation' + const { searchDocsServerTool } = await import( + '@/lib/copilot/tools/server/docs/search-docs' ) const rawQuery = (userMessage || '').trim() || ctx.label || 'Sim documentation' const query = sanitizeMessageForDocs(rawQuery, contexts) - const res = await searchDocumentationServerTool.execute({ query, topK: 10 }) + const res = await searchDocsServerTool.execute({ query, topK: 10 }) const content = JSON.stringify(res?.results || []) return { type: 'docs', tag: ctx.label ? `@${ctx.label}` : '@', content } } catch (e) { diff --git a/apps/sim/lib/copilot/tools/server/docs/search-docs.test.ts b/apps/sim/lib/copilot/tools/server/docs/search-docs.test.ts new file mode 100644 index 00000000000..4d0077f5540 --- /dev/null +++ b/apps/sim/lib/copilot/tools/server/docs/search-docs.test.ts @@ -0,0 +1,42 @@ +/** + * @vitest-environment node + */ +import { describe, expect, it, vi } from 'vitest' + +vi.mock('@/lib/knowledge/embeddings', () => ({ + generateSearchEmbedding: vi.fn(), +})) + +import { docsScopeTail } from '@/lib/copilot/tools/server/docs/search-docs' + +describe('docsScopeTail', () => { + it('returns undefined for an unscoped search', () => { + expect(docsScopeTail(undefined)).toBeUndefined() + expect(docsScopeTail('')).toBeUndefined() + expect(docsScopeTail(' ')).toBeUndefined() + }) + + it('treats the bare docs/documentation prefix as unscoped', () => { + expect(docsScopeTail('docs/documentation')).toBeUndefined() + expect(docsScopeTail('docs/documentation/')).toBeUndefined() + expect(docsScopeTail('/docs/documentation/')).toBeUndefined() + }) + + it('maps directory scopes to their source_document tail', () => { + expect(docsScopeTail('docs/documentation/workflows')).toBe('workflows') + expect(docsScopeTail('/docs/documentation/workflows/')).toBe('workflows') + expect(docsScopeTail('docs/documentation/integrations/gmail')).toBe('integrations/gmail') + }) + + it('maps file scopes by stripping the mdx extension', () => { + expect(docsScopeTail('docs/documentation/agents/choosing.mdx')).toBe('agents/choosing') + expect(docsScopeTail('docs/documentation/workflows/index.mdx')).toBe('workflows') + }) + + it('rejects paths outside docs/documentation/', () => { + expect(() => docsScopeTail('docs/academy/agents')).toThrow(/must start with/) + expect(() => docsScopeTail('docs/api-reference/workflows.json')).toThrow(/must start with/) + expect(() => docsScopeTail('workflows')).toThrow(/must start with/) + expect(() => docsScopeTail('docs/documentation-extra/foo')).toThrow(/must start with/) + }) +}) diff --git a/apps/sim/lib/copilot/tools/server/docs/search-docs.ts b/apps/sim/lib/copilot/tools/server/docs/search-docs.ts new file mode 100644 index 00000000000..dcc3b6d6b67 --- /dev/null +++ b/apps/sim/lib/copilot/tools/server/docs/search-docs.ts @@ -0,0 +1,110 @@ +import { db } from '@sim/db' +import { docsEmbeddings } from '@sim/db/schema' +import { createLogger } from '@sim/logger' +import { and, eq, like, notLike, or, sql } from 'drizzle-orm' +import { SearchDocs } from '@/lib/copilot/generated/tool-catalog-v1' +import type { BaseServerTool } from '@/lib/copilot/tools/server/base-tool' +import { generateSearchEmbedding } from '@/lib/knowledge/embeddings' + +interface SearchDocsParams { + query: string + topK?: number + path?: string +} + +const DEFAULT_DOCS_SIMILARITY_THRESHOLD = 0.3 +const DEFAULT_TOP_K = 10 +const MAX_TOP_K = 25 +const DOCS_DOCUMENTATION_PREFIX = 'docs/documentation' + +/** + * Maps a docs/documentation/... VFS path onto a docs_embeddings source_document + * scope tail. VFS paths mirror docs.sim.ai URLs while source_document stores + * the en-relative mdx path, so a scope tail must cover both layouts a page can + * have on disk: `.mdx` and `/...` (including `/index.mdx`). + * Returns undefined for an unscoped search; throws when the path does not + * address docs/documentation/. + */ +export function docsScopeTail(path?: string): string | undefined { + if (!path || path.trim() === '') return undefined + const normalized = path.trim().replace(/^\.?\//, '') + if ( + normalized !== DOCS_DOCUMENTATION_PREFIX && + !normalized.startsWith(`${DOCS_DOCUMENTATION_PREFIX}/`) + ) { + throw new Error(`path must start with ${DOCS_DOCUMENTATION_PREFIX}/ (got "${path}")`) + } + const tail = normalized + .slice(DOCS_DOCUMENTATION_PREFIX.length) + .replace(/^\/+|\/+$/g, '') + .replace(/\/index\.mdx$/, '') + .replace(/\.mdx$/, '') + return tail === '' ? undefined : tail +} + +function escapeLikePattern(value: string): string { + return value.replace(/[\\%_]/g, (char) => `\\${char}`) +} + +/** + * Unscoped searches cover exactly the Documentation tab (everything under the + * docs/documentation/ VFS tree), so Academy and API-reference rows are + * excluded; a scope tail narrows to one page or directory subtree. + */ +function scopeCondition(tail?: string) { + if (!tail) { + return and( + notLike(docsEmbeddings.sourceDocument, 'academy/%'), + notLike(docsEmbeddings.sourceDocument, 'api-reference/%') + ) + } + return or( + eq(docsEmbeddings.sourceDocument, `${tail}.mdx`), + like(docsEmbeddings.sourceDocument, `${escapeLikePattern(tail)}/%`) + ) +} + +export const searchDocsServerTool: BaseServerTool = { + name: SearchDocs.id, + async execute(params: SearchDocsParams): Promise { + const logger = createLogger('SearchDocsServerTool') + const { query, path } = params + if (!query || typeof query !== 'string') throw new Error('query is required') + const topK = Math.min(Math.max(Math.trunc(params.topK ?? DEFAULT_TOP_K), 1), MAX_TOP_K) + const scopeTail = docsScopeTail(path) + + logger.info('Executing docs search', { query, topK, path: path ?? null }) + + const { embedding: queryEmbedding } = await generateSearchEmbedding(query) + if (!queryEmbedding || queryEmbedding.length === 0) { + return { results: [], query, totalResults: 0 } + } + + const results = await db + .select({ + chunkId: docsEmbeddings.chunkId, + chunkText: docsEmbeddings.chunkText, + sourceDocument: docsEmbeddings.sourceDocument, + sourceLink: docsEmbeddings.sourceLink, + headerText: docsEmbeddings.headerText, + headerLevel: docsEmbeddings.headerLevel, + similarity: sql`1 - (${docsEmbeddings.embedding} <=> ${JSON.stringify(queryEmbedding)}::vector)`, + }) + .from(docsEmbeddings) + .where(scopeCondition(scopeTail)) + .orderBy(sql`${docsEmbeddings.embedding} <=> ${JSON.stringify(queryEmbedding)}::vector`) + .limit(topK) + + const filteredResults = results.filter((r) => r.similarity >= DEFAULT_DOCS_SIMILARITY_THRESHOLD) + const documentationResults = filteredResults.map((r, idx) => ({ + id: idx + 1, + title: String(r.headerText || 'Untitled Section'), + url: String(r.sourceLink || '#'), + content: String(r.chunkText || ''), + similarity: r.similarity, + })) + + logger.info('Docs search complete', { count: documentationResults.length }) + return { results: documentationResults, query, totalResults: documentationResults.length } + }, +} diff --git a/apps/sim/lib/copilot/tools/server/docs/search-documentation.ts b/apps/sim/lib/copilot/tools/server/docs/search-documentation.ts deleted file mode 100644 index ad14c3937a6..00000000000 --- a/apps/sim/lib/copilot/tools/server/docs/search-documentation.ts +++ /dev/null @@ -1,60 +0,0 @@ -import { db } from '@sim/db' -import { docsEmbeddings } from '@sim/db/schema' -import { createLogger } from '@sim/logger' -import { sql } from 'drizzle-orm' -import { SearchDocumentation } from '@/lib/copilot/generated/tool-catalog-v1' -import type { BaseServerTool } from '@/lib/copilot/tools/server/base-tool' -import { generateSearchEmbedding } from '@/lib/knowledge/embeddings' - -interface DocsSearchParams { - query: string - topK?: number - threshold?: number -} - -const DEFAULT_DOCS_SIMILARITY_THRESHOLD = 0.3 - -export const searchDocumentationServerTool: BaseServerTool = { - name: SearchDocumentation.id, - async execute(params: DocsSearchParams): Promise { - const logger = createLogger('SearchDocumentationServerTool') - const { query, topK = 10, threshold } = params - if (!query || typeof query !== 'string') throw new Error('query is required') - - logger.info('Executing docs search', { queryLength: query.length, topK }) - - const similarityThreshold = threshold ?? DEFAULT_DOCS_SIMILARITY_THRESHOLD - - const modelQuery = query - const { embedding: queryEmbedding } = await generateSearchEmbedding(modelQuery) - if (!queryEmbedding || queryEmbedding.length === 0) { - return { results: [], query, totalResults: 0 } - } - - const results = await db - .select({ - chunkId: docsEmbeddings.chunkId, - chunkText: docsEmbeddings.chunkText, - sourceDocument: docsEmbeddings.sourceDocument, - sourceLink: docsEmbeddings.sourceLink, - headerText: docsEmbeddings.headerText, - headerLevel: docsEmbeddings.headerLevel, - similarity: sql`1 - (${docsEmbeddings.embedding} <=> ${JSON.stringify(queryEmbedding)}::vector)`, - }) - .from(docsEmbeddings) - .orderBy(sql`${docsEmbeddings.embedding} <=> ${JSON.stringify(queryEmbedding)}::vector`) - .limit(topK) - - const filteredResults = results.filter((r) => r.similarity >= similarityThreshold) - const documentationResults = filteredResults.map((r, idx) => ({ - id: idx + 1, - title: String(r.headerText || 'Untitled Section'), - url: String(r.sourceLink || '#'), - content: String(r.chunkText || ''), - similarity: r.similarity, - })) - - logger.info('Docs search complete', { count: documentationResults.length }) - return { results: documentationResults, query, totalResults: documentationResults.length } - }, -} diff --git a/apps/sim/lib/copilot/tools/server/router.ts b/apps/sim/lib/copilot/tools/server/router.ts index 7d87b432218..ab6a882b30e 100644 --- a/apps/sim/lib/copilot/tools/server/router.ts +++ b/apps/sim/lib/copilot/tools/server/router.ts @@ -24,7 +24,7 @@ import { } from '@/lib/copilot/tools/server/base-tool' import { getBlocksMetadataServerTool } from '@/lib/copilot/tools/server/blocks/get-blocks-metadata-tool' import { getTriggerBlocksServerTool } from '@/lib/copilot/tools/server/blocks/get-trigger-blocks' -import { searchDocumentationServerTool } from '@/lib/copilot/tools/server/docs/search-documentation' +import { searchDocsServerTool } from '@/lib/copilot/tools/server/docs/search-docs' import { enrichmentRunServerTool } from '@/lib/copilot/tools/server/enrichment/enrichment-run' import { createFileServerTool } from '@/lib/copilot/tools/server/files/create-file' import { downloadToWorkspaceFileServerTool } from '@/lib/copilot/tools/server/files/download-to-workspace-file' @@ -168,7 +168,7 @@ const baseServerToolRegistry: Record = { [getTriggerBlocksServerTool.name]: getTriggerBlocksServerTool, [editWorkflowServerTool.name]: editWorkflowServerTool, [queryLogsServerTool.name]: queryLogsServerTool, - [searchDocumentationServerTool.name]: searchDocumentationServerTool, + [searchDocsServerTool.name]: searchDocsServerTool, [searchOnlineServerTool.name]: searchOnlineServerTool, [setEnvironmentVariablesServerTool.name]: setEnvironmentVariablesServerTool, [getCredentialsServerTool.name]: getCredentialsServerTool, diff --git a/apps/sim/lib/copilot/tools/tool-display.ts b/apps/sim/lib/copilot/tools/tool-display.ts index f15c80c5224..91c2a00ebdc 100644 --- a/apps/sim/lib/copilot/tools/tool-display.ts +++ b/apps/sim/lib/copilot/tools/tool-display.ts @@ -503,7 +503,7 @@ const TOOL_TITLES: Record = { restore_resource: 'Restoring resource', run_block: 'Running block', scheduled_task: 'Managing scheduled task', - search_documentation: 'Searching documentation', + search_docs: 'Searching docs', search_patterns: 'Searching patterns', set_block_enabled: 'Toggling block', set_environment_variables: 'Setting environment variables', From 010f0a650ea0540c541526c97c23e56d0bd6850b Mon Sep 17 00:00:00 2001 From: Justin Blumencranz <96924014+j15z@users.noreply.github.com> Date: Thu, 23 Jul 2026 20:28:41 -0700 Subject: [PATCH 03/32] improvement(copilot): label docs corpus reads as Section/filename in tool chips read("docs/documentation/workflows/index.mdx") now renders "Read Workflows/index" instead of the leaf-only fallback ("Read Index"). Co-Authored-By: Claude Fable 5 --- .../copilot/tools/client/store-utils.test.ts | 26 ++++++++++++++++++ .../lib/copilot/tools/client/store-utils.ts | 27 +++++++++++++++++++ 2 files changed, 53 insertions(+) diff --git a/apps/sim/lib/copilot/tools/client/store-utils.test.ts b/apps/sim/lib/copilot/tools/client/store-utils.test.ts index 7a849821895..6f973c23f8e 100644 --- a/apps/sim/lib/copilot/tools/client/store-utils.test.ts +++ b/apps/sim/lib/copilot/tools/client/store-utils.test.ts @@ -49,6 +49,32 @@ describe('resolveToolDisplay', () => { ).toBe('Read RET XYZ') }) + it('formats docs corpus reads as Section/filename', () => { + expect( + resolveToolDisplay(ReadTool.id, ClientToolCallState.success, { + path: 'docs/documentation/workflows/index.mdx', + })?.text + ).toBe('Read Workflows/index') + + expect( + resolveToolDisplay(ReadTool.id, ClientToolCallState.executing, { + path: 'docs/academy/agents/block.mdx', + })?.text + ).toBe('Reading Agents/block') + + expect( + resolveToolDisplay(ReadTool.id, ClientToolCallState.success, { + path: 'docs/api-reference/workflows.json', + })?.text + ).toBe('Read Workflows') + + expect( + resolveToolDisplay(ReadTool.id, ClientToolCallState.error, { + path: 'docs/documentation/getting-started.mdx', + })?.text + ).toBe('Attempted to read Getting-started') + }) + it('decodes percent-encoded VFS path segments for display', () => { expect( resolveToolDisplay(ReadTool.id, ClientToolCallState.executing, { diff --git a/apps/sim/lib/copilot/tools/client/store-utils.ts b/apps/sim/lib/copilot/tools/client/store-utils.ts index 343c9e2712d..5ca68ff5597 100644 --- a/apps/sim/lib/copilot/tools/client/store-utils.ts +++ b/apps/sim/lib/copilot/tools/client/store-utils.ts @@ -97,6 +97,10 @@ function describeReadTarget(path: string | undefined): string | undefined { if (segments.length === 0) return undefined + if (segments[0] === 'docs') { + return describeDocsReadTarget(segments) + } + const resourceType = VFS_DIR_TO_RESOURCE[segments[0]] if (!resourceType) { return humanizeDisplayIdentifier(stripExtension(segments[segments.length - 1]), 'sentence') @@ -140,6 +144,29 @@ function describeFileReadTarget(segments: string[]): string { return lastSegment } +const DOCS_TAB_SEGMENTS = new Set(['documentation', 'academy', 'api-reference']) + +/** + * Labels a docs/ corpus read as `
/` (e.g. `Workflows/index` + * for docs/documentation/workflows/index.mdx). The tab segment is dropped and + * single-level pages show just their capitalized name (e.g. `Getting-started`, + * or `Workflows` for the api-reference tag file workflows.json). + */ +function describeDocsReadTarget(segments: string[]): string { + let rest = segments.slice(1) + if (rest.length > 0 && DOCS_TAB_SEGMENTS.has(rest[0])) { + rest = rest.slice(1) + } + if (rest.length === 0) return 'docs' + const leaf = stripExtension(rest[rest.length - 1]) + if (rest.length === 1) return capitalizeFirst(leaf) + return `${capitalizeFirst(rest[0])}/${leaf}` +} + +function capitalizeFirst(value: string): string { + return value.charAt(0).toUpperCase() + value.slice(1) +} + function getLeafResourceSegment(segments: string[]): string { const lastSegment = segments[segments.length - 1] || '' if (hasFileExtension(lastSegment) && segments.length > 1) { From c5f355e712c0564228eee26f9bb787a06fac4dba Mon Sep 17 00:00:00 2001 From: Justin Blumencranz <96924014+j15z@users.noreply.github.com> Date: Thu, 23 Jul 2026 20:51:00 -0700 Subject: [PATCH 04/32] improvement(copilot): show the query in search_docs tool chips "Searched docs" becomes 'Searched docs for ""' (toolTitle/title preferred, query fallback, truncated at 60 chars). Also adds the missing browser_list_sessions display title the catalog regen surfaced. Co-Authored-By: Claude Fable 5 --- apps/sim/lib/copilot/tools/tool-display.test.ts | 13 +++++++++++++ apps/sim/lib/copilot/tools/tool-display.ts | 6 +++++- 2 files changed, 18 insertions(+), 1 deletion(-) diff --git a/apps/sim/lib/copilot/tools/tool-display.test.ts b/apps/sim/lib/copilot/tools/tool-display.test.ts index 027ce68d915..948ffa2adcc 100644 --- a/apps/sim/lib/copilot/tools/tool-display.test.ts +++ b/apps/sim/lib/copilot/tools/tool-display.test.ts @@ -78,6 +78,19 @@ describe('getToolDisplayTitle natural-language coverage', () => { expect(getToolDisplayTitle('diff_workflows')).toBe('Comparing workflows') }) + it('includes the query in search_docs titles', () => { + expect(getToolDisplayTitle('search_docs')).toBe('Searching docs') + expect(getToolDisplayTitle('search_docs', { query: 'loop blocks iteration' })).toBe( + 'Searching docs for "loop blocks iteration"' + ) + expect( + getToolDisplayTitle('search_docs', { + query: + 'reference block outputs connection tags blockname.field pass data between blocks in a workflow', + })?.length + ).toBeLessThanOrEqual('Searching docs for ""'.length + 60 + '...'.length) + }) + it('falls back to running code for function_execute without a title', () => { expect(getToolDisplayTitle('function_execute')).toBe('Running code') expect(getToolDisplayTitle('function_execute', { title: 'Crunching numbers' })).toBe( diff --git a/apps/sim/lib/copilot/tools/tool-display.ts b/apps/sim/lib/copilot/tools/tool-display.ts index 91c2a00ebdc..58f5de96f23 100644 --- a/apps/sim/lib/copilot/tools/tool-display.ts +++ b/apps/sim/lib/copilot/tools/tool-display.ts @@ -1,4 +1,4 @@ -import { stripVersionSuffix } from '@sim/utils/string' +import { stripVersionSuffix, truncate } from '@sim/utils/string' /** * Single source of truth for copilot tool-call display titles. @@ -803,6 +803,10 @@ export function getToolDisplayTitle(name: string, args?: Record const target = firstStringArg(args, 'toolTitle', 'title') return target ? `Searching online for ${target}` : 'Searching online' } + case 'search_docs': { + const target = firstStringArg(args, 'toolTitle', 'title', 'query') + return target ? `Searching docs for "${truncate(target, 60)}"` : 'Searching docs' + } case 'grep': { const target = firstStringArg(args, 'toolTitle', 'title') return target ? `Searching for ${target}` : 'Searching' From 9aa29aa7994f429efbd0e37460009779d03814e2 Mon Sep 17 00:00:00 2001 From: Justin Blumencranz <96924014+j15z@users.noreply.github.com> Date: Fri, 24 Jul 2026 15:07:42 -0700 Subject: [PATCH 05/32] feat(copilot): build the docs vfs from a generated manifest, rescope search_docs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Replaces the mothership's runtime docs corpus (llms.txt + llms-full.txt + openapi.json behind a 15m TTL cache) with a static manifest generated from the docs source, plus live per-page fetches. ~1,000 fewer lines of hand- written code and one repo instead of two. - scripts/sync-docs-manifest.ts walks apps/docs/content/docs/en and emits lib/copilot/generated/docs-manifest.ts. Each entry is simultaneously the docs/ VFS path and the docs.sim.ai URL path, so a read is a plain fetch. Section index pages fold onto their parent (fumadocs serves /workflows, not /workflows/index); academy/ and api-reference/ are excluded — they stay unmounted and unsearchable, reachable only via scrape_page. - docs-manifest:generate / :check, with a CI step so a page added, renamed, or deleted without regenerating fails the build. Content edits don't. - lib/copilot/docs/docs-corpus.ts + tools/handlers/vfs.ts: glob matches the manifest with no network, read fetches the page live, grep takes exactly ONE page (each is a fetch, so there is no corpus-wide grep). Opt-in like uploads/ — only an explicit docs/ prefix ever matches. - search_docs now scopes to the docs/ tree instead of docs/documentation/, validates its path against the manifest (a bad path errors instead of silently returning nothing), and returns the docs/ path with every chunk so search chains into read. Unscoped searches drop rows the agent could not then read: unmounted sections, and pages gone since the last index rebuild. - @docs tagging disabled: its query was the raw user message, a poor embedding query, and the mention UI it fed was already dead code. - Reverts the apps/docs /openapi.json route, added only for the old api-reference VFS views. Companion: simstudioai/mothership feat/enhance-search-agent Co-Authored-By: Claude Opus 5 (1M context) --- .github/workflows/test-build.yml | 3 + apps/docs/app/openapi.json/route.ts | 23 -- apps/sim/lib/copilot/chat/process-contents.ts | 69 +--- apps/sim/lib/copilot/docs/docs-corpus.test.ts | 134 +++++++ apps/sim/lib/copilot/docs/docs-corpus.ts | 174 +++++++++ apps/sim/lib/copilot/docs/docs-search.test.ts | 171 ++++++++ apps/sim/lib/copilot/docs/docs-search.ts | 143 +++++++ .../lib/copilot/generated/docs-manifest.ts | 365 ++++++++++++++++++ .../copilot/tools/client/store-utils.test.ts | 18 +- .../lib/copilot/tools/client/store-utils.ts | 14 +- apps/sim/lib/copilot/tools/handlers/vfs.ts | 53 ++- .../tools/server/docs/search-docs.test.ts | 42 -- .../copilot/tools/server/docs/search-docs.ts | 106 +---- .../lib/copilot/tools/tool-display.test.ts | 13 - apps/sim/lib/copilot/tools/tool-display.ts | 6 +- package.json | 2 + scripts/sync-docs-manifest.ts | 108 ++++++ 17 files changed, 1175 insertions(+), 269 deletions(-) delete mode 100644 apps/docs/app/openapi.json/route.ts create mode 100644 apps/sim/lib/copilot/docs/docs-corpus.test.ts create mode 100644 apps/sim/lib/copilot/docs/docs-corpus.ts create mode 100644 apps/sim/lib/copilot/docs/docs-search.test.ts create mode 100644 apps/sim/lib/copilot/docs/docs-search.ts create mode 100644 apps/sim/lib/copilot/generated/docs-manifest.ts delete mode 100644 apps/sim/lib/copilot/tools/server/docs/search-docs.test.ts create mode 100644 scripts/sync-docs-manifest.ts diff --git a/.github/workflows/test-build.yml b/.github/workflows/test-build.yml index 09cdf7dbb48..d5aa22c1ac2 100644 --- a/.github/workflows/test-build.yml +++ b/.github/workflows/test-build.yml @@ -123,6 +123,9 @@ jobs: - name: Repo audits run: bun run check:audits + - name: Verify docs manifest is in sync + run: bun run docs-manifest:check + - name: Migration safety (zero-downtime) audit run: | if [ "${{ github.event_name }}" = "pull_request" ]; then diff --git a/apps/docs/app/openapi.json/route.ts b/apps/docs/app/openapi.json/route.ts deleted file mode 100644 index a7d07ae3fa8..00000000000 --- a/apps/docs/app/openapi.json/route.ts +++ /dev/null @@ -1,23 +0,0 @@ -import { readFile } from 'node:fs/promises' -import { join } from 'node:path' - -export const revalidate = false - -/** - * Serves the raw OpenAPI spec (apps/docs/openapi.json) publicly so external - * consumers — notably the Mothership search agent's docs/api-reference/ VFS — - * can build per-tag views from the same spec that renders the API Reference. - */ -export async function GET() { - try { - const spec = await readFile(join(process.cwd(), 'openapi.json'), 'utf-8') - return new Response(spec, { - headers: { - 'Content-Type': 'application/json; charset=utf-8', - }, - }) - } catch (error) { - console.error('Error serving openapi.json:', error) - return new Response('OpenAPI spec unavailable', { status: 500 }) - } -} diff --git a/apps/sim/lib/copilot/chat/process-contents.ts b/apps/sim/lib/copilot/chat/process-contents.ts index 2cfc17a68c0..54b44e7afff 100644 --- a/apps/sim/lib/copilot/chat/process-contents.ts +++ b/apps/sim/lib/copilot/chat/process-contents.ts @@ -48,7 +48,6 @@ import { listFolders } from '@/lib/workflows/utils' import { readWorkspaceFileMetadata } from '@/lib/workspace-files/application/read-workspace-file-metadata' import { parseWorkspaceFileFolderDisplayPath } from '@/lib/workspace-files/folder-display-path' import { getUserPermissionConfig } from '@/ee/access-control/utils/permission-check' -import { escapeRegExp } from '@/executor/constants' import type { BrowserTextSelection, ChatContext, TerminalTextSelection } from '@/stores/panel' type AgentContextType = @@ -122,7 +121,8 @@ function formatTerminalSelection(selection: TerminalTextSelection): string { export async function processContextsServer( contexts: ChatContext[] | undefined, userId: string, - userMessage?: string, + /** Retained for call-site compatibility; unused while @docs tagging is disabled. */ + _userMessage: string | undefined, currentWorkspaceId?: string, chatId?: string ): Promise { @@ -312,21 +312,9 @@ export async function processContextsServer( path: result.path, } } - if (ctx.kind === 'docs') { - try { - const { searchDocsServerTool } = await import( - '@/lib/copilot/tools/server/docs/search-docs' - ) - const rawQuery = (userMessage || '').trim() || ctx.label || 'Sim documentation' - const query = sanitizeMessageForDocs(rawQuery, contexts) - const res = await searchDocsServerTool.execute({ query, topK: 10 }) - const content = JSON.stringify(res?.results || []) - return { type: 'docs', tag: ctx.label ? `@${ctx.label}` : '@', content } - } catch (e) { - logger.error('Failed to process docs context', e) - return null - } - } + // `docs` contexts are intentionally inert: @docs tagging is disabled while + // the docs corpus moves to the `docs/` VFS tree. A tagged context resolves + // to nothing and is filtered out below. return null } catch (error) { logger.error('Failed processing context (server)', { ctx, error }) @@ -348,53 +336,6 @@ export async function processContextsServer( return filtered } -function sanitizeMessageForDocs(rawMessage: string, contexts: ChatContext[] | undefined): string { - if (!rawMessage) return '' - if (!Array.isArray(contexts) || contexts.length === 0) { - // No context mapping; conservatively strip all @mentions-like tokens - const stripped = rawMessage - .replace(/(^|\s)@([^\s]+)/g, ' ') - .replace(/\s{2,}/g, ' ') - .trim() - return stripped - } - - // Gather labels by kind - const blockLabels = new Set( - contexts - .filter((c) => c.kind === 'blocks') - .map((c) => c.label) - .filter((l): l is string => typeof l === 'string' && l.length > 0) - ) - const nonBlockLabels = new Set( - contexts - .filter((c) => c.kind !== 'blocks') - .map((c) => c.label) - .filter((l): l is string => typeof l === 'string' && l.length > 0) - ) - - let result = rawMessage - - // 1) Remove all non-block mentions entirely - for (const label of nonBlockLabels) { - const pattern = new RegExp(`(^|\\s)@${escapeRegExp(label)}(?!\\S)`, 'g') - result = result.replace(pattern, ' ') - } - - // 2) For block mentions, strip the '@' but keep the block name - for (const label of blockLabels) { - const pattern = new RegExp(`@${escapeRegExp(label)}(?!\\S)`, 'g') - result = result.replace(pattern, label) - } - - // 3) Remove any remaining @mentions (unknown or not in contexts) - result = result.replace(/(^|\s)@([^\s]+)/g, ' ') - - // Normalize whitespace - result = result.replace(/\s{2,}/g, ' ').trim() - return result -} - async function processSkillFromDb( skillId: string, workspaceId: string, diff --git a/apps/sim/lib/copilot/docs/docs-corpus.test.ts b/apps/sim/lib/copilot/docs/docs-corpus.test.ts new file mode 100644 index 00000000000..0142ee4f169 --- /dev/null +++ b/apps/sim/lib/copilot/docs/docs-corpus.test.ts @@ -0,0 +1,134 @@ +/** + * @vitest-environment node + */ +import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest' +import { + couldMatchDocsScope, + DocsCorpusError, + globDocs, + grepDocsPage, + isDocsPath, + readDocsPage, +} from '@/lib/copilot/docs/docs-corpus' +import { DOCS_MANIFEST } from '@/lib/copilot/generated/docs-manifest' + +const SAMPLE_PAGE = DOCS_MANIFEST.find((path) => path === 'workflows/blocks/agent.mdx') + +describe('docs corpus scoping', () => { + it('recognizes docs paths', () => { + expect(isDocsPath('docs/workflows.mdx')).toBe(true) + expect(isDocsPath('docs')).toBe(true) + expect(isDocsPath('/docs/workflows.mdx')).toBe(true) + expect(isDocsPath('workflows.mdx')).toBe(false) + expect(isDocsPath('files/report.pdf')).toBe(false) + expect(isDocsPath('docsomething/x')).toBe(false) + expect(isDocsPath(undefined)).toBe(false) + }) + + it('is opt-in: only an explicit docs/ pattern can match', () => { + expect(couldMatchDocsScope('docs/**')).toBe(true) + expect(couldMatchDocsScope('docs/workflows/**')).toBe(true) + expect(couldMatchDocsScope('**')).toBe(false) + expect(couldMatchDocsScope('**/*.mdx')).toBe(false) + expect(couldMatchDocsScope('*')).toBe(false) + expect(couldMatchDocsScope(undefined)).toBe(false) + }) +}) + +describe('globDocs', () => { + it('lists the whole corpus under docs/**', () => { + const files = globDocs('docs/**') + expect(files.length).toBeGreaterThan(DOCS_MANIFEST.length) + expect(files).toContain('docs/workflows/blocks/agent.mdx') + expect(files).toContain('docs/workflows/blocks') + }) + + it('scopes to a section', () => { + const files = globDocs('docs/integrations/*.mdx') + expect(files).toContain('docs/integrations/gmail.mdx') + expect(files.every((path) => path.startsWith('docs/integrations/'))).toBe(true) + }) + + it('excludes academy and api-reference', () => { + expect(globDocs('docs/academy/**')).toEqual([]) + expect(globDocs('docs/api-reference/**')).toEqual([]) + }) + + it('maps section index pages onto their parent URL path', () => { + expect(globDocs('docs/workflows.mdx')).toEqual(['docs/workflows.mdx']) + expect(globDocs('docs/workflows/index.mdx')).toEqual([]) + }) +}) + +describe('readDocsPage', () => { + const fetchMock = vi.fn() + + beforeEach(() => { + fetchMock.mockReset() + vi.stubGlobal('fetch', fetchMock) + }) + + afterEach(() => { + vi.unstubAllGlobals() + }) + + it('fetches the manifest path verbatim from the docs site', async () => { + expect(SAMPLE_PAGE).toBeDefined() + fetchMock.mockResolvedValue({ ok: true, status: 200, text: async () => '# Agent\n\nbody' }) + + const page = await readDocsPage(`docs/${SAMPLE_PAGE}`) + + expect(fetchMock).toHaveBeenCalledOnce() + expect(fetchMock.mock.calls[0][0]).toBe(`https://docs.sim.ai/${SAMPLE_PAGE}`) + expect(page).toEqual({ content: '# Agent\n\nbody', totalLines: 3 }) + }) + + it('rejects an unknown page without fetching', async () => { + await expect(readDocsPage('docs/not-a-real-page.mdx')).rejects.toThrow(DocsCorpusError) + expect(fetchMock).not.toHaveBeenCalled() + }) + + it('points a directory read at glob', async () => { + await expect(readDocsPage('docs/workflows/blocks')).rejects.toThrow(/is a directory/) + expect(fetchMock).not.toHaveBeenCalled() + }) + + it('surfaces a docs-site failure as a retryable error', async () => { + fetchMock.mockResolvedValue({ ok: false, status: 502, text: async () => '' }) + await expect(readDocsPage(`docs/${SAMPLE_PAGE}`)).rejects.toThrow(/temporarily unavailable/) + }) +}) + +describe('grepDocsPage', () => { + const fetchMock = vi.fn() + + beforeEach(() => { + fetchMock.mockReset() + vi.stubGlobal('fetch', fetchMock) + }) + + afterEach(() => { + vi.unstubAllGlobals() + }) + + it('greps exactly one page', async () => { + fetchMock.mockResolvedValue({ + ok: true, + status: 200, + text: async () => 'intro line\nsystemPrompt matters\ntail', + }) + + const matches = await grepDocsPage(`docs/${SAMPLE_PAGE}`, 'systemPrompt') + + expect(fetchMock).toHaveBeenCalledOnce() + expect(matches).toEqual([ + { path: `docs/${SAMPLE_PAGE}`, line: 2, content: 'systemPrompt matters' }, + ]) + }) + + it('refuses a multi-page scope so one grep is never hundreds of fetches', async () => { + await expect(grepDocsPage('docs/', 'cron')).rejects.toThrow(/single page/) + await expect(grepDocsPage('docs/workflows', 'cron')).rejects.toThrow(/single page/) + expect(fetchMock).not.toHaveBeenCalled() + }) +}) diff --git a/apps/sim/lib/copilot/docs/docs-corpus.ts b/apps/sim/lib/copilot/docs/docs-corpus.ts new file mode 100644 index 00000000000..5a5c3f1d7ee --- /dev/null +++ b/apps/sim/lib/copilot/docs/docs-corpus.ts @@ -0,0 +1,174 @@ +import { createLogger } from '@sim/logger' +import { toError } from '@sim/utils/errors' +import { DOCS_MANIFEST } from '@/lib/copilot/generated/docs-manifest' +import type { GrepCountEntry, GrepMatch, GrepOptions } from '@/lib/copilot/vfs/operations' +import { glob as globPaths, grep as grepFiles } from '@/lib/copilot/vfs/operations' + +const logger = createLogger('DocsCorpus') + +/** The public docs site the `docs/` tree is a lazy view of. */ +const DOCS_BASE_URL = 'https://docs.sim.ai' + +/** VFS prefix the docs corpus is mounted at. */ +const DOCS_PREFIX = 'docs/' + +const FETCH_TIMEOUT_MS = 10_000 + +/** + * Thrown for expected, user-facing docs-corpus conditions (unknown page, + * directory path, site unreachable). The VFS handlers return the message as the + * tool error instead of logging an internal failure. + */ +export class DocsCorpusError extends Error { + readonly code = 'DOCS_CORPUS' as const + constructor(message: string) { + super(message) + this.name = 'DocsCorpusError' + } +} + +/** + * Keys-only view of the corpus for glob: every manifest path under `docs/`, + * mapped to empty content. `ops.glob` matches keys and derives the virtual + * directories from them, so this never touches the network. + */ +const docsKeyView: Map = new Map( + DOCS_MANIFEST.map((path) => [`${DOCS_PREFIX}${path}`, '']) +) + +function normalize(path: string): string { + return path.trim().replace(/^\/+/, '') +} + +/** + * True when a read/grep `path` addresses the docs corpus. Deliberately not a + * `path is string` type predicate: the callers chain it ahead of the other + * namespace checks, and a predicate would narrow `path` to `never` in every + * later branch. + */ +export function isDocsPath(path: string | undefined): boolean { + if (!path) return false + const normalized = normalize(path) + return normalized === 'docs' || normalized.startsWith(DOCS_PREFIX) +} + +/** + * True when a glob `pattern` could match the docs corpus. Like `uploads/` and + * `recently-deleted/`, the corpus is opt-in: only a pattern that explicitly + * starts with `docs/` (or is exactly `docs`) sees it, so a broad `**` glob never + * drags 300+ doc pages into the result. + */ +export function couldMatchDocsScope(pattern: string | undefined): boolean { + if (!pattern) return false + const normalized = normalize(pattern) + return normalized === 'docs' || normalized.startsWith(DOCS_PREFIX) +} + +/** Manifest paths (and their virtual directories) matching an explicit `docs/` pattern. */ +export function globDocs(pattern: string): string[] { + return globPaths(docsKeyView, normalize(pattern)) +} + +/** True when `path` is a page in the docs tree. */ +export function isDocsPage(path: string): boolean { + return docsKeyView.has(normalize(path)) +} + +/** + * Map a `docs_embeddings.source_document` (the en-relative mdx file path) back to + * its `docs/` VFS path, applying the same index-page fold as the manifest + * generator. Returns null when the source has no live VFS path — an unmounted + * section (academy, api-reference) or a page deleted since the index was built. + */ +export function docsPathForSourceDocument(sourceDocument: string | null): string | null { + if (!sourceDocument) return null + const path = `${DOCS_PREFIX}${sourceDocument.replace(/^\/+/, '').replace(/\/index\.mdx$/, '.mdx')}` + return docsKeyView.has(path) ? path : null +} + +/** True when `path` is a directory in the docs tree rather than a page. */ +export function isDocsDir(path: string): boolean { + const dir = `${normalize(path).replace(/\/+$/, '')}/` + if (dir === DOCS_PREFIX) return true + for (const key of docsKeyView.keys()) { + if (key.startsWith(dir)) return true + } + return false +} + +export interface DocsPage { + content: string + totalLines: number +} + +/** + * Fetch one docs page's raw markdown from the live site. The manifest path IS + * the URL path (`docs/workflows/blocks/agent.mdx` → + * `https://docs.sim.ai/workflows/blocks/agent.mdx`, which the docs app rewrites + * to its raw-markdown route), so no mapping table is needed. Returns null when + * the page is not in the manifest or the site does not serve it. + */ +async function fetchDocsPage(path: string): Promise { + const key = normalize(path) + if (!docsKeyView.has(key)) return null + const url = `${DOCS_BASE_URL}/${key.slice(DOCS_PREFIX.length)}` + try { + const response = await fetch(url, { + signal: AbortSignal.timeout(FETCH_TIMEOUT_MS), + headers: { Accept: 'text/markdown, text/plain' }, + }) + if (!response.ok) { + logger.warn('Docs page fetch returned a non-OK status', { url, status: response.status }) + return null + } + return await response.text() + } catch (err) { + logger.warn('Docs page fetch failed', { url, error: toError(err).message }) + return null + } +} + +/** + * Read one docs page. Throws {@link DocsCorpusError} for the expected user-facing + * conditions (directory path, unknown page, site unreachable) so the handler can + * surface the message verbatim. + */ +export async function readDocsPage(path: string): Promise { + const key = normalize(path) + if (!docsKeyView.has(key)) { + if (isDocsDir(key)) { + const dir = key.replace(/\/+$/, '') + throw new DocsCorpusError(`${dir} is a directory — glob "${dir}/**" to list its pages.`) + } + throw new DocsCorpusError( + `Docs page not found: ${path}. Use glob("docs/**") to list the docs corpus.` + ) + } + const content = await fetchDocsPage(key) + if (content === null) { + throw new DocsCorpusError( + `Could not load ${key} from ${DOCS_BASE_URL} — the docs site is temporarily unavailable. Retry shortly.` + ) + } + return { content, totalLines: content.split('\n').length } +} + +/** + * Grep ONE docs page, mirroring how grep over `files/` works: each page is a + * separate fetch from the docs site, so a multi-page grep would mean hundreds of + * requests. A path that is not a single page throws. + */ +export async function grepDocsPage( + path: string, + pattern: string, + options?: GrepOptions +): Promise { + const key = normalize(path) + if (!docsKeyView.has(key)) { + throw new DocsCorpusError( + `Grep over the docs corpus must target a single page (e.g. path: "docs/workflows/blocks/agent.mdx"). "${path}" is not a docs page. Use glob("docs/**") to find the exact path, then grep that one page.` + ) + } + const page = await readDocsPage(key) + return grepFiles(new Map([[key, page.content]]), pattern, undefined, options) +} diff --git a/apps/sim/lib/copilot/docs/docs-search.test.ts b/apps/sim/lib/copilot/docs/docs-search.test.ts new file mode 100644 index 00000000000..8407f2e336f --- /dev/null +++ b/apps/sim/lib/copilot/docs/docs-search.test.ts @@ -0,0 +1,171 @@ +/** + * @vitest-environment node + */ +import { beforeEach, describe, expect, it, vi } from 'vitest' + +const { mockGenerateSearchEmbedding, capturedWhere, mockRows } = vi.hoisted(() => ({ + mockGenerateSearchEmbedding: vi.fn(), + capturedWhere: { value: undefined as unknown }, + mockRows: { value: [] as unknown[] }, +})) + +vi.mock('@/lib/knowledge/embeddings', () => ({ + generateSearchEmbedding: mockGenerateSearchEmbedding, +})) + +/** + * Override the global drizzle mock with operators that record their arguments, + * so a test can assert on the `source_document` filter the scope produced. + */ +vi.mock('drizzle-orm', () => { + const op = + (name: string) => + (...args: unknown[]) => ({ op: name, args }) + return { + and: op('and'), + or: op('or'), + eq: op('eq'), + like: op('like'), + notLike: op('notLike'), + sql: (strings: TemplateStringsArray) => ({ op: 'sql', text: strings.join('?') }), + } +}) + +vi.mock('@sim/db', () => ({ + db: { + select: () => ({ + from: () => ({ + where: (condition: unknown) => { + capturedWhere.value = condition + return { + orderBy: () => ({ limit: async () => mockRows.value }), + } + }, + }), + }), + }, +})) + +import { DocsSearchScopeError, searchDocs } from '@/lib/copilot/docs/docs-search' + +/** Render a drizzle condition to comparable SQL-ish text for assertions. */ +function whereText(): string { + return JSON.stringify(capturedWhere.value) +} + +describe('searchDocs path scoping', () => { + beforeEach(() => { + capturedWhere.value = undefined + mockRows.value = [] + mockGenerateSearchEmbedding.mockResolvedValue({ embedding: [0.1, 0.2] }) + }) + + it('excludes unmounted sections when unscoped', async () => { + await searchDocs('cron') + expect(whereText()).toContain('academy/%') + expect(whereText()).toContain('api-reference/%') + }) + + it('treats a bare docs prefix as unscoped', async () => { + await searchDocs('cron', { path: 'docs/' }) + expect(whereText()).toContain('academy/%') + }) + + it('scopes a page to both on-disk layouts', async () => { + await searchDocs('cron', { path: 'docs/workflows/blocks/agent.mdx' }) + const text = whereText() + expect(text).toContain('workflows/blocks/agent.mdx') + expect(text).toContain('workflows/blocks/agent/index.mdx') + }) + + it('maps a section overview page onto its index file', async () => { + await searchDocs('cron', { path: 'docs/workflows.mdx' }) + const text = whereText() + expect(text).toContain('workflows/index.mdx') + }) + + it('scopes a directory to its subtree', async () => { + await searchDocs('cron', { path: 'docs/workflows' }) + expect(whereText()).toContain('workflows/%') + }) + + it('rejects a path outside the docs corpus', async () => { + await expect(searchDocs('cron', { path: 'files/report.pdf' })).rejects.toThrow( + DocsSearchScopeError + ) + }) + + it('rejects a docs path that is neither a page nor a section', async () => { + await expect(searchDocs('cron', { path: 'docs/not-a-real-section' })).rejects.toThrow( + /not a page or section/ + ) + }) + + it('rejects unmounted sections that exist on the site but not in the VFS', async () => { + await expect(searchDocs('cron', { path: 'docs/academy' })).rejects.toThrow( + /not a page or section/ + ) + }) +}) + +describe('searchDocs results', () => { + beforeEach(() => { + capturedWhere.value = undefined + mockGenerateSearchEmbedding.mockResolvedValue({ embedding: [0.1, 0.2] }) + }) + + it('returns the docs/ path to read next, folding index pages', async () => { + mockRows.value = [ + { + chunkText: 'body', + sourceDocument: 'workflows/index.mdx', + sourceLink: 'https://docs.sim.ai/workflows', + headerText: 'Overview', + similarity: 0.8, + }, + ] + const results = await searchDocs('cron') + expect(results).toEqual([ + { + path: 'docs/workflows.mdx', + url: 'https://docs.sim.ai/workflows', + title: 'Overview', + content: 'body', + similarity: 0.8, + }, + ]) + }) + + it('drops chunks whose source has no live docs/ path', async () => { + mockRows.value = [ + { + chunkText: 'a', + sourceDocument: 'academy/lesson-1.mdx', + sourceLink: 'x', + headerText: 'h', + similarity: 0.9, + }, + { + chunkText: 'b', + sourceDocument: 'deleted-page.mdx', + sourceLink: 'y', + headerText: 'h', + similarity: 0.9, + }, + ] + expect(await searchDocs('cron')).toEqual([]) + }) + + it('drops chunks below the similarity threshold', async () => { + mockRows.value = [ + { + chunkText: 'a', + sourceDocument: 'agents.mdx', + sourceLink: 'x', + headerText: 'h', + similarity: 0.1, + }, + ] + expect(await searchDocs('cron')).toEqual([]) + }) +}) diff --git a/apps/sim/lib/copilot/docs/docs-search.ts b/apps/sim/lib/copilot/docs/docs-search.ts new file mode 100644 index 00000000000..0f5553a4858 --- /dev/null +++ b/apps/sim/lib/copilot/docs/docs-search.ts @@ -0,0 +1,143 @@ +import { db } from '@sim/db' +import { docsEmbeddings } from '@sim/db/schema' +import { createLogger } from '@sim/logger' +import { and, eq, like, notLike, or, sql } from 'drizzle-orm' +import { docsPathForSourceDocument, isDocsDir, isDocsPage } from '@/lib/copilot/docs/docs-corpus' +import { generateSearchEmbedding } from '@/lib/knowledge/embeddings' + +const logger = createLogger('DocsSearch') + +const SIMILARITY_THRESHOLD = 0.3 +const DEFAULT_TOP_K = 10 +const MAX_TOP_K = 25 + +export interface DocsSearchResult { + /** The `docs/` VFS path this chunk came from — pass it to `read` for the full page. */ + path: string + /** Public docs.sim.ai URL for the section, for citation. */ + url: string + title: string + content: string + similarity: number +} + +/** + * Thrown when the caller scopes a search to a `path` that is not a real page or + * section in the docs corpus. Surfaced verbatim so the model can correct itself + * rather than reading an empty result as "the docs say nothing about this". + */ +export class DocsSearchScopeError extends Error { + readonly code = 'DOCS_SEARCH_SCOPE' as const + constructor(message: string) { + super(message) + this.name = 'DocsSearchScopeError' + } +} + +/** + * Translate an optional `docs/` VFS path into a `source_document` filter. + * + * `source_document` stores the en-relative mdx file path, while VFS paths mirror + * the public URL — so a section overview is `docs/workflows.mdx` in the VFS but + * `workflows/index.mdx` (or `workflows.mdx`) on disk. A directory scope covers + * the whole subtree, including that overview page. + * + * Returns undefined for an unscoped search, which excludes `academy/` and + * `api-reference/`: both are indexed but neither is mounted in the VFS, so a hit + * there would be a chunk the agent cannot then read. + */ +function scopeCondition(path?: string) { + const normalized = (path ?? '').trim().replace(/^\/+/, '').replace(/\/+$/, '') + if (normalized === '' || normalized === 'docs') { + return and( + notLike(docsEmbeddings.sourceDocument, 'academy/%'), + notLike(docsEmbeddings.sourceDocument, 'api-reference/%') + ) + } + + if (!normalized.startsWith('docs/')) { + throw new DocsSearchScopeError( + `path must be a docs/ VFS path (got "${path}"). Use glob("docs/**") to find one, or omit path to search everything.` + ) + } + + const tail = normalized.slice('docs/'.length) + + if (isDocsPage(normalized)) { + // One page: on disk it is either `.mdx` or `/index.mdx`. + const stem = tail.replace(/\.mdx$/, '') + return or( + eq(docsEmbeddings.sourceDocument, `${stem}.mdx`), + eq(docsEmbeddings.sourceDocument, `${stem}/index.mdx`) + ) + } + + if (isDocsDir(normalized)) { + return like(docsEmbeddings.sourceDocument, `${escapeLikePattern(tail)}/%`) + } + + throw new DocsSearchScopeError( + `"${path}" is not a page or section in the docs corpus. Use glob("docs/**") to find a valid path, or omit path to search everything.` + ) +} + +function escapeLikePattern(value: string): string { + return value.replace(/[\\%_]/g, (char) => `\\${char}`) +} + +/** + * Semantic search over the indexed docs corpus (`docs_embeddings`, rebuilt by + * `scripts/process-docs.ts` on release). Every result carries the `docs/` path + * it came from so the caller can `read` the full page next. + * + * The index lags the VFS: a page added since the last index rebuild is readable + * but not searchable, and a deleted one can still return chunks. Results whose + * source no longer maps to a live `docs/` path are dropped. + */ +export async function searchDocs( + query: string, + options?: { path?: string; topK?: number } +): Promise { + if (!query || typeof query !== 'string') throw new Error('query is required') + + const topK = Math.min(Math.max(Math.trunc(options?.topK ?? DEFAULT_TOP_K), 1), MAX_TOP_K) + const where = scopeCondition(options?.path) + + logger.info('Executing docs search', { query, topK, path: options?.path ?? null }) + + const { embedding: queryEmbedding } = await generateSearchEmbedding(query) + if (!queryEmbedding || queryEmbedding.length === 0) return [] + + const rows = await db + .select({ + chunkText: docsEmbeddings.chunkText, + sourceDocument: docsEmbeddings.sourceDocument, + sourceLink: docsEmbeddings.sourceLink, + headerText: docsEmbeddings.headerText, + similarity: sql`1 - (${docsEmbeddings.embedding} <=> ${JSON.stringify(queryEmbedding)}::vector)`, + }) + .from(docsEmbeddings) + .where(where) + .orderBy(sql`${docsEmbeddings.embedding} <=> ${JSON.stringify(queryEmbedding)}::vector`) + .limit(topK) + + const results: DocsSearchResult[] = [] + for (const row of rows) { + if (row.similarity < SIMILARITY_THRESHOLD) continue + const path = docsPathForSourceDocument(row.sourceDocument) + if (!path) continue + results.push({ + path, + url: String(row.sourceLink || '#'), + title: String(row.headerText || 'Untitled Section'), + content: String(row.chunkText || ''), + similarity: row.similarity, + }) + } + + logger.info('Docs search complete', { + count: results.length, + dropped: rows.length - results.length, + }) + return results +} diff --git a/apps/sim/lib/copilot/generated/docs-manifest.ts b/apps/sim/lib/copilot/generated/docs-manifest.ts new file mode 100644 index 00000000000..720d5371947 --- /dev/null +++ b/apps/sim/lib/copilot/generated/docs-manifest.ts @@ -0,0 +1,365 @@ +// AUTO-GENERATED FILE. DO NOT EDIT. +// Generated from apps/docs/content/docs/en by scripts/sync-docs-manifest.ts +// Run: bun run docs-manifest:generate +// + +/** + * Every page in the copilot's read-only `docs/` VFS tree, as a path that is + * simultaneously the `docs/`-relative VFS path and the docs.sim.ai URL path + * (so `docs/workflows/blocks/agent.mdx` reads + * `https://docs.sim.ai/workflows/blocks/agent.mdx`). Sorted. + */ +export const DOCS_MANIFEST: readonly string[] = [ + 'agents.mdx', + 'agents/choosing.mdx', + 'agents/custom-tools.mdx', + 'agents/mcp.mdx', + 'agents/skills.mdx', + 'files.mdx', + 'files/editor.mdx', + 'files/generating.mdx', + 'files/passing-files.mdx', + 'files/using-in-workflows.mdx', + 'getting-started.mdx', + 'integrations.mdx', + 'integrations/a2a.mdx', + 'integrations/agentmail.mdx', + 'integrations/agentphone.mdx', + 'integrations/agiloft.mdx', + 'integrations/ahrefs.mdx', + 'integrations/airtable-service-account.mdx', + 'integrations/airtable.mdx', + 'integrations/airweave.mdx', + 'integrations/algolia.mdx', + 'integrations/amplitude.mdx', + 'integrations/apify.mdx', + 'integrations/apollo.mdx', + 'integrations/appconfig.mdx', + 'integrations/arxiv.mdx', + 'integrations/asana-service-account.mdx', + 'integrations/asana.mdx', + 'integrations/ashby.mdx', + 'integrations/athena.mdx', + 'integrations/atlassian-service-account.mdx', + 'integrations/attio-service-account.mdx', + 'integrations/attio.mdx', + 'integrations/azure_devops.mdx', + 'integrations/box-service-account.mdx', + 'integrations/box.mdx', + 'integrations/brandfetch.mdx', + 'integrations/brex.mdx', + 'integrations/brightdata.mdx', + 'integrations/browser_use.mdx', + 'integrations/buffer.mdx', + 'integrations/calcom-service-account.mdx', + 'integrations/calcom.mdx', + 'integrations/calendly.mdx', + 'integrations/circleback.mdx', + 'integrations/clay.mdx', + 'integrations/clerk.mdx', + 'integrations/clickhouse.mdx', + 'integrations/clickup-service-account.mdx', + 'integrations/clickup.mdx', + 'integrations/cloudflare.mdx', + 'integrations/cloudformation.mdx', + 'integrations/cloudwatch.mdx', + 'integrations/codepipeline.mdx', + 'integrations/confluence.mdx', + 'integrations/context_dev.mdx', + 'integrations/convex.mdx', + 'integrations/crowdstrike.mdx', + 'integrations/cursor.mdx', + 'integrations/dagster.mdx', + 'integrations/databricks.mdx', + 'integrations/datadog.mdx', + 'integrations/datagma.mdx', + 'integrations/daytona.mdx', + 'integrations/deployments.mdx', + 'integrations/devin.mdx', + 'integrations/discord.mdx', + 'integrations/docusign.mdx', + 'integrations/downdetector.mdx', + 'integrations/dropbox.mdx', + 'integrations/dropcontact.mdx', + 'integrations/dspy.mdx', + 'integrations/dub.mdx', + 'integrations/duckduckgo.mdx', + 'integrations/dynamodb.mdx', + 'integrations/elasticsearch.mdx', + 'integrations/elevenlabs.mdx', + 'integrations/emailbison.mdx', + 'integrations/enrich.mdx', + 'integrations/enrichment.mdx', + 'integrations/enrow.mdx', + 'integrations/evernote.mdx', + 'integrations/exa.mdx', + 'integrations/extend.mdx', + 'integrations/fathom.mdx', + 'integrations/file.mdx', + 'integrations/findymail.mdx', + 'integrations/firecrawl.mdx', + 'integrations/fireflies.mdx', + 'integrations/flint.mdx', + 'integrations/gamma.mdx', + 'integrations/github.mdx', + 'integrations/gitlab.mdx', + 'integrations/gmail.mdx', + 'integrations/gong.mdx', + 'integrations/google-service-account.mdx', + 'integrations/google_ads.mdx', + 'integrations/google_appsheet.mdx', + 'integrations/google_bigquery.mdx', + 'integrations/google_books.mdx', + 'integrations/google_calendar.mdx', + 'integrations/google_contacts.mdx', + 'integrations/google_docs.mdx', + 'integrations/google_drive.mdx', + 'integrations/google_forms.mdx', + 'integrations/google_groups.mdx', + 'integrations/google_maps.mdx', + 'integrations/google_meet.mdx', + 'integrations/google_pagespeed.mdx', + 'integrations/google_search.mdx', + 'integrations/google_sheets.mdx', + 'integrations/google_slides.mdx', + 'integrations/google_tasks.mdx', + 'integrations/google_translate.mdx', + 'integrations/google_vault.mdx', + 'integrations/grafana.mdx', + 'integrations/grain.mdx', + 'integrations/granola.mdx', + 'integrations/greenhouse.mdx', + 'integrations/greptile.mdx', + 'integrations/hex.mdx', + 'integrations/hubspot-service-account.mdx', + 'integrations/hubspot-setup.mdx', + 'integrations/hubspot.mdx', + 'integrations/huggingface.mdx', + 'integrations/hunter.mdx', + 'integrations/iam.mdx', + 'integrations/icypeas.mdx', + 'integrations/identity_center.mdx', + 'integrations/imap.mdx', + 'integrations/incidentio.mdx', + 'integrations/infisical.mdx', + 'integrations/instantly.mdx', + 'integrations/intercom.mdx', + 'integrations/jina.mdx', + 'integrations/jira.mdx', + 'integrations/jira_service_management.mdx', + 'integrations/jupyter.mdx', + 'integrations/kalshi.mdx', + 'integrations/ketch.mdx', + 'integrations/knowledge.mdx', + 'integrations/langsmith.mdx', + 'integrations/latex.mdx', + 'integrations/launchdarkly.mdx', + 'integrations/leadmagic.mdx', + 'integrations/lemlist.mdx', + 'integrations/linear-service-account.mdx', + 'integrations/linear.mdx', + 'integrations/linkedin.mdx', + 'integrations/linkup.mdx', + 'integrations/linq.mdx', + 'integrations/logs.mdx', + 'integrations/loops.mdx', + 'integrations/luma.mdx', + 'integrations/mailchimp.mdx', + 'integrations/mailgun.mdx', + 'integrations/mem0.mdx', + 'integrations/memory.mdx', + 'integrations/microsoft_ad.mdx', + 'integrations/microsoft_dataverse.mdx', + 'integrations/microsoft_excel.mdx', + 'integrations/microsoft_planner.mdx', + 'integrations/microsoft_teams.mdx', + 'integrations/millionverifier.mdx', + 'integrations/mistral_parse.mdx', + 'integrations/monday-service-account.mdx', + 'integrations/monday.mdx', + 'integrations/mongodb.mdx', + 'integrations/mysql.mdx', + 'integrations/neo4j.mdx', + 'integrations/neverbounce.mdx', + 'integrations/new_relic.mdx', + 'integrations/notion-service-account.mdx', + 'integrations/notion.mdx', + 'integrations/obsidian.mdx', + 'integrations/okta.mdx', + 'integrations/onedrive.mdx', + 'integrations/onepassword.mdx', + 'integrations/openai.mdx', + 'integrations/outlook.mdx', + 'integrations/pagerduty.mdx', + 'integrations/parallel_ai.mdx', + 'integrations/peopledatalabs.mdx', + 'integrations/perplexity.mdx', + 'integrations/persona.mdx', + 'integrations/pinecone.mdx', + 'integrations/pipedrive-service-account.mdx', + 'integrations/pipedrive.mdx', + 'integrations/polymarket.mdx', + 'integrations/postgresql.mdx', + 'integrations/posthog.mdx', + 'integrations/profound.mdx', + 'integrations/prospeo.mdx', + 'integrations/pulse.mdx', + 'integrations/qdrant.mdx', + 'integrations/quartr.mdx', + 'integrations/quiver.mdx', + 'integrations/railway.mdx', + 'integrations/rb2b.mdx', + 'integrations/rds.mdx', + 'integrations/reddit.mdx', + 'integrations/redis.mdx', + 'integrations/reducto.mdx', + 'integrations/resend.mdx', + 'integrations/revenuecat.mdx', + 'integrations/rippling.mdx', + 'integrations/rocketlane.mdx', + 'integrations/rootly.mdx', + 'integrations/s3.mdx', + 'integrations/salesforce-service-account.mdx', + 'integrations/salesforce.mdx', + 'integrations/sap_concur.mdx', + 'integrations/sap_s4hana.mdx', + 'integrations/secrets_manager.mdx', + 'integrations/sendblue.mdx', + 'integrations/sendgrid.mdx', + 'integrations/sentry.mdx', + 'integrations/serper.mdx', + 'integrations/servicenow.mdx', + 'integrations/ses.mdx', + 'integrations/sftp.mdx', + 'integrations/sharepoint.mdx', + 'integrations/shopify-service-account.mdx', + 'integrations/shopify.mdx', + 'integrations/similarweb.mdx', + 'integrations/sixtyfour.mdx', + 'integrations/slack.mdx', + 'integrations/smtp.mdx', + 'integrations/sportmonks.mdx', + 'integrations/sqs.mdx', + 'integrations/square.mdx', + 'integrations/ssh.mdx', + 'integrations/stagehand.mdx', + 'integrations/stripe.mdx', + 'integrations/sts.mdx', + 'integrations/supabase.mdx', + 'integrations/table.mdx', + 'integrations/tailscale.mdx', + 'integrations/tavily.mdx', + 'integrations/telegram.mdx', + 'integrations/temporal.mdx', + 'integrations/textract.mdx', + 'integrations/thrive.mdx', + 'integrations/tinybird.mdx', + 'integrations/trello-service-account.mdx', + 'integrations/trello.mdx', + 'integrations/trigger_dev.mdx', + 'integrations/twilio.mdx', + 'integrations/twilio_sms.mdx', + 'integrations/twilio_voice.mdx', + 'integrations/typeform.mdx', + 'integrations/upstash.mdx', + 'integrations/uptimerobot.mdx', + 'integrations/vanta.mdx', + 'integrations/vercel.mdx', + 'integrations/wealthbox-service-account.mdx', + 'integrations/wealthbox.mdx', + 'integrations/webflow-service-account.mdx', + 'integrations/webflow.mdx', + 'integrations/whatsapp.mdx', + 'integrations/wikipedia.mdx', + 'integrations/wiza.mdx', + 'integrations/wordpress.mdx', + 'integrations/workday.mdx', + 'integrations/x.mdx', + 'integrations/youtube.mdx', + 'integrations/zendesk.mdx', + 'integrations/zep.mdx', + 'integrations/zerobounce.mdx', + 'integrations/zoom-service-account.mdx', + 'integrations/zoom.mdx', + 'integrations/zoominfo.mdx', + 'introduction.mdx', + 'keyboard-shortcuts.mdx', + 'knowledgebase.mdx', + 'knowledgebase/chunking-strategies.mdx', + 'knowledgebase/connectors.mdx', + 'knowledgebase/debugging-retrieval.mdx', + 'knowledgebase/tags.mdx', + 'knowledgebase/using-in-workflows.mdx', + 'logs-debugging.mdx', + 'logs-debugging/alerts.mdx', + 'logs-debugging/logging.mdx', + 'mothership.mdx', + 'mothership/files.mdx', + 'mothership/knowledge.mdx', + 'mothership/mailer.mdx', + 'mothership/research.mdx', + 'mothership/tables.mdx', + 'mothership/tasks.mdx', + 'mothership/workflows.mdx', + 'platform/costs.mdx', + 'platform/credentials.mdx', + 'platform/enterprise.mdx', + 'platform/enterprise/access-control.mdx', + 'platform/enterprise/audit-logs.mdx', + 'platform/enterprise/custom-blocks.mdx', + 'platform/enterprise/data-drains.mdx', + 'platform/enterprise/data-retention.mdx', + 'platform/enterprise/forks.mdx', + 'platform/enterprise/session-policies.mdx', + 'platform/enterprise/sso.mdx', + 'platform/enterprise/verified-domains.mdx', + 'platform/enterprise/whitelabeling.mdx', + 'platform/organization.mdx', + 'platform/permissions.mdx', + 'platform/self-hosting.mdx', + 'platform/self-hosting/docker.mdx', + 'platform/self-hosting/environment-variables.mdx', + 'platform/self-hosting/kubernetes.mdx', + 'platform/self-hosting/object-storage.mdx', + 'platform/self-hosting/platforms.mdx', + 'platform/self-hosting/troubleshooting.mdx', + 'platform/workspaces.mdx', + 'quick-reference.mdx', + 'tables.mdx', + 'tables/using-in-workflows.mdx', + 'tables/workflow-columns.mdx', + 'workflows.mdx', + 'workflows/blocks/agent.mdx', + 'workflows/blocks/api.mdx', + 'workflows/blocks/condition.mdx', + 'workflows/blocks/credential.mdx', + 'workflows/blocks/evaluator.mdx', + 'workflows/blocks/function.mdx', + 'workflows/blocks/guardrails.mdx', + 'workflows/blocks/human-in-the-loop.mdx', + 'workflows/blocks/logs.mdx', + 'workflows/blocks/loop.mdx', + 'workflows/blocks/parallel.mdx', + 'workflows/blocks/pi.mdx', + 'workflows/blocks/response.mdx', + 'workflows/blocks/router.mdx', + 'workflows/blocks/variables.mdx', + 'workflows/blocks/wait.mdx', + 'workflows/blocks/webhook.mdx', + 'workflows/blocks/workflow.mdx', + 'workflows/connections.mdx', + 'workflows/data-flow.mdx', + 'workflows/deployment.mdx', + 'workflows/deployment/agent-events.mdx', + 'workflows/deployment/api.mdx', + 'workflows/deployment/chat.mdx', + 'workflows/deployment/mcp.mdx', + 'workflows/how-it-runs.mdx', + 'workflows/triggers/rss.mdx', + 'workflows/triggers/schedule.mdx', + 'workflows/triggers/sim.mdx', + 'workflows/triggers/start.mdx', + 'workflows/triggers/table.mdx', + 'workflows/triggers/webhook.mdx', + 'workflows/variables.mdx', +] diff --git a/apps/sim/lib/copilot/tools/client/store-utils.test.ts b/apps/sim/lib/copilot/tools/client/store-utils.test.ts index 6f973c23f8e..fa6de4c0b14 100644 --- a/apps/sim/lib/copilot/tools/client/store-utils.test.ts +++ b/apps/sim/lib/copilot/tools/client/store-utils.test.ts @@ -49,28 +49,22 @@ describe('resolveToolDisplay', () => { ).toBe('Read RET XYZ') }) - it('formats docs corpus reads as Section/filename', () => { + it('formats docs corpus reads as Section/page', () => { expect( resolveToolDisplay(ReadTool.id, ClientToolCallState.success, { - path: 'docs/documentation/workflows/index.mdx', + path: 'docs/workflows/blocks/agent.mdx', })?.text - ).toBe('Read Workflows/index') + ).toBe('Read Workflows/agent') expect( resolveToolDisplay(ReadTool.id, ClientToolCallState.executing, { - path: 'docs/academy/agents/block.mdx', + path: 'docs/integrations/gmail.mdx', })?.text - ).toBe('Reading Agents/block') - - expect( - resolveToolDisplay(ReadTool.id, ClientToolCallState.success, { - path: 'docs/api-reference/workflows.json', - })?.text - ).toBe('Read Workflows') + ).toBe('Reading Integrations/gmail') expect( resolveToolDisplay(ReadTool.id, ClientToolCallState.error, { - path: 'docs/documentation/getting-started.mdx', + path: 'docs/getting-started.mdx', })?.text ).toBe('Attempted to read Getting-started') }) diff --git a/apps/sim/lib/copilot/tools/client/store-utils.ts b/apps/sim/lib/copilot/tools/client/store-utils.ts index 5ca68ff5597..1a448d75e5d 100644 --- a/apps/sim/lib/copilot/tools/client/store-utils.ts +++ b/apps/sim/lib/copilot/tools/client/store-utils.ts @@ -144,19 +144,13 @@ function describeFileReadTarget(segments: string[]): string { return lastSegment } -const DOCS_TAB_SEGMENTS = new Set(['documentation', 'academy', 'api-reference']) - /** - * Labels a docs/ corpus read as `
/` (e.g. `Workflows/index` - * for docs/documentation/workflows/index.mdx). The tab segment is dropped and - * single-level pages show just their capitalized name (e.g. `Getting-started`, - * or `Workflows` for the api-reference tag file workflows.json). + * Labels a docs/ corpus read as `
/` (e.g. `Workflows/agent` for + * docs/workflows/blocks/agent.mdx). Top-level pages show just their capitalized + * name (e.g. `Getting-started` for docs/getting-started.mdx). */ function describeDocsReadTarget(segments: string[]): string { - let rest = segments.slice(1) - if (rest.length > 0 && DOCS_TAB_SEGMENTS.has(rest[0])) { - rest = rest.slice(1) - } + const rest = segments.slice(1) if (rest.length === 0) return 'docs' const leaf = stripExtension(rest[rest.length - 1]) if (rest.length === 1) return capitalizeFirst(leaf) diff --git a/apps/sim/lib/copilot/tools/handlers/vfs.ts b/apps/sim/lib/copilot/tools/handlers/vfs.ts index ba8bd734bca..e2c7f13c3aa 100644 --- a/apps/sim/lib/copilot/tools/handlers/vfs.ts +++ b/apps/sim/lib/copilot/tools/handlers/vfs.ts @@ -4,6 +4,14 @@ import { resolveCopilotKnowledgePrincipal } from '@/lib/copilot/application/exec import { resolveCopilotFilePrincipal } from '@/lib/copilot/auth/file-delegation' import { getBlockVisibilityForCopilot } from '@/lib/copilot/block-visibility' import { TOOL_RESULT_MAX_INLINE_CHARS } from '@/lib/copilot/constants' +import { + couldMatchDocsScope, + DocsCorpusError, + globDocs, + grepDocsPage, + isDocsPath, + readDocsPage, +} from '@/lib/copilot/docs/docs-corpus' import type { ExecutionContext, ToolCallResult } from '@/lib/copilot/request/types' import { getOrMaterializeVFS } from '@/lib/copilot/vfs' import type { GrepCountEntry, GrepMatch } from '@/lib/copilot/vfs/operations' @@ -154,14 +162,17 @@ export async function executeVfsGrep( // Routing mirrors read/glob: // - uploads/ -> grep one chat upload's content (chat-scoped) + // - docs/ -> grep one docs.sim.ai page (one page only — each is a fetch) // - files/ -> grep one workspace file's content (one file only) // - everything else -> grep the in-memory VFS map (workflow JSON, metadata) - // Chat uploads are opt-in like recently-deleted/: they are never in the VFS - // map, so an unscoped grep can't touch them — only an explicit uploads/ - // path does, and only one upload at a time. + // Chat uploads and the docs corpus are opt-in like recently-deleted/: they are + // never in the VFS map, so an unscoped grep can't touch them — only an explicit + // uploads/ or docs/ path does, and only one at a time. let result: GrepMatch[] | string[] | GrepCountEntry[] let provenanceFile: WorkspaceFileSecretProvenanceIdentity | undefined - if (isChatUploadGrepPath(rawPath)) { + if (rawPath !== undefined && isDocsPath(rawPath)) { + result = await grepDocsPage(rawPath, pattern, grepOptions) + } else if (isChatUploadGrepPath(rawPath)) { if (!context.chatId) { return { success: false, error: 'No chat context available for uploads/' } } @@ -223,8 +234,8 @@ export async function executeVfsGrep( } catch (err) { // Expected single-file scoping / no-text / too-large conditions: surface the // message verbatim instead of logging an internal failure. - if (err instanceof WorkspaceFileGrepError) { - logger.debug('vfs_grep workspace file rejected', { + if (err instanceof WorkspaceFileGrepError || err instanceof DocsCorpusError) { + logger.debug('vfs_grep single-file scope rejected', { pattern, path: rawPath, error: err.message, @@ -255,6 +266,15 @@ export async function executeVfsGlob( } try { + // The docs corpus is a lazy view of docs.sim.ai built from the generated + // manifest, not part of the workspace VFS — an explicit docs/ pattern is the + // only way to see it. + if (couldMatchDocsScope(pattern)) { + const files = globDocs(pattern) + logger.debug('vfs_glob docs result', { pattern, fileCount: files.length }) + return { success: true, output: { files } } + } + const vfs = await getGatedVFS(context) let files = vfs.glob(pattern) @@ -323,6 +343,21 @@ export async function executeVfsRead( } } + // Docs pages are fetched from the live docs site on demand — the manifest + // path is the URL path, so there is nothing workspace-scoped to resolve. + if (isDocsPath(path)) { + const page = await readDocsPage(path) + const windowed = applyWindow(page) + if (serializedResultSize(windowed) > TOOL_RESULT_MAX_INLINE_CHARS) { + return { + success: false, + error: `${path} is too large to return inline. Grep that one page for the relevant section, then retry read with offset/limit.`, + } + } + logger.debug('vfs_read resolved docs page', { path, totalLines: page.totalLines }) + return { success: true, output: windowed } + } + // Handle chat-scoped uploads via the uploads/ virtual prefix. // Uploads are flat and have no metadata/content split like files/ — the upload // IS the first path segment after uploads/. Any trailing segment (e.g. a @@ -482,6 +517,12 @@ export async function executeVfsRead( output: result, } } catch (err) { + // Expected docs-corpus conditions (unknown page, directory path, site + // unreachable): surface the message verbatim. + if (err instanceof DocsCorpusError) { + logger.debug('vfs_read docs page rejected', { path, error: err.message }) + return { success: false, error: err.message } + } logger.error('vfs_read failed', { path, error: toError(err).message, diff --git a/apps/sim/lib/copilot/tools/server/docs/search-docs.test.ts b/apps/sim/lib/copilot/tools/server/docs/search-docs.test.ts deleted file mode 100644 index 4d0077f5540..00000000000 --- a/apps/sim/lib/copilot/tools/server/docs/search-docs.test.ts +++ /dev/null @@ -1,42 +0,0 @@ -/** - * @vitest-environment node - */ -import { describe, expect, it, vi } from 'vitest' - -vi.mock('@/lib/knowledge/embeddings', () => ({ - generateSearchEmbedding: vi.fn(), -})) - -import { docsScopeTail } from '@/lib/copilot/tools/server/docs/search-docs' - -describe('docsScopeTail', () => { - it('returns undefined for an unscoped search', () => { - expect(docsScopeTail(undefined)).toBeUndefined() - expect(docsScopeTail('')).toBeUndefined() - expect(docsScopeTail(' ')).toBeUndefined() - }) - - it('treats the bare docs/documentation prefix as unscoped', () => { - expect(docsScopeTail('docs/documentation')).toBeUndefined() - expect(docsScopeTail('docs/documentation/')).toBeUndefined() - expect(docsScopeTail('/docs/documentation/')).toBeUndefined() - }) - - it('maps directory scopes to their source_document tail', () => { - expect(docsScopeTail('docs/documentation/workflows')).toBe('workflows') - expect(docsScopeTail('/docs/documentation/workflows/')).toBe('workflows') - expect(docsScopeTail('docs/documentation/integrations/gmail')).toBe('integrations/gmail') - }) - - it('maps file scopes by stripping the mdx extension', () => { - expect(docsScopeTail('docs/documentation/agents/choosing.mdx')).toBe('agents/choosing') - expect(docsScopeTail('docs/documentation/workflows/index.mdx')).toBe('workflows') - }) - - it('rejects paths outside docs/documentation/', () => { - expect(() => docsScopeTail('docs/academy/agents')).toThrow(/must start with/) - expect(() => docsScopeTail('docs/api-reference/workflows.json')).toThrow(/must start with/) - expect(() => docsScopeTail('workflows')).toThrow(/must start with/) - expect(() => docsScopeTail('docs/documentation-extra/foo')).toThrow(/must start with/) - }) -}) diff --git a/apps/sim/lib/copilot/tools/server/docs/search-docs.ts b/apps/sim/lib/copilot/tools/server/docs/search-docs.ts index dcc3b6d6b67..cf88c0bfa1b 100644 --- a/apps/sim/lib/copilot/tools/server/docs/search-docs.ts +++ b/apps/sim/lib/copilot/tools/server/docs/search-docs.ts @@ -1,10 +1,6 @@ -import { db } from '@sim/db' -import { docsEmbeddings } from '@sim/db/schema' -import { createLogger } from '@sim/logger' -import { and, eq, like, notLike, or, sql } from 'drizzle-orm' +import { searchDocs } from '@/lib/copilot/docs/docs-search' import { SearchDocs } from '@/lib/copilot/generated/tool-catalog-v1' import type { BaseServerTool } from '@/lib/copilot/tools/server/base-tool' -import { generateSearchEmbedding } from '@/lib/knowledge/embeddings' interface SearchDocsParams { query: string @@ -12,99 +8,21 @@ interface SearchDocsParams { path?: string } -const DEFAULT_DOCS_SIMILARITY_THRESHOLD = 0.3 -const DEFAULT_TOP_K = 10 -const MAX_TOP_K = 25 -const DOCS_DOCUMENTATION_PREFIX = 'docs/documentation' - -/** - * Maps a docs/documentation/... VFS path onto a docs_embeddings source_document - * scope tail. VFS paths mirror docs.sim.ai URLs while source_document stores - * the en-relative mdx path, so a scope tail must cover both layouts a page can - * have on disk: `.mdx` and `/...` (including `/index.mdx`). - * Returns undefined for an unscoped search; throws when the path does not - * address docs/documentation/. - */ -export function docsScopeTail(path?: string): string | undefined { - if (!path || path.trim() === '') return undefined - const normalized = path.trim().replace(/^\.?\//, '') - if ( - normalized !== DOCS_DOCUMENTATION_PREFIX && - !normalized.startsWith(`${DOCS_DOCUMENTATION_PREFIX}/`) - ) { - throw new Error(`path must start with ${DOCS_DOCUMENTATION_PREFIX}/ (got "${path}")`) - } - const tail = normalized - .slice(DOCS_DOCUMENTATION_PREFIX.length) - .replace(/^\/+|\/+$/g, '') - .replace(/\/index\.mdx$/, '') - .replace(/\.mdx$/, '') - return tail === '' ? undefined : tail -} - -function escapeLikePattern(value: string): string { - return value.replace(/[\\%_]/g, (char) => `\\${char}`) +interface SearchDocsOutput { + results: Awaited> + query: string + totalResults: number } /** - * Unscoped searches cover exactly the Documentation tab (everything under the - * docs/documentation/ VFS tree), so Academy and API-reference rows are - * excluded; a scope tail narrows to one page or directory subtree. + * Vector search over Sim's product documentation, scoped to the same pages the + * agent can `read` from the `docs/` VFS tree. Search-agent only; the corpus + * logic lives in `@/lib/copilot/docs/docs-search`. */ -function scopeCondition(tail?: string) { - if (!tail) { - return and( - notLike(docsEmbeddings.sourceDocument, 'academy/%'), - notLike(docsEmbeddings.sourceDocument, 'api-reference/%') - ) - } - return or( - eq(docsEmbeddings.sourceDocument, `${tail}.mdx`), - like(docsEmbeddings.sourceDocument, `${escapeLikePattern(tail)}/%`) - ) -} - -export const searchDocsServerTool: BaseServerTool = { +export const searchDocsServerTool: BaseServerTool = { name: SearchDocs.id, - async execute(params: SearchDocsParams): Promise { - const logger = createLogger('SearchDocsServerTool') - const { query, path } = params - if (!query || typeof query !== 'string') throw new Error('query is required') - const topK = Math.min(Math.max(Math.trunc(params.topK ?? DEFAULT_TOP_K), 1), MAX_TOP_K) - const scopeTail = docsScopeTail(path) - - logger.info('Executing docs search', { query, topK, path: path ?? null }) - - const { embedding: queryEmbedding } = await generateSearchEmbedding(query) - if (!queryEmbedding || queryEmbedding.length === 0) { - return { results: [], query, totalResults: 0 } - } - - const results = await db - .select({ - chunkId: docsEmbeddings.chunkId, - chunkText: docsEmbeddings.chunkText, - sourceDocument: docsEmbeddings.sourceDocument, - sourceLink: docsEmbeddings.sourceLink, - headerText: docsEmbeddings.headerText, - headerLevel: docsEmbeddings.headerLevel, - similarity: sql`1 - (${docsEmbeddings.embedding} <=> ${JSON.stringify(queryEmbedding)}::vector)`, - }) - .from(docsEmbeddings) - .where(scopeCondition(scopeTail)) - .orderBy(sql`${docsEmbeddings.embedding} <=> ${JSON.stringify(queryEmbedding)}::vector`) - .limit(topK) - - const filteredResults = results.filter((r) => r.similarity >= DEFAULT_DOCS_SIMILARITY_THRESHOLD) - const documentationResults = filteredResults.map((r, idx) => ({ - id: idx + 1, - title: String(r.headerText || 'Untitled Section'), - url: String(r.sourceLink || '#'), - content: String(r.chunkText || ''), - similarity: r.similarity, - })) - - logger.info('Docs search complete', { count: documentationResults.length }) - return { results: documentationResults, query, totalResults: documentationResults.length } + async execute(params: SearchDocsParams): Promise { + const results = await searchDocs(params.query, { path: params.path, topK: params.topK }) + return { results, query: params.query, totalResults: results.length } }, } diff --git a/apps/sim/lib/copilot/tools/tool-display.test.ts b/apps/sim/lib/copilot/tools/tool-display.test.ts index 948ffa2adcc..027ce68d915 100644 --- a/apps/sim/lib/copilot/tools/tool-display.test.ts +++ b/apps/sim/lib/copilot/tools/tool-display.test.ts @@ -78,19 +78,6 @@ describe('getToolDisplayTitle natural-language coverage', () => { expect(getToolDisplayTitle('diff_workflows')).toBe('Comparing workflows') }) - it('includes the query in search_docs titles', () => { - expect(getToolDisplayTitle('search_docs')).toBe('Searching docs') - expect(getToolDisplayTitle('search_docs', { query: 'loop blocks iteration' })).toBe( - 'Searching docs for "loop blocks iteration"' - ) - expect( - getToolDisplayTitle('search_docs', { - query: - 'reference block outputs connection tags blockname.field pass data between blocks in a workflow', - })?.length - ).toBeLessThanOrEqual('Searching docs for ""'.length + 60 + '...'.length) - }) - it('falls back to running code for function_execute without a title', () => { expect(getToolDisplayTitle('function_execute')).toBe('Running code') expect(getToolDisplayTitle('function_execute', { title: 'Crunching numbers' })).toBe( diff --git a/apps/sim/lib/copilot/tools/tool-display.ts b/apps/sim/lib/copilot/tools/tool-display.ts index 58f5de96f23..91c2a00ebdc 100644 --- a/apps/sim/lib/copilot/tools/tool-display.ts +++ b/apps/sim/lib/copilot/tools/tool-display.ts @@ -1,4 +1,4 @@ -import { stripVersionSuffix, truncate } from '@sim/utils/string' +import { stripVersionSuffix } from '@sim/utils/string' /** * Single source of truth for copilot tool-call display titles. @@ -803,10 +803,6 @@ export function getToolDisplayTitle(name: string, args?: Record const target = firstStringArg(args, 'toolTitle', 'title') return target ? `Searching online for ${target}` : 'Searching online' } - case 'search_docs': { - const target = firstStringArg(args, 'toolTitle', 'title', 'query') - return target ? `Searching docs for "${truncate(target, 60)}"` : 'Searching docs' - } case 'grep': { const target = firstStringArg(args, 'toolTitle', 'title') return target ? `Searching for ${target}` : 'Searching' diff --git a/package.json b/package.json index 81f5d23783b..2826be7b11c 100644 --- a/package.json +++ b/package.json @@ -73,6 +73,8 @@ "metrics-contract:check": "bun run scripts/sync-metrics-contract.ts --check", "vfs-snapshot-contract:generate": "bun run scripts/sync-vfs-snapshot-contract.ts", "vfs-snapshot-contract:check": "bun run scripts/sync-vfs-snapshot-contract.ts --check", + "docs-manifest:generate": "bun run scripts/sync-docs-manifest.ts", + "docs-manifest:check": "bun run scripts/sync-docs-manifest.ts --check", "mship:generate": "bun run scripts/generate-mship-contracts.ts", "mship:check": "bun run scripts/generate-mship-contracts.ts --check", "library:covers": "bun run scripts/generate-library-covers.tsx", diff --git a/scripts/sync-docs-manifest.ts b/scripts/sync-docs-manifest.ts new file mode 100644 index 00000000000..2d81f277331 --- /dev/null +++ b/scripts/sync-docs-manifest.ts @@ -0,0 +1,108 @@ +/** + * Generate the static docs manifest the copilot's `docs/` VFS tree is built from. + * + * Source of truth: `apps/docs/content/docs/en/**\/*.mdx` — the English docs + * corpus, whose folder structure mirrors the public docs.sim.ai URL structure. + * The copilot never reads those files from disk (they are not deployed with + * `apps/sim`); it globs this manifest for structure and fetches page content + * from the live site on demand. That makes the manifest the one thing that can + * drift, hence `--check` in CI. + * + * Path derivation (each entry is BOTH the `docs/`-relative VFS path and the + * docs.sim.ai URL path, so a read is a plain fetch of `https://docs.sim.ai/`): + * - `workflows/blocks/agent.mdx` → `workflows/blocks/agent.mdx` + * - `workflows/index.mdx` → `workflows.mdx` (fumadocs folds index pages + * into their parent URL; `/workflows/index.mdx` + * is a 404 on the site) + * + * Excluded, and intentionally absent from the VFS: `academy/` and + * `api-reference/` (fetch those with the scrape tool if ever needed), the root + * `index.mdx` (its URL is `/`, which redirects), and every non-`en` locale. + * + * Usage: + * bun run docs-manifest:generate # write the manifest + * bun run docs-manifest:check # fail (exit 1) if the manifest is stale + */ +import { readdir, readFile, writeFile } from 'node:fs/promises' +import { dirname, resolve } from 'node:path' +import { fileURLToPath } from 'node:url' +import { formatGeneratedSource } from './format-generated-source' + +const SCRIPT_DIR = dirname(fileURLToPath(import.meta.url)) +const ROOT = resolve(SCRIPT_DIR, '..') +const DOCS_CONTENT_DIR = resolve(ROOT, 'apps/docs/content/docs/en') +const OUTPUT_PATH = resolve(ROOT, 'apps/sim/lib/copilot/generated/docs-manifest.ts') + +/** Top-level docs sections deliberately left out of the copilot's `docs/` tree. */ +const EXCLUDED_SECTIONS = new Set(['academy', 'api-reference']) + +/** Collect every `.mdx` file under `dir`, as paths relative to {@link DOCS_CONTENT_DIR}. */ +async function collectMdxPaths(dir: string, prefix = ''): Promise { + const entries = await readdir(dir, { withFileTypes: true }) + const paths: string[] = [] + for (const entry of entries) { + const relative = prefix ? `${prefix}/${entry.name}` : entry.name + if (entry.isDirectory()) { + if (prefix === '' && EXCLUDED_SECTIONS.has(entry.name)) continue + paths.push(...(await collectMdxPaths(resolve(dir, entry.name), relative))) + continue + } + if (entry.isFile() && entry.name.endsWith('.mdx')) paths.push(relative) + } + return paths +} + +/** Map an `en`-relative mdx file path to its docs.sim.ai URL path, or null to drop it. */ +function toDocsPath(mdxPath: string): string | null { + if (mdxPath === 'index.mdx') return null + return mdxPath.replace(/\/index\.mdx$/, '.mdx') +} + +function render(paths: string[]): string { + const entries = paths.map((path) => ` '${path}',`).join('\n') + return `// AUTO-GENERATED FILE. DO NOT EDIT. +// Generated from apps/docs/content/docs/en by scripts/sync-docs-manifest.ts +// Run: bun run docs-manifest:generate +// + +/** + * Every page in the copilot's read-only \`docs/\` VFS tree, as a path that is + * simultaneously the \`docs/\`-relative VFS path and the docs.sim.ai URL path + * (so \`docs/workflows/blocks/agent.mdx\` reads + * \`https://docs.sim.ai/workflows/blocks/agent.mdx\`). Sorted. + */ +export const DOCS_MANIFEST: readonly string[] = [ +${entries} +] +` +} + +async function main() { + const checkOnly = process.argv.includes('--check') + + const mdxPaths = await collectMdxPaths(DOCS_CONTENT_DIR) + const docsPaths = mdxPaths + .map(toDocsPath) + .filter((path): path is string => path !== null) + .sort() + + if (docsPaths.length === 0) { + throw new Error(`No docs pages found under ${DOCS_CONTENT_DIR}`) + } + + const rendered = formatGeneratedSource(render(docsPaths), OUTPUT_PATH, ROOT) + + if (checkOnly) { + const existing = await readFile(OUTPUT_PATH, 'utf8').catch(() => null) + if (existing !== rendered) { + throw new Error( + 'Generated docs manifest is stale — the docs tree changed (page added, removed, or renamed). Run: bun run docs-manifest:generate' + ) + } + return + } + + await writeFile(OUTPUT_PATH, rendered, 'utf8') +} + +await main() From c6b8eecc807da8ede4ebef84cbc66e7df8b84f91 Mon Sep 17 00:00:00 2001 From: Justin Blumencranz <96924014+j15z@users.noreply.github.com> Date: Fri, 24 Jul 2026 16:13:29 -0700 Subject: [PATCH 06/32] fix(review): act on docs-vfs review findings MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Multi-agent review of the docs/ VFS change. Applied the behavior-preserving fixes plus two agent-facing bugs that made real pages unreadable. - docs read no longer hard-fails on oversized pages. Six+ live integration references exceed the inline cap (github.mdx is 354KB, sportmonks 513KB), so a plain read of them ALWAYS failed and cost a second fetch to recover. Truncate to the largest whole-line prefix that fits, keep the true totalLines, and tell the model how to page. An explicit offset/limit that still overflows is still an error — that one is a caller mistake. - classify docs fetch failures. Everything collapsed to null, so a permanent 404 was reported to the agent as "temporarily unavailable, retry shortly", inviting a retry loop on a page that will never exist. 4xx (except 429) is now permanent and says so; 5xx/429/network/timeout keep the retry wording. - register search_documentation as a transitional alias for search_docs. sim and mothership deploy independently and the rename deleted the old id on both sides, so BOTH deploy orders broke docs lookup for the window between them. Old params are a subset of the new. Remove once both ship. - extract the index-page fold (X/index.mdx <-> X.mdx) into docs-path.ts. It was re-derived in three places — the manifest generator, the source_document reverse mapping, and the search scope filter — which is the hand-synced-duplicate shape that has drifted in this repo before. - grepDocsPage now goes through grepReadResult, the primitive files/ and uploads/ grep already use, instead of calling grep directly. - couldMatchDocsScope delegates to isDocsPath; the bodies were identical. - drop the dead 'docs' member from AgentContextType. Tests: 404-vs-5xx-vs-429 classification, network failure, and a docs-path round-trip asserting one source candidate reproduces every manifest entry. Verified: tsc clean, 932 copilot tests, biome clean, docs-manifest:check, check:utils and check:api-validation:strict both pass. Co-Authored-By: Claude Opus 5 (1M context) --- apps/sim/lib/copilot/chat/process-contents.ts | 1 - apps/sim/lib/copilot/docs/docs-corpus.test.ts | 21 ++++++++- apps/sim/lib/copilot/docs/docs-corpus.ts | 43 +++++++++++------ apps/sim/lib/copilot/docs/docs-path.test.ts | 35 ++++++++++++++ apps/sim/lib/copilot/docs/docs-path.ts | 36 ++++++++++++++ apps/sim/lib/copilot/docs/docs-search.ts | 7 +-- apps/sim/lib/copilot/tools/handlers/vfs.ts | 47 +++++++++++++++++-- apps/sim/lib/copilot/tools/server/router.ts | 5 ++ scripts/sync-docs-manifest.ts | 3 +- 9 files changed, 174 insertions(+), 24 deletions(-) create mode 100644 apps/sim/lib/copilot/docs/docs-path.test.ts create mode 100644 apps/sim/lib/copilot/docs/docs-path.ts diff --git a/apps/sim/lib/copilot/chat/process-contents.ts b/apps/sim/lib/copilot/chat/process-contents.ts index 54b44e7afff..c5a49d8a787 100644 --- a/apps/sim/lib/copilot/chat/process-contents.ts +++ b/apps/sim/lib/copilot/chat/process-contents.ts @@ -62,7 +62,6 @@ type AgentContextType = | 'file' | 'file_selection' | 'workflow_block' - | 'docs' | 'folder' | 'filefolder' | 'active_resource' diff --git a/apps/sim/lib/copilot/docs/docs-corpus.test.ts b/apps/sim/lib/copilot/docs/docs-corpus.test.ts index 0142ee4f169..31117855a08 100644 --- a/apps/sim/lib/copilot/docs/docs-corpus.test.ts +++ b/apps/sim/lib/copilot/docs/docs-corpus.test.ts @@ -93,10 +93,29 @@ describe('readDocsPage', () => { expect(fetchMock).not.toHaveBeenCalled() }) - it('surfaces a docs-site failure as a retryable error', async () => { + it('surfaces a docs-site outage as a retryable error', async () => { fetchMock.mockResolvedValue({ ok: false, status: 502, text: async () => '' }) await expect(readDocsPage(`docs/${SAMPLE_PAGE}`)).rejects.toThrow(/temporarily unavailable/) }) + + it('treats a network failure as retryable', async () => { + fetchMock.mockRejectedValue(new Error('socket hang up')) + await expect(readDocsPage(`docs/${SAMPLE_PAGE}`)).rejects.toThrow(/temporarily unavailable/) + }) + + it('reports a page the site no longer serves as permanent, not retryable', async () => { + fetchMock.mockResolvedValue({ ok: false, status: 404, text: async () => '' }) + const error = await readDocsPage(`docs/${SAMPLE_PAGE}`).catch((e) => e) + expect(error).toBeInstanceOf(DocsCorpusError) + expect(error.message).toMatch(/does not serve it/) + expect(error.message).toMatch(/retrying will not help/) + expect(error.message).not.toMatch(/temporarily unavailable/) + }) + + it('still treats 429 as retryable rather than permanent', async () => { + fetchMock.mockResolvedValue({ ok: false, status: 429, text: async () => '' }) + await expect(readDocsPage(`docs/${SAMPLE_PAGE}`)).rejects.toThrow(/temporarily unavailable/) + }) }) describe('grepDocsPage', () => { diff --git a/apps/sim/lib/copilot/docs/docs-corpus.ts b/apps/sim/lib/copilot/docs/docs-corpus.ts index 5a5c3f1d7ee..16a202a4f84 100644 --- a/apps/sim/lib/copilot/docs/docs-corpus.ts +++ b/apps/sim/lib/copilot/docs/docs-corpus.ts @@ -1,8 +1,9 @@ import { createLogger } from '@sim/logger' import { toError } from '@sim/utils/errors' +import { foldDocsIndexPath } from '@/lib/copilot/docs/docs-path' import { DOCS_MANIFEST } from '@/lib/copilot/generated/docs-manifest' import type { GrepCountEntry, GrepMatch, GrepOptions } from '@/lib/copilot/vfs/operations' -import { glob as globPaths, grep as grepFiles } from '@/lib/copilot/vfs/operations' +import { glob as globPaths, grepReadResult } from '@/lib/copilot/vfs/operations' const logger = createLogger('DocsCorpus') @@ -56,12 +57,11 @@ export function isDocsPath(path: string | undefined): boolean { * True when a glob `pattern` could match the docs corpus. Like `uploads/` and * `recently-deleted/`, the corpus is opt-in: only a pattern that explicitly * starts with `docs/` (or is exactly `docs`) sees it, so a broad `**` glob never - * drags 300+ doc pages into the result. + * drags 300+ doc pages into the result. Same rule as {@link isDocsPath}; the + * separate name reads correctly at the glob call site. */ export function couldMatchDocsScope(pattern: string | undefined): boolean { - if (!pattern) return false - const normalized = normalize(pattern) - return normalized === 'docs' || normalized.startsWith(DOCS_PREFIX) + return isDocsPath(pattern) } /** Manifest paths (and their virtual directories) matching an explicit `docs/` pattern. */ @@ -82,7 +82,7 @@ export function isDocsPage(path: string): boolean { */ export function docsPathForSourceDocument(sourceDocument: string | null): string | null { if (!sourceDocument) return null - const path = `${DOCS_PREFIX}${sourceDocument.replace(/^\/+/, '').replace(/\/index\.mdx$/, '.mdx')}` + const path = `${DOCS_PREFIX}${foldDocsIndexPath(sourceDocument.replace(/^\/+/, ''))}` return docsKeyView.has(path) ? path : null } @@ -108,9 +108,16 @@ export interface DocsPage { * to its raw-markdown route), so no mapping table is needed. Returns null when * the page is not in the manifest or the site does not serve it. */ -async function fetchDocsPage(path: string): Promise { +type DocsFetchResult = + | { outcome: 'ok'; content: string } + /** The site will not serve this path however many times we ask. */ + | { outcome: 'missing' } + /** Transient: 5xx, 429, network error, or timeout. */ + | { outcome: 'unavailable' } + +async function fetchDocsPage(path: string): Promise { const key = normalize(path) - if (!docsKeyView.has(key)) return null + if (!docsKeyView.has(key)) return { outcome: 'missing' } const url = `${DOCS_BASE_URL}/${key.slice(DOCS_PREFIX.length)}` try { const response = await fetch(url, { @@ -119,12 +126,13 @@ async function fetchDocsPage(path: string): Promise { }) if (!response.ok) { logger.warn('Docs page fetch returned a non-OK status', { url, status: response.status }) - return null + const permanent = response.status >= 400 && response.status < 500 && response.status !== 429 + return { outcome: permanent ? 'missing' : 'unavailable' } } - return await response.text() + return { outcome: 'ok', content: await response.text() } } catch (err) { logger.warn('Docs page fetch failed', { url, error: toError(err).message }) - return null + return { outcome: 'unavailable' } } } @@ -144,13 +152,18 @@ export async function readDocsPage(path: string): Promise { `Docs page not found: ${path}. Use glob("docs/**") to list the docs corpus.` ) } - const content = await fetchDocsPage(key) - if (content === null) { + const result = await fetchDocsPage(key) + if (result.outcome === 'missing') { + throw new DocsCorpusError( + `${key} is in the docs index but ${DOCS_BASE_URL} does not serve it — the page was likely moved or removed. Use glob("docs/**") to find the current path; retrying will not help.` + ) + } + if (result.outcome === 'unavailable') { throw new DocsCorpusError( `Could not load ${key} from ${DOCS_BASE_URL} — the docs site is temporarily unavailable. Retry shortly.` ) } - return { content, totalLines: content.split('\n').length } + return { content: result.content, totalLines: result.content.split('\n').length } } /** @@ -170,5 +183,5 @@ export async function grepDocsPage( ) } const page = await readDocsPage(key) - return grepFiles(new Map([[key, page.content]]), pattern, undefined, options) + return grepReadResult(key, page, pattern, key, options) } diff --git a/apps/sim/lib/copilot/docs/docs-path.test.ts b/apps/sim/lib/copilot/docs/docs-path.test.ts new file mode 100644 index 00000000000..c40ba0a7abb --- /dev/null +++ b/apps/sim/lib/copilot/docs/docs-path.test.ts @@ -0,0 +1,35 @@ +/** + * @vitest-environment node + */ +import { describe, expect, it } from 'vitest' +import { docsSourceCandidates, foldDocsIndexPath } from '@/lib/copilot/docs/docs-path' +import { DOCS_MANIFEST } from '@/lib/copilot/generated/docs-manifest' + +describe('foldDocsIndexPath', () => { + it('folds a section overview onto the section path', () => { + expect(foldDocsIndexPath('workflows/index.mdx')).toBe('workflows.mdx') + expect(foldDocsIndexPath('platform/enterprise/index.mdx')).toBe('platform/enterprise.mdx') + }) + + it('leaves a plain page untouched', () => { + expect(foldDocsIndexPath('workflows/blocks/agent.mdx')).toBe('workflows/blocks/agent.mdx') + expect(foldDocsIndexPath('agents.mdx')).toBe('agents.mdx') + }) + + it('does not fold a page merely named index', () => { + expect(foldDocsIndexPath('index.mdx')).toBe('index.mdx') + }) +}) + +describe('docsSourceCandidates', () => { + it('is the inverse of the fold — one candidate always reproduces the input', () => { + for (const publicPath of DOCS_MANIFEST) { + const candidates = docsSourceCandidates(publicPath) + expect(candidates.map(foldDocsIndexPath)).toContain(publicPath) + } + }) + + it('offers both on-disk layouts for a section path', () => { + expect(docsSourceCandidates('workflows.mdx')).toEqual(['workflows.mdx', 'workflows/index.mdx']) + }) +}) diff --git a/apps/sim/lib/copilot/docs/docs-path.ts b/apps/sim/lib/copilot/docs/docs-path.ts new file mode 100644 index 00000000000..650fd2977ac --- /dev/null +++ b/apps/sim/lib/copilot/docs/docs-path.ts @@ -0,0 +1,36 @@ +/** + * The single definition of how a docs source file maps onto its public path. + * + * Fumadocs folds a section's `index.mdx` into the section URL itself, so + * `workflows/index.mdx` on disk is `/workflows` on the site (and + * `/workflows/index.mdx` is a 404). Three places need that rule — the manifest + * generator, the `source_document` -> VFS reverse mapping, and the vector + * search's scope filter — and hand-syncing it has bitten this repo before, so + * it lives here. + * + * Deliberately dependency-free: `scripts/sync-docs-manifest.ts` imports this by + * relative path, and it must not pull in the manifest it generates. + */ + +/** Suffix that marks a section overview page on disk. */ +export const DOCS_INDEX_SUFFIX = '/index.mdx' + +/** + * Fold an `en`-relative mdx file path onto its public path — the value used as + * both the `docs/`-relative VFS path and the docs.sim.ai URL path. + */ +export function foldDocsIndexPath(mdxPath: string): string { + return mdxPath.endsWith(DOCS_INDEX_SUFFIX) + ? `${mdxPath.slice(0, -DOCS_INDEX_SUFFIX.length)}.mdx` + : mdxPath +} + +/** + * The inverse of {@link foldDocsIndexPath}: the on-disk file names a public + * path could have come from. A page is stored either as `.mdx` or, when + * it is a section overview, as `/index.mdx`. + */ +export function docsSourceCandidates(publicPath: string): [string, string] { + const stem = publicPath.replace(/\.mdx$/, '') + return [`${stem}.mdx`, `${stem}${DOCS_INDEX_SUFFIX}`] +} diff --git a/apps/sim/lib/copilot/docs/docs-search.ts b/apps/sim/lib/copilot/docs/docs-search.ts index 0f5553a4858..37679cc867b 100644 --- a/apps/sim/lib/copilot/docs/docs-search.ts +++ b/apps/sim/lib/copilot/docs/docs-search.ts @@ -3,6 +3,7 @@ import { docsEmbeddings } from '@sim/db/schema' import { createLogger } from '@sim/logger' import { and, eq, like, notLike, or, sql } from 'drizzle-orm' import { docsPathForSourceDocument, isDocsDir, isDocsPage } from '@/lib/copilot/docs/docs-corpus' +import { docsSourceCandidates } from '@/lib/copilot/docs/docs-path' import { generateSearchEmbedding } from '@/lib/knowledge/embeddings' const logger = createLogger('DocsSearch') @@ -65,10 +66,10 @@ function scopeCondition(path?: string) { if (isDocsPage(normalized)) { // One page: on disk it is either `.mdx` or `/index.mdx`. - const stem = tail.replace(/\.mdx$/, '') + const [pageFile, indexFile] = docsSourceCandidates(tail) return or( - eq(docsEmbeddings.sourceDocument, `${stem}.mdx`), - eq(docsEmbeddings.sourceDocument, `${stem}/index.mdx`) + eq(docsEmbeddings.sourceDocument, pageFile), + eq(docsEmbeddings.sourceDocument, indexFile) ) } diff --git a/apps/sim/lib/copilot/tools/handlers/vfs.ts b/apps/sim/lib/copilot/tools/handlers/vfs.ts index e2c7f13c3aa..e364cefd0cc 100644 --- a/apps/sim/lib/copilot/tools/handlers/vfs.ts +++ b/apps/sim/lib/copilot/tools/handlers/vfs.ts @@ -134,6 +134,33 @@ async function canReturnWorkspaceFileValue( return true } +/** + * Trim an oversized docs page to the largest whole-line prefix that fits the + * inline budget, preserving the true `totalLines` so the model can page through + * the rest with offset/limit. + */ +function truncateDocsPageToInlineCap(page: { content: string; totalLines: number }): { + output: { content: string; totalLines: number } + returnedLines: number +} { + const lines = page.content.split('\n') + const notice = (shown: number) => + `\n\n[Page truncated: showing lines 1-${shown} of ${page.totalLines}. Grep this path for the section you need, then read with offset/limit.]` + + let kept = lines.length + let content = page.content + while (kept > 0) { + content = `${lines.slice(0, kept).join('\n')}${notice(kept)}` + if ( + serializedResultSize({ content, totalLines: page.totalLines }) <= TOOL_RESULT_MAX_INLINE_CHARS + ) { + break + } + kept = Math.floor(kept / 2) + } + return { output: { content, totalLines: page.totalLines }, returnedLines: kept } +} + export async function executeVfsGrep( params: Record, context: ExecutionContext @@ -349,10 +376,24 @@ export async function executeVfsRead( const page = await readDocsPage(path) const windowed = applyWindow(page) if (serializedResultSize(windowed) > TOOL_RESULT_MAX_INLINE_CHARS) { - return { - success: false, - error: `${path} is too large to return inline. Grep that one page for the relevant section, then retry read with offset/limit.`, + // Several real docs pages (the largest integration references) exceed the + // inline cap, so failing here would make a plain read of them always fail + // and cost a second fetch to recover. Truncate to what fits instead and + // tell the model how to page — but only when it did not ask for a window, + // since an explicit offset/limit that still overflows is a caller error. + if (offset !== undefined || limit !== undefined) { + return { + success: false, + error: `${path} is still too large over the requested window. Narrow offset/limit, or grep this page for the section you need.`, + } } + const truncated = truncateDocsPageToInlineCap(page) + logger.debug('vfs_read truncated oversized docs page', { + path, + totalLines: page.totalLines, + returnedLines: truncated.returnedLines, + }) + return { success: true, output: truncated.output } } logger.debug('vfs_read resolved docs page', { path, totalLines: page.totalLines }) return { success: true, output: windowed } diff --git a/apps/sim/lib/copilot/tools/server/router.ts b/apps/sim/lib/copilot/tools/server/router.ts index ab6a882b30e..1410c37941f 100644 --- a/apps/sim/lib/copilot/tools/server/router.ts +++ b/apps/sim/lib/copilot/tools/server/router.ts @@ -169,6 +169,11 @@ const baseServerToolRegistry: Record = { [editWorkflowServerTool.name]: editWorkflowServerTool, [queryLogsServerTool.name]: queryLogsServerTool, [searchDocsServerTool.name]: searchDocsServerTool, + // Transitional alias: sim and mothership deploy independently, so during the + // rollout of the search_documentation -> search_docs rename one side is still + // emitting the old id. The old params are a subset of the new, so routing them + // here is safe. Remove once both repos have shipped the rename. + search_documentation: searchDocsServerTool, [searchOnlineServerTool.name]: searchOnlineServerTool, [setEnvironmentVariablesServerTool.name]: setEnvironmentVariablesServerTool, [getCredentialsServerTool.name]: getCredentialsServerTool, diff --git a/scripts/sync-docs-manifest.ts b/scripts/sync-docs-manifest.ts index 2d81f277331..fa1f0ddcd81 100644 --- a/scripts/sync-docs-manifest.ts +++ b/scripts/sync-docs-manifest.ts @@ -26,6 +26,7 @@ import { readdir, readFile, writeFile } from 'node:fs/promises' import { dirname, resolve } from 'node:path' import { fileURLToPath } from 'node:url' +import { foldDocsIndexPath } from '../apps/sim/lib/copilot/docs/docs-path' import { formatGeneratedSource } from './format-generated-source' const SCRIPT_DIR = dirname(fileURLToPath(import.meta.url)) @@ -55,7 +56,7 @@ async function collectMdxPaths(dir: string, prefix = ''): Promise { /** Map an `en`-relative mdx file path to its docs.sim.ai URL path, or null to drop it. */ function toDocsPath(mdxPath: string): string | null { if (mdxPath === 'index.mdx') return null - return mdxPath.replace(/\/index\.mdx$/, '.mdx') + return foldDocsIndexPath(mdxPath) } function render(paths: string[]): string { From da102c7e5157b6e792666c3ba33c0fe54cd25fbc Mon Sep 17 00:00:00 2001 From: Justin Blumencranz <96924014+j15z@users.noreply.github.com> Date: Fri, 24 Jul 2026 17:13:40 -0700 Subject: [PATCH 07/32] fix(copilot): explain a short or empty search_docs result set MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The SQL LIMIT is applied before the similarity-threshold and liveness filters, so search_docs can return fewer hits than topK — or none, when every candidate was filtered. An empty array is indistinguishable from "the documentation does not cover this", which sends the agent off to guess instead of rephrasing or falling back to glob. searchDocs now returns the drop counts alongside the results, and the tool attaches a note when anything was dropped: how many candidates the index returned, why they went, and what to try next. Silent on the common path. This does not change which rows are returned or how many — the ordering issue behind the shortfall is a pre-existing bug the deleted search-documentation.ts had too, and pushing the threshold into SQL is its own change. Co-Authored-By: Claude Opus 5 (1M context) --- apps/sim/lib/copilot/docs/docs-search.test.ts | 55 ++++++++++++++++++- apps/sim/lib/copilot/docs/docs-search.ts | 48 ++++++++++++++-- .../copilot/tools/server/docs/search-docs.ts | 43 ++++++++++++++- 3 files changed, 134 insertions(+), 12 deletions(-) diff --git a/apps/sim/lib/copilot/docs/docs-search.test.ts b/apps/sim/lib/copilot/docs/docs-search.test.ts index 8407f2e336f..c0981a22a82 100644 --- a/apps/sim/lib/copilot/docs/docs-search.test.ts +++ b/apps/sim/lib/copilot/docs/docs-search.test.ts @@ -124,7 +124,7 @@ describe('searchDocs results', () => { similarity: 0.8, }, ] - const results = await searchDocs('cron') + const { results } = await searchDocs('cron') expect(results).toEqual([ { path: 'docs/workflows.mdx', @@ -153,7 +153,7 @@ describe('searchDocs results', () => { similarity: 0.9, }, ] - expect(await searchDocs('cron')).toEqual([]) + expect((await searchDocs('cron')).results).toEqual([]) }) it('drops chunks below the similarity threshold', async () => { @@ -166,6 +166,55 @@ describe('searchDocs results', () => { similarity: 0.1, }, ] - expect(await searchDocs('cron')).toEqual([]) + expect((await searchDocs('cron')).results).toEqual([]) + }) +}) + +describe('searchDocs shortfall reporting', () => { + beforeEach(() => { + capturedWhere.value = undefined + mockGenerateSearchEmbedding.mockResolvedValue({ embedding: [0.1, 0.2] }) + }) + + it('counts why candidates were dropped so an empty set is explainable', async () => { + mockRows.value = [ + { + chunkText: 'a', + sourceDocument: 'agents.mdx', + sourceLink: 'x', + headerText: 'h', + similarity: 0.1, + }, + { + chunkText: 'b', + sourceDocument: 'deleted-page.mdx', + sourceLink: 'y', + headerText: 'h', + similarity: 0.9, + }, + ] + const outcome = await searchDocs('cron') + expect(outcome).toEqual({ + results: [], + candidatesConsidered: 2, + droppedBelowThreshold: 1, + droppedStale: 1, + }) + }) + + it('reports no drops when every candidate survives', async () => { + mockRows.value = [ + { + chunkText: 'a', + sourceDocument: 'agents.mdx', + sourceLink: 'x', + headerText: 'h', + similarity: 0.9, + }, + ] + const outcome = await searchDocs('cron') + expect(outcome.droppedBelowThreshold).toBe(0) + expect(outcome.droppedStale).toBe(0) + expect(outcome.results).toHaveLength(1) }) }) diff --git a/apps/sim/lib/copilot/docs/docs-search.ts b/apps/sim/lib/copilot/docs/docs-search.ts index 37679cc867b..e30145d3a3e 100644 --- a/apps/sim/lib/copilot/docs/docs-search.ts +++ b/apps/sim/lib/copilot/docs/docs-search.ts @@ -27,6 +27,21 @@ export interface DocsSearchResult { * section in the docs corpus. Surfaced verbatim so the model can correct itself * rather than reading an empty result as "the docs say nothing about this". */ +/** + * A search result set plus why it may be shorter than `topK`. The SQL LIMIT is + * applied before the threshold and liveness filters, so these counts are what + * distinguishes "nothing matched" from "matches were filtered out". + */ +export interface DocsSearchOutcome { + results: DocsSearchResult[] + /** Rows the vector search returned before filtering. */ + candidatesConsidered: number + /** Candidates dropped for scoring below the similarity threshold. */ + droppedBelowThreshold: number + /** Candidates dropped because their page is no longer in the docs manifest. */ + droppedStale: number +} + export class DocsSearchScopeError extends Error { readonly code = 'DOCS_SEARCH_SCOPE' as const constructor(message: string) { @@ -94,11 +109,16 @@ function escapeLikePattern(value: string): string { * The index lags the VFS: a page added since the last index rebuild is readable * but not searchable, and a deleted one can still return chunks. Results whose * source no longer maps to a live `docs/` path are dropped. + * + * Because those drops happen after the SQL LIMIT, a caller can get fewer hits + * than it asked for — or none at all when every candidate was filtered. The + * returned {@link DocsSearchOutcome} reports that explicitly so an empty result + * is never mistaken for "the documentation does not cover this". */ export async function searchDocs( query: string, options?: { path?: string; topK?: number } -): Promise { +): Promise { if (!query || typeof query !== 'string') throw new Error('query is required') const topK = Math.min(Math.max(Math.trunc(options?.topK ?? DEFAULT_TOP_K), 1), MAX_TOP_K) @@ -107,7 +127,9 @@ export async function searchDocs( logger.info('Executing docs search', { query, topK, path: options?.path ?? null }) const { embedding: queryEmbedding } = await generateSearchEmbedding(query) - if (!queryEmbedding || queryEmbedding.length === 0) return [] + if (!queryEmbedding || queryEmbedding.length === 0) { + return { results: [], candidatesConsidered: 0, droppedBelowThreshold: 0, droppedStale: 0 } + } const rows = await db .select({ @@ -123,10 +145,18 @@ export async function searchDocs( .limit(topK) const results: DocsSearchResult[] = [] + let droppedBelowThreshold = 0 + let droppedStale = 0 for (const row of rows) { - if (row.similarity < SIMILARITY_THRESHOLD) continue + if (row.similarity < SIMILARITY_THRESHOLD) { + droppedBelowThreshold++ + continue + } const path = docsPathForSourceDocument(row.sourceDocument) - if (!path) continue + if (!path) { + droppedStale++ + continue + } results.push({ path, url: String(row.sourceLink || '#'), @@ -138,7 +168,13 @@ export async function searchDocs( logger.info('Docs search complete', { count: results.length, - dropped: rows.length - results.length, + droppedBelowThreshold, + droppedStale, }) - return results + return { + results, + candidatesConsidered: rows.length, + droppedBelowThreshold, + droppedStale, + } } diff --git a/apps/sim/lib/copilot/tools/server/docs/search-docs.ts b/apps/sim/lib/copilot/tools/server/docs/search-docs.ts index cf88c0bfa1b..96bdc922e2c 100644 --- a/apps/sim/lib/copilot/tools/server/docs/search-docs.ts +++ b/apps/sim/lib/copilot/tools/server/docs/search-docs.ts @@ -1,3 +1,4 @@ +import type { DocsSearchResult } from '@/lib/copilot/docs/docs-search' import { searchDocs } from '@/lib/copilot/docs/docs-search' import { SearchDocs } from '@/lib/copilot/generated/tool-catalog-v1' import type { BaseServerTool } from '@/lib/copilot/tools/server/base-tool' @@ -9,9 +10,39 @@ interface SearchDocsParams { } interface SearchDocsOutput { - results: Awaited> + results: DocsSearchResult[] query: string totalResults: number + /** + * Present only when the vector search matched chunks that were then filtered + * out. Without it an empty result set reads as "the docs do not cover this", + * which sends the caller off to guess instead of rephrasing or falling back + * to glob. + */ + note?: string +} + +/** + * Explain a short or empty result set in terms the caller can act on. Returns + * undefined when nothing was dropped — the common case needs no commentary. + */ +function shortfallNote(outcome: Awaited>): string | undefined { + const { results, candidatesConsidered, droppedBelowThreshold, droppedStale } = outcome + if (droppedBelowThreshold === 0 && droppedStale === 0) return undefined + + const reasons: string[] = [] + if (droppedBelowThreshold > 0) + reasons.push(`${droppedBelowThreshold} scored too low to be relevant`) + if (droppedStale > 0) { + reasons.push( + `${droppedStale} point at pages no longer in the docs (the search index lags the site)` + ) + } + const dropped = reasons.join(' and ') + + return results.length === 0 + ? `No relevant matches. The search index returned ${candidatesConsidered} candidate(s), but ${dropped} — this does NOT mean the docs lack this topic. Rephrase the query, widen it by dropping the path scope, or browse with glob("docs/**").` + : `Returned ${results.length} of ${candidatesConsidered} candidate(s); ${dropped}. Rephrase or widen the query if these look off-topic.` } /** @@ -22,7 +53,13 @@ interface SearchDocsOutput { export const searchDocsServerTool: BaseServerTool = { name: SearchDocs.id, async execute(params: SearchDocsParams): Promise { - const results = await searchDocs(params.query, { path: params.path, topK: params.topK }) - return { results, query: params.query, totalResults: results.length } + const outcome = await searchDocs(params.query, { path: params.path, topK: params.topK }) + const note = shortfallNote(outcome) + return { + results: outcome.results, + query: params.query, + totalResults: outcome.results.length, + ...(note ? { note } : {}), + } }, } From 32e07e52c6408b77e0ebbe30cdaa340ba62e47cd Mon Sep 17 00:00:00 2001 From: Justin Blumencranz <96924014+j15z@users.noreply.github.com> Date: Fri, 24 Jul 2026 18:02:29 -0700 Subject: [PATCH 08/32] fix(copilot): include a section overview in either layout when scoping search MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit A directory scope matched only `
/%`, which covers an overview stored as `
/index.mdx` but not one stored as a sibling `
.mdx`. Fumadocs accepts both layouts and page scope already handles both via docsSourceCandidates, so a scoped section search could silently omit the overview chunks — and the doc comment claimed it did not. Every section in the tree currently uses the index.mdx layout, so nothing is broken today; this closes the gap before someone adds a sibling overview and gets quietly incomplete results. --- apps/sim/lib/copilot/docs/docs-search.test.ts | 9 +++++++++ apps/sim/lib/copilot/docs/docs-search.ts | 11 +++++++++-- 2 files changed, 18 insertions(+), 2 deletions(-) diff --git a/apps/sim/lib/copilot/docs/docs-search.test.ts b/apps/sim/lib/copilot/docs/docs-search.test.ts index c0981a22a82..5c1a288487e 100644 --- a/apps/sim/lib/copilot/docs/docs-search.test.ts +++ b/apps/sim/lib/copilot/docs/docs-search.test.ts @@ -89,6 +89,15 @@ describe('searchDocs path scoping', () => { expect(whereText()).toContain('workflows/%') }) + it('includes a section overview stored in either on-disk layout', async () => { + await searchDocs('cron', { path: 'docs/workflows' }) + const text = whereText() + // `workflows/index.mdx` is inside the subtree; a sibling `workflows.mdx` is not, + // and fumadocs accepts either, so the scope must name it explicitly. + expect(text).toContain('workflows/%') + expect(text).toContain('workflows.mdx') + }) + it('rejects a path outside the docs corpus', async () => { await expect(searchDocs('cron', { path: 'files/report.pdf' })).rejects.toThrow( DocsSearchScopeError diff --git a/apps/sim/lib/copilot/docs/docs-search.ts b/apps/sim/lib/copilot/docs/docs-search.ts index e30145d3a3e..9c545b40d60 100644 --- a/apps/sim/lib/copilot/docs/docs-search.ts +++ b/apps/sim/lib/copilot/docs/docs-search.ts @@ -56,7 +56,7 @@ export class DocsSearchScopeError extends Error { * `source_document` stores the en-relative mdx file path, while VFS paths mirror * the public URL — so a section overview is `docs/workflows.mdx` in the VFS but * `workflows/index.mdx` (or `workflows.mdx`) on disk. A directory scope covers - * the whole subtree, including that overview page. + * the whole subtree plus the overview in either layout. * * Returns undefined for an unscoped search, which excludes `academy/` and * `api-reference/`: both are indexed but neither is mounted in the VFS, so a hit @@ -89,7 +89,14 @@ function scopeCondition(path?: string) { } if (isDocsDir(normalized)) { - return like(docsEmbeddings.sourceDocument, `${escapeLikePattern(tail)}/%`) + // Everything under the directory, PLUS a sibling `.mdx`. Fumadocs + // accepts either layout for a section overview and only `/index.mdx` + // is inside the subtree, so matching the prefix alone would silently omit + // the overview for the sibling layout — page scope already covers both. + return or( + like(docsEmbeddings.sourceDocument, `${escapeLikePattern(tail)}/%`), + eq(docsEmbeddings.sourceDocument, `${tail}.mdx`) + ) } throw new DocsSearchScopeError( From 7fdce7134818122407aa4729c17263bd327c96aa Mon Sep 17 00:00:00 2001 From: Justin Blumencranz <96924014+j15z@users.noreply.github.com> Date: Fri, 24 Jul 2026 18:27:39 -0700 Subject: [PATCH 09/32] fix(copilot): make the search_docs topK clamp type-safe and test it MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The clamp guarded magnitude but not type: Math.min/Math.max propagate NaN, so a non-numeric topK reached the query as `.limit(NaN)`. The `?? DEFAULT` only caught undefined. Nothing enforced this but the generated Ajv schema, and searchDocs is also called directly, so it should not depend on that. Extract clampTopK, which falls back to the default for anything non-finite (NaN, Infinity, a string that slipped through) and clamps the rest to [1, 25]. The clamp was completely untested because the db mock's .limit() stub discarded its argument — the mock now records it. Covers default, cap, floor, truncation, and the non-finite fallback. Worth pinning: staging's search_documentation documented "max 10" and enforced nothing, so this bound is new behavior, not just a bigger number. --- apps/sim/lib/copilot/docs/docs-search.test.ts | 50 ++++++++++++++++++- apps/sim/lib/copilot/docs/docs-search.ts | 15 +++++- 2 files changed, 62 insertions(+), 3 deletions(-) diff --git a/apps/sim/lib/copilot/docs/docs-search.test.ts b/apps/sim/lib/copilot/docs/docs-search.test.ts index 5c1a288487e..a78672d52d6 100644 --- a/apps/sim/lib/copilot/docs/docs-search.test.ts +++ b/apps/sim/lib/copilot/docs/docs-search.test.ts @@ -3,9 +3,10 @@ */ import { beforeEach, describe, expect, it, vi } from 'vitest' -const { mockGenerateSearchEmbedding, capturedWhere, mockRows } = vi.hoisted(() => ({ +const { mockGenerateSearchEmbedding, capturedWhere, capturedLimit, mockRows } = vi.hoisted(() => ({ mockGenerateSearchEmbedding: vi.fn(), capturedWhere: { value: undefined as unknown }, + capturedLimit: { value: undefined as number | undefined }, mockRows: { value: [] as unknown[] }, })) @@ -38,7 +39,12 @@ vi.mock('@sim/db', () => ({ where: (condition: unknown) => { capturedWhere.value = condition return { - orderBy: () => ({ limit: async () => mockRows.value }), + orderBy: () => ({ + limit: async (n: number) => { + capturedLimit.value = n + return mockRows.value + }, + }), } }, }), @@ -227,3 +233,43 @@ describe('searchDocs shortfall reporting', () => { expect(outcome.results).toHaveLength(1) }) }) + +describe('searchDocs topK clamping', () => { + beforeEach(() => { + capturedLimit.value = undefined + mockRows.value = [] + mockGenerateSearchEmbedding.mockResolvedValue({ embedding: [0.1, 0.2] }) + }) + + it('defaults to 10 when unspecified', async () => { + await searchDocs('cron') + expect(capturedLimit.value).toBe(10) + }) + + it('caps at 25 — the documented max, which the old tool never enforced', async () => { + await searchDocs('cron', { topK: 500 }) + expect(capturedLimit.value).toBe(25) + }) + + it('floors at 1', async () => { + await searchDocs('cron', { topK: 0 }) + expect(capturedLimit.value).toBe(1) + await searchDocs('cron', { topK: -8 }) + expect(capturedLimit.value).toBe(1) + }) + + it('truncates a fractional count', async () => { + await searchDocs('cron', { topK: 7.9 }) + expect(capturedLimit.value).toBe(7) + }) + + it('falls back to the default rather than passing NaN to the query', async () => { + // Math.min/Math.max propagate NaN, so a bare clamp would reach `.limit(NaN)`. + await searchDocs('cron', { topK: Number.NaN }) + expect(capturedLimit.value).toBe(10) + await searchDocs('cron', { topK: 'twelve' as unknown as number }) + expect(capturedLimit.value).toBe(10) + await searchDocs('cron', { topK: Number.POSITIVE_INFINITY }) + expect(capturedLimit.value).toBe(10) + }) +}) diff --git a/apps/sim/lib/copilot/docs/docs-search.ts b/apps/sim/lib/copilot/docs/docs-search.ts index 9c545b40d60..2b77e0f0f67 100644 --- a/apps/sim/lib/copilot/docs/docs-search.ts +++ b/apps/sim/lib/copilot/docs/docs-search.ts @@ -108,6 +108,19 @@ function escapeLikePattern(value: string): string { return value.replace(/[\\%_]/g, (char) => `\\${char}`) } +/** + * Clamp a caller-supplied result count into [1, {@link MAX_TOP_K}]. + * + * Guards magnitude AND type: `Math.min`/`Math.max` propagate NaN, so a + * non-numeric value would otherwise reach the query as `.limit(NaN)`. The + * generated tool schema rejects a non-number upstream today, but this function + * is also called directly, so it does not rely on that. + */ +function clampTopK(requested: number | undefined): number { + if (requested === undefined || !Number.isFinite(requested)) return DEFAULT_TOP_K + return Math.min(Math.max(Math.trunc(requested), 1), MAX_TOP_K) +} + /** * Semantic search over the indexed docs corpus (`docs_embeddings`, rebuilt by * `scripts/process-docs.ts` on release). Every result carries the `docs/` path @@ -128,7 +141,7 @@ export async function searchDocs( ): Promise { if (!query || typeof query !== 'string') throw new Error('query is required') - const topK = Math.min(Math.max(Math.trunc(options?.topK ?? DEFAULT_TOP_K), 1), MAX_TOP_K) + const topK = clampTopK(options?.topK) const where = scopeCondition(options?.path) logger.info('Executing docs search', { query, topK, path: options?.path ?? null }) From b175d0a172118951570665ddc44a7dd00f0a4406 Mon Sep 17 00:00:00 2001 From: Justin Blumencranz <96924014+j15z@users.noreply.github.com> Date: Fri, 24 Jul 2026 19:08:16 -0700 Subject: [PATCH 10/32] fix(copilot): restore the query in search_docs tool chips MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Chips read "Searched docs" with no indication of what was searched. The query-aware title existed earlier on this branch and this commit's own predecessor dropped it: removing search_docs from the catalog deleted the display case and its test, and putting the tool back only restored the static map entry. The generic "every visible catalog tool has a title" assertion still passed, because it checks that a title exists, not that it is the useful one. Chips now read: Searching docs for "how to read workflow logs and view executions" -> Searched docs for "...". The gerund flip already preserves the suffix, so the completed state needs no extra handling — the test now pins that too, since it was the part most likely to regress silently. --- .../lib/copilot/tools/tool-display.test.ts | 20 +++++++++++++++++++ apps/sim/lib/copilot/tools/tool-display.ts | 6 +++++- 2 files changed, 25 insertions(+), 1 deletion(-) diff --git a/apps/sim/lib/copilot/tools/tool-display.test.ts b/apps/sim/lib/copilot/tools/tool-display.test.ts index 027ce68d915..24b7be3681f 100644 --- a/apps/sim/lib/copilot/tools/tool-display.test.ts +++ b/apps/sim/lib/copilot/tools/tool-display.test.ts @@ -78,6 +78,26 @@ describe('getToolDisplayTitle natural-language coverage', () => { expect(getToolDisplayTitle('diff_workflows')).toBe('Comparing workflows') }) + it('includes the query in search_docs titles', () => { + expect(getToolDisplayTitle('search_docs')).toBe('Searching docs') + expect(getToolDisplayTitle('search_docs', { query: 'loop blocks iteration' })).toBe( + 'Searching docs for "loop blocks iteration"' + ) + // The completed-state flip must keep the suffix, not drop back to the bare label. + expect( + getToolCompletedTitle( + getToolDisplayTitle('search_docs', { query: 'how to read workflow logs' }) + ) + ).toBe('Searched docs for "how to read workflow logs"') + // A long agent-written query is truncated rather than blowing out the chip. + expect( + getToolDisplayTitle('search_docs', { + query: + 'reference block outputs connection tags blockname.field pass data between blocks in a workflow', + })?.length + ).toBeLessThanOrEqual('Searching docs for ""'.length + 60 + '...'.length) + }) + it('falls back to running code for function_execute without a title', () => { expect(getToolDisplayTitle('function_execute')).toBe('Running code') expect(getToolDisplayTitle('function_execute', { title: 'Crunching numbers' })).toBe( diff --git a/apps/sim/lib/copilot/tools/tool-display.ts b/apps/sim/lib/copilot/tools/tool-display.ts index 91c2a00ebdc..58f5de96f23 100644 --- a/apps/sim/lib/copilot/tools/tool-display.ts +++ b/apps/sim/lib/copilot/tools/tool-display.ts @@ -1,4 +1,4 @@ -import { stripVersionSuffix } from '@sim/utils/string' +import { stripVersionSuffix, truncate } from '@sim/utils/string' /** * Single source of truth for copilot tool-call display titles. @@ -803,6 +803,10 @@ export function getToolDisplayTitle(name: string, args?: Record const target = firstStringArg(args, 'toolTitle', 'title') return target ? `Searching online for ${target}` : 'Searching online' } + case 'search_docs': { + const target = firstStringArg(args, 'toolTitle', 'title', 'query') + return target ? `Searching docs for "${truncate(target, 60)}"` : 'Searching docs' + } case 'grep': { const target = firstStringArg(args, 'toolTitle', 'title') return target ? `Searching for ${target}` : 'Searching' From bb65387bdbb78d5573814a3b08bc604549d311c4 Mon Sep 17 00:00:00 2001 From: Justin Blumencranz <96924014+j15z@users.noreply.github.com> Date: Tue, 28 Jul 2026 15:33:39 -0700 Subject: [PATCH 11/32] improvement(copilot): share the unmounted-docs list, shrink the search default MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Two places decide what the docs/ corpus is: the manifest generator (what is readable) and the vector search's unscoped filter (what is findable). They each carried their own copy of the excluded-section list. If they drift, a hit in a section that is indexed but not mounted comes back as a chunk the agent cannot then read — dropped as stale, silently shrinking the result set. UNMOUNTED_DOCS_SECTIONS is now the one list both import. search_docs returns 5 chunks by default instead of 10; raise topK when a pass genuinely comes back thin. A truncated docs page now routes to one more fetch instead of two. grep and read cost the same single uncached fetch of the page, so grep is an alternative to a read here, never a step after one. Co-Authored-By: Claude Opus 5 (1M context) --- apps/sim/lib/copilot/docs/docs-path.ts | 22 +++++++++++++++++++ apps/sim/lib/copilot/docs/docs-search.test.ts | 10 ++++----- apps/sim/lib/copilot/docs/docs-search.ts | 15 +++++++------ apps/sim/lib/copilot/tools/handlers/vfs.ts | 6 ++++- scripts/sync-docs-manifest.ts | 17 +++++++++----- 5 files changed, 51 insertions(+), 19 deletions(-) diff --git a/apps/sim/lib/copilot/docs/docs-path.ts b/apps/sim/lib/copilot/docs/docs-path.ts index 650fd2977ac..b4e5ff66bc1 100644 --- a/apps/sim/lib/copilot/docs/docs-path.ts +++ b/apps/sim/lib/copilot/docs/docs-path.ts @@ -15,6 +15,28 @@ /** Suffix that marks a section overview page on disk. */ export const DOCS_INDEX_SUFFIX = '/index.mdx' +/** + * Top-level docs sections deliberately left out of the copilot's `docs/` tree. + * + * Two places must agree on this list or the corpus goes subtly wrong: the + * manifest generator (which decides what is readable) and the vector search's + * unscoped filter (which decides what is findable). If search still matched an + * unmounted section, every hit there would be a chunk the agent cannot then + * `read` — dropped as stale, silently shrinking the result set. + * + * Mounting a section later is not uniform work, so plan per section: + * - `academy` is plain mdx under `apps/docs/content/docs/en/academy` and is + * already indexed in `docs_embeddings` — removing it here and regenerating + * the manifest is the whole change. + * - `api-reference` is mostly generated from `apps/docs/openapi.json` at build + * time, so its pages have no source mdx for the generator to walk (only the + * four handwritten ones: authentication, getting-started, python, typescript). + * Mounting it properly needs the spec served publicly again — the + * `apps/docs/app/openapi.json` route existed for exactly this and was + * reverted — plus a generator branch that walks the spec's tags. + */ +export const UNMOUNTED_DOCS_SECTIONS = ['academy', 'api-reference'] as const + /** * Fold an `en`-relative mdx file path onto its public path — the value used as * both the `docs/`-relative VFS path and the docs.sim.ai URL path. diff --git a/apps/sim/lib/copilot/docs/docs-search.test.ts b/apps/sim/lib/copilot/docs/docs-search.test.ts index a78672d52d6..5b2bf75f23d 100644 --- a/apps/sim/lib/copilot/docs/docs-search.test.ts +++ b/apps/sim/lib/copilot/docs/docs-search.test.ts @@ -241,9 +241,9 @@ describe('searchDocs topK clamping', () => { mockGenerateSearchEmbedding.mockResolvedValue({ embedding: [0.1, 0.2] }) }) - it('defaults to 10 when unspecified', async () => { + it('defaults to 5 when unspecified', async () => { await searchDocs('cron') - expect(capturedLimit.value).toBe(10) + expect(capturedLimit.value).toBe(5) }) it('caps at 25 — the documented max, which the old tool never enforced', async () => { @@ -266,10 +266,10 @@ describe('searchDocs topK clamping', () => { it('falls back to the default rather than passing NaN to the query', async () => { // Math.min/Math.max propagate NaN, so a bare clamp would reach `.limit(NaN)`. await searchDocs('cron', { topK: Number.NaN }) - expect(capturedLimit.value).toBe(10) + expect(capturedLimit.value).toBe(5) await searchDocs('cron', { topK: 'twelve' as unknown as number }) - expect(capturedLimit.value).toBe(10) + expect(capturedLimit.value).toBe(5) await searchDocs('cron', { topK: Number.POSITIVE_INFINITY }) - expect(capturedLimit.value).toBe(10) + expect(capturedLimit.value).toBe(5) }) }) diff --git a/apps/sim/lib/copilot/docs/docs-search.ts b/apps/sim/lib/copilot/docs/docs-search.ts index 2b77e0f0f67..93e5b2f208f 100644 --- a/apps/sim/lib/copilot/docs/docs-search.ts +++ b/apps/sim/lib/copilot/docs/docs-search.ts @@ -3,13 +3,13 @@ import { docsEmbeddings } from '@sim/db/schema' import { createLogger } from '@sim/logger' import { and, eq, like, notLike, or, sql } from 'drizzle-orm' import { docsPathForSourceDocument, isDocsDir, isDocsPage } from '@/lib/copilot/docs/docs-corpus' -import { docsSourceCandidates } from '@/lib/copilot/docs/docs-path' +import { docsSourceCandidates, UNMOUNTED_DOCS_SECTIONS } from '@/lib/copilot/docs/docs-path' import { generateSearchEmbedding } from '@/lib/knowledge/embeddings' const logger = createLogger('DocsSearch') const SIMILARITY_THRESHOLD = 0.3 -const DEFAULT_TOP_K = 10 +const DEFAULT_TOP_K = 5 const MAX_TOP_K = 25 export interface DocsSearchResult { @@ -58,16 +58,17 @@ export class DocsSearchScopeError extends Error { * `workflows/index.mdx` (or `workflows.mdx`) on disk. A directory scope covers * the whole subtree plus the overview in either layout. * - * Returns undefined for an unscoped search, which excludes `academy/` and - * `api-reference/`: both are indexed but neither is mounted in the VFS, so a hit - * there would be a chunk the agent cannot then read. + * An unscoped search excludes every {@link UNMOUNTED_DOCS_SECTIONS} section: + * they are indexed but not mounted in the VFS, so a hit there would be a chunk + * the agent cannot then read. */ function scopeCondition(path?: string) { const normalized = (path ?? '').trim().replace(/^\/+/, '').replace(/\/+$/, '') if (normalized === '' || normalized === 'docs') { return and( - notLike(docsEmbeddings.sourceDocument, 'academy/%'), - notLike(docsEmbeddings.sourceDocument, 'api-reference/%') + ...UNMOUNTED_DOCS_SECTIONS.map((section) => + notLike(docsEmbeddings.sourceDocument, `${section}/%`) + ) ) } diff --git a/apps/sim/lib/copilot/tools/handlers/vfs.ts b/apps/sim/lib/copilot/tools/handlers/vfs.ts index e364cefd0cc..ee2559b02c0 100644 --- a/apps/sim/lib/copilot/tools/handlers/vfs.ts +++ b/apps/sim/lib/copilot/tools/handlers/vfs.ts @@ -144,8 +144,12 @@ function truncateDocsPageToInlineCap(page: { content: string; totalLines: number returnedLines: number } { const lines = page.content.split('\n') + // Route to ONE more fetch, not two. Telling the model to grep and then read + // costs two more uncached fetches of a page it already partly has; grep and + // read cost the same single fetch, so grep is an alternative to a read here, + // never a step before one. const notice = (shown: number) => - `\n\n[Page truncated: showing lines 1-${shown} of ${page.totalLines}. Grep this path for the section you need, then read with offset/limit.]` + `\n\n[Page truncated: returned lines 1-${shown} of ${page.totalLines}. To continue, read this path with offset: ${shown}. To jump straight to a section, grep this path INSTEAD of reading it — grep is the same single fetch and returns only matching lines with their numbers.]` let kept = lines.length let content = page.content diff --git a/scripts/sync-docs-manifest.ts b/scripts/sync-docs-manifest.ts index fa1f0ddcd81..7373a72e26c 100644 --- a/scripts/sync-docs-manifest.ts +++ b/scripts/sync-docs-manifest.ts @@ -15,9 +15,10 @@ * into their parent URL; `/workflows/index.mdx` * is a 404 on the site) * - * Excluded, and intentionally absent from the VFS: `academy/` and - * `api-reference/` (fetch those with the scrape tool if ever needed), the root - * `index.mdx` (its URL is `/`, which redirects), and every non-`en` locale. + * Excluded, and intentionally absent from the VFS: every section in + * `UNMOUNTED_DOCS_SECTIONS` (fetch those with the scrape tool if ever needed), + * the root `index.mdx` (its URL is `/`, which redirects), and every non-`en` + * locale. * * Usage: * bun run docs-manifest:generate # write the manifest @@ -26,7 +27,7 @@ import { readdir, readFile, writeFile } from 'node:fs/promises' import { dirname, resolve } from 'node:path' import { fileURLToPath } from 'node:url' -import { foldDocsIndexPath } from '../apps/sim/lib/copilot/docs/docs-path' +import { foldDocsIndexPath, UNMOUNTED_DOCS_SECTIONS } from '../apps/sim/lib/copilot/docs/docs-path' import { formatGeneratedSource } from './format-generated-source' const SCRIPT_DIR = dirname(fileURLToPath(import.meta.url)) @@ -34,8 +35,12 @@ const ROOT = resolve(SCRIPT_DIR, '..') const DOCS_CONTENT_DIR = resolve(ROOT, 'apps/docs/content/docs/en') const OUTPUT_PATH = resolve(ROOT, 'apps/sim/lib/copilot/generated/docs-manifest.ts') -/** Top-level docs sections deliberately left out of the copilot's `docs/` tree. */ -const EXCLUDED_SECTIONS = new Set(['academy', 'api-reference']) +/** + * Top-level docs sections deliberately left out of the copilot's `docs/` tree. + * Shared with the vector search's unscoped filter so readability and + * findability cannot drift apart — see `UNMOUNTED_DOCS_SECTIONS`. + */ +const EXCLUDED_SECTIONS = new Set(UNMOUNTED_DOCS_SECTIONS) /** Collect every `.mdx` file under `dir`, as paths relative to {@link DOCS_CONTENT_DIR}. */ async function collectMdxPaths(dir: string, prefix = ''): Promise { From 8dd7bf6a5e27428daa6b695187a223202104caa0 Mon Sep 17 00:00:00 2001 From: Justin Blumencranz <96924014+j15z@users.noreply.github.com> Date: Tue, 28 Jul 2026 16:53:43 -0700 Subject: [PATCH 12/32] chore(copilot): regenerate the tool catalog for the retired quick-reference tool Picks up get_platform_actions' hidden/retired description from mothership. The id stays in the catalog so isKnownTool keeps routing calls from an older build during a mixed deploy; the handler is unchanged. Co-Authored-By: Claude Opus 5 (1M context) --- apps/sim/lib/copilot/generated/tool-catalog-v1.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/apps/sim/lib/copilot/generated/tool-catalog-v1.ts b/apps/sim/lib/copilot/generated/tool-catalog-v1.ts index 3d522d70351..54bb070eeca 100644 --- a/apps/sim/lib/copilot/generated/tool-catalog-v1.ts +++ b/apps/sim/lib/copilot/generated/tool-catalog-v1.ts @@ -3032,6 +3032,7 @@ export const GetPlatformActions: ToolCatalogEntry = { route: 'sim', mode: 'async', parameters: { type: 'object', properties: {} }, + hidden: true, } export const GetWorkflowData: ToolCatalogEntry = { From 2bb974c2f59a0aa1b460b7a270718a856c250088 Mon Sep 17 00:00:00 2001 From: Justin Blumencranz <96924014+j15z@users.noreply.github.com> Date: Tue, 28 Jul 2026 18:50:53 -0700 Subject: [PATCH 13/32] fix(review): attach the scope-error TSDoc to the class it documents Two TSDoc blocks sat back to back above DocsSearchOutcome; the first describes DocsSearchScopeError, which had no doc comment of its own. Moved it to the class. Co-Authored-By: Claude Opus 5 (1M context) --- apps/sim/lib/copilot/docs/docs-search.ts | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/apps/sim/lib/copilot/docs/docs-search.ts b/apps/sim/lib/copilot/docs/docs-search.ts index 93e5b2f208f..db45bb66990 100644 --- a/apps/sim/lib/copilot/docs/docs-search.ts +++ b/apps/sim/lib/copilot/docs/docs-search.ts @@ -22,11 +22,6 @@ export interface DocsSearchResult { similarity: number } -/** - * Thrown when the caller scopes a search to a `path` that is not a real page or - * section in the docs corpus. Surfaced verbatim so the model can correct itself - * rather than reading an empty result as "the docs say nothing about this". - */ /** * A search result set plus why it may be shorter than `topK`. The SQL LIMIT is * applied before the threshold and liveness filters, so these counts are what @@ -42,6 +37,11 @@ export interface DocsSearchOutcome { droppedStale: number } +/** + * Thrown when the caller scopes a search to a `path` that is not a real page or + * section in the docs corpus. Surfaced verbatim so the model can correct itself + * rather than reading an empty result as "the docs say nothing about this". + */ export class DocsSearchScopeError extends Error { readonly code = 'DOCS_SEARCH_SCOPE' as const constructor(message: string) { From ae25efdc61a5da35c27dfd3f4fd62cef864fbd90 Mon Sep 17 00:00:00 2001 From: Justin Blumencranz <96924014+j15z@users.noreply.github.com> Date: Wed, 29 Jul 2026 09:53:23 -0700 Subject: [PATCH 14/32] =?UTF-8?q?fix(review):=20harden=20docs=20corpus=20e?= =?UTF-8?q?dges=20=E2=80=94=20trailing-slash=20glob,=20root-index=20drops,?= =?UTF-8?q?=20oversized-line=20reads?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Review findings applied from the multi-agent pass on this branch: - glob("docs/") matched no key and silently returned empty; normalize now strips trailing slashes so it resolves like "docs" - unscoped search_docs no longer returns root-homepage chunks that would only be counted against topK and then dropped as stale (the manifest deliberately omits index.mdx) - a docs page whose single line exceeds the inline cap now fails with grep guidance instead of returning an over-cap payload as success - test coverage for the vfs docs routing (glob/read/grep dispatch, DocsCorpusError surfacing, truncation paths), the search_docs server tool's shortfall notes, the empty-embedding outcome, and the inert @docs context Co-Authored-By: Claude Fable 5 --- .../lib/copilot/chat/process-contents.test.ts | 17 +++ apps/sim/lib/copilot/docs/docs-corpus.test.ts | 5 + apps/sim/lib/copilot/docs/docs-corpus.ts | 5 +- apps/sim/lib/copilot/docs/docs-search.test.ts | 18 +++ apps/sim/lib/copilot/docs/docs-search.ts | 8 +- .../lib/copilot/tools/handlers/vfs.test.ts | 108 +++++++++++++++++- apps/sim/lib/copilot/tools/handlers/vfs.ts | 19 ++- .../tools/server/docs/search-docs.test.ts | 102 +++++++++++++++++ 8 files changed, 272 insertions(+), 10 deletions(-) create mode 100644 apps/sim/lib/copilot/tools/server/docs/search-docs.test.ts diff --git a/apps/sim/lib/copilot/chat/process-contents.test.ts b/apps/sim/lib/copilot/chat/process-contents.test.ts index 6570628e3bb..f36f755f587 100644 --- a/apps/sim/lib/copilot/chat/process-contents.test.ts +++ b/apps/sim/lib/copilot/chat/process-contents.test.ts @@ -282,6 +282,23 @@ describe('processContextsServer - skill contexts', () => { }) }) +describe('processContextsServer - docs contexts', () => { + beforeEach(() => { + vi.clearAllMocks() + }) + + it('resolves a tagged docs context to nothing while @docs tagging is disabled', async () => { + const result = await processContextsServer( + [{ kind: 'docs', label: 'Docs' } as ChatContext], + 'user-1', + 'how do loops work @Docs', + 'ws-1' + ) + + expect(result).toEqual([]) + }) +}) + describe('processContextsServer - MCP contexts', () => { beforeEach(() => { vi.clearAllMocks() diff --git a/apps/sim/lib/copilot/docs/docs-corpus.test.ts b/apps/sim/lib/copilot/docs/docs-corpus.test.ts index 31117855a08..f3dd5a8f4ad 100644 --- a/apps/sim/lib/copilot/docs/docs-corpus.test.ts +++ b/apps/sim/lib/copilot/docs/docs-corpus.test.ts @@ -58,6 +58,11 @@ describe('globDocs', () => { expect(globDocs('docs/workflows.mdx')).toEqual(['docs/workflows.mdx']) expect(globDocs('docs/workflows/index.mdx')).toEqual([]) }) + + it('treats a trailing-slash pattern like the bare directory instead of matching nothing', () => { + expect(globDocs('docs/')).toEqual(['docs']) + expect(globDocs('docs/integrations/')).toEqual(['docs/integrations']) + }) }) describe('readDocsPage', () => { diff --git a/apps/sim/lib/copilot/docs/docs-corpus.ts b/apps/sim/lib/copilot/docs/docs-corpus.ts index 16a202a4f84..5b8bcbc3213 100644 --- a/apps/sim/lib/copilot/docs/docs-corpus.ts +++ b/apps/sim/lib/copilot/docs/docs-corpus.ts @@ -38,7 +38,10 @@ const docsKeyView: Map = new Map( ) function normalize(path: string): string { - return path.trim().replace(/^\/+/, '') + // Trailing slashes are stripped so `docs/` addresses the corpus the same way + // `docs` does — otherwise a trailing-slash glob pattern matches no key and + // silently returns an empty result instead of the corpus listing. + return path.trim().replace(/^\/+/, '').replace(/\/+$/, '') } /** diff --git a/apps/sim/lib/copilot/docs/docs-search.test.ts b/apps/sim/lib/copilot/docs/docs-search.test.ts index 5b2bf75f23d..5920c0d9fef 100644 --- a/apps/sim/lib/copilot/docs/docs-search.test.ts +++ b/apps/sim/lib/copilot/docs/docs-search.test.ts @@ -26,6 +26,7 @@ vi.mock('drizzle-orm', () => { and: op('and'), or: op('or'), eq: op('eq'), + ne: op('ne'), like: op('like'), notLike: op('notLike'), sql: (strings: TemplateStringsArray) => ({ op: 'sql', text: strings.join('?') }), @@ -77,6 +78,12 @@ describe('searchDocs path scoping', () => { expect(whereText()).toContain('academy/%') }) + it('excludes the root homepage when unscoped — its chunks have no live docs/ path', async () => { + await searchDocs('cron') + expect(whereText()).toContain('"op":"ne"') + expect(whereText()).toContain('index.mdx') + }) + it('scopes a page to both on-disk layouts', async () => { await searchDocs('cron', { path: 'docs/workflows/blocks/agent.mdx' }) const text = whereText() @@ -171,6 +178,17 @@ describe('searchDocs results', () => { expect((await searchDocs('cron')).results).toEqual([]) }) + it('returns the zero-candidate outcome without querying when the embedding is empty', async () => { + mockGenerateSearchEmbedding.mockResolvedValue({ embedding: [] }) + const outcome = await searchDocs('cron') + expect(outcome).toEqual({ + results: [], + candidatesConsidered: 0, + droppedBelowThreshold: 0, + droppedStale: 0, + }) + }) + it('drops chunks below the similarity threshold', async () => { mockRows.value = [ { diff --git a/apps/sim/lib/copilot/docs/docs-search.ts b/apps/sim/lib/copilot/docs/docs-search.ts index db45bb66990..0b70d840608 100644 --- a/apps/sim/lib/copilot/docs/docs-search.ts +++ b/apps/sim/lib/copilot/docs/docs-search.ts @@ -1,7 +1,7 @@ import { db } from '@sim/db' import { docsEmbeddings } from '@sim/db/schema' import { createLogger } from '@sim/logger' -import { and, eq, like, notLike, or, sql } from 'drizzle-orm' +import { and, eq, like, ne, notLike, or, sql } from 'drizzle-orm' import { docsPathForSourceDocument, isDocsDir, isDocsPage } from '@/lib/copilot/docs/docs-corpus' import { docsSourceCandidates, UNMOUNTED_DOCS_SECTIONS } from '@/lib/copilot/docs/docs-path' import { generateSearchEmbedding } from '@/lib/knowledge/embeddings' @@ -60,12 +60,16 @@ export class DocsSearchScopeError extends Error { * * An unscoped search excludes every {@link UNMOUNTED_DOCS_SECTIONS} section: * they are indexed but not mounted in the VFS, so a hit there would be a chunk - * the agent cannot then read. + * the agent cannot then read. The root homepage (`index.mdx`) is excluded for + * the same reason — the manifest generator drops it (its URL is `/`, which + * redirects), so its chunks would only ever be counted against topK and then + * discarded as stale. */ function scopeCondition(path?: string) { const normalized = (path ?? '').trim().replace(/^\/+/, '').replace(/\/+$/, '') if (normalized === '' || normalized === 'docs') { return and( + ne(docsEmbeddings.sourceDocument, 'index.mdx'), ...UNMOUNTED_DOCS_SECTIONS.map((section) => notLike(docsEmbeddings.sourceDocument, `${section}/%`) ) diff --git a/apps/sim/lib/copilot/tools/handlers/vfs.test.ts b/apps/sim/lib/copilot/tools/handlers/vfs.test.ts index 283f63c0709..348bea6fb1a 100644 --- a/apps/sim/lib/copilot/tools/handlers/vfs.test.ts +++ b/apps/sim/lib/copilot/tools/handlers/vfs.test.ts @@ -2,7 +2,7 @@ * @vitest-environment node */ -import { beforeEach, describe, expect, it, vi } from 'vitest' +import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest' import { TOOL_RESULT_MAX_INLINE_CHARS } from '@/lib/copilot/constants' const { getOrMaterializeVFS } = vi.hoisted(() => ({ @@ -702,3 +702,109 @@ describe('vfs uploads are opt-in (like recently-deleted/)', () => { expect(grepChatUpload).toHaveBeenCalledWith('report.json', 'chat-1', 'x', expect.any(Object)) }) }) + +describe('vfs handlers docs corpus routing', () => { + const fetchMock = vi.fn() + const DOCS_PAGE = 'docs/workflows/blocks/agent.mdx' + + beforeEach(() => { + vi.clearAllMocks() + fetchMock.mockReset() + vi.stubGlobal('fetch', fetchMock) + }) + + afterEach(() => { + vi.unstubAllGlobals() + }) + + it('globs the docs corpus without materializing the workspace VFS', async () => { + const result = await executeVfsGlob({ pattern: 'docs/**' }, GREP_CTX) + + expect(result.success).toBe(true) + expect((result.output as { files: string[] }).files).toContain(DOCS_PAGE) + expect(getOrMaterializeVFS).not.toHaveBeenCalled() + }) + + it('reads a docs page via the live-site fetch, not the workspace VFS', async () => { + fetchMock.mockResolvedValue({ ok: true, status: 200, text: async () => 'line one\nline two' }) + + const result = await executeVfsRead({ path: DOCS_PAGE }, GREP_CTX) + + expect(result.success).toBe(true) + expect(result.output).toEqual({ content: 'line one\nline two', totalLines: 2 }) + expect(getOrMaterializeVFS).not.toHaveBeenCalled() + }) + + it('surfaces DocsCorpusError messages verbatim from read, without fetching', async () => { + const unknown = await executeVfsRead({ path: 'docs/not-a-real-page.mdx' }, GREP_CTX) + expect(unknown.success).toBe(false) + expect(unknown.error).toContain('Docs page not found') + + const dir = await executeVfsRead({ path: 'docs/workflows/blocks' }, GREP_CTX) + expect(dir.success).toBe(false) + expect(dir.error).toContain('is a directory') + expect(fetchMock).not.toHaveBeenCalled() + }) + + it('greps exactly one docs page and rejects multi-page scopes verbatim', async () => { + fetchMock.mockResolvedValue({ + ok: true, + status: 200, + text: async () => 'alpha\ncron beta\ngamma', + }) + + const single = await executeVfsGrep({ pattern: 'cron', path: DOCS_PAGE }, GREP_CTX) + expect(single.success).toBe(true) + + const multi = await executeVfsGrep({ pattern: 'cron', path: 'docs/workflows' }, GREP_CTX) + expect(multi.success).toBe(false) + expect(multi.error).toContain('single page') + expect(getOrMaterializeVFS).not.toHaveBeenCalled() + }) + + it('truncates an oversized multi-line docs page to fit the inline cap', async () => { + const line = 'y'.repeat(200) + const totalLines = Math.ceil((TOOL_RESULT_MAX_INLINE_CHARS * 2) / (line.length + 1)) + fetchMock.mockResolvedValue({ + ok: true, + status: 200, + text: async () => Array.from({ length: totalLines }, () => line).join('\n'), + }) + + const result = await executeVfsRead({ path: DOCS_PAGE }, GREP_CTX) + + expect(result.success).toBe(true) + const output = result.output as { content: string; totalLines: number } + expect(output.totalLines).toBe(totalLines) + expect(output.content).toContain('[Page truncated: returned lines 1-') + expect(JSON.stringify(output).length).toBeLessThanOrEqual(TOOL_RESULT_MAX_INLINE_CHARS) + }) + + it('fails a docs page whose single line cannot fit inline instead of returning it oversized', async () => { + fetchMock.mockResolvedValue({ + ok: true, + status: 200, + text: async () => 'z'.repeat(TOOL_RESULT_MAX_INLINE_CHARS + 1000), + }) + + const result = await executeVfsRead({ path: DOCS_PAGE }, GREP_CTX) + + expect(result.success).toBe(false) + expect(result.error).toContain('Grep this page') + }) + + it('rejects an explicit window that still overflows instead of truncating it', async () => { + const line = 'y'.repeat(200) + const totalLines = Math.ceil((TOOL_RESULT_MAX_INLINE_CHARS * 2) / (line.length + 1)) + fetchMock.mockResolvedValue({ + ok: true, + status: 200, + text: async () => Array.from({ length: totalLines }, () => line).join('\n'), + }) + + const result = await executeVfsRead({ path: DOCS_PAGE, offset: 0, limit: totalLines }, GREP_CTX) + + expect(result.success).toBe(false) + expect(result.error).toContain('still too large over the requested window') + }) +}) diff --git a/apps/sim/lib/copilot/tools/handlers/vfs.ts b/apps/sim/lib/copilot/tools/handlers/vfs.ts index ee2559b02c0..c8bac616ed6 100644 --- a/apps/sim/lib/copilot/tools/handlers/vfs.ts +++ b/apps/sim/lib/copilot/tools/handlers/vfs.ts @@ -137,12 +137,14 @@ async function canReturnWorkspaceFileValue( /** * Trim an oversized docs page to the largest whole-line prefix that fits the * inline budget, preserving the true `totalLines` so the model can page through - * the rest with offset/limit. + * the rest with offset/limit. Returns null when not even one line fits — a + * single line longer than the cap — so the caller can fail instead of returning + * an over-cap payload as success. */ function truncateDocsPageToInlineCap(page: { content: string; totalLines: number }): { output: { content: string; totalLines: number } returnedLines: number -} { +} | null { const lines = page.content.split('\n') // Route to ONE more fetch, not two. Telling the model to grep and then read // costs two more uncached fetches of a page it already partly has; grep and @@ -152,17 +154,16 @@ function truncateDocsPageToInlineCap(page: { content: string; totalLines: number `\n\n[Page truncated: returned lines 1-${shown} of ${page.totalLines}. To continue, read this path with offset: ${shown}. To jump straight to a section, grep this path INSTEAD of reading it — grep is the same single fetch and returns only matching lines with their numbers.]` let kept = lines.length - let content = page.content while (kept > 0) { - content = `${lines.slice(0, kept).join('\n')}${notice(kept)}` + const content = `${lines.slice(0, kept).join('\n')}${notice(kept)}` if ( serializedResultSize({ content, totalLines: page.totalLines }) <= TOOL_RESULT_MAX_INLINE_CHARS ) { - break + return { output: { content, totalLines: page.totalLines }, returnedLines: kept } } kept = Math.floor(kept / 2) } - return { output: { content, totalLines: page.totalLines }, returnedLines: kept } + return null } export async function executeVfsGrep( @@ -392,6 +393,12 @@ export async function executeVfsRead( } } const truncated = truncateDocsPageToInlineCap(page) + if (!truncated) { + return { + success: false, + error: `${path} is too large to return inline even truncated. Grep this page for the section you need.`, + } + } logger.debug('vfs_read truncated oversized docs page', { path, totalLines: page.totalLines, diff --git a/apps/sim/lib/copilot/tools/server/docs/search-docs.test.ts b/apps/sim/lib/copilot/tools/server/docs/search-docs.test.ts new file mode 100644 index 00000000000..37318f5fc53 --- /dev/null +++ b/apps/sim/lib/copilot/tools/server/docs/search-docs.test.ts @@ -0,0 +1,102 @@ +/** + * @vitest-environment node + */ +import { beforeEach, describe, expect, it, vi } from 'vitest' +import type { DocsSearchOutcome } from '@/lib/copilot/docs/docs-search' + +const { mockSearchDocs } = vi.hoisted(() => ({ + mockSearchDocs: vi.fn(), +})) + +vi.mock('@/lib/copilot/docs/docs-search', () => ({ + searchDocs: mockSearchDocs, +})) + +import { searchDocsServerTool } from '@/lib/copilot/tools/server/docs/search-docs' + +function outcome(overrides: Partial): DocsSearchOutcome { + return { + results: [], + candidatesConsidered: 0, + droppedBelowThreshold: 0, + droppedStale: 0, + ...overrides, + } +} + +const RESULT = { + path: 'docs/agents.mdx', + url: 'https://docs.sim.ai/agents', + title: 'Agents', + content: 'body', + similarity: 0.9, +} + +describe('searchDocsServerTool', () => { + beforeEach(() => { + mockSearchDocs.mockReset() + }) + + it('forwards query, path, and topK to the search layer', async () => { + mockSearchDocs.mockResolvedValue(outcome({ results: [RESULT], candidatesConsidered: 1 })) + + const output = await searchDocsServerTool.execute({ + query: 'how do agents work', + path: 'docs/agents.mdx', + topK: 7, + }) + + expect(mockSearchDocs).toHaveBeenCalledWith('how do agents work', { + path: 'docs/agents.mdx', + topK: 7, + }) + expect(output).toEqual({ + results: [RESULT], + query: 'how do agents work', + totalResults: 1, + }) + }) + + it('omits the note when nothing was dropped', async () => { + mockSearchDocs.mockResolvedValue(outcome({ results: [RESULT], candidatesConsidered: 1 })) + + const output = await searchDocsServerTool.execute({ query: 'q' }) + + expect(output.note).toBeUndefined() + }) + + it('explains an empty result set caused by filtering, so it does not read as missing docs', async () => { + mockSearchDocs.mockResolvedValue( + outcome({ candidatesConsidered: 2, droppedBelowThreshold: 1, droppedStale: 1 }) + ) + + const output = await searchDocsServerTool.execute({ query: 'q' }) + + expect(output.note).toContain('does NOT mean the docs lack this topic') + expect(output.note).toContain('1 scored too low') + expect(output.note).toContain('1 point at pages no longer in the docs') + }) + + it('notes threshold-only drops on a partial result set', async () => { + mockSearchDocs.mockResolvedValue( + outcome({ results: [RESULT], candidatesConsidered: 3, droppedBelowThreshold: 2 }) + ) + + const output = await searchDocsServerTool.execute({ query: 'q' }) + + expect(output.note).toContain('Returned 1 of 3 candidate(s)') + expect(output.note).toContain('2 scored too low') + expect(output.note).not.toContain('no longer in the docs') + }) + + it('notes stale-only drops on a partial result set', async () => { + mockSearchDocs.mockResolvedValue( + outcome({ results: [RESULT], candidatesConsidered: 2, droppedStale: 1 }) + ) + + const output = await searchDocsServerTool.execute({ query: 'q' }) + + expect(output.note).toContain('1 point at pages no longer in the docs') + expect(output.note).not.toContain('scored too low') + }) +}) From 5e66306901d8e33ac0ca2c825baaa7b88d408372 Mon Sep 17 00:00:00 2001 From: Justin Blumencranz <96924014+j15z@users.noreply.github.com> Date: Wed, 29 Jul 2026 14:39:04 -0700 Subject: [PATCH 15/32] chore(copilot): regenerate the tool catalog for the lean search agent MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The search subagent's task description now tells callers to pass a fully self-contained task — it no longer inherits the conversation (see the companion mothership change). Co-Authored-By: Claude Fable 5 --- apps/sim/lib/copilot/generated/tool-catalog-v1.ts | 2 +- apps/sim/lib/copilot/generated/tool-schemas-v1.ts | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/apps/sim/lib/copilot/generated/tool-catalog-v1.ts b/apps/sim/lib/copilot/generated/tool-catalog-v1.ts index 54bb070eeca..e3f1fc548b3 100644 --- a/apps/sim/lib/copilot/generated/tool-catalog-v1.ts +++ b/apps/sim/lib/copilot/generated/tool-catalog-v1.ts @@ -4549,7 +4549,7 @@ export const Search: ToolCatalogEntry = { properties: { task: { description: - "One short scoping sentence — the search agent has full conversation context. Example: 'find current Stripe metered-billing API limits' or 'count how many rows in the leads table have invalid emails'.", + "A fully self-contained task — the search agent sees none of this conversation, so include the question plus every name, id, constraint, and prior finding it needs. Example: 'find current Stripe metered-billing API limits' or 'count how many rows in the leads table have invalid emails'.", type: 'string', }, }, diff --git a/apps/sim/lib/copilot/generated/tool-schemas-v1.ts b/apps/sim/lib/copilot/generated/tool-schemas-v1.ts index a3fd31e1c85..593ccc62c0f 100644 --- a/apps/sim/lib/copilot/generated/tool-schemas-v1.ts +++ b/apps/sim/lib/copilot/generated/tool-schemas-v1.ts @@ -4394,7 +4394,7 @@ export const TOOL_RUNTIME_SCHEMAS: Record = { properties: { task: { description: - "One short scoping sentence — the search agent has full conversation context. Example: 'find current Stripe metered-billing API limits' or 'count how many rows in the leads table have invalid emails'.", + "A fully self-contained task — the search agent sees none of this conversation, so include the question plus every name, id, constraint, and prior finding it needs. Example: 'find current Stripe metered-billing API limits' or 'count how many rows in the leads table have invalid emails'.", type: 'string', }, }, From d28b9564f3ef150373f18529c4407c4afae43861 Mon Sep 17 00:00:00 2001 From: Justin Blumencranz <96924014+j15z@users.noreply.github.com> Date: Wed, 29 Jul 2026 15:25:09 -0700 Subject: [PATCH 16/32] improvement(copilot): retire search_documentation and get_platform_actions outright, no shims MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The transitional apparatus is gone: no search_documentation registry alias, no get_platform_actions handler, and the ids are out of the regenerated catalog/schemas. During the deploy window an old Mothership build calling either id gets the recoverable tool-not-found result. The two ids stay in HIDDEN_TOOL_NAMES forever — like load_agent_skill, historical persisted chats contain their tool calls and must replay without rendering chips for retired tools. The alias test is replaced by a dispatch test pinning search_docs's own catalog -> route -> handler chain and the retired ids' gone-but-chip-hidden state. Co-Authored-By: Claude Fable 5 --- .../tool-executor/register-handlers.ts | 3 - .../tools/handlers/platform-actions.ts | 118 ------------------ .../lib/copilot/tools/handlers/platform.ts | 9 -- .../server/docs/search-docs-dispatch.test.ts | 45 +++++++ apps/sim/lib/copilot/tools/server/router.ts | 5 - 5 files changed, 45 insertions(+), 135 deletions(-) delete mode 100644 apps/sim/lib/copilot/tools/handlers/platform-actions.ts delete mode 100644 apps/sim/lib/copilot/tools/handlers/platform.ts create mode 100644 apps/sim/lib/copilot/tools/server/docs/search-docs-dispatch.test.ts diff --git a/apps/sim/lib/copilot/tool-executor/register-handlers.ts b/apps/sim/lib/copilot/tool-executor/register-handlers.ts index f2f9eb6d304..b5b9768ac14 100644 --- a/apps/sim/lib/copilot/tool-executor/register-handlers.ts +++ b/apps/sim/lib/copilot/tool-executor/register-handlers.ts @@ -16,7 +16,6 @@ import { GetBlockUpstreamReferences, GetDeployedWorkflowState, GetDeploymentLog, - GetPlatformActions, GetWorkflowData, GetWorkflowRunOptions, Glob as GlobTool, @@ -81,7 +80,6 @@ import { executeManageSandbox } from '../tools/handlers/management/manage-sandbo import { executeManageSkill } from '../tools/handlers/management/manage-skill' import { executeMaterializeFile } from '../tools/handlers/materialize-file' import { executeOAuthGetAuthLink, executeOAuthRequestAccess } from '../tools/handlers/oauth' -import { executeGetPlatformActions } from '../tools/handlers/platform' import { executeOpenResource } from '../tools/handlers/resources' import { executeRestoreResource } from '../tools/handlers/restore-resource' import { executeRunCode } from '../tools/handlers/run-code' @@ -192,7 +190,6 @@ function buildHandlerMap(): Record { [OauthRequestAccess.id]: h(executeOAuthRequestAccess), [OpenResource.id]: h(executeOpenResource), [RestoreResource.id]: h(executeRestoreResource), - [GetPlatformActions.id]: h(executeGetPlatformActions), [ListIntegrationTools.id]: h(executeListIntegrationTools), [MaterializeFile.id]: h(executeMaterializeFile), [FunctionExecute.id]: h(executeFunctionExecute), diff --git a/apps/sim/lib/copilot/tools/handlers/platform-actions.ts b/apps/sim/lib/copilot/tools/handlers/platform-actions.ts deleted file mode 100644 index c3c3ac14384..00000000000 --- a/apps/sim/lib/copilot/tools/handlers/platform-actions.ts +++ /dev/null @@ -1,118 +0,0 @@ -/** - * Static content for the get_platform_actions tool. - * Contains the Sim platform quick reference and keyboard shortcuts. - */ -export const PLATFORM_ACTIONS_CONTENT = `# Sim Platform Quick Reference & Keyboard Shortcuts - -## Keyboard Shortcuts -**Mod** = Cmd (macOS) / Ctrl (Windows/Linux). Shortcuts work when canvas is focused. - -### Workflow Actions -| Shortcut | Action | -|----------|--------| -| Mod+Enter | Run workflow (or cancel if running) | -| Mod+Z | Undo | -| Mod+Shift+Z | Redo | -| Mod+C | Copy selected blocks | -| Mod+X | Cut selected blocks | -| Mod+V | Paste blocks | -| Delete/Backspace | Delete selected blocks or edges | -| Shift+L | Auto-layout canvas | -| Mod+Shift+F | Fit to view | -| Mod+Shift+Enter | Accept Copilot changes | - -### Panel Navigation -| Shortcut | Action | -|----------|--------| -| Mod+F | Open workflow search and replace | -| Mod+Alt+F | Focus Toolbar search | - -### Global Navigation -| Shortcut | Action | -|----------|--------| -| Mod+K | Open search | -| Mod+Shift+A | Add new agent workflow | -| Mod+Shift+P | Create workflow | -| Mod+B | Toggle sidebar | -| Mod+L | Go to logs | - -### Utility -| Shortcut | Action | -|----------|--------| -| Mod+D | Clear terminal console | - -### Mouse Controls -| Action | Control | -|--------|---------| -| Pan/move canvas | Left-drag on empty space (hand mode, the default), middle-drag, scroll, or trackpad | -| Select multiple blocks | Shift+drag to draw a selection box. In cursor mode, left-drag on empty space draws it instead | -| Drag block | Left-drag on block header | -| Add to selection | Mod+Click or Shift+Click on blocks | - -## Quick Reference — Workspaces -| Action | How | -|--------|-----| -| Create workspace | Click workspace dropdown → New Workspace | -| Switch workspaces | Click workspace dropdown → Select workspace | -| Invite teammates | Sidebar → Invite | -| Rename/Duplicate/Export/Delete workspace | Right-click workspace → action | - -## Quick Reference — Workflows -| Action | How | -|--------|-----| -| Create workflow | Click + button in sidebar | -| Reorder/move workflows | Drag workflow up/down or onto a folder | -| Import workflow | Click import button in sidebar → Select file | -| Multi-select workflows | Mod+Click or Shift+Click workflows in sidebar | -| Open in new tab | Right-click workflow → Open in New Tab | -| Rename/Duplicate/Export/Delete | Right-click workflow → action | - -## Quick Reference — Blocks -| Action | How | -|--------|-----| -| Add a block | Drag from Toolbar panel, or right-click canvas → Add Block | -| Multi-select blocks | Mod+Click or Shift+Click additional blocks, or Shift+drag a selection box | -| Copy/Paste blocks | Mod+C / Mod+V | -| Duplicate/Delete blocks | Right-click → action | -| Rename a block | Click block name in header | -| Enable/Disable block | Right-click → Enable/Disable | -| Lock/Unlock block | Hover block → Click lock icon (Admin only) | -| Toggle handle orientation | Right-click → Toggle Handles | -| Open a block in the Editor panel | Right-click → Open Editor | -| Move a block out of a loop/parallel | Right-click → Remove from Subflow | -| Configure a block | Select block → use Editor panel on right | - -## Quick Reference — Connections -| Action | How | -|--------|-----| -| Create connection | Drag from output handle to input handle | -| Delete connection | Click edge to select → Delete key | -| Use output in another block | Drag connection tag into input field | - -## Quick Reference — Running & Testing -| Action | How | -|--------|-----| -| Run workflow | Click Run Workflow button or Mod+Enter | -| Stop workflow | Click Stop button or Mod+Enter while running | -| Test with chat | Use Chat panel on the right side | -| Run from block | Hover block → Click play button, or right-click → Run from block | -| Run until block | Right-click block → Run until block | -| View execution logs | Open terminal panel at bottom, or Mod+L | -| Filter/Search/Copy/Clear logs | Terminal panel controls | - -## Quick Reference — Deployment -| Action | How | -|--------|-----| -| Deploy workflow | Click Deploy button in panel | -| Update deployment | Click Update when changes are detected | -| Revert deployment | Previous versions in Deploy tab → Promote to live | -| Copy API endpoint | Deploy tab → API → Copy API cURL | - -## Quick Reference — Variables -| Action | How | -|--------|-----| -| Add/Edit/Delete workflow variable | Panel → Variables → Add Variable | -| Add environment variable | Settings → Environment Variables → Add | -| Reference workflow variable | Use syntax | -| Reference environment variable | Use {{ENV_VAR}} syntax | -` diff --git a/apps/sim/lib/copilot/tools/handlers/platform.ts b/apps/sim/lib/copilot/tools/handlers/platform.ts deleted file mode 100644 index f5cc43f910b..00000000000 --- a/apps/sim/lib/copilot/tools/handlers/platform.ts +++ /dev/null @@ -1,9 +0,0 @@ -import type { ExecutionContext, ToolCallResult } from '@/lib/copilot/request/types' -import { PLATFORM_ACTIONS_CONTENT } from './platform-actions' - -export async function executeGetPlatformActions( - _rawParams: Record, - _context: ExecutionContext -): Promise { - return { success: true, output: { content: PLATFORM_ACTIONS_CONTENT } } -} diff --git a/apps/sim/lib/copilot/tools/server/docs/search-docs-dispatch.test.ts b/apps/sim/lib/copilot/tools/server/docs/search-docs-dispatch.test.ts new file mode 100644 index 00000000000..c3f406c56b9 --- /dev/null +++ b/apps/sim/lib/copilot/tools/server/docs/search-docs-dispatch.test.ts @@ -0,0 +1,45 @@ +/** + * @vitest-environment node + */ +import { describe, expect, it } from 'vitest' +import { TOOL_CATALOG } from '@/lib/copilot/generated/tool-catalog-v1' +import { isKnownTool, isSimExecuted } from '@/lib/copilot/tool-executor/router' +import { getHiddenToolNames } from '@/lib/copilot/tools/client/hidden-tools' +import { getRegisteredServerToolNames } from '@/lib/copilot/tools/server/router' + +/** + * `executeTool` gates on `isKnownTool` (catalog membership) before it ever + * consults the handler registry, so a sim-routed tool needs every link of this + * chain or dispatch rejects it before the handler is reached. These assertions + * pin that chain for search_docs. + */ +describe('search_docs dispatch chain', () => { + it('is in the catalog, so dispatch does not reject it as unknown', () => { + expect(isKnownTool('search_docs')).toBe(true) + }) + + it('routes to sim, so dispatch reaches the server tool registry', () => { + expect(isSimExecuted('search_docs')).toBe(true) + }) + + it('has a registered server handler', () => { + expect(getRegisteredServerToolNames()).toContain('search_docs') + }) +}) + +/** + * The retired ids are fully unregistered server-side — no catalog entry, no + * handler, no alias. Only the client-side chip suppression survives, forever, + * so historical persisted chats replay without rendering chips for tools that + * no longer exist (the load_agent_skill precedent). + */ +describe('retired docs-tool ids', () => { + for (const retired of ['search_documentation', 'get_platform_actions']) { + it(`${retired} is gone from the catalog and server registry but stays chip-hidden`, () => { + expect(TOOL_CATALOG[retired]).toBeUndefined() + expect(isKnownTool(retired)).toBe(false) + expect(getRegisteredServerToolNames()).not.toContain(retired) + expect(getHiddenToolNames().has(retired)).toBe(true) + }) + } +}) diff --git a/apps/sim/lib/copilot/tools/server/router.ts b/apps/sim/lib/copilot/tools/server/router.ts index 1410c37941f..ab6a882b30e 100644 --- a/apps/sim/lib/copilot/tools/server/router.ts +++ b/apps/sim/lib/copilot/tools/server/router.ts @@ -169,11 +169,6 @@ const baseServerToolRegistry: Record = { [editWorkflowServerTool.name]: editWorkflowServerTool, [queryLogsServerTool.name]: queryLogsServerTool, [searchDocsServerTool.name]: searchDocsServerTool, - // Transitional alias: sim and mothership deploy independently, so during the - // rollout of the search_documentation -> search_docs rename one side is still - // emitting the old id. The old params are a subset of the new, so routing them - // here is safe. Remove once both repos have shipped the rename. - search_documentation: searchDocsServerTool, [searchOnlineServerTool.name]: searchOnlineServerTool, [setEnvironmentVariablesServerTool.name]: setEnvironmentVariablesServerTool, [getCredentialsServerTool.name]: getCredentialsServerTool, From df7295904531d833a73c00c36a215914ed92ed08 Mon Sep 17 00:00:00 2001 From: Justin Blumencranz <96924014+j15z@users.noreply.github.com> Date: Wed, 29 Jul 2026 15:43:40 -0700 Subject: [PATCH 17/32] changed search_docs tool title to Searching Sim docs --- apps/sim/lib/copilot/tools/tool-display.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/apps/sim/lib/copilot/tools/tool-display.ts b/apps/sim/lib/copilot/tools/tool-display.ts index 58f5de96f23..cae077aceab 100644 --- a/apps/sim/lib/copilot/tools/tool-display.ts +++ b/apps/sim/lib/copilot/tools/tool-display.ts @@ -503,7 +503,7 @@ const TOOL_TITLES: Record = { restore_resource: 'Restoring resource', run_block: 'Running block', scheduled_task: 'Managing scheduled task', - search_docs: 'Searching docs', + search_docs: 'Searching Sim docs', search_patterns: 'Searching patterns', set_block_enabled: 'Toggling block', set_environment_variables: 'Setting environment variables', From d651d6ffbdb25c866cded3fb1c6a4414a18ba415 Mon Sep 17 00:00:00 2001 From: Justin Blumencranz <96924014+j15z@users.noreply.github.com> Date: Wed, 29 Jul 2026 15:45:45 -0700 Subject: [PATCH 18/32] fix(copilot): apply the Searching Sim docs rename to the dynamic title case MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The static TOOL_TITLES entry is unreachable for search_docs — the dynamic switch case returns first so it can include the query — so the rename only takes effect there. Tests updated to the new wording. Co-Authored-By: Claude Fable 5 --- apps/sim/lib/copilot/tools/tool-display.test.ts | 8 ++++---- apps/sim/lib/copilot/tools/tool-display.ts | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/apps/sim/lib/copilot/tools/tool-display.test.ts b/apps/sim/lib/copilot/tools/tool-display.test.ts index 24b7be3681f..681e555f92d 100644 --- a/apps/sim/lib/copilot/tools/tool-display.test.ts +++ b/apps/sim/lib/copilot/tools/tool-display.test.ts @@ -79,23 +79,23 @@ describe('getToolDisplayTitle natural-language coverage', () => { }) it('includes the query in search_docs titles', () => { - expect(getToolDisplayTitle('search_docs')).toBe('Searching docs') + expect(getToolDisplayTitle('search_docs')).toBe('Searching Sim docs') expect(getToolDisplayTitle('search_docs', { query: 'loop blocks iteration' })).toBe( - 'Searching docs for "loop blocks iteration"' + 'Searching Sim docs for "loop blocks iteration"' ) // The completed-state flip must keep the suffix, not drop back to the bare label. expect( getToolCompletedTitle( getToolDisplayTitle('search_docs', { query: 'how to read workflow logs' }) ) - ).toBe('Searched docs for "how to read workflow logs"') + ).toBe('Searched Sim docs for "how to read workflow logs"') // A long agent-written query is truncated rather than blowing out the chip. expect( getToolDisplayTitle('search_docs', { query: 'reference block outputs connection tags blockname.field pass data between blocks in a workflow', })?.length - ).toBeLessThanOrEqual('Searching docs for ""'.length + 60 + '...'.length) + ).toBeLessThanOrEqual('Searching Sim docs for ""'.length + 60 + '...'.length) }) it('falls back to running code for function_execute without a title', () => { diff --git a/apps/sim/lib/copilot/tools/tool-display.ts b/apps/sim/lib/copilot/tools/tool-display.ts index cae077aceab..8f77f4cd856 100644 --- a/apps/sim/lib/copilot/tools/tool-display.ts +++ b/apps/sim/lib/copilot/tools/tool-display.ts @@ -805,7 +805,7 @@ export function getToolDisplayTitle(name: string, args?: Record } case 'search_docs': { const target = firstStringArg(args, 'toolTitle', 'title', 'query') - return target ? `Searching docs for "${truncate(target, 60)}"` : 'Searching docs' + return target ? `Searching Sim docs for "${truncate(target, 60)}"` : 'Searching Sim docs' } case 'grep': { const target = firstStringArg(args, 'toolTitle', 'title') From ae89151692e55e97a158a64c63e4babcf6eb4186 Mon Sep 17 00:00:00 2001 From: Justin Blumencranz <96924014+j15z@users.noreply.github.com> Date: Thu, 6 Aug 2026 16:26:59 -0700 Subject: [PATCH 19/32] improvement(copilot): retry docs fetches and grep docs directories in parallel Two robustness upgrades to the docs corpus. Page fetches from docs.sim.ai now retry transient failures (5xx, 429, network, timeout) with jittered backoff over three 3s attempts instead of a single 10s attempt, so a momentary stall recovers in seconds instead of failing the tool call. And grep now accepts a docs directory path: it fans out to every manifest page under the directory with bounded concurrency and runs one multi-file grep, replacing the single-page restriction that forced agents into per-page call sweeps. Pages the site no longer serves are skipped; an unreachable page fails the whole grep so a partial result is never mistaken for "not documented". Co-Authored-By: Claude Fable 5 --- apps/sim/lib/copilot/docs/docs-corpus.test.ts | 93 ++++++++++++++++--- apps/sim/lib/copilot/docs/docs-corpus.ts | 80 ++++++++++++---- apps/sim/lib/copilot/tools/handlers/vfs.ts | 4 +- .../server/docs/search-docs-dispatch.test.ts | 20 ++-- 4 files changed, 151 insertions(+), 46 deletions(-) diff --git a/apps/sim/lib/copilot/docs/docs-corpus.test.ts b/apps/sim/lib/copilot/docs/docs-corpus.test.ts index f3dd5a8f4ad..33211bb7b9b 100644 --- a/apps/sim/lib/copilot/docs/docs-corpus.test.ts +++ b/apps/sim/lib/copilot/docs/docs-corpus.test.ts @@ -2,15 +2,21 @@ * @vitest-environment node */ import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest' + +vi.mock('@sim/utils/helpers', () => ({ + sleep: vi.fn(() => Promise.resolve()), +})) + import { couldMatchDocsScope, DocsCorpusError, globDocs, - grepDocsPage, + grepDocs, isDocsPath, readDocsPage, } from '@/lib/copilot/docs/docs-corpus' import { DOCS_MANIFEST } from '@/lib/copilot/generated/docs-manifest' +import type { GrepMatch } from '@/lib/copilot/vfs/operations' const SAMPLE_PAGE = DOCS_MANIFEST.find((path) => path === 'workflows/blocks/agent.mdx') @@ -98,33 +104,52 @@ describe('readDocsPage', () => { expect(fetchMock).not.toHaveBeenCalled() }) - it('surfaces a docs-site outage as a retryable error', async () => { + it('surfaces a docs-site outage as a retryable error after exhausting retries', async () => { fetchMock.mockResolvedValue({ ok: false, status: 502, text: async () => '' }) - await expect(readDocsPage(`docs/${SAMPLE_PAGE}`)).rejects.toThrow(/temporarily unavailable/) + await expect(readDocsPage(`docs/${SAMPLE_PAGE}`)).rejects.toThrow(/could not be reached/) + expect(fetchMock).toHaveBeenCalledTimes(3) }) it('treats a network failure as retryable', async () => { fetchMock.mockRejectedValue(new Error('socket hang up')) - await expect(readDocsPage(`docs/${SAMPLE_PAGE}`)).rejects.toThrow(/temporarily unavailable/) + await expect(readDocsPage(`docs/${SAMPLE_PAGE}`)).rejects.toThrow(/could not be reached/) + expect(fetchMock).toHaveBeenCalledTimes(3) + }) + + it('recovers when a transient failure clears on retry', async () => { + fetchMock + .mockRejectedValueOnce(new Error('socket hang up')) + .mockResolvedValue({ ok: true, status: 200, text: async () => '# Agent\n\nbody' }) + + const page = await readDocsPage(`docs/${SAMPLE_PAGE}`) + + expect(fetchMock).toHaveBeenCalledTimes(2) + expect(page).toEqual({ content: '# Agent\n\nbody', totalLines: 3 }) }) - it('reports a page the site no longer serves as permanent, not retryable', async () => { + it('reports a page the site no longer serves as permanent, without retrying', async () => { fetchMock.mockResolvedValue({ ok: false, status: 404, text: async () => '' }) const error = await readDocsPage(`docs/${SAMPLE_PAGE}`).catch((e) => e) expect(error).toBeInstanceOf(DocsCorpusError) expect(error.message).toMatch(/does not serve it/) expect(error.message).toMatch(/retrying will not help/) - expect(error.message).not.toMatch(/temporarily unavailable/) + expect(error.message).not.toMatch(/could not be reached/) + expect(fetchMock).toHaveBeenCalledOnce() }) it('still treats 429 as retryable rather than permanent', async () => { fetchMock.mockResolvedValue({ ok: false, status: 429, text: async () => '' }) - await expect(readDocsPage(`docs/${SAMPLE_PAGE}`)).rejects.toThrow(/temporarily unavailable/) + await expect(readDocsPage(`docs/${SAMPLE_PAGE}`)).rejects.toThrow(/could not be reached/) + expect(fetchMock).toHaveBeenCalledTimes(3) }) }) -describe('grepDocsPage', () => { +describe('grepDocs', () => { const fetchMock = vi.fn() + const SECTION_DIR = 'docs/workflows/blocks' + const SECTION_PAGES = DOCS_MANIFEST.filter((path) => path.startsWith('workflows/blocks/')).map( + (path) => `docs/${path}` + ) beforeEach(() => { fetchMock.mockReset() @@ -135,14 +160,14 @@ describe('grepDocsPage', () => { vi.unstubAllGlobals() }) - it('greps exactly one page', async () => { + it('greps exactly one page for a page path', async () => { fetchMock.mockResolvedValue({ ok: true, status: 200, text: async () => 'intro line\nsystemPrompt matters\ntail', }) - const matches = await grepDocsPage(`docs/${SAMPLE_PAGE}`, 'systemPrompt') + const matches = await grepDocs(`docs/${SAMPLE_PAGE}`, 'systemPrompt') expect(fetchMock).toHaveBeenCalledOnce() expect(matches).toEqual([ @@ -150,9 +175,51 @@ describe('grepDocsPage', () => { ]) }) - it('refuses a multi-page scope so one grep is never hundreds of fetches', async () => { - await expect(grepDocsPage('docs/', 'cron')).rejects.toThrow(/single page/) - await expect(grepDocsPage('docs/workflows', 'cron')).rejects.toThrow(/single page/) + it('greps a directory by fetching every page under it', async () => { + fetchMock.mockResolvedValue({ + ok: true, + status: 200, + text: async () => 'intro\ncron marker line\ntail', + }) + expect(SECTION_PAGES.length).toBeGreaterThan(1) + + const matches = (await grepDocs(SECTION_DIR, 'cron marker', { + maxResults: 10_000, + })) as GrepMatch[] + + expect(fetchMock).toHaveBeenCalledTimes(SECTION_PAGES.length) + expect(matches.map((match) => match.path)).toEqual(SECTION_PAGES) + }) + + it('skips pages the site no longer serves instead of failing the directory grep', async () => { + const missingUrl = `https://docs.sim.ai/${SECTION_PAGES[0].slice('docs/'.length)}` + fetchMock.mockImplementation(async (url: string) => + url === missingUrl + ? { ok: false, status: 404, text: async () => '' } + : { ok: true, status: 200, text: async () => 'cron marker line' } + ) + + const matches = (await grepDocs(SECTION_DIR, 'cron marker', { + maxResults: 10_000, + })) as GrepMatch[] + + expect(matches.map((match) => match.path)).toEqual(SECTION_PAGES.slice(1)) + }) + + it('fails the whole directory grep when a page cannot be reached', async () => { + fetchMock.mockImplementation(async (url: string) => + url.endsWith(`/${SAMPLE_PAGE}`) + ? { ok: false, status: 502, text: async () => '' } + : { ok: true, status: 200, text: async () => 'cron marker line' } + ) + + await expect(grepDocs(SECTION_DIR, 'cron marker')).rejects.toThrow(/Retry shortly/) + }) + + it('rejects a path that is neither a page nor a directory without fetching', async () => { + await expect(grepDocs('docs/not-a-real-page.mdx', 'cron')).rejects.toThrow( + /not a docs page or directory/ + ) expect(fetchMock).not.toHaveBeenCalled() }) }) diff --git a/apps/sim/lib/copilot/docs/docs-corpus.ts b/apps/sim/lib/copilot/docs/docs-corpus.ts index 5b8bcbc3213..d02d07aa7ce 100644 --- a/apps/sim/lib/copilot/docs/docs-corpus.ts +++ b/apps/sim/lib/copilot/docs/docs-corpus.ts @@ -1,9 +1,12 @@ import { createLogger } from '@sim/logger' import { toError } from '@sim/utils/errors' +import { sleep } from '@sim/utils/helpers' +import { backoffWithJitter } from '@sim/utils/retry' import { foldDocsIndexPath } from '@/lib/copilot/docs/docs-path' import { DOCS_MANIFEST } from '@/lib/copilot/generated/docs-manifest' import type { GrepCountEntry, GrepMatch, GrepOptions } from '@/lib/copilot/vfs/operations' -import { glob as globPaths, grepReadResult } from '@/lib/copilot/vfs/operations' +import { glob as globPaths, grep, grepReadResult } from '@/lib/copilot/vfs/operations' +import { mapWithConcurrency } from '@/lib/core/utils/concurrency' const logger = createLogger('DocsCorpus') @@ -13,7 +16,12 @@ const DOCS_BASE_URL = 'https://docs.sim.ai' /** VFS prefix the docs corpus is mounted at. */ const DOCS_PREFIX = 'docs/' -const FETCH_TIMEOUT_MS = 10_000 +/** Per-attempt budget — the site is CDN-cached and normally answers in well under a second. */ +const FETCH_ATTEMPT_TIMEOUT_MS = 3_000 +const FETCH_MAX_ATTEMPTS = 3 + +/** Parallel page fetches for a directory-scoped grep. */ +const GREP_FETCH_CONCURRENCY = 8 /** * Thrown for expected, user-facing docs-corpus conditions (unknown page, @@ -108,8 +116,9 @@ export interface DocsPage { * Fetch one docs page's raw markdown from the live site. The manifest path IS * the URL path (`docs/workflows/blocks/agent.mdx` → * `https://docs.sim.ai/workflows/blocks/agent.mdx`, which the docs app rewrites - * to its raw-markdown route), so no mapping table is needed. Returns null when - * the page is not in the manifest or the site does not serve it. + * to its raw-markdown route), so no mapping table is needed. Transient failures + * (5xx, 429, network error, timeout) are retried with jittered backoff before + * being reported as unavailable. */ type DocsFetchResult = | { outcome: 'ok'; content: string } @@ -118,13 +127,10 @@ type DocsFetchResult = /** Transient: 5xx, 429, network error, or timeout. */ | { outcome: 'unavailable' } -async function fetchDocsPage(path: string): Promise { - const key = normalize(path) - if (!docsKeyView.has(key)) return { outcome: 'missing' } - const url = `${DOCS_BASE_URL}/${key.slice(DOCS_PREFIX.length)}` +async function fetchDocsPageOnce(url: string): Promise { try { const response = await fetch(url, { - signal: AbortSignal.timeout(FETCH_TIMEOUT_MS), + signal: AbortSignal.timeout(FETCH_ATTEMPT_TIMEOUT_MS), headers: { Accept: 'text/markdown, text/plain' }, }) if (!response.ok) { @@ -139,6 +145,17 @@ async function fetchDocsPage(path: string): Promise { } } +async function fetchDocsPage(path: string): Promise { + const key = normalize(path) + if (!docsKeyView.has(key)) return { outcome: 'missing' } + const url = `${DOCS_BASE_URL}/${key.slice(DOCS_PREFIX.length)}` + for (let attempt = 1; ; attempt++) { + const result = await fetchDocsPageOnce(url) + if (result.outcome !== 'unavailable' || attempt >= FETCH_MAX_ATTEMPTS) return result + await sleep(backoffWithJitter(attempt, null)) + } +} + /** * Read one docs page. Throws {@link DocsCorpusError} for the expected user-facing * conditions (directory path, unknown page, site unreachable) so the handler can @@ -163,28 +180,55 @@ export async function readDocsPage(path: string): Promise { } if (result.outcome === 'unavailable') { throw new DocsCorpusError( - `Could not load ${key} from ${DOCS_BASE_URL} — the docs site is temporarily unavailable. Retry shortly.` + `Could not load ${key} from ${DOCS_BASE_URL} — the docs site could not be reached. Retry shortly.` ) } return { content: result.content, totalLines: result.content.split('\n').length } } /** - * Grep ONE docs page, mirroring how grep over `files/` works: each page is a - * separate fetch from the docs site, so a multi-page grep would mean hundreds of - * requests. A path that is not a single page throws. + * Grep the docs corpus. A single page greps just that page. A directory path + * (`docs`, `docs/files`) fans out to every manifest page under it: pages are + * fetched in parallel and searched as one multi-file grep, so results follow + * manifest order and `maxResults` applies across pages. Pages the site no + * longer serves are skipped; a page that cannot be reached after retries fails + * the whole grep, because a silent partial result would misread as "not + * documented". */ -export async function grepDocsPage( +export async function grepDocs( path: string, pattern: string, options?: GrepOptions ): Promise { const key = normalize(path) - if (!docsKeyView.has(key)) { + if (docsKeyView.has(key)) { + const page = await readDocsPage(key) + return grepReadResult(key, page, pattern, key, options) + } + if (!isDocsDir(key)) { + throw new DocsCorpusError( + `"${path}" is not a docs page or directory. Use glob("docs/**") to list the docs corpus.` + ) + } + const dir = `${key}/` + const pages = [...docsKeyView.keys()].filter((pageKey) => pageKey.startsWith(dir)) + let unreachable = 0 + const results = await mapWithConcurrency(pages, GREP_FETCH_CONCURRENCY, async (pageKey) => { + // Once any page is unreachable the grep is going to fail — skip the + // remaining fetches instead of hammering a site that is not answering. + if (unreachable > 0) return null + const result = await fetchDocsPage(pageKey) + if (result.outcome === 'unavailable') unreachable++ + return result + }) + if (unreachable > 0) { throw new DocsCorpusError( - `Grep over the docs corpus must target a single page (e.g. path: "docs/workflows/blocks/agent.mdx"). "${path}" is not a docs page. Use glob("docs/**") to find the exact path, then grep that one page.` + `Could not load every page under ${dir} from ${DOCS_BASE_URL} — a partial grep could misread as "not documented". Retry shortly.` ) } - const page = await readDocsPage(key) - return grepReadResult(key, page, pattern, key, options) + const contents = new Map() + results.forEach((result, index) => { + if (result?.outcome === 'ok') contents.set(pages[index], result.content) + }) + return grep(contents, pattern, undefined, options) } diff --git a/apps/sim/lib/copilot/tools/handlers/vfs.ts b/apps/sim/lib/copilot/tools/handlers/vfs.ts index c8bac616ed6..a7b93399238 100644 --- a/apps/sim/lib/copilot/tools/handlers/vfs.ts +++ b/apps/sim/lib/copilot/tools/handlers/vfs.ts @@ -8,7 +8,7 @@ import { couldMatchDocsScope, DocsCorpusError, globDocs, - grepDocsPage, + grepDocs, isDocsPath, readDocsPage, } from '@/lib/copilot/docs/docs-corpus' @@ -203,7 +203,7 @@ export async function executeVfsGrep( let result: GrepMatch[] | string[] | GrepCountEntry[] let provenanceFile: WorkspaceFileSecretProvenanceIdentity | undefined if (rawPath !== undefined && isDocsPath(rawPath)) { - result = await grepDocsPage(rawPath, pattern, grepOptions) + result = await grepDocs(rawPath, pattern, grepOptions) } else if (isChatUploadGrepPath(rawPath)) { if (!context.chatId) { return { success: false, error: 'No chat context available for uploads/' } diff --git a/apps/sim/lib/copilot/tools/server/docs/search-docs-dispatch.test.ts b/apps/sim/lib/copilot/tools/server/docs/search-docs-dispatch.test.ts index c3f406c56b9..3634648b5b8 100644 --- a/apps/sim/lib/copilot/tools/server/docs/search-docs-dispatch.test.ts +++ b/apps/sim/lib/copilot/tools/server/docs/search-docs-dispatch.test.ts @@ -27,19 +27,13 @@ describe('search_docs dispatch chain', () => { }) }) -/** - * The retired ids are fully unregistered server-side — no catalog entry, no - * handler, no alias. Only the client-side chip suppression survives, forever, - * so historical persisted chats replay without rendering chips for tools that - * no longer exist (the load_agent_skill precedent). - */ -describe('retired docs-tool ids', () => { - for (const retired of ['search_documentation', 'get_platform_actions']) { - it(`${retired} is gone from the catalog and server registry but stays chip-hidden`, () => { - expect(TOOL_CATALOG[retired]).toBeUndefined() - expect(isKnownTool(retired)).toBe(false) - expect(getRegisteredServerToolNames()).not.toContain(retired) - expect(getHiddenToolNames().has(retired)).toBe(true) +describe('removed docs-tool ids', () => { + for (const removed of ['search_documentation', 'get_platform_actions']) { + it(`${removed} is absent from the catalog, registries, and hidden-tool set`, () => { + expect(TOOL_CATALOG[removed]).toBeUndefined() + expect(isKnownTool(removed)).toBe(false) + expect(getRegisteredServerToolNames()).not.toContain(removed) + expect(getHiddenToolNames().has(removed)).toBe(false) }) } }) From b272cf1a95c8878285c69824d79a0b7e3d3ea611 Mon Sep 17 00:00:00 2001 From: Justin Blumencranz <96924014+j15z@users.noreply.github.com> Date: Thu, 6 Aug 2026 16:27:36 -0700 Subject: [PATCH 20/32] chore(copilot): drop the retired search_documentation test The tool was retired outright with the search_docs replacement; its test outlived the module on staging and no longer resolves. Co-Authored-By: Claude Fable 5 --- .../server/docs/search-documentation.test.ts | 56 ------------------- 1 file changed, 56 deletions(-) delete mode 100644 apps/sim/lib/copilot/tools/server/docs/search-documentation.test.ts diff --git a/apps/sim/lib/copilot/tools/server/docs/search-documentation.test.ts b/apps/sim/lib/copilot/tools/server/docs/search-documentation.test.ts deleted file mode 100644 index 14693f75913..00000000000 --- a/apps/sim/lib/copilot/tools/server/docs/search-documentation.test.ts +++ /dev/null @@ -1,56 +0,0 @@ -/** - * @vitest-environment node - */ -import { loggerMock } from '@sim/testing' -import { beforeEach, describe, expect, it, vi } from 'vitest' - -const { mockGenerateSearchEmbedding } = vi.hoisted(() => ({ - mockGenerateSearchEmbedding: vi.fn(), -})) - -vi.mock('@/lib/copilot/generated/tool-catalog-v1', () => ({ - SearchDocumentation: { id: 'search_documentation' }, -})) -vi.mock('@/lib/knowledge/embeddings', () => ({ - generateSearchEmbedding: mockGenerateSearchEmbedding, -})) - -import { searchDocumentationServerTool } from '@/lib/copilot/tools/server/docs/search-documentation' -import { ResolvedSecretTraceRegistry } from '@/executor/utils/resolved-secret-trace-registry' - -describe('documentation search model boundary', () => { - beforeEach(() => { - vi.clearAllMocks() - mockGenerateSearchEmbedding.mockResolvedValue({ embedding: [], isBYOK: false }) - }) - - it('preserves a query that merely collides with ambient secret plaintext', async () => { - const registry = new ResolvedSecretTraceRegistry([ - { - name: 'DOCS_QUERY', - plaintext: 'private documentation query', - encryptedValue: 'encrypted-query', - }, - ]) - registry.recordResolved('DOCS_QUERY', 'private documentation query') - - const result = await searchDocumentationServerTool.execute( - { query: 'private documentation query' }, - { userId: 'user-1', resolvedSecretTraceRegistry: registry } - ) - - expect(mockGenerateSearchEmbedding).toHaveBeenCalledWith('private documentation query') - expect(result).toEqual({ - results: [], - query: 'private documentation query', - totalResults: 0, - }) - - const logger = loggerMock.createLogger.mock.results.at(-1)?.value - expect(logger?.info).toHaveBeenCalledWith('Executing docs search', { - queryLength: 'private documentation query'.length, - topK: 10, - }) - expect(JSON.stringify(logger?.info.mock.calls)).not.toContain('private documentation query') - }) -}) From 407c7c7d6b28961488e3514b4af42710f8a1958e Mon Sep 17 00:00:00 2001 From: Justin Blumencranz <96924014+j15z@users.noreply.github.com> Date: Thu, 6 Aug 2026 16:28:59 -0700 Subject: [PATCH 21/32] test(copilot): cover directory-scoped docs grep at the handler level The vfs handler test still pinned the retired single-page restriction; directory grep now succeeds with a parallel page fan-out, and an invalid path (neither page nor directory) is the remaining rejection. Co-Authored-By: Claude Fable 5 --- apps/sim/lib/copilot/tools/handlers/vfs.test.ts | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/apps/sim/lib/copilot/tools/handlers/vfs.test.ts b/apps/sim/lib/copilot/tools/handlers/vfs.test.ts index 348bea6fb1a..464bb2ccc6b 100644 --- a/apps/sim/lib/copilot/tools/handlers/vfs.test.ts +++ b/apps/sim/lib/copilot/tools/handlers/vfs.test.ts @@ -746,7 +746,7 @@ describe('vfs handlers docs corpus routing', () => { expect(fetchMock).not.toHaveBeenCalled() }) - it('greps exactly one docs page and rejects multi-page scopes verbatim', async () => { + it('greps one docs page or a docs directory without touching the workspace VFS', async () => { fetchMock.mockResolvedValue({ ok: true, status: 200, @@ -756,9 +756,16 @@ describe('vfs handlers docs corpus routing', () => { const single = await executeVfsGrep({ pattern: 'cron', path: DOCS_PAGE }, GREP_CTX) expect(single.success).toBe(true) - const multi = await executeVfsGrep({ pattern: 'cron', path: 'docs/workflows' }, GREP_CTX) - expect(multi.success).toBe(false) - expect(multi.error).toContain('single page') + const multi = await executeVfsGrep( + { pattern: 'cron', path: 'docs/workflows', maxResults: 10_000 }, + GREP_CTX + ) + expect(multi.success).toBe(true) + expect(fetchMock.mock.calls.length).toBeGreaterThan(1) + + const invalid = await executeVfsGrep({ pattern: 'cron', path: 'docs/not-a-page.mdx' }, GREP_CTX) + expect(invalid.success).toBe(false) + expect(invalid.error).toContain('not a docs page or directory') expect(getOrMaterializeVFS).not.toHaveBeenCalled() }) From a807e2eb1d4a9c7bb2e7e76b51290cce31ac18a6 Mon Sep 17 00:00:00 2001 From: Justin Blumencranz <96924014+j15z@users.noreply.github.com> Date: Fri, 7 Aug 2026 11:36:33 -0700 Subject: [PATCH 22/32] chore(copilot): regenerate the docs manifest for staging docs content Staging added docs pages since the manifest was generated; the CI freshness check (docs-manifest:check) catches exactly this drift. Co-Authored-By: Claude Fable 5 --- .../lib/copilot/generated/docs-manifest.ts | 36 +- .../2026-08-03-platform-agent-ideation.html | 511 ++++++++++++++++++ 2 files changed, 539 insertions(+), 8 deletions(-) create mode 100644 docs/ideation/2026-08-03-platform-agent-ideation.html diff --git a/apps/sim/lib/copilot/generated/docs-manifest.ts b/apps/sim/lib/copilot/generated/docs-manifest.ts index 720d5371947..6c747f97593 100644 --- a/apps/sim/lib/copilot/generated/docs-manifest.ts +++ b/apps/sim/lib/copilot/generated/docs-manifest.ts @@ -15,6 +15,14 @@ export const DOCS_MANIFEST: readonly string[] = [ 'agents/custom-tools.mdx', 'agents/mcp.mdx', 'agents/skills.mdx', + 'chat.mdx', + 'chat/files.mdx', + 'chat/knowledge.mdx', + 'chat/mailer.mdx', + 'chat/research.mdx', + 'chat/tables.mdx', + 'chat/tasks.mdx', + 'chat/workflows.mdx', 'files.mdx', 'files/editor.mdx', 'files/generating.mdx', @@ -88,6 +96,7 @@ export const DOCS_MANIFEST: readonly string[] = [ 'integrations/elasticsearch.mdx', 'integrations/elevenlabs.mdx', 'integrations/emailbison.mdx', + 'integrations/embeddings.mdx', 'integrations/enrich.mdx', 'integrations/enrichment.mdx', 'integrations/enrow.mdx', @@ -161,11 +170,13 @@ export const DOCS_MANIFEST: readonly string[] = [ 'integrations/linkedin.mdx', 'integrations/linkup.mdx', 'integrations/linq.mdx', + 'integrations/logfire.mdx', 'integrations/logs.mdx', 'integrations/loops.mdx', 'integrations/luma.mdx', 'integrations/mailchimp.mdx', 'integrations/mailgun.mdx', + 'integrations/managed_agent.mdx', 'integrations/mem0.mdx', 'integrations/memory.mdx', 'integrations/microsoft_ad.mdx', @@ -237,6 +248,7 @@ export const DOCS_MANIFEST: readonly string[] = [ 'integrations/similarweb.mdx', 'integrations/sixtyfour.mdx', 'integrations/slack.mdx', + 'integrations/smartlead.mdx', 'integrations/smtp.mdx', 'integrations/sportmonks.mdx', 'integrations/sqs.mdx', @@ -253,6 +265,7 @@ export const DOCS_MANIFEST: readonly string[] = [ 'integrations/temporal.mdx', 'integrations/textract.mdx', 'integrations/thrive.mdx', + 'integrations/tiktok.mdx', 'integrations/tinybird.mdx', 'integrations/trello-service-account.mdx', 'integrations/trello.mdx', @@ -279,6 +292,8 @@ export const DOCS_MANIFEST: readonly string[] = [ 'integrations/zendesk.mdx', 'integrations/zep.mdx', 'integrations/zerobounce.mdx', + 'integrations/zoho-desk-service-account.mdx', + 'integrations/zoho_desk.mdx', 'integrations/zoom-service-account.mdx', 'integrations/zoom.mdx', 'integrations/zoominfo.mdx', @@ -293,14 +308,6 @@ export const DOCS_MANIFEST: readonly string[] = [ 'logs-debugging.mdx', 'logs-debugging/alerts.mdx', 'logs-debugging/logging.mdx', - 'mothership.mdx', - 'mothership/files.mdx', - 'mothership/knowledge.mdx', - 'mothership/mailer.mdx', - 'mothership/research.mdx', - 'mothership/tables.mdx', - 'mothership/tasks.mdx', - 'mothership/workflows.mdx', 'platform/costs.mdx', 'platform/credentials.mdx', 'platform/enterprise.mdx', @@ -310,6 +317,7 @@ export const DOCS_MANIFEST: readonly string[] = [ 'platform/enterprise/data-drains.mdx', 'platform/enterprise/data-retention.mdx', 'platform/enterprise/forks.mdx', + 'platform/enterprise/self-hosted.mdx', 'platform/enterprise/session-policies.mdx', 'platform/enterprise/sso.mdx', 'platform/enterprise/verified-domains.mdx', @@ -317,12 +325,24 @@ export const DOCS_MANIFEST: readonly string[] = [ 'platform/organization.mdx', 'platform/permissions.mdx', 'platform/self-hosting.mdx', + 'platform/self-hosting/architecture.mdx', + 'platform/self-hosting/authentication.mdx', + 'platform/self-hosting/background-jobs.mdx', 'platform/self-hosting/docker.mdx', + 'platform/self-hosting/email.mdx', 'platform/self-hosting/environment-variables.mdx', + 'platform/self-hosting/integrations-oauth.mdx', 'platform/self-hosting/kubernetes.mdx', + 'platform/self-hosting/networking.mdx', 'platform/self-hosting/object-storage.mdx', + 'platform/self-hosting/observability.mdx', 'platform/self-hosting/platforms.mdx', + 'platform/self-hosting/redis.mdx', + 'platform/self-hosting/scaling.mdx', + 'platform/self-hosting/security.mdx', 'platform/self-hosting/troubleshooting.mdx', + 'platform/self-hosting/upgrades.mdx', + 'platform/self-hosting/verify.mdx', 'platform/workspaces.mdx', 'quick-reference.mdx', 'tables.mdx', diff --git a/docs/ideation/2026-08-03-platform-agent-ideation.html b/docs/ideation/2026-08-03-platform-agent-ideation.html new file mode 100644 index 00000000000..cfa784716f5 --- /dev/null +++ b/docs/ideation/2026-08-03-platform-agent-ideation.html @@ -0,0 +1,511 @@ + + + + + + Platform agent — ideation + + + +
+
+

Ideation · Platform intelligence

+

Turn the docs agent into a trusted platform operator

+

The strongest direction is not an omniscient agent. It is a source-aware agent that knows the user’s operating context, fetches private state only when needed, explains access and billing in product language, and leaves evidence behind whenever it reads sensitive data.

+ +
+ Date · + Topic · platform-agent + Mode · repo-grounded + Focus · tools, prompt context, private platform data +
+ +
+
30raw candidates
+
12deduped directions
+
6ranked survivors
+
4topic axes covered
+
+ + +
+ +
+

What the codebase already gives us

+

Grounding Context

+

The branch introduces a dedicated platform child that is intentionally isolated from parent conversation and restricted to documentation search, VFS reads, and response. That isolation is useful, but the runtime already has stronger seams than the prompt admits.

+ +
+
+

Trusted request context already exists

+

Child execution carries trusted user/workspace IDs, effective permission, entitlements, timezone, and workspace/session/workflow bootstrap. Human-readable UserMetadata is the notable omission.

+
+
+

Central handlers are the security seam

+

Sim-side tool handlers receive authenticated actor/workspace context and can enforce permission before returning data. Model-supplied IDs do not need to become authority.

+
+
+

Most live data services already exist

+

Billing, permission groups, audit events, execution logs and metrics, and metadata-only subagent invocation records already expose the underlying facts with distinct gates.

+
+
+

Prior art converges on the same split

+

Microsoft, AWS, and Intercom separate ambient identity from permission-trimmed retrieval and persona-specific behavior.

+
+
+ +
+ + Four source-of-truth layers feeding the platform agent + Injected context, live tools, public docs, and component schemas each answer a different class of question. The platform agent synthesizes them into a scoped answer with provenance. + + + + + + + Injected context + who · where · current role + + + Live Sim tools + private · mutable · scoped + + + Product docs + behavior · limits · UI + + + Component schemas + fields · enums · tool IDs + + + + + + + + Platform agent + chooses authority by question + + + scoped + cited + fresh + + Answer with provenance + +
Directional overview: each source is authoritative for a different kind of fact. The model chooses among them; authorization remains in Sim.
+
+
+ +
+

Surface map

+

Topic Axes

+
+

1. Identity and current context

Who is asking, where they are operating, and what request-local context is safe to carry ambiently.

+

2. Access and resource visibility

What the viewer may discover or do, why something is unavailable, and how to avoid resource-existence leaks.

+

3. Plan, billing, and usage

Personal plan, effective coverage, exact workspace payer, usage gates, limits, credits, and management authority.

+

4. Activity, audit, and operational health

What changed, what failed, which evidence source applies, and how private reads become inspectable.

+
+
+ +
+

Qualified directions

+

Ranked Ideas

+ + +
+
+
1

Idea 1. Context passport + source hierarchy

+
Confidence · 94%Complexity · Low
+
+

Description: Inject a small trusted Current Platform Context block into the child: display name, timezone, workspace name/ID, current workflow or selected resource, effective read|write|admin, broad entitlements, and an asOf value. Rewrite the prompt around four authorities: this passport for orientation, live tools for private or mutable facts, docs for product behavior, and component schemas for exact configuration.

+
+
Axis
Identity and current context
+
Basis
direct: The request already threads trusted workspace, permission, entitlement, timezone, session/workflow bootstrap, and VFS inventory to the child, but not human-readable UserMetadata. The current prompt already distinguishes docs behavior from schema truth, so this adds the missing live-data tier rather than replacing the model.
+
Rationale
It removes repeated disambiguation while creating a crisp rule for stale, conflicting, or private facts. This is the smallest change that makes every later tool safer and easier to use.
+
Downsides
The passport becomes a compatibility contract and must stay deliberately small. Current page/resource context needs careful selection so it does not leak browser state to children unnecessarily.
+
+
+ +
+
+
2

Idea 2. Capability/access explainer

+
Confidence · 92%Complexity · Medium
+
+

Description: Add explain_capability(action, resourceType?). It returns available, needs_write, needs_admin, blocked_by_policy, not_entitled, or not_configured, identifies the controlling layer, and gives a safe next step. It never returns names, counts, or existence signals for hidden resources.

+
+
Axis
Access and resource visibility
+
Basis
direct: Sim already combines workspace permission, organization role, permission-group restrictions, integration/model/tool allowlists, and per-viewer feature visibility. Handler-side enforcement and trusted execution context are already the normal boundary.
+
Rationale
This turns “the docs say I can” into “here is whether you can, why, and what legitimate path exists.” It can absorb the useful part of a buildability map without exposing a broad hidden-feature manifest.
+
Downsides
A stable causal vocabulary is product work, not just plumbing. Incorrect denial explanations are worse than a generic denial, so the tool must reuse the same policy decisions as execution rather than reimplementing them.
+
+
+ +
+
+
3

Idea 3. Three-lens billing snapshot + run preflight

+
Confidence · 91%Complexity · Medium
+
+

Description: Add one billing tool with explicit lenses: personal_subscription, effective_user_coverage, and current_workspace_payer. Return only decision-ready fields—plan/status, usable/block state, usage and limit, credits, period, management authority, freshness—and an optional operation preflight that reports the first live gate and user-appropriate remediation.

+
+
Personal

What the user personally owns or pays for.

+
Effective

What coverage the user currently receives.

+
Workspace payer

Which billing pool governs work here.

+
+
+
Axis
Plan, billing, and usage
+
Basis
direct: Those three meanings deliberately differ in the billing code. Billing status also differs from product-usable access, and enforcement-grade reads have stronger freshness requirements than display reads.
+
Rationale
A naïve get_plan would encode the wrong product semantics. A lens-based projection answers “what plan am I on?”, “who pays for this?”, and “why is this run blocked?” without exposing raw subscriptions, Stripe identifiers, invoices, or other members’ usage.
+
Downsides
Organizations and personal accounts need different redaction and management guidance. Live preflight may cost more than a replica-backed informational answer, so freshness must be explicit.
+
+
+ +
+
+
4

Idea 4. Evidence-routed activity investigator

+
Confidence · 88%Complexity · High
+
+

Description: Add investigate_activity(question, timeRange). It classifies the symptom and queries only the authorized evidence family: execution percentiles for latency, workflow logs for failures, organization audit events for “who changed this?”, and metadata-only subagent invocation records for delegation health. It returns a bounded timeline, saved filters or deep links, truncation/freshness notices, and facts clearly separated from hypotheses.

+
+
Axis
Activity, audit, and operational health
+
Basis
direct: Sim already has each source with separate authorization, filter, pagination, and payload semantics. external: Azure copilots use reviewable queries and deep links rather than becoming a parallel source of truth.
+
Rationale
This is the step-function move: the platform agent becomes a credible first responder for “what changed?” and “why did this fail?” while preserving the authority of existing observability surfaces.
+
Downsides
Joining evidence can create false causality. The first version should route and summarize rather than claim root cause, and enterprise audit access must stay independently gated.
+
+
+ +
+
+
5

Idea 5. Sensitive-read receipts

+
Confidence · 87%Complexity · Medium
+
+

Description: Treat read-only billing, audit, member, and execution-data access as sensitive. Every lookup emits a metadata-only receipt containing actor, scope, tool, authorization result, reason or query hash, timestamp, and trace linkage—never the returned private body. The prompt briefly discloses when private records were inspected and offers an inspectable activity link.

+
+
Axis
Activity, audit, and operational health
+
Basis
direct: Sim already records audit metadata and durable subagent-invocation metadata without conversational content. external: AWS and Google log agent-mediated or admin data reads, including dry-run permission checks.
+
Rationale
This is the trust foundation for every private-data tool. It makes agent access governable and answers the security question “what did the agent look at?” without storing sensitive outputs twice.
+
Downsides
Receipts create volume, retention, and user-experience questions. Query hashes and reason fields must avoid becoming a new content-leak channel.
+
+
+ +
+
+
6

Idea 6. Persona/access evaluation matrix

+
Confidence · 85%Complexity · Medium
+
+

Description: Evaluate the same platform questions as free/paid, member/admin/owner, billing-manager/non-manager, policy-restricted/unrestricted, and resource-access/no-access personas. Assert the answer, visible tools, denial wording, non-disclosure, citations, freshness labels, and sensitive-read receipts—not only whether a handler returns 200 or 403.

+
+
Axis
Access and resource visibility
+
Basis
external: Intercom tests Fin as real or synthetic users, plans, audiences, and brands while inspecting triggered behavior. direct: Sim’s access semantics span enough independent layers that isolated handler tests cannot validate what the model ultimately says.
+
Rationale
This converts permission awareness from an architectural claim into product behavior that can be regression-tested. It is especially valuable for “must not reveal” cases where a function-level authorization test can pass while the answer leaks context.
+
Downsides
Model-evaluation stability and fixture maintenance are real costs. Start with a small invariant suite around identity, capability denials, billing lenses, and audit authorization.
+
+
Useful invariantThe same question should produce different, correct answers for a member and an admin—without either answer mentioning what the other persona can see.
+
+
+ +
+

What did not survive intact

+

Rejection Summary

+ + + + + + + + + + + +
#IdeaReason rejected or merged
1Viewer-specific buildability mapThe proposed breadth outran current evidence; its supported capability categories were folded into Idea 2.
2Standalone run-capability preflightStrong but duplicate; merged into the exact-payer billing semantics in Idea 3.
3Usage-driver narrativeReduced public logs do not support detailed workflow attribution without crossing payer-sensitive boundaries.
4Standalone source hierarchyStrong but inseparable from ambient context design; merged into Idea 1.
5Intent-gated private-tool revealRequest-time permission filtering already exists; extra progressive revelation lacked demonstrated value.
6Standalone deep-link behaviorValuable response behavior rather than a product direction; merged into Idea 4.
7Repeated context, access, billing, and incident variantsFive independent lenses converged; duplicates were combined into the strongest source-aware forms above.
+
+ +
Composed by ce-ideate from the platform-agent enhancement prompt and the active Sim/Mothership worktrees.
+
+ + From 8b5a8d8d821270987b125305a36248d8fe412eef Mon Sep 17 00:00:00 2001 From: Justin Blumencranz <96924014+j15z@users.noreply.github.com> Date: Fri, 7 Aug 2026 11:48:30 -0700 Subject: [PATCH 23/32] chore(copilot): resync the grep tool description from mothership contracts Mirrors the schema fix documenting the docs corpus grep mode. Co-Authored-By: Claude Fable 5 --- apps/sim/lib/copilot/generated/tool-catalog-v1.ts | 4 ++-- apps/sim/lib/copilot/generated/tool-schemas-v1.ts | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/apps/sim/lib/copilot/generated/tool-catalog-v1.ts b/apps/sim/lib/copilot/generated/tool-catalog-v1.ts index e3f1fc548b3..3903492b7ec 100644 --- a/apps/sim/lib/copilot/generated/tool-catalog-v1.ts +++ b/apps/sim/lib/copilot/generated/tool-catalog-v1.ts @@ -3128,12 +3128,12 @@ export const Grep: ToolCatalogEntry = { path: { type: 'string', description: - "Optional scope. A prefix (e.g. 'workflows/', 'environment/', 'internal/') searches the VFS map under it. An exact single-file path under files/ or uploads/ (optionally with /content) searches that file's content only; folders and multi-file trees are rejected for content search.", + "Optional scope. A prefix (e.g. 'workflows/', 'environment/', 'internal/') searches the VFS map under it. An exact single-file path under files/ or uploads/ (optionally with /content) searches that file's content only; folders and multi-file trees there are rejected for content search. A docs/ page or directory searches live page text — a directory fans out to every docs page under it.", }, pattern: { type: 'string', description: - "Regex pattern to search for. Searches VFS map entries (workflow JSON, metadata, memories) by default; searches a single file's extracted text when path is one files/ or uploads/ file leaf.", + "Regex pattern to search for. Searches VFS map entries (workflow JSON, metadata, memories) by default; searches a single file's extracted text when path is one files/ or uploads/ file leaf, and live docs page text when path is a docs/ page or directory.", }, toolTitle: { type: 'string', diff --git a/apps/sim/lib/copilot/generated/tool-schemas-v1.ts b/apps/sim/lib/copilot/generated/tool-schemas-v1.ts index 593ccc62c0f..94e8452296e 100644 --- a/apps/sim/lib/copilot/generated/tool-schemas-v1.ts +++ b/apps/sim/lib/copilot/generated/tool-schemas-v1.ts @@ -3007,12 +3007,12 @@ export const TOOL_RUNTIME_SCHEMAS: Record = { path: { type: 'string', description: - "Optional scope. A prefix (e.g. 'workflows/', 'environment/', 'internal/') searches the VFS map under it. An exact single-file path under files/ or uploads/ (optionally with /content) searches that file's content only; folders and multi-file trees are rejected for content search.", + "Optional scope. A prefix (e.g. 'workflows/', 'environment/', 'internal/') searches the VFS map under it. An exact single-file path under files/ or uploads/ (optionally with /content) searches that file's content only; folders and multi-file trees there are rejected for content search. A docs/ page or directory searches live page text — a directory fans out to every docs page under it.", }, pattern: { type: 'string', description: - "Regex pattern to search for. Searches VFS map entries (workflow JSON, metadata, memories) by default; searches a single file's extracted text when path is one files/ or uploads/ file leaf.", + "Regex pattern to search for. Searches VFS map entries (workflow JSON, metadata, memories) by default; searches a single file's extracted text when path is one files/ or uploads/ file leaf, and live docs page text when path is a docs/ page or directory.", }, toolTitle: { type: 'string', From 60cccd2e650801f2f673ebab7d05c50fcfd74892 Mon Sep 17 00:00:00 2001 From: Justin Blumencranz <96924014+j15z@users.noreply.github.com> Date: Fri, 7 Aug 2026 11:57:49 -0700 Subject: [PATCH 24/32] improvement(copilot): stamp docs grep fan-out size on the grep span A directory-scoped docs grep now records copilot.vfs.grep.docs_page_count (pages fetched from the live site) on the active tool span, mirroring the new contract attribute. Co-Authored-By: Claude Fable 5 --- apps/sim/lib/copilot/docs/docs-corpus.ts | 3 +++ apps/sim/lib/copilot/generated/trace-attributes-v1.ts | 2 ++ 2 files changed, 5 insertions(+) diff --git a/apps/sim/lib/copilot/docs/docs-corpus.ts b/apps/sim/lib/copilot/docs/docs-corpus.ts index d02d07aa7ce..11462895bb8 100644 --- a/apps/sim/lib/copilot/docs/docs-corpus.ts +++ b/apps/sim/lib/copilot/docs/docs-corpus.ts @@ -1,9 +1,11 @@ +import { trace } from '@opentelemetry/api' import { createLogger } from '@sim/logger' import { toError } from '@sim/utils/errors' import { sleep } from '@sim/utils/helpers' import { backoffWithJitter } from '@sim/utils/retry' import { foldDocsIndexPath } from '@/lib/copilot/docs/docs-path' import { DOCS_MANIFEST } from '@/lib/copilot/generated/docs-manifest' +import { TraceAttr } from '@/lib/copilot/generated/trace-attributes-v1' import type { GrepCountEntry, GrepMatch, GrepOptions } from '@/lib/copilot/vfs/operations' import { glob as globPaths, grep, grepReadResult } from '@/lib/copilot/vfs/operations' import { mapWithConcurrency } from '@/lib/core/utils/concurrency' @@ -212,6 +214,7 @@ export async function grepDocs( } const dir = `${key}/` const pages = [...docsKeyView.keys()].filter((pageKey) => pageKey.startsWith(dir)) + trace.getActiveSpan()?.setAttribute(TraceAttr.CopilotVfsGrepDocsPageCount, pages.length) let unreachable = 0 const results = await mapWithConcurrency(pages, GREP_FETCH_CONCURRENCY, async (pageKey) => { // Once any page is unreachable the grep is going to fail — skip the diff --git a/apps/sim/lib/copilot/generated/trace-attributes-v1.ts b/apps/sim/lib/copilot/generated/trace-attributes-v1.ts index 5a026a33c3a..37a9c72387b 100644 --- a/apps/sim/lib/copilot/generated/trace-attributes-v1.ts +++ b/apps/sim/lib/copilot/generated/trace-attributes-v1.ts @@ -279,6 +279,7 @@ export const TraceAttr = { CopilotVfsFileMediaType: 'copilot.vfs.file.media_type', CopilotVfsFileName: 'copilot.vfs.file.name', CopilotVfsFileSizeBytes: 'copilot.vfs.file.size_bytes', + CopilotVfsGrepDocsPageCount: 'copilot.vfs.grep.docs_page_count', CopilotVfsHasAlpha: 'copilot.vfs.has_alpha', CopilotVfsInputBytes: 'copilot.vfs.input.bytes', CopilotVfsInputHeight: 'copilot.vfs.input.height', @@ -924,6 +925,7 @@ export const TraceAttrValues: readonly TraceAttrValue[] = [ 'copilot.vfs.file.media_type', 'copilot.vfs.file.name', 'copilot.vfs.file.size_bytes', + 'copilot.vfs.grep.docs_page_count', 'copilot.vfs.has_alpha', 'copilot.vfs.input.bytes', 'copilot.vfs.input.height', From 4107177d296d70d8e22fe8fc28e483440ad9a749 Mon Sep 17 00:00:00 2001 From: Justin Blumencranz <96924014+j15z@users.noreply.github.com> Date: Tue, 11 Aug 2026 20:02:47 -0700 Subject: [PATCH 25/32] chore(copilot): resync docs and mothership contracts after restack --- .../lib/copilot/generated/docs-manifest.ts | 4 +++ .../lib/copilot/generated/tool-catalog-v1.ts | 34 ++++++------------- .../lib/copilot/generated/tool-schemas-v1.ts | 18 ++++------ .../lib/copilot/generated/vfs-snapshot-v1.ts | 14 -------- 4 files changed, 22 insertions(+), 48 deletions(-) diff --git a/apps/sim/lib/copilot/generated/docs-manifest.ts b/apps/sim/lib/copilot/generated/docs-manifest.ts index 6c747f97593..13e896c2bfc 100644 --- a/apps/sim/lib/copilot/generated/docs-manifest.ts +++ b/apps/sim/lib/copilot/generated/docs-manifest.ts @@ -93,6 +93,7 @@ export const DOCS_MANIFEST: readonly string[] = [ 'integrations/dub.mdx', 'integrations/duckduckgo.mdx', 'integrations/dynamodb.mdx', + 'integrations/dynatrace.mdx', 'integrations/elasticsearch.mdx', 'integrations/elevenlabs.mdx', 'integrations/emailbison.mdx', @@ -185,6 +186,7 @@ export const DOCS_MANIFEST: readonly string[] = [ 'integrations/microsoft_planner.mdx', 'integrations/microsoft_teams.mdx', 'integrations/millionverifier.mdx', + 'integrations/mintlify.mdx', 'integrations/mistral_parse.mdx', 'integrations/monday-service-account.mdx', 'integrations/monday.mdx', @@ -250,6 +252,8 @@ export const DOCS_MANIFEST: readonly string[] = [ 'integrations/slack.mdx', 'integrations/smartlead.mdx', 'integrations/smtp.mdx', + 'integrations/snowflake-service-account.mdx', + 'integrations/snowflake.mdx', 'integrations/sportmonks.mdx', 'integrations/sqs.mdx', 'integrations/square.mdx', diff --git a/apps/sim/lib/copilot/generated/tool-catalog-v1.ts b/apps/sim/lib/copilot/generated/tool-catalog-v1.ts index 3903492b7ec..4d0a4f13977 100644 --- a/apps/sim/lib/copilot/generated/tool-catalog-v1.ts +++ b/apps/sim/lib/copilot/generated/tool-catalog-v1.ts @@ -61,7 +61,6 @@ export interface ToolCatalogEntry { | 'get_deployed_workflow_state' | 'get_deployment_log' | 'get_page_contents' - | 'get_platform_actions' | 'get_workflow_data' | 'get_workflow_run_options' | 'glob' @@ -102,7 +101,7 @@ export interface ToolCatalogEntry { | 'run_workflow_until_block' | 'scrape_page' | 'search' - | 'search_documentation' + | 'search_docs' | 'search_integration_tools' | 'search_knowledge_base' | 'search_library_docs' @@ -182,7 +181,6 @@ export interface ToolCatalogEntry { | 'get_deployed_workflow_state' | 'get_deployment_log' | 'get_page_contents' - | 'get_platform_actions' | 'get_workflow_data' | 'get_workflow_run_options' | 'glob' @@ -223,7 +221,7 @@ export interface ToolCatalogEntry { | 'run_workflow_until_block' | 'scrape_page' | 'search' - | 'search_documentation' + | 'search_docs' | 'search_integration_tools' | 'search_knowledge_base' | 'search_library_docs' @@ -3026,15 +3024,6 @@ export const GetPageContents: ToolCatalogEntry = { }, } -export const GetPlatformActions: ToolCatalogEntry = { - id: 'get_platform_actions', - name: 'get_platform_actions', - route: 'sim', - mode: 'async', - parameters: { type: 'object', properties: {} }, - hidden: true, -} - export const GetWorkflowData: ToolCatalogEntry = { id: 'get_workflow_data', name: 'get_workflow_data', @@ -4560,21 +4549,21 @@ export const Search: ToolCatalogEntry = { internal: true, } -export const SearchDocumentation: ToolCatalogEntry = { - id: 'search_documentation', - name: 'search_documentation', +export const SearchDocs: ToolCatalogEntry = { + id: 'search_docs', + name: 'search_docs', route: 'sim', mode: 'async', parameters: { type: 'object', properties: { - query: { type: 'string', description: 'The search query' }, - topK: { - type: 'number', + path: { + type: 'string', description: - 'Number of results to return (default 10). Not clamped — keep it small, since each result is a full doc chunk.', - default: 10, + 'Optional docs/ VFS path (a page such as docs/workflows/blocks/agent.mdx, or a section such as docs/workflows) that limits the search scope', }, + query: { type: 'string', description: 'The search query' }, + topK: { type: 'number', description: 'Number of results (default 5, max 25)' }, }, required: ['query'], }, @@ -6561,7 +6550,6 @@ export const TOOL_CATALOG: Record = { [GetDeployedWorkflowState.id]: GetDeployedWorkflowState, [GetDeploymentLog.id]: GetDeploymentLog, [GetPageContents.id]: GetPageContents, - [GetPlatformActions.id]: GetPlatformActions, [GetWorkflowData.id]: GetWorkflowData, [GetWorkflowRunOptions.id]: GetWorkflowRunOptions, [Glob.id]: Glob, @@ -6602,7 +6590,7 @@ export const TOOL_CATALOG: Record = { [RunWorkflowUntilBlock.id]: RunWorkflowUntilBlock, [ScrapePage.id]: ScrapePage, [Search.id]: Search, - [SearchDocumentation.id]: SearchDocumentation, + [SearchDocs.id]: SearchDocs, [SearchIntegrationTools.id]: SearchIntegrationTools, [SearchKnowledgeBase.id]: SearchKnowledgeBase, [SearchLibraryDocs.id]: SearchLibraryDocs, diff --git a/apps/sim/lib/copilot/generated/tool-schemas-v1.ts b/apps/sim/lib/copilot/generated/tool-schemas-v1.ts index 94e8452296e..c36a3d2bc8b 100644 --- a/apps/sim/lib/copilot/generated/tool-schemas-v1.ts +++ b/apps/sim/lib/copilot/generated/tool-schemas-v1.ts @@ -2918,13 +2918,6 @@ export const TOOL_RUNTIME_SCHEMAS: Record = { }, resultSchema: undefined, }, - get_platform_actions: { - parameters: { - type: 'object', - properties: {}, - }, - resultSchema: undefined, - }, get_workflow_data: { parameters: { type: 'object', @@ -4403,19 +4396,22 @@ export const TOOL_RUNTIME_SCHEMAS: Record = { }, resultSchema: undefined, }, - search_documentation: { + search_docs: { parameters: { type: 'object', properties: { + path: { + type: 'string', + description: + 'Optional docs/ VFS path (a page such as docs/workflows/blocks/agent.mdx, or a section such as docs/workflows) that limits the search scope', + }, query: { type: 'string', description: 'The search query', }, topK: { type: 'number', - description: - 'Number of results to return (default 10). Not clamped — keep it small, since each result is a full doc chunk.', - default: 10, + description: 'Number of results (default 5, max 25)', }, }, required: ['query'], diff --git a/apps/sim/lib/copilot/generated/vfs-snapshot-v1.ts b/apps/sim/lib/copilot/generated/vfs-snapshot-v1.ts index ee8a2dc4f62..6559a690ca7 100644 --- a/apps/sim/lib/copilot/generated/vfs-snapshot-v1.ts +++ b/apps/sim/lib/copilot/generated/vfs-snapshot-v1.ts @@ -10,7 +10,6 @@ export interface VfsSnapshotV1 { envVars?: string[] files?: VfsSnapshotV1File[] integrations?: VfsSnapshotV1Integration[] - jobs?: VfsSnapshotV1Job[] knowledgeBases?: VfsSnapshotV1KnowledgeBase[] mcpServers?: VfsSnapshotV1McpServer[] members?: VfsSnapshotV1Member[] @@ -59,19 +58,6 @@ export interface VfsSnapshotV1Integration { providerId: string role?: string } -/** - * This interface was referenced by `VfsSnapshotV1`'s JSON-Schema - * via the `definition` "VfsSnapshotV1Job". - */ -export interface VfsSnapshotV1Job { - cronExpression?: string - id: string - lifecycle?: string - prompt?: string - sourceTaskName?: string - status?: string - title?: string -} /** * This interface was referenced by `VfsSnapshotV1`'s JSON-Schema * via the `definition` "VfsSnapshotV1KnowledgeBase". From be702bc0c6182a3278ed5d30dd8b4ba3692996a7 Mon Sep 17 00:00:00 2001 From: Justin Blumencranz <96924014+j15z@users.noreply.github.com> Date: Wed, 12 Aug 2026 17:08:44 -0700 Subject: [PATCH 26/32] improvement(copilot): narrow the docs search rollout --- .../app/api/mothership/execute/route.test.ts | 4 +- apps/sim/app/api/mothership/execute/route.ts | 21 +- .../chat-context-kind-registry.tsx | 1 - .../components/chip-clipboard-codec.ts | 4 +- .../user-input/components/constants.ts | 6 +- .../prompt-editor/use-prompt-editor.ts | 4 +- .../components/resource-context.test.ts | 4 + .../[workspaceId]/home/hooks/use-chat.ts | 2 - .../components/user-input/constants.ts | 17 +- .../hooks/use-mention-insert-handlers.ts | 34 +- .../user-input/hooks/use-mention-keyboard.ts | 33 +- .../user-input/hooks/use-mention-menu.ts | 2 +- .../copilot/components/user-input/utils.ts | 2 - .../lib/copilot/chat/display-message.test.ts | 6 +- .../copilot/chat/persisted-message.test.ts | 6 +- apps/sim/lib/copilot/chat/post.ts | 6 +- .../lib/copilot/chat/process-contents.test.ts | 45 +- apps/sim/lib/copilot/chat/process-contents.ts | 5 - apps/sim/lib/copilot/docs/docs-corpus.test.ts | 56 +- apps/sim/lib/copilot/docs/docs-corpus.ts | 85 +-- apps/sim/lib/copilot/docs/docs-path.ts | 18 +- apps/sim/lib/copilot/docs/docs-search.test.ts | 11 +- apps/sim/lib/copilot/docs/docs-search.ts | 42 +- .../lib/copilot/generated/docs-manifest.ts | 9 +- .../lib/copilot/generated/tool-catalog-v1.ts | 6 +- .../lib/copilot/generated/tool-schemas-v1.ts | 5 +- .../copilot/generated/trace-attributes-v1.ts | 2 - .../lib/copilot/tools/handlers/vfs.test.ts | 13 +- apps/sim/lib/copilot/tools/handlers/vfs.ts | 31 +- .../tools/server/docs/search-docs.test.ts | 68 ++- .../copilot/tools/server/docs/search-docs.ts | 21 +- .../lib/copilot/tools/tool-display.test.ts | 2 - apps/sim/stores/panel/types.ts | 1 - .../2026-08-03-platform-agent-ideation.html | 511 ------------------ scripts/sync-docs-manifest.ts | 11 +- 35 files changed, 211 insertions(+), 883 deletions(-) delete mode 100644 docs/ideation/2026-08-03-platform-agent-ideation.html diff --git a/apps/sim/app/api/mothership/execute/route.test.ts b/apps/sim/app/api/mothership/execute/route.test.ts index 007f9424f1b..513c4ea3de4 100644 --- a/apps/sim/app/api/mothership/execute/route.test.ts +++ b/apps/sim/app/api/mothership/execute/route.test.ts @@ -224,7 +224,7 @@ describe('mothership private trace provenance transport', () => { { ...requestBody, messages: [{ role: 'user', content: 'secret-value __var_FOREIGN' }], - contexts: [{ kind: 'docs', label: 'Docs' }], + contexts: [{ kind: 'knowledge', knowledgeId: 'knowledge-1', label: 'Docs' }], }, { Authorization: 'Bearer internal', 'x-sim-billing-attribution': 'billing' }, 'http://localhost:3000/api/mothership/execute' @@ -235,7 +235,6 @@ describe('mothership private trace provenance transport', () => { expect(mockProcessContextsServer).toHaveBeenCalledWith( expect.any(Array), 'user-1', - 'secret-value __var_FOREIGN', 'workspace-1', 'chat-1' ) @@ -288,7 +287,6 @@ describe('mothership private trace provenance transport', () => { }, ], 'user-1', - 'hello', 'workspace-1', 'chat-1' ) diff --git a/apps/sim/app/api/mothership/execute/route.ts b/apps/sim/app/api/mothership/execute/route.ts index 39f061a92d3..fc583885765 100644 --- a/apps/sim/app/api/mothership/execute/route.ts +++ b/apps/sim/app/api/mothership/execute/route.ts @@ -211,7 +211,6 @@ export const POST = withRouteHandler(async (req: NextRequest) => { workflowId, executionId, }) - const lastUserMessage = messages.filter((message) => message.role === 'user').at(-1)?.content // double-cast-allowed: the contract validates contexts as open kind/label objects; processContextsServer narrows on `kind` at runtime const agentMentions = contexts as unknown as ChatContext[] | undefined const taggedMcpServerIds = (agentMentions ?? []).flatMap((context) => @@ -239,18 +238,14 @@ export const POST = withRouteHandler(async (req: NextRequest) => { buildIntegrationToolSchemas(userId, messageId, undefined, workspaceId), mothershipToolsPromise, computeWorkspaceEntitlements(workspaceId, userId), - processContextsServer( - nonMcpAgentMentions, - userId, - lastUserMessage, - workspaceId, - effectiveChatId - ).catch((error) => { - reqLogger.warn('Failed to resolve agent contexts for execution', { - error: toError(error).message, - }) - return [] - }), + processContextsServer(nonMcpAgentMentions, userId, workspaceId, effectiveChatId).catch( + (error) => { + reqLogger.warn('Failed to resolve agent contexts for execution', { + error: toError(error).message, + }) + return [] + } + ), ]) const requestPayload: Record = { messages, diff --git a/apps/sim/app/workspace/[workspaceId]/home/components/chat-context-kind-registry/chat-context-kind-registry.tsx b/apps/sim/app/workspace/[workspaceId]/home/components/chat-context-kind-registry/chat-context-kind-registry.tsx index 1a251e0bc4a..1d6d2ad210f 100644 --- a/apps/sim/app/workspace/[workspaceId]/home/components/chat-context-kind-registry/chat-context-kind-registry.tsx +++ b/apps/sim/app/workspace/[workspaceId]/home/components/chat-context-kind-registry/chat-context-kind-registry.tsx @@ -110,7 +110,6 @@ export const CHAT_CONTEXT_KIND_REGISTRY: Record , }, - docs: { label: 'Docs', renderIcon: () => null }, slash_command: { label: 'Command', renderIcon: () => null }, integration: { label: 'Integration', renderIcon: renderIntegrationTile }, skill: { diff --git a/apps/sim/app/workspace/[workspaceId]/home/components/user-input/components/chip-clipboard-codec.ts b/apps/sim/app/workspace/[workspaceId]/home/components/user-input/components/chip-clipboard-codec.ts index 73eb6eff658..378092fac2e 100644 --- a/apps/sim/app/workspace/[workspaceId]/home/components/user-input/components/chip-clipboard-codec.ts +++ b/apps/sim/app/workspace/[workspaceId]/home/components/user-input/components/chip-clipboard-codec.ts @@ -19,8 +19,8 @@ const CHIP_LINK_SCHEME = 'sim' * string>>` keeps it union-synced: rename a kind's id field and this stops * type-checking. * - * Excluded kinds (`current_workflow`, `blocks`, `workflow_block`, `docs`) carry - * no single portable id (an array / two ids / none) and degrade to plain text. + * Kinds absent from this map have no portable single-id representation and + * degrade to plain text. */ const PORTABLE_KIND_TO_ID_FIELD = { table: 'tableId', diff --git a/apps/sim/app/workspace/[workspaceId]/home/components/user-input/components/constants.ts b/apps/sim/app/workspace/[workspaceId]/home/components/user-input/components/constants.ts index f24b1890ee7..a0ffd98df46 100644 --- a/apps/sim/app/workspace/[workspaceId]/home/components/user-input/components/constants.ts +++ b/apps/sim/app/workspace/[workspaceId]/home/components/user-input/components/constants.ts @@ -113,7 +113,7 @@ export const SPEECH_RECOGNITION_LANG = 'en-US' // inner tab. The singleton ids ask the agent to inspect the whole resource; // every other id is a precise live-tab pointer. const RESOURCE_TO_CONTEXT: Record< - MothershipResourceType, + Exclude, (resource: MothershipResource) => ChatContext > = { browser: (r) => ({ kind: 'browser_tab', tabId: r.id, label: r.title }), @@ -127,9 +127,9 @@ const RESOURCE_TO_CONTEXT: Record< task: (r) => ({ kind: 'past_chat', chatId: r.id, label: r.title }), log: (r) => ({ kind: 'logs', executionId: r.id, label: r.title }), integration: (r) => ({ kind: 'integration', blockType: r.id, label: r.title }), - generic: (r) => ({ kind: 'docs', label: r.title }), } -export function mapResourceToContext(resource: MothershipResource): ChatContext { +export function mapResourceToContext(resource: MothershipResource): ChatContext | null { + if (resource.type === 'generic') return null return RESOURCE_TO_CONTEXT[resource.type](resource) } diff --git a/apps/sim/app/workspace/[workspaceId]/home/components/user-input/components/prompt-editor/use-prompt-editor.ts b/apps/sim/app/workspace/[workspaceId]/home/components/user-input/components/prompt-editor/use-prompt-editor.ts index f86f69f24a2..74f25c7f237 100644 --- a/apps/sim/app/workspace/[workspaceId]/home/components/user-input/components/prompt-editor/use-prompt-editor.ts +++ b/apps/sim/app/workspace/[workspaceId]/home/components/user-input/components/prompt-editor/use-prompt-editor.ts @@ -407,6 +407,9 @@ export function usePromptEditor({ const insertResource = useCallback( (resource: MothershipResource) => { + const context = mapResourceToContext(resource) + if (!context) return + const textarea = textareaRef.current if (textarea) { const currentValue = valueRef.current @@ -442,7 +445,6 @@ export function usePromptEditor({ setValueState(newValue) } - const context = mapResourceToContext(resource) addContextNotified(context) }, [textareaRef, addContextNotified] diff --git a/apps/sim/app/workspace/[workspaceId]/home/components/user-input/components/resource-context.test.ts b/apps/sim/app/workspace/[workspaceId]/home/components/user-input/components/resource-context.test.ts index 47e0216319f..3441bd0ed61 100644 --- a/apps/sim/app/workspace/[workspaceId]/home/components/user-input/components/resource-context.test.ts +++ b/apps/sim/app/workspace/[workspaceId]/home/components/user-input/components/resource-context.test.ts @@ -47,4 +47,8 @@ describe('mapResourceToContext', () => { label: 'Leads', }) }) + + it('does not turn a synthetic panel into a chat context', () => { + expect(mapResourceToContext(resource({ type: 'generic', title: 'Results' }))).toBeNull() + }) }) diff --git a/apps/sim/app/workspace/[workspaceId]/home/hooks/use-chat.ts b/apps/sim/app/workspace/[workspaceId]/home/hooks/use-chat.ts index acbea0bd61f..26cc3ca9fb3 100644 --- a/apps/sim/app/workspace/[workspaceId]/home/hooks/use-chat.ts +++ b/apps/sim/app/workspace/[workspaceId]/home/hooks/use-chat.ts @@ -458,8 +458,6 @@ function isChatContext(value: unknown): value is ChatContext { return typeof value.folderId === 'string' case 'filefolder': return typeof value.fileFolderId === 'string' - case 'docs': - return true case 'slash_command': return typeof value.command === 'string' case 'integration': diff --git a/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/copilot/components/user-input/constants.ts b/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/copilot/components/user-input/constants.ts index d9cdf9702ac..7860b326ae7 100644 --- a/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/copilot/components/user-input/constants.ts +++ b/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/copilot/components/user-input/constants.ts @@ -12,11 +12,6 @@ export type MentionFolderId = | 'logs' | 'integrations' -/** - * Menu item category types for mention menu (includes folders + docs item) - */ -export type MentionCategory = MentionFolderId | 'docs' - /** * Configuration interface for folder types */ @@ -184,17 +179,9 @@ export const FOLDER_ORDER: MentionFolderId[] = [ ] /** - * Docs item configuration (special case - not a folder) - */ -export const DOCS_CONFIG = { - getLabel: () => 'Docs', - buildContext: (): ChatContext => ({ kind: 'docs', label: 'Docs' }), -} as const - -/** - * Total number of items in root menu (folders + docs) + * Total number of items in the root menu. */ -export const ROOT_MENU_ITEM_COUNT = FOLDER_ORDER.length + 1 +export const ROOT_MENU_ITEM_COUNT = FOLDER_ORDER.length /** * Slash command configuration diff --git a/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/copilot/components/user-input/hooks/use-mention-insert-handlers.ts b/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/copilot/components/user-input/hooks/use-mention-insert-handlers.ts index 75eb4f7ec50..8a67a524458 100644 --- a/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/copilot/components/user-input/hooks/use-mention-insert-handlers.ts +++ b/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/copilot/components/user-input/hooks/use-mention-insert-handlers.ts @@ -1,6 +1,5 @@ import { useCallback, useMemo } from 'react' import { - DOCS_CONFIG, FOLDER_CONFIGS, type FolderConfig, } from '@/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/copilot/components/user-input/constants' @@ -89,36 +88,6 @@ export function useMentionInsertHandlers({ ] ) - /** - * Special handler for Docs (no item parameter, uses DOCS_CONFIG) - */ - const insertDocsMention = useCallback(() => { - const label = DOCS_CONFIG.getLabel() - const context = DOCS_CONFIG.buildContext() - - // Prevent duplicate insertion - if (isContextAlreadySelected(context, selectedContexts)) { - resetActiveMentionQuery() - closeMenus() - return - } - - // Docs uses fallback insertion - if (!replaceActiveMentionWith(label)) { - insertAtCursor(` @${label} `) - } - - onContextAdd(context) - closeMenus() - }, [ - selectedContexts, - replaceActiveMentionWith, - insertAtCursor, - onContextAdd, - resetActiveMentionQuery, - closeMenus, - ]) - const handlers = useMemo( () => ({ insertPastChatMention: createInsertHandler(FOLDER_CONFIGS.chats), @@ -128,9 +97,8 @@ export function useMentionInsertHandlers({ insertWorkflowBlockMention: createInsertHandler(FOLDER_CONFIGS['workflow-blocks']), insertLogMention: createInsertHandler(FOLDER_CONFIGS.logs), insertIntegrationMention: createInsertHandler(FOLDER_CONFIGS.integrations), - insertDocsMention, }), - [createInsertHandler, insertDocsMention] + [createInsertHandler] ) return handlers diff --git a/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/copilot/components/user-input/hooks/use-mention-keyboard.ts b/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/copilot/components/user-input/hooks/use-mention-keyboard.ts index 8ab898483ff..1c7c5d9a5d7 100644 --- a/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/copilot/components/user-input/hooks/use-mention-keyboard.ts +++ b/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/copilot/components/user-input/hooks/use-mention-keyboard.ts @@ -29,7 +29,6 @@ interface UseMentionKeyboardProps { insertWorkflowBlockMention: (blk: any) => void insertLogMention: (log: any) => void insertIntegrationMention: (integration: any) => void - insertDocsMention: () => void } /** Folder navigation state exposed from MentionMenu via callback */ mentionFolderNav: MentionFolderNav | null @@ -114,9 +113,9 @@ export function useMentionKeyboard({ * Build aggregated list matching the portal's ordering */ const buildAggregatedList = useCallback( - (query: string): Array<{ type: MentionFolderId | 'docs'; value: any }> => { + (query: string): Array<{ type: MentionFolderId; value: any }> => { const q = query.toLowerCase() - const result: Array<{ type: MentionFolderId | 'docs'; value: any }> = [] + const result: Array<{ type: MentionFolderId; value: any }> = [] for (const folderId of FOLDER_ORDER) { const filtered = filterFolderItems(folderId, q) @@ -125,10 +124,6 @@ export function useMentionKeyboard({ }) } - if ('docs'.includes(q)) { - result.push({ type: 'docs', value: null }) - } - return result }, [filterFolderItems] @@ -215,13 +210,6 @@ export function useMentionKeyboard({ e.preventDefault() - const isDocsSelected = mentionActiveIndex === FOLDER_ORDER.length - if (isDocsSelected) { - resetActiveMentionQuery() - insertHandlers.insertDocsMention() - return true - } - const selectedFolderId = FOLDER_ORDER[mentionActiveIndex] if (selectedFolderId) { const config = FOLDER_CONFIGS[selectedFolderId] @@ -242,7 +230,6 @@ export function useMentionKeyboard({ resetActiveMentionQuery, setSubmenuQueryStart, ensureFolderLoaded, - insertHandlers, ] ) @@ -283,12 +270,8 @@ export function useMentionKeyboard({ const idx = Math.max(0, Math.min(submenuActiveIndex, aggregated.length - 1)) const chosen = aggregated[idx] if (chosen) { - if (chosen.type === 'docs') { - insertHandlers.insertDocsMention() - } else { - const handler = insertHandlerMap[chosen.type] - handler(chosen.value) - } + const handler = insertHandlerMap[chosen.type] + handler(chosen.value) } return true } @@ -306,13 +289,6 @@ export function useMentionKeyboard({ return true } - const isDocsSelected = mentionActiveIndex === FOLDER_ORDER.length - if (isDocsSelected) { - resetActiveMentionQuery() - insertHandlers.insertDocsMention() - return true - } - const selectedFolderId = FOLDER_ORDER[mentionActiveIndex] if (selectedFolderId && mentionFolderNav) { const config = FOLDER_CONFIGS[selectedFolderId] @@ -342,7 +318,6 @@ export function useMentionKeyboard({ setSubmenuActiveIndex, setSubmenuQueryStart, ensureFolderLoaded, - insertHandlers, ] ) diff --git a/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/copilot/components/user-input/hooks/use-mention-menu.ts b/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/copilot/components/user-input/hooks/use-mention-menu.ts index 3e9a390f5ac..fd9d826c6cf 100644 --- a/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/copilot/components/user-input/hooks/use-mention-menu.ts +++ b/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/copilot/components/user-input/hooks/use-mention-menu.ts @@ -229,7 +229,7 @@ export function useMentionMenu({ /** * Inserts text at the current cursor position * - * @param text - Text to insert (e.g., " @Docs ") + * @param text - Text to insert at the current cursor position */ const insertAtCursor = useCallback( (text: string) => { diff --git a/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/copilot/components/user-input/utils.ts b/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/copilot/components/user-input/utils.ts index 3e8c4d8be5d..c1e87d5a5ab 100644 --- a/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/copilot/components/user-input/utils.ts +++ b/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/copilot/components/user-input/utils.ts @@ -305,8 +305,6 @@ export function areContextsEqual(c: ChatContext, context: ChatContext): boolean const ctx = context as IntegrationContext return c.blockType === ctx.blockType } - case 'docs': - return true // Only one docs context allowed case 'slash_command': { const ctx = context as SlashCommandContext return c.command === ctx.command diff --git a/apps/sim/lib/copilot/chat/display-message.test.ts b/apps/sim/lib/copilot/chat/display-message.test.ts index e70a32314a4..907dd2e650e 100644 --- a/apps/sim/lib/copilot/chat/display-message.test.ts +++ b/apps/sim/lib/copilot/chat/display-message.test.ts @@ -150,12 +150,12 @@ describe('display-message', () => { const display = toDisplayMessage({ id: 'msg-selection', role: 'user', - content: '@Docs @Terminal', + content: '@Guide @Terminal', timestamp: '2024-01-01T00:00:00.000Z', contexts: [ { kind: 'browser_tab', - label: 'Docs', + label: 'Guide', tabId: 'tab-1', selection: { text: 'Selected browser text', @@ -179,7 +179,7 @@ describe('display-message', () => { expect(display.contexts).toEqual([ { kind: 'browser_tab', - label: 'Docs', + label: 'Guide', tabId: 'tab-1', selection: { text: 'Selected browser text', diff --git a/apps/sim/lib/copilot/chat/persisted-message.test.ts b/apps/sim/lib/copilot/chat/persisted-message.test.ts index 304a9dcfce7..fe2ffff91c7 100644 --- a/apps/sim/lib/copilot/chat/persisted-message.test.ts +++ b/apps/sim/lib/copilot/chat/persisted-message.test.ts @@ -280,11 +280,11 @@ describe('persisted-message', () => { it('round-trips browser and terminal selection snapshots', () => { const persisted = buildPersistedUserMessage({ id: 'user-selection', - content: '@Docs @Terminal', + content: '@Guide @Terminal', contexts: [ { kind: 'browser_tab', - label: 'Docs', + label: 'Guide', tabId: 'tab-1', selection: { text: 'Selected browser text', @@ -310,7 +310,7 @@ describe('persisted-message', () => { expect(normalized.contexts).toEqual([ { kind: 'browser_tab', - label: 'Docs', + label: 'Guide', tabId: 'tab-1', selection: { text: 'Selected browser text', diff --git a/apps/sim/lib/copilot/chat/post.ts b/apps/sim/lib/copilot/chat/post.ts index 0bde82a6c45..d696cae7133 100644 --- a/apps/sim/lib/copilot/chat/post.ts +++ b/apps/sim/lib/copilot/chat/post.ts @@ -205,7 +205,6 @@ const ChatContextSchema = z 'logs', 'workflow_block', 'knowledge', - 'docs', 'table', 'table_selection', 'file', @@ -458,12 +457,11 @@ async function resolveAgentContexts(params: { contexts?: UnifiedChatRequest['contexts'] resourceAttachments?: UnifiedChatRequest['resourceAttachments'] userId: string - message: string workspaceId?: string chatId?: string requestId: string }): Promise> { - const { contexts, resourceAttachments, userId, message, workspaceId, chatId, requestId } = params + const { contexts, resourceAttachments, userId, workspaceId, chatId, requestId } = params let agentContexts: Array<{ type: string; content: string; tag?: string; path?: string }> = [] @@ -472,7 +470,6 @@ async function resolveAgentContexts(params: { agentContexts = await processContextsServer( contexts as ChatContext[], userId, - message, workspaceId, chatId ) @@ -1279,7 +1276,6 @@ export async function handleUnifiedChatPost(req: NextRequest) { contexts: normalizedContexts, resourceAttachments: body.resourceAttachments, userId: authenticatedUserId, - message: body.message, workspaceId, chatId: actualChatId, requestId, diff --git a/apps/sim/lib/copilot/chat/process-contents.test.ts b/apps/sim/lib/copilot/chat/process-contents.test.ts index f36f755f587..03d0b0d4706 100644 --- a/apps/sim/lib/copilot/chat/process-contents.test.ts +++ b/apps/sim/lib/copilot/chat/process-contents.test.ts @@ -75,9 +75,8 @@ describe('processContextsServer - knowledge contexts', () => { it('reads through the fixed application query with a trusted chat principal', async () => { const result = await processContextsServer( - [{ kind: 'knowledge', knowledgeId: 'knowledge-1', label: 'Docs' } as ChatContext], + [{ kind: 'knowledge', knowledgeId: 'knowledge-1', label: 'Product KB' } as ChatContext], 'dual-workspace-user', - 'hello', 'workspace-a', 'chat-1' ) @@ -98,7 +97,7 @@ describe('processContextsServer - knowledge contexts', () => { expect(result).toEqual([ { type: 'knowledge', - tag: '@Docs', + tag: '@Product KB', content: '', path: 'knowledgebases/Product%20docs/meta.json', }, @@ -112,7 +111,6 @@ describe('processContextsServer - knowledge contexts', () => { processContextsServer( [{ kind: 'knowledge', knowledgeId: 'knowledge-b', label: 'Hidden' } as ChatContext], 'dual-workspace-user', - 'hello', 'workspace-a', 'chat-1' ) @@ -126,7 +124,6 @@ describe('processContextsServer - knowledge contexts', () => { processContextsServer( [{ kind: 'knowledge', knowledgeId: 'knowledge-b', label: 'Hidden' } as ChatContext], 'dual-workspace-user', - 'hello', 'workspace-a', 'chat-1' ) @@ -159,7 +156,6 @@ describe('processContextsServer - block contexts', () => { { kind: 'blocks', blockIds: ['notion'], label: 'Notion' } as ChatContext, ], 'user-1', - 'hello', 'workspace-1' ) @@ -190,7 +186,6 @@ describe('processContextsServer - skill contexts', () => { const result = await processContextsServer( [{ kind: 'skill', skillId: 'sk-1', label: 'My Skill — PostHog' } as ChatContext], 'user-1', - 'hello', 'ws-1' ) @@ -217,7 +212,6 @@ describe('processContextsServer - skill contexts', () => { const result = await processContextsServer( [{ kind: 'skill', skillId, label: 'Skill' } as ChatContext], 'user-1', - 'hello', 'ws-1' ) @@ -240,7 +234,6 @@ describe('processContextsServer - skill contexts', () => { const result = await processContextsServer( [{ kind: 'skill', skillId: 'missing', label: 'x' } as ChatContext], 'user-1', - 'hello', 'ws-1' ) @@ -251,7 +244,6 @@ describe('processContextsServer - skill contexts', () => { const result = await processContextsServer( [{ kind: 'skill', skillId: 'sk-1', label: 'x' } as ChatContext], 'user-1', - 'hello', undefined ) @@ -266,7 +258,6 @@ describe('processContextsServer - skill contexts', () => { const result = await processContextsServer( [{ kind: 'skill', skillId, label: 'Skill 1' } as ChatContext], 'user-1', - 'hello', 'ws-1' ) @@ -282,23 +273,6 @@ describe('processContextsServer - skill contexts', () => { }) }) -describe('processContextsServer - docs contexts', () => { - beforeEach(() => { - vi.clearAllMocks() - }) - - it('resolves a tagged docs context to nothing while @docs tagging is disabled', async () => { - const result = await processContextsServer( - [{ kind: 'docs', label: 'Docs' } as ChatContext], - 'user-1', - 'how do loops work @Docs', - 'ws-1' - ) - - expect(result).toEqual([]) - }) -}) - describe('processContextsServer - MCP contexts', () => { beforeEach(() => { vi.clearAllMocks() @@ -318,7 +292,6 @@ describe('processContextsServer - MCP contexts', () => { const result = await processContextsServer( [{ kind: 'mcp', serverId: 'mcp-server-1', label: 'Docs' }], 'user-1', - '/Docs find auth docs', 'ws-1' ) @@ -479,7 +452,6 @@ describe('processContextsServer - logs contexts', () => { const result = await processContextsServer( [{ kind: 'logs', executionId: 'exec-1', label: 'My Flow' } as ChatContext], 'user-1', - 'hello', 'ws-1' ) @@ -547,7 +519,6 @@ describe('processContextsServer - logs contexts', () => { const result = await processContextsServer( [{ kind: 'logs', executionId: 'exec-1', label: 'My Flow' } as ChatContext], 'user-1', - 'hello', 'ws-1' ) @@ -581,7 +552,6 @@ describe('processContextsServer - logs contexts', () => { const result = await processContextsServer( [{ kind: 'logs', executionId: 'exec-1', label: 'My Flow' } as ChatContext], 'user-1', - 'hello', 'ws-1' ) @@ -611,7 +581,6 @@ describe('processContextsServer - logs contexts', () => { const result = await processContextsServer( [{ kind: 'logs', executionId: 'exec-1', label: 'My Flow' } as ChatContext], 'user-1', - 'hello', 'ws-1' ) @@ -646,7 +615,6 @@ describe('processContextsServer - file_selection contexts', () => { } as ChatContext, ], 'user-1', - 'explain this', 'ws-1' ) @@ -673,7 +641,6 @@ describe('processContextsServer - file_selection contexts', () => { } as ChatContext, ], 'user-1', - 'hello', 'ws-1' ) @@ -696,7 +663,6 @@ describe('processContextsServer - file_selection contexts', () => { } as ChatContext, ], 'user-1', - 'explain', 'ws-1' ) @@ -743,7 +709,6 @@ describe('processContextsServer - table_selection contexts', () => { } as ChatContext, ], 'user-1', - 'summarize', 'ws-1' ) @@ -776,7 +741,6 @@ describe('processContextsServer - table_selection contexts', () => { } as ChatContext, ], 'user-1', - 'hello', 'ws-1' ) @@ -804,7 +768,6 @@ describe('processContextsServer - table_selection contexts', () => { } as ChatContext, ], 'user-1', - 'summarize', 'ws-1' ) @@ -839,7 +802,6 @@ describe('processContextsServer - table_selection contexts', () => { } as ChatContext, ], 'user-1', - 'summarize', 'ws-1' ) @@ -880,7 +842,6 @@ describe('processContextsServer - table_selection contexts', () => { } as ChatContext, ], 'user-1', - 'summarize', 'ws-1' ) @@ -918,7 +879,6 @@ describe('processContextsServer - table_selection contexts', () => { } as ChatContext, ], 'user-1', - 'summarize', 'ws-1' ) @@ -947,7 +907,6 @@ describe('processContextsServer - table_selection contexts', () => { } as ChatContext, ], 'user-1', - 'summarize', 'ws-1' ) diff --git a/apps/sim/lib/copilot/chat/process-contents.ts b/apps/sim/lib/copilot/chat/process-contents.ts index c5a49d8a787..2d7a47d63ab 100644 --- a/apps/sim/lib/copilot/chat/process-contents.ts +++ b/apps/sim/lib/copilot/chat/process-contents.ts @@ -120,8 +120,6 @@ function formatTerminalSelection(selection: TerminalTextSelection): string { export async function processContextsServer( contexts: ChatContext[] | undefined, userId: string, - /** Retained for call-site compatibility; unused while @docs tagging is disabled. */ - _userMessage: string | undefined, currentWorkspaceId?: string, chatId?: string ): Promise { @@ -311,9 +309,6 @@ export async function processContextsServer( path: result.path, } } - // `docs` contexts are intentionally inert: @docs tagging is disabled while - // the docs corpus moves to the `docs/` VFS tree. A tagged context resolves - // to nothing and is filtered out below. return null } catch (error) { logger.error('Failed processing context (server)', { ctx, error }) diff --git a/apps/sim/lib/copilot/docs/docs-corpus.test.ts b/apps/sim/lib/copilot/docs/docs-corpus.test.ts index 33211bb7b9b..e1222c9ab36 100644 --- a/apps/sim/lib/copilot/docs/docs-corpus.test.ts +++ b/apps/sim/lib/copilot/docs/docs-corpus.test.ts @@ -16,7 +16,6 @@ import { readDocsPage, } from '@/lib/copilot/docs/docs-corpus' import { DOCS_MANIFEST } from '@/lib/copilot/generated/docs-manifest' -import type { GrepMatch } from '@/lib/copilot/vfs/operations' const SAMPLE_PAGE = DOCS_MANIFEST.find((path) => path === 'workflows/blocks/agent.mdx') @@ -142,14 +141,17 @@ describe('readDocsPage', () => { await expect(readDocsPage(`docs/${SAMPLE_PAGE}`)).rejects.toThrow(/could not be reached/) expect(fetchMock).toHaveBeenCalledTimes(3) }) + + it('treats 408 as retryable rather than a missing page', async () => { + fetchMock.mockResolvedValue({ ok: false, status: 408, text: async () => '' }) + await expect(readDocsPage(`docs/${SAMPLE_PAGE}`)).rejects.toThrow(/could not be reached/) + expect(fetchMock).toHaveBeenCalledTimes(3) + }) }) describe('grepDocs', () => { const fetchMock = vi.fn() const SECTION_DIR = 'docs/workflows/blocks' - const SECTION_PAGES = DOCS_MANIFEST.filter((path) => path.startsWith('workflows/blocks/')).map( - (path) => `docs/${path}` - ) beforeEach(() => { fetchMock.mockReset() @@ -175,51 +177,15 @@ describe('grepDocs', () => { ]) }) - it('greps a directory by fetching every page under it', async () => { - fetchMock.mockResolvedValue({ - ok: true, - status: 200, - text: async () => 'intro\ncron marker line\ntail', - }) - expect(SECTION_PAGES.length).toBeGreaterThan(1) - - const matches = (await grepDocs(SECTION_DIR, 'cron marker', { - maxResults: 10_000, - })) as GrepMatch[] - - expect(fetchMock).toHaveBeenCalledTimes(SECTION_PAGES.length) - expect(matches.map((match) => match.path)).toEqual(SECTION_PAGES) - }) - - it('skips pages the site no longer serves instead of failing the directory grep', async () => { - const missingUrl = `https://docs.sim.ai/${SECTION_PAGES[0].slice('docs/'.length)}` - fetchMock.mockImplementation(async (url: string) => - url === missingUrl - ? { ok: false, status: 404, text: async () => '' } - : { ok: true, status: 200, text: async () => 'cron marker line' } - ) - - const matches = (await grepDocs(SECTION_DIR, 'cron marker', { - maxResults: 10_000, - })) as GrepMatch[] - - expect(matches.map((match) => match.path)).toEqual(SECTION_PAGES.slice(1)) - }) - - it('fails the whole directory grep when a page cannot be reached', async () => { - fetchMock.mockImplementation(async (url: string) => - url.endsWith(`/${SAMPLE_PAGE}`) - ? { ok: false, status: 502, text: async () => '' } - : { ok: true, status: 200, text: async () => 'cron marker line' } + it('rejects a directory without fetching any pages', async () => { + await expect(grepDocs(SECTION_DIR, 'cron marker')).rejects.toThrow( + /grep must target one docs page/ ) - - await expect(grepDocs(SECTION_DIR, 'cron marker')).rejects.toThrow(/Retry shortly/) + expect(fetchMock).not.toHaveBeenCalled() }) it('rejects a path that is neither a page nor a directory without fetching', async () => { - await expect(grepDocs('docs/not-a-real-page.mdx', 'cron')).rejects.toThrow( - /not a docs page or directory/ - ) + await expect(grepDocs('docs/not-a-real-page.mdx', 'cron')).rejects.toThrow(/not a docs page/) expect(fetchMock).not.toHaveBeenCalled() }) }) diff --git a/apps/sim/lib/copilot/docs/docs-corpus.ts b/apps/sim/lib/copilot/docs/docs-corpus.ts index 11462895bb8..27e249b1ac7 100644 --- a/apps/sim/lib/copilot/docs/docs-corpus.ts +++ b/apps/sim/lib/copilot/docs/docs-corpus.ts @@ -1,14 +1,11 @@ -import { trace } from '@opentelemetry/api' import { createLogger } from '@sim/logger' import { toError } from '@sim/utils/errors' import { sleep } from '@sim/utils/helpers' import { backoffWithJitter } from '@sim/utils/retry' import { foldDocsIndexPath } from '@/lib/copilot/docs/docs-path' import { DOCS_MANIFEST } from '@/lib/copilot/generated/docs-manifest' -import { TraceAttr } from '@/lib/copilot/generated/trace-attributes-v1' import type { GrepCountEntry, GrepMatch, GrepOptions } from '@/lib/copilot/vfs/operations' -import { glob as globPaths, grep, grepReadResult } from '@/lib/copilot/vfs/operations' -import { mapWithConcurrency } from '@/lib/core/utils/concurrency' +import { glob as globPaths, grepReadResult } from '@/lib/copilot/vfs/operations' const logger = createLogger('DocsCorpus') @@ -22,16 +19,12 @@ const DOCS_PREFIX = 'docs/' const FETCH_ATTEMPT_TIMEOUT_MS = 3_000 const FETCH_MAX_ATTEMPTS = 3 -/** Parallel page fetches for a directory-scoped grep. */ -const GREP_FETCH_CONCURRENCY = 8 - /** * Thrown for expected, user-facing docs-corpus conditions (unknown page, * directory path, site unreachable). The VFS handlers return the message as the * tool error instead of logging an internal failure. */ export class DocsCorpusError extends Error { - readonly code = 'DOCS_CORPUS' as const constructor(message: string) { super(message) this.name = 'DocsCorpusError' @@ -47,10 +40,11 @@ const docsKeyView: Map = new Map( DOCS_MANIFEST.map((path) => [`${DOCS_PREFIX}${path}`, '']) ) -function normalize(path: string): string { - // Trailing slashes are stripped so `docs/` addresses the corpus the same way - // `docs` does — otherwise a trailing-slash glob pattern matches no key and - // silently returns an empty result instead of the corpus listing. +/** + * Normalize a docs path and make `docs/` equivalent to `docs`, avoiding empty + * glob results caused only by a trailing slash. + */ +export function normalizeDocsPath(path: string): string { return path.trim().replace(/^\/+/, '').replace(/\/+$/, '') } @@ -62,7 +56,7 @@ function normalize(path: string): string { */ export function isDocsPath(path: string | undefined): boolean { if (!path) return false - const normalized = normalize(path) + const normalized = normalizeDocsPath(path) return normalized === 'docs' || normalized.startsWith(DOCS_PREFIX) } @@ -79,12 +73,12 @@ export function couldMatchDocsScope(pattern: string | undefined): boolean { /** Manifest paths (and their virtual directories) matching an explicit `docs/` pattern. */ export function globDocs(pattern: string): string[] { - return globPaths(docsKeyView, normalize(pattern)) + return globPaths(docsKeyView, normalizeDocsPath(pattern)) } /** True when `path` is a page in the docs tree. */ export function isDocsPage(path: string): boolean { - return docsKeyView.has(normalize(path)) + return docsKeyView.has(normalizeDocsPath(path)) } /** @@ -101,7 +95,7 @@ export function docsPathForSourceDocument(sourceDocument: string | null): string /** True when `path` is a directory in the docs tree rather than a page. */ export function isDocsDir(path: string): boolean { - const dir = `${normalize(path).replace(/\/+$/, '')}/` + const dir = `${normalizeDocsPath(path).replace(/\/+$/, '')}/` if (dir === DOCS_PREFIX) return true for (const key of docsKeyView.keys()) { if (key.startsWith(dir)) return true @@ -137,7 +131,11 @@ async function fetchDocsPageOnce(url: string): Promise { }) if (!response.ok) { logger.warn('Docs page fetch returned a non-OK status', { url, status: response.status }) - const permanent = response.status >= 400 && response.status < 500 && response.status !== 429 + const permanent = + response.status >= 400 && + response.status < 500 && + response.status !== 408 && + response.status !== 429 return { outcome: permanent ? 'missing' : 'unavailable' } } return { outcome: 'ok', content: await response.text() } @@ -148,7 +146,7 @@ async function fetchDocsPageOnce(url: string): Promise { } async function fetchDocsPage(path: string): Promise { - const key = normalize(path) + const key = normalizeDocsPath(path) if (!docsKeyView.has(key)) return { outcome: 'missing' } const url = `${DOCS_BASE_URL}/${key.slice(DOCS_PREFIX.length)}` for (let attempt = 1; ; attempt++) { @@ -164,7 +162,7 @@ async function fetchDocsPage(path: string): Promise { * surface the message verbatim. */ export async function readDocsPage(path: string): Promise { - const key = normalize(path) + const key = normalizeDocsPath(path) if (!docsKeyView.has(key)) { if (isDocsDir(key)) { const dir = key.replace(/\/+$/, '') @@ -189,49 +187,26 @@ export async function readDocsPage(path: string): Promise { } /** - * Grep the docs corpus. A single page greps just that page. A directory path - * (`docs`, `docs/files`) fans out to every manifest page under it: pages are - * fetched in parallel and searched as one multi-file grep, so results follow - * manifest order and `maxResults` applies across pages. Pages the site no - * longer serves are skipped; a page that cannot be reached after retries fails - * the whole grep, because a silent partial result would misread as "not - * documented". + * Grep one docs page. Directory-wide grep is deliberately unsupported because + * each page is a separate network fetch; use `search_docs` for corpus search or + * `glob("docs/**")` to find a page first. */ export async function grepDocs( path: string, pattern: string, options?: GrepOptions ): Promise { - const key = normalize(path) - if (docsKeyView.has(key)) { - const page = await readDocsPage(key) - return grepReadResult(key, page, pattern, key, options) - } - if (!isDocsDir(key)) { - throw new DocsCorpusError( - `"${path}" is not a docs page or directory. Use glob("docs/**") to list the docs corpus.` - ) - } - const dir = `${key}/` - const pages = [...docsKeyView.keys()].filter((pageKey) => pageKey.startsWith(dir)) - trace.getActiveSpan()?.setAttribute(TraceAttr.CopilotVfsGrepDocsPageCount, pages.length) - let unreachable = 0 - const results = await mapWithConcurrency(pages, GREP_FETCH_CONCURRENCY, async (pageKey) => { - // Once any page is unreachable the grep is going to fail — skip the - // remaining fetches instead of hammering a site that is not answering. - if (unreachable > 0) return null - const result = await fetchDocsPage(pageKey) - if (result.outcome === 'unavailable') unreachable++ - return result - }) - if (unreachable > 0) { + const key = normalizeDocsPath(path) + if (!docsKeyView.has(key)) { + if (isDocsDir(key)) { + throw new DocsCorpusError( + `"${path}" is a docs directory; grep must target one docs page. Use search_docs to search the corpus or glob("${key}/**") to list its pages.` + ) + } throw new DocsCorpusError( - `Could not load every page under ${dir} from ${DOCS_BASE_URL} — a partial grep could misread as "not documented". Retry shortly.` + `"${path}" is not a docs page. Use glob("docs/**") to list the docs corpus.` ) } - const contents = new Map() - results.forEach((result, index) => { - if (result?.outcome === 'ok') contents.set(pages[index], result.content) - }) - return grep(contents, pattern, undefined, options) + const page = await readDocsPage(key) + return grepReadResult(key, page, pattern, key, options) } diff --git a/apps/sim/lib/copilot/docs/docs-path.ts b/apps/sim/lib/copilot/docs/docs-path.ts index b4e5ff66bc1..61785418035 100644 --- a/apps/sim/lib/copilot/docs/docs-path.ts +++ b/apps/sim/lib/copilot/docs/docs-path.ts @@ -18,22 +18,8 @@ export const DOCS_INDEX_SUFFIX = '/index.mdx' /** * Top-level docs sections deliberately left out of the copilot's `docs/` tree. * - * Two places must agree on this list or the corpus goes subtly wrong: the - * manifest generator (which decides what is readable) and the vector search's - * unscoped filter (which decides what is findable). If search still matched an - * unmounted section, every hit there would be a chunk the agent cannot then - * `read` — dropped as stale, silently shrinking the result set. - * - * Mounting a section later is not uniform work, so plan per section: - * - `academy` is plain mdx under `apps/docs/content/docs/en/academy` and is - * already indexed in `docs_embeddings` — removing it here and regenerating - * the manifest is the whole change. - * - `api-reference` is mostly generated from `apps/docs/openapi.json` at build - * time, so its pages have no source mdx for the generator to walk (only the - * four handwritten ones: authentication, getting-started, python, typescript). - * Mounting it properly needs the spec served publicly again — the - * `apps/docs/app/openapi.json` route existed for exactly this and was - * reverted — plus a generator branch that walks the spec's tags. + * The manifest generator and vector search share this list so search cannot + * return pages that the VFS cannot read. */ export const UNMOUNTED_DOCS_SECTIONS = ['academy', 'api-reference'] as const diff --git a/apps/sim/lib/copilot/docs/docs-search.test.ts b/apps/sim/lib/copilot/docs/docs-search.test.ts index 5920c0d9fef..16d19141f43 100644 --- a/apps/sim/lib/copilot/docs/docs-search.test.ts +++ b/apps/sim/lib/copilot/docs/docs-search.test.ts @@ -54,6 +54,7 @@ vi.mock('@sim/db', () => ({ })) import { DocsSearchScopeError, searchDocs } from '@/lib/copilot/docs/docs-search' +import { OrchestrationError } from '@/lib/core/orchestration/types' /** Render a drizzle condition to comparable SQL-ish text for assertions. */ function whereText(): string { @@ -105,16 +106,15 @@ describe('searchDocs path scoping', () => { it('includes a section overview stored in either on-disk layout', async () => { await searchDocs('cron', { path: 'docs/workflows' }) const text = whereText() - // `workflows/index.mdx` is inside the subtree; a sibling `workflows.mdx` is not, - // and fumadocs accepts either, so the scope must name it explicitly. expect(text).toContain('workflows/%') expect(text).toContain('workflows.mdx') }) it('rejects a path outside the docs corpus', async () => { - await expect(searchDocs('cron', { path: 'files/report.pdf' })).rejects.toThrow( - DocsSearchScopeError - ) + const error = await searchDocs('cron', { path: 'files/report.pdf' }).catch((cause) => cause) + expect(error).toBeInstanceOf(DocsSearchScopeError) + expect(error).toBeInstanceOf(OrchestrationError) + expect(error).toMatchObject({ code: 'validation' }) }) it('rejects a docs path that is neither a page nor a section', async () => { @@ -282,7 +282,6 @@ describe('searchDocs topK clamping', () => { }) it('falls back to the default rather than passing NaN to the query', async () => { - // Math.min/Math.max propagate NaN, so a bare clamp would reach `.limit(NaN)`. await searchDocs('cron', { topK: Number.NaN }) expect(capturedLimit.value).toBe(5) await searchDocs('cron', { topK: 'twelve' as unknown as number }) diff --git a/apps/sim/lib/copilot/docs/docs-search.ts b/apps/sim/lib/copilot/docs/docs-search.ts index 0b70d840608..e506dff48ef 100644 --- a/apps/sim/lib/copilot/docs/docs-search.ts +++ b/apps/sim/lib/copilot/docs/docs-search.ts @@ -2,8 +2,15 @@ import { db } from '@sim/db' import { docsEmbeddings } from '@sim/db/schema' import { createLogger } from '@sim/logger' import { and, eq, like, ne, notLike, or, sql } from 'drizzle-orm' -import { docsPathForSourceDocument, isDocsDir, isDocsPage } from '@/lib/copilot/docs/docs-corpus' +import { escapeLikePattern } from '@/lib/api/list-query' +import { + docsPathForSourceDocument, + isDocsDir, + isDocsPage, + normalizeDocsPath, +} from '@/lib/copilot/docs/docs-corpus' import { docsSourceCandidates, UNMOUNTED_DOCS_SECTIONS } from '@/lib/copilot/docs/docs-path' +import { OrchestrationError } from '@/lib/core/orchestration/types' import { generateSearchEmbedding } from '@/lib/knowledge/embeddings' const logger = createLogger('DocsSearch') @@ -42,10 +49,9 @@ export interface DocsSearchOutcome { * section in the docs corpus. Surfaced verbatim so the model can correct itself * rather than reading an empty result as "the docs say nothing about this". */ -export class DocsSearchScopeError extends Error { - readonly code = 'DOCS_SEARCH_SCOPE' as const +export class DocsSearchScopeError extends OrchestrationError { constructor(message: string) { - super(message) + super('validation', message) this.name = 'DocsSearchScopeError' } } @@ -66,7 +72,7 @@ export class DocsSearchScopeError extends Error { * discarded as stale. */ function scopeCondition(path?: string) { - const normalized = (path ?? '').trim().replace(/^\/+/, '').replace(/\/+$/, '') + const normalized = normalizeDocsPath(path ?? '') if (normalized === '' || normalized === 'docs') { return and( ne(docsEmbeddings.sourceDocument, 'index.mdx'), @@ -85,7 +91,6 @@ function scopeCondition(path?: string) { const tail = normalized.slice('docs/'.length) if (isDocsPage(normalized)) { - // One page: on disk it is either `.mdx` or `/index.mdx`. const [pageFile, indexFile] = docsSourceCandidates(tail) return or( eq(docsEmbeddings.sourceDocument, pageFile), @@ -94,10 +99,6 @@ function scopeCondition(path?: string) { } if (isDocsDir(normalized)) { - // Everything under the directory, PLUS a sibling `.mdx`. Fumadocs - // accepts either layout for a section overview and only `/index.mdx` - // is inside the subtree, so matching the prefix alone would silently omit - // the overview for the sibling layout — page scope already covers both. return or( like(docsEmbeddings.sourceDocument, `${escapeLikePattern(tail)}/%`), eq(docsEmbeddings.sourceDocument, `${tail}.mdx`) @@ -109,10 +110,6 @@ function scopeCondition(path?: string) { ) } -function escapeLikePattern(value: string): string { - return value.replace(/[\\%_]/g, (char) => `\\${char}`) -} - /** * Clamp a caller-supplied result count into [1, {@link MAX_TOP_K}]. * @@ -149,12 +146,17 @@ export async function searchDocs( const topK = clampTopK(options?.topK) const where = scopeCondition(options?.path) - logger.info('Executing docs search', { query, topK, path: options?.path ?? null }) + logger.info('Executing docs search', { + queryLength: query.length, + topK, + path: options?.path ?? null, + }) const { embedding: queryEmbedding } = await generateSearchEmbedding(query) if (!queryEmbedding || queryEmbedding.length === 0) { return { results: [], candidatesConsidered: 0, droppedBelowThreshold: 0, droppedStale: 0 } } + const queryVector = JSON.stringify(queryEmbedding) const rows = await db .select({ @@ -162,11 +164,11 @@ export async function searchDocs( sourceDocument: docsEmbeddings.sourceDocument, sourceLink: docsEmbeddings.sourceLink, headerText: docsEmbeddings.headerText, - similarity: sql`1 - (${docsEmbeddings.embedding} <=> ${JSON.stringify(queryEmbedding)}::vector)`, + similarity: sql`1 - (${docsEmbeddings.embedding} <=> ${queryVector}::vector)`, }) .from(docsEmbeddings) .where(where) - .orderBy(sql`${docsEmbeddings.embedding} <=> ${JSON.stringify(queryEmbedding)}::vector`) + .orderBy(sql`${docsEmbeddings.embedding} <=> ${queryVector}::vector`) .limit(topK) const results: DocsSearchResult[] = [] @@ -184,9 +186,9 @@ export async function searchDocs( } results.push({ path, - url: String(row.sourceLink || '#'), - title: String(row.headerText || 'Untitled Section'), - content: String(row.chunkText || ''), + url: row.sourceLink, + title: row.headerText, + content: row.chunkText, similarity: row.similarity, }) } diff --git a/apps/sim/lib/copilot/generated/docs-manifest.ts b/apps/sim/lib/copilot/generated/docs-manifest.ts index 13e896c2bfc..c068a936569 100644 --- a/apps/sim/lib/copilot/generated/docs-manifest.ts +++ b/apps/sim/lib/copilot/generated/docs-manifest.ts @@ -1,9 +1,8 @@ -// AUTO-GENERATED FILE. DO NOT EDIT. -// Generated from apps/docs/content/docs/en by scripts/sync-docs-manifest.ts -// Run: bun run docs-manifest:generate -// - /** + * AUTO-GENERATED FILE. DO NOT EDIT. + * Generated from apps/docs/content/docs/en by scripts/sync-docs-manifest.ts. + * Run: bun run docs-manifest:generate. + * * Every page in the copilot's read-only `docs/` VFS tree, as a path that is * simultaneously the `docs/`-relative VFS path and the docs.sim.ai URL path * (so `docs/workflows/blocks/agent.mdx` reads diff --git a/apps/sim/lib/copilot/generated/tool-catalog-v1.ts b/apps/sim/lib/copilot/generated/tool-catalog-v1.ts index 4d0a4f13977..2930c2ca0a3 100644 --- a/apps/sim/lib/copilot/generated/tool-catalog-v1.ts +++ b/apps/sim/lib/copilot/generated/tool-catalog-v1.ts @@ -3117,12 +3117,12 @@ export const Grep: ToolCatalogEntry = { path: { type: 'string', description: - "Optional scope. A prefix (e.g. 'workflows/', 'environment/', 'internal/') searches the VFS map under it. An exact single-file path under files/ or uploads/ (optionally with /content) searches that file's content only; folders and multi-file trees there are rejected for content search. A docs/ page or directory searches live page text — a directory fans out to every docs page under it.", + "Optional scope. A prefix (e.g. 'workflows/', 'environment/', 'internal/') searches the VFS map under it. An exact supported single-file path searches that file's content; folders and multi-file trees are rejected for content search.", }, pattern: { type: 'string', description: - "Regex pattern to search for. Searches VFS map entries (workflow JSON, metadata, memories) by default; searches a single file's extracted text when path is one files/ or uploads/ file leaf, and live docs page text when path is a docs/ page or directory.", + "Regex pattern to search for. Searches VFS map entries (workflow JSON, metadata, memories) by default, or an exact supported file leaf's content when path selects one.", }, toolTitle: { type: 'string', @@ -4563,7 +4563,7 @@ export const SearchDocs: ToolCatalogEntry = { 'Optional docs/ VFS path (a page such as docs/workflows/blocks/agent.mdx, or a section such as docs/workflows) that limits the search scope', }, query: { type: 'string', description: 'The search query' }, - topK: { type: 'number', description: 'Number of results (default 5, max 25)' }, + topK: { type: 'number', description: 'Number of results (default 5, max 25)', default: 5 }, }, required: ['query'], }, diff --git a/apps/sim/lib/copilot/generated/tool-schemas-v1.ts b/apps/sim/lib/copilot/generated/tool-schemas-v1.ts index c36a3d2bc8b..6ef9d8f2e09 100644 --- a/apps/sim/lib/copilot/generated/tool-schemas-v1.ts +++ b/apps/sim/lib/copilot/generated/tool-schemas-v1.ts @@ -3000,12 +3000,12 @@ export const TOOL_RUNTIME_SCHEMAS: Record = { path: { type: 'string', description: - "Optional scope. A prefix (e.g. 'workflows/', 'environment/', 'internal/') searches the VFS map under it. An exact single-file path under files/ or uploads/ (optionally with /content) searches that file's content only; folders and multi-file trees there are rejected for content search. A docs/ page or directory searches live page text — a directory fans out to every docs page under it.", + "Optional scope. A prefix (e.g. 'workflows/', 'environment/', 'internal/') searches the VFS map under it. An exact supported single-file path searches that file's content; folders and multi-file trees are rejected for content search.", }, pattern: { type: 'string', description: - "Regex pattern to search for. Searches VFS map entries (workflow JSON, metadata, memories) by default; searches a single file's extracted text when path is one files/ or uploads/ file leaf, and live docs page text when path is a docs/ page or directory.", + "Regex pattern to search for. Searches VFS map entries (workflow JSON, metadata, memories) by default, or an exact supported file leaf's content when path selects one.", }, toolTitle: { type: 'string', @@ -4412,6 +4412,7 @@ export const TOOL_RUNTIME_SCHEMAS: Record = { topK: { type: 'number', description: 'Number of results (default 5, max 25)', + default: 5, }, }, required: ['query'], diff --git a/apps/sim/lib/copilot/generated/trace-attributes-v1.ts b/apps/sim/lib/copilot/generated/trace-attributes-v1.ts index 37a9c72387b..5a026a33c3a 100644 --- a/apps/sim/lib/copilot/generated/trace-attributes-v1.ts +++ b/apps/sim/lib/copilot/generated/trace-attributes-v1.ts @@ -279,7 +279,6 @@ export const TraceAttr = { CopilotVfsFileMediaType: 'copilot.vfs.file.media_type', CopilotVfsFileName: 'copilot.vfs.file.name', CopilotVfsFileSizeBytes: 'copilot.vfs.file.size_bytes', - CopilotVfsGrepDocsPageCount: 'copilot.vfs.grep.docs_page_count', CopilotVfsHasAlpha: 'copilot.vfs.has_alpha', CopilotVfsInputBytes: 'copilot.vfs.input.bytes', CopilotVfsInputHeight: 'copilot.vfs.input.height', @@ -925,7 +924,6 @@ export const TraceAttrValues: readonly TraceAttrValue[] = [ 'copilot.vfs.file.media_type', 'copilot.vfs.file.name', 'copilot.vfs.file.size_bytes', - 'copilot.vfs.grep.docs_page_count', 'copilot.vfs.has_alpha', 'copilot.vfs.input.bytes', 'copilot.vfs.input.height', diff --git a/apps/sim/lib/copilot/tools/handlers/vfs.test.ts b/apps/sim/lib/copilot/tools/handlers/vfs.test.ts index 464bb2ccc6b..f858cc57436 100644 --- a/apps/sim/lib/copilot/tools/handlers/vfs.test.ts +++ b/apps/sim/lib/copilot/tools/handlers/vfs.test.ts @@ -746,7 +746,7 @@ describe('vfs handlers docs corpus routing', () => { expect(fetchMock).not.toHaveBeenCalled() }) - it('greps one docs page or a docs directory without touching the workspace VFS', async () => { + it('greps one docs page and rejects directory scope without touching the workspace VFS', async () => { fetchMock.mockResolvedValue({ ok: true, status: 200, @@ -756,16 +756,17 @@ describe('vfs handlers docs corpus routing', () => { const single = await executeVfsGrep({ pattern: 'cron', path: DOCS_PAGE }, GREP_CTX) expect(single.success).toBe(true) - const multi = await executeVfsGrep( + const directory = await executeVfsGrep( { pattern: 'cron', path: 'docs/workflows', maxResults: 10_000 }, GREP_CTX ) - expect(multi.success).toBe(true) - expect(fetchMock.mock.calls.length).toBeGreaterThan(1) + expect(directory.success).toBe(false) + expect(directory.error).toContain('grep must target one docs page') + expect(fetchMock).toHaveBeenCalledOnce() const invalid = await executeVfsGrep({ pattern: 'cron', path: 'docs/not-a-page.mdx' }, GREP_CTX) expect(invalid.success).toBe(false) - expect(invalid.error).toContain('not a docs page or directory') + expect(invalid.error).toContain('not a docs page') expect(getOrMaterializeVFS).not.toHaveBeenCalled() }) @@ -784,6 +785,8 @@ describe('vfs handlers docs corpus routing', () => { const output = result.output as { content: string; totalLines: number } expect(output.totalLines).toBe(totalLines) expect(output.content).toContain('[Page truncated: returned lines 1-') + expect(output.content).toMatch(/offset: \d+ and limit: \d+/) + expect(output.content).toContain('reduce the limit if that window is still too large') expect(JSON.stringify(output).length).toBeLessThanOrEqual(TOOL_RESULT_MAX_INLINE_CHARS) }) diff --git a/apps/sim/lib/copilot/tools/handlers/vfs.ts b/apps/sim/lib/copilot/tools/handlers/vfs.ts index a7b93399238..e46d1f15e31 100644 --- a/apps/sim/lib/copilot/tools/handlers/vfs.ts +++ b/apps/sim/lib/copilot/tools/handlers/vfs.ts @@ -135,23 +135,20 @@ async function canReturnWorkspaceFileValue( } /** - * Trim an oversized docs page to the largest whole-line prefix that fits the + * Trim an oversized docs page to a whole-line prefix that fits the * inline budget, preserving the true `totalLines` so the model can page through * the rest with offset/limit. Returns null when not even one line fits — a * single line longer than the cap — so the caller can fail instead of returning - * an over-cap payload as success. + * an over-cap payload as success. The notice offers grep as an alternative to + * another read because either operation fetches the page once. */ function truncateDocsPageToInlineCap(page: { content: string; totalLines: number }): { output: { content: string; totalLines: number } returnedLines: number } | null { const lines = page.content.split('\n') - // Route to ONE more fetch, not two. Telling the model to grep and then read - // costs two more uncached fetches of a page it already partly has; grep and - // read cost the same single fetch, so grep is an alternative to a read here, - // never a step before one. const notice = (shown: number) => - `\n\n[Page truncated: returned lines 1-${shown} of ${page.totalLines}. To continue, read this path with offset: ${shown}. To jump straight to a section, grep this path INSTEAD of reading it — grep is the same single fetch and returns only matching lines with their numbers.]` + `\n\n[Page truncated: returned lines 1-${shown} of ${page.totalLines}. To continue, read this path with offset: ${shown} and limit: ${shown}; reduce the limit if that window is still too large. To jump straight to a section, grep this path INSTEAD of reading it — grep is the same single fetch and returns only matching lines with their numbers.]` let kept = lines.length while (kept > 0) { @@ -192,14 +189,6 @@ export async function executeVfsGrep( context: (params.context as number) ?? 0, } - // Routing mirrors read/glob: - // - uploads/ -> grep one chat upload's content (chat-scoped) - // - docs/ -> grep one docs.sim.ai page (one page only — each is a fetch) - // - files/ -> grep one workspace file's content (one file only) - // - everything else -> grep the in-memory VFS map (workflow JSON, metadata) - // Chat uploads and the docs corpus are opt-in like recently-deleted/: they are - // never in the VFS map, so an unscoped grep can't touch them — only an explicit - // uploads/ or docs/ path does, and only one at a time. let result: GrepMatch[] | string[] | GrepCountEntry[] let provenanceFile: WorkspaceFileSecretProvenanceIdentity | undefined if (rawPath !== undefined && isDocsPath(rawPath)) { @@ -298,9 +287,6 @@ export async function executeVfsGlob( } try { - // The docs corpus is a lazy view of docs.sim.ai built from the generated - // manifest, not part of the workspace VFS — an explicit docs/ pattern is the - // only way to see it. if (couldMatchDocsScope(pattern)) { const files = globDocs(pattern) logger.debug('vfs_glob docs result', { pattern, fileCount: files.length }) @@ -375,17 +361,10 @@ export async function executeVfsRead( } } - // Docs pages are fetched from the live docs site on demand — the manifest - // path is the URL path, so there is nothing workspace-scoped to resolve. if (isDocsPath(path)) { const page = await readDocsPage(path) const windowed = applyWindow(page) if (serializedResultSize(windowed) > TOOL_RESULT_MAX_INLINE_CHARS) { - // Several real docs pages (the largest integration references) exceed the - // inline cap, so failing here would make a plain read of them always fail - // and cost a second fetch to recover. Truncate to what fits instead and - // tell the model how to page — but only when it did not ask for a window, - // since an explicit offset/limit that still overflows is a caller error. if (offset !== undefined || limit !== undefined) { return { success: false, @@ -569,8 +548,6 @@ export async function executeVfsRead( output: result, } } catch (err) { - // Expected docs-corpus conditions (unknown page, directory path, site - // unreachable): surface the message verbatim. if (err instanceof DocsCorpusError) { logger.debug('vfs_read docs page rejected', { path, error: err.message }) return { success: false, error: err.message } diff --git a/apps/sim/lib/copilot/tools/server/docs/search-docs.test.ts b/apps/sim/lib/copilot/tools/server/docs/search-docs.test.ts index 37318f5fc53..1b01c4c8dd5 100644 --- a/apps/sim/lib/copilot/tools/server/docs/search-docs.test.ts +++ b/apps/sim/lib/copilot/tools/server/docs/search-docs.test.ts @@ -3,6 +3,7 @@ */ import { beforeEach, describe, expect, it, vi } from 'vitest' import type { DocsSearchOutcome } from '@/lib/copilot/docs/docs-search' +import { ResolvedSecretTraceRegistry } from '@/executor/utils/resolved-secret-trace-registry' const { mockSearchDocs } = vi.hoisted(() => ({ mockSearchDocs: vi.fn(), @@ -32,6 +33,11 @@ const RESULT = { similarity: 0.9, } +const CONTEXT = { + userId: 'user-1', + resolvedSecretTraceRegistry: new ResolvedSecretTraceRegistry(), +} + describe('searchDocsServerTool', () => { beforeEach(() => { mockSearchDocs.mockReset() @@ -40,11 +46,14 @@ describe('searchDocsServerTool', () => { it('forwards query, path, and topK to the search layer', async () => { mockSearchDocs.mockResolvedValue(outcome({ results: [RESULT], candidatesConsidered: 1 })) - const output = await searchDocsServerTool.execute({ - query: 'how do agents work', - path: 'docs/agents.mdx', - topK: 7, - }) + const output = await searchDocsServerTool.execute( + { + query: 'how do agents work', + path: 'docs/agents.mdx', + topK: 7, + }, + CONTEXT + ) expect(mockSearchDocs).toHaveBeenCalledWith('how do agents work', { path: 'docs/agents.mdx', @@ -60,17 +69,27 @@ describe('searchDocsServerTool', () => { it('omits the note when nothing was dropped', async () => { mockSearchDocs.mockResolvedValue(outcome({ results: [RESULT], candidatesConsidered: 1 })) - const output = await searchDocsServerTool.execute({ query: 'q' }) + const output = await searchDocsServerTool.execute({ query: 'q' }, CONTEXT) expect(output.note).toBeUndefined() }) + it('explains when the index returns no candidates', async () => { + mockSearchDocs.mockResolvedValue(outcome({})) + + const output = await searchDocsServerTool.execute({ query: 'brand new feature' }, CONTEXT) + + expect(output.note).toContain('search index may lag') + expect(output.note).toContain('read it directly') + expect(output.note).toContain('glob("docs/**")') + }) + it('explains an empty result set caused by filtering, so it does not read as missing docs', async () => { mockSearchDocs.mockResolvedValue( outcome({ candidatesConsidered: 2, droppedBelowThreshold: 1, droppedStale: 1 }) ) - const output = await searchDocsServerTool.execute({ query: 'q' }) + const output = await searchDocsServerTool.execute({ query: 'q' }, CONTEXT) expect(output.note).toContain('does NOT mean the docs lack this topic') expect(output.note).toContain('1 scored too low') @@ -82,7 +101,7 @@ describe('searchDocsServerTool', () => { outcome({ results: [RESULT], candidatesConsidered: 3, droppedBelowThreshold: 2 }) ) - const output = await searchDocsServerTool.execute({ query: 'q' }) + const output = await searchDocsServerTool.execute({ query: 'q' }, CONTEXT) expect(output.note).toContain('Returned 1 of 3 candidate(s)') expect(output.note).toContain('2 scored too low') @@ -94,9 +113,40 @@ describe('searchDocsServerTool', () => { outcome({ results: [RESULT], candidatesConsidered: 2, droppedStale: 1 }) ) - const output = await searchDocsServerTool.execute({ query: 'q' }) + const output = await searchDocsServerTool.execute({ query: 'q' }, CONTEXT) expect(output.note).toContain('1 point at pages no longer in the docs') expect(output.note).not.toContain('scored too low') }) + + it('projects resolved secrets before embedding or returning the query', async () => { + const registry = new ResolvedSecretTraceRegistry([ + { + name: 'DOCS_QUERY', + plaintext: 'private docs query', + encryptedValue: 'ciphertext', + }, + ]) + registry.recordResolved('DOCS_QUERY', 'private docs query') + mockSearchDocs.mockResolvedValue(outcome({ results: [RESULT], candidatesConsidered: 1 })) + + const output = await searchDocsServerTool.execute( + { query: 'private docs query' }, + { userId: 'user-1', resolvedSecretTraceRegistry: registry } + ) + + expect(mockSearchDocs).toHaveBeenCalledWith('{{DOCS_QUERY}}', { + path: undefined, + topK: undefined, + }) + expect(output.query).toBe('{{DOCS_QUERY}}') + expect(JSON.stringify(output)).not.toContain('private docs query') + }) + + it('fails closed when secret provenance is unavailable', async () => { + await expect(searchDocsServerTool.execute({ query: 'query' })).rejects.toThrow( + 'Docs search query could not be processed safely' + ) + expect(mockSearchDocs).not.toHaveBeenCalled() + }) }) diff --git a/apps/sim/lib/copilot/tools/server/docs/search-docs.ts b/apps/sim/lib/copilot/tools/server/docs/search-docs.ts index 96bdc922e2c..a95e3be3a79 100644 --- a/apps/sim/lib/copilot/tools/server/docs/search-docs.ts +++ b/apps/sim/lib/copilot/tools/server/docs/search-docs.ts @@ -1,7 +1,9 @@ import type { DocsSearchResult } from '@/lib/copilot/docs/docs-search' import { searchDocs } from '@/lib/copilot/docs/docs-search' import { SearchDocs } from '@/lib/copilot/generated/tool-catalog-v1' -import type { BaseServerTool } from '@/lib/copilot/tools/server/base-tool' +import type { BaseServerTool, ServerToolContext } from '@/lib/copilot/tools/server/base-tool' +import { ServerToolModelInputError } from '@/lib/copilot/tools/server/model-input' +import { projectResolvedSecretModelContent } from '@/executor/utils/resolved-secret-content-projection' interface SearchDocsParams { query: string @@ -28,6 +30,9 @@ interface SearchDocsOutput { */ function shortfallNote(outcome: Awaited>): string | undefined { const { results, candidatesConsidered, droppedBelowThreshold, droppedStale } = outcome + if (results.length === 0 && candidatesConsidered === 0) { + return 'No indexed candidates were returned. The search index may lag the live docs. If you know the page, read it directly; otherwise use glob("docs/**") to find the current path.' + } if (droppedBelowThreshold === 0 && droppedStale === 0) return undefined const reasons: string[] = [] @@ -52,12 +57,20 @@ function shortfallNote(outcome: Awaited>): string */ export const searchDocsServerTool: BaseServerTool = { name: SearchDocs.id, - async execute(params: SearchDocsParams): Promise { - const outcome = await searchDocs(params.query, { path: params.path, topK: params.topK }) + async execute(params: SearchDocsParams, context?: ServerToolContext): Promise { + const queryProjection = projectResolvedSecretModelContent( + params.query, + context?.resolvedSecretTraceRegistry + ) + if (!queryProjection.safe || typeof queryProjection.value !== 'string') { + throw new ServerToolModelInputError('Docs search query could not be processed safely') + } + const query = queryProjection.value + const outcome = await searchDocs(query, { path: params.path, topK: params.topK }) const note = shortfallNote(outcome) return { results: outcome.results, - query: params.query, + query, totalResults: outcome.results.length, ...(note ? { note } : {}), } diff --git a/apps/sim/lib/copilot/tools/tool-display.test.ts b/apps/sim/lib/copilot/tools/tool-display.test.ts index 681e555f92d..94cfedd34af 100644 --- a/apps/sim/lib/copilot/tools/tool-display.test.ts +++ b/apps/sim/lib/copilot/tools/tool-display.test.ts @@ -83,13 +83,11 @@ describe('getToolDisplayTitle natural-language coverage', () => { expect(getToolDisplayTitle('search_docs', { query: 'loop blocks iteration' })).toBe( 'Searching Sim docs for "loop blocks iteration"' ) - // The completed-state flip must keep the suffix, not drop back to the bare label. expect( getToolCompletedTitle( getToolDisplayTitle('search_docs', { query: 'how to read workflow logs' }) ) ).toBe('Searched Sim docs for "how to read workflow logs"') - // A long agent-written query is truncated rather than blowing out the chip. expect( getToolDisplayTitle('search_docs', { query: diff --git a/apps/sim/stores/panel/types.ts b/apps/sim/stores/panel/types.ts index 42c4a8cfd54..f5ff7aaa54c 100644 --- a/apps/sim/stores/panel/types.ts +++ b/apps/sim/stores/panel/types.ts @@ -77,7 +77,6 @@ export type ChatContext = } | { kind: 'folder'; folderId: string; label: string } | { kind: 'filefolder'; fileFolderId: string; label: string } - | { kind: 'docs'; label: string } /** * A tab in the desktop browser or terminal panel, dragged into the input to * say "this one". Resource tags remain live pointers; tags created from an diff --git a/docs/ideation/2026-08-03-platform-agent-ideation.html b/docs/ideation/2026-08-03-platform-agent-ideation.html deleted file mode 100644 index cfa784716f5..00000000000 --- a/docs/ideation/2026-08-03-platform-agent-ideation.html +++ /dev/null @@ -1,511 +0,0 @@ - - - - - - Platform agent — ideation - - - -
-
-

Ideation · Platform intelligence

-

Turn the docs agent into a trusted platform operator

-

The strongest direction is not an omniscient agent. It is a source-aware agent that knows the user’s operating context, fetches private state only when needed, explains access and billing in product language, and leaves evidence behind whenever it reads sensitive data.

- -
- Date · - Topic · platform-agent - Mode · repo-grounded - Focus · tools, prompt context, private platform data -
- -
-
30raw candidates
-
12deduped directions
-
6ranked survivors
-
4topic axes covered
-
- - -
- -
-

What the codebase already gives us

-

Grounding Context

-

The branch introduces a dedicated platform child that is intentionally isolated from parent conversation and restricted to documentation search, VFS reads, and response. That isolation is useful, but the runtime already has stronger seams than the prompt admits.

- -
-
-

Trusted request context already exists

-

Child execution carries trusted user/workspace IDs, effective permission, entitlements, timezone, and workspace/session/workflow bootstrap. Human-readable UserMetadata is the notable omission.

-
-
-

Central handlers are the security seam

-

Sim-side tool handlers receive authenticated actor/workspace context and can enforce permission before returning data. Model-supplied IDs do not need to become authority.

-
-
-

Most live data services already exist

-

Billing, permission groups, audit events, execution logs and metrics, and metadata-only subagent invocation records already expose the underlying facts with distinct gates.

-
-
-

Prior art converges on the same split

-

Microsoft, AWS, and Intercom separate ambient identity from permission-trimmed retrieval and persona-specific behavior.

-
-
- -
- - Four source-of-truth layers feeding the platform agent - Injected context, live tools, public docs, and component schemas each answer a different class of question. The platform agent synthesizes them into a scoped answer with provenance. - - - - - - - Injected context - who · where · current role - - - Live Sim tools - private · mutable · scoped - - - Product docs - behavior · limits · UI - - - Component schemas - fields · enums · tool IDs - - - - - - - - Platform agent - chooses authority by question - - - scoped + cited + fresh - - Answer with provenance - -
Directional overview: each source is authoritative for a different kind of fact. The model chooses among them; authorization remains in Sim.
-
-
- -
-

Surface map

-

Topic Axes

-
-

1. Identity and current context

Who is asking, where they are operating, and what request-local context is safe to carry ambiently.

-

2. Access and resource visibility

What the viewer may discover or do, why something is unavailable, and how to avoid resource-existence leaks.

-

3. Plan, billing, and usage

Personal plan, effective coverage, exact workspace payer, usage gates, limits, credits, and management authority.

-

4. Activity, audit, and operational health

What changed, what failed, which evidence source applies, and how private reads become inspectable.

-
-
- -
-

Qualified directions

-

Ranked Ideas

- - -
-
-
1

Idea 1. Context passport + source hierarchy

-
Confidence · 94%Complexity · Low
-
-

Description: Inject a small trusted Current Platform Context block into the child: display name, timezone, workspace name/ID, current workflow or selected resource, effective read|write|admin, broad entitlements, and an asOf value. Rewrite the prompt around four authorities: this passport for orientation, live tools for private or mutable facts, docs for product behavior, and component schemas for exact configuration.

-
-
Axis
Identity and current context
-
Basis
direct: The request already threads trusted workspace, permission, entitlement, timezone, session/workflow bootstrap, and VFS inventory to the child, but not human-readable UserMetadata. The current prompt already distinguishes docs behavior from schema truth, so this adds the missing live-data tier rather than replacing the model.
-
Rationale
It removes repeated disambiguation while creating a crisp rule for stale, conflicting, or private facts. This is the smallest change that makes every later tool safer and easier to use.
-
Downsides
The passport becomes a compatibility contract and must stay deliberately small. Current page/resource context needs careful selection so it does not leak browser state to children unnecessarily.
-
-
- -
-
-
2

Idea 2. Capability/access explainer

-
Confidence · 92%Complexity · Medium
-
-

Description: Add explain_capability(action, resourceType?). It returns available, needs_write, needs_admin, blocked_by_policy, not_entitled, or not_configured, identifies the controlling layer, and gives a safe next step. It never returns names, counts, or existence signals for hidden resources.

-
-
Axis
Access and resource visibility
-
Basis
direct: Sim already combines workspace permission, organization role, permission-group restrictions, integration/model/tool allowlists, and per-viewer feature visibility. Handler-side enforcement and trusted execution context are already the normal boundary.
-
Rationale
This turns “the docs say I can” into “here is whether you can, why, and what legitimate path exists.” It can absorb the useful part of a buildability map without exposing a broad hidden-feature manifest.
-
Downsides
A stable causal vocabulary is product work, not just plumbing. Incorrect denial explanations are worse than a generic denial, so the tool must reuse the same policy decisions as execution rather than reimplementing them.
-
-
- -
-
-
3

Idea 3. Three-lens billing snapshot + run preflight

-
Confidence · 91%Complexity · Medium
-
-

Description: Add one billing tool with explicit lenses: personal_subscription, effective_user_coverage, and current_workspace_payer. Return only decision-ready fields—plan/status, usable/block state, usage and limit, credits, period, management authority, freshness—and an optional operation preflight that reports the first live gate and user-appropriate remediation.

-
-
Personal

What the user personally owns or pays for.

-
Effective

What coverage the user currently receives.

-
Workspace payer

Which billing pool governs work here.

-
-
-
Axis
Plan, billing, and usage
-
Basis
direct: Those three meanings deliberately differ in the billing code. Billing status also differs from product-usable access, and enforcement-grade reads have stronger freshness requirements than display reads.
-
Rationale
A naïve get_plan would encode the wrong product semantics. A lens-based projection answers “what plan am I on?”, “who pays for this?”, and “why is this run blocked?” without exposing raw subscriptions, Stripe identifiers, invoices, or other members’ usage.
-
Downsides
Organizations and personal accounts need different redaction and management guidance. Live preflight may cost more than a replica-backed informational answer, so freshness must be explicit.
-
-
- -
-
-
4

Idea 4. Evidence-routed activity investigator

-
Confidence · 88%Complexity · High
-
-

Description: Add investigate_activity(question, timeRange). It classifies the symptom and queries only the authorized evidence family: execution percentiles for latency, workflow logs for failures, organization audit events for “who changed this?”, and metadata-only subagent invocation records for delegation health. It returns a bounded timeline, saved filters or deep links, truncation/freshness notices, and facts clearly separated from hypotheses.

-
-
Axis
Activity, audit, and operational health
-
Basis
direct: Sim already has each source with separate authorization, filter, pagination, and payload semantics. external: Azure copilots use reviewable queries and deep links rather than becoming a parallel source of truth.
-
Rationale
This is the step-function move: the platform agent becomes a credible first responder for “what changed?” and “why did this fail?” while preserving the authority of existing observability surfaces.
-
Downsides
Joining evidence can create false causality. The first version should route and summarize rather than claim root cause, and enterprise audit access must stay independently gated.
-
-
- -
-
-
5

Idea 5. Sensitive-read receipts

-
Confidence · 87%Complexity · Medium
-
-

Description: Treat read-only billing, audit, member, and execution-data access as sensitive. Every lookup emits a metadata-only receipt containing actor, scope, tool, authorization result, reason or query hash, timestamp, and trace linkage—never the returned private body. The prompt briefly discloses when private records were inspected and offers an inspectable activity link.

-
-
Axis
Activity, audit, and operational health
-
Basis
direct: Sim already records audit metadata and durable subagent-invocation metadata without conversational content. external: AWS and Google log agent-mediated or admin data reads, including dry-run permission checks.
-
Rationale
This is the trust foundation for every private-data tool. It makes agent access governable and answers the security question “what did the agent look at?” without storing sensitive outputs twice.
-
Downsides
Receipts create volume, retention, and user-experience questions. Query hashes and reason fields must avoid becoming a new content-leak channel.
-
-
- -
-
-
6

Idea 6. Persona/access evaluation matrix

-
Confidence · 85%Complexity · Medium
-
-

Description: Evaluate the same platform questions as free/paid, member/admin/owner, billing-manager/non-manager, policy-restricted/unrestricted, and resource-access/no-access personas. Assert the answer, visible tools, denial wording, non-disclosure, citations, freshness labels, and sensitive-read receipts—not only whether a handler returns 200 or 403.

-
-
Axis
Access and resource visibility
-
Basis
external: Intercom tests Fin as real or synthetic users, plans, audiences, and brands while inspecting triggered behavior. direct: Sim’s access semantics span enough independent layers that isolated handler tests cannot validate what the model ultimately says.
-
Rationale
This converts permission awareness from an architectural claim into product behavior that can be regression-tested. It is especially valuable for “must not reveal” cases where a function-level authorization test can pass while the answer leaks context.
-
Downsides
Model-evaluation stability and fixture maintenance are real costs. Start with a small invariant suite around identity, capability denials, billing lenses, and audit authorization.
-
-
Useful invariantThe same question should produce different, correct answers for a member and an admin—without either answer mentioning what the other persona can see.
-
-
- -
-

What did not survive intact

-

Rejection Summary

- - - - - - - - - - - -
#IdeaReason rejected or merged
1Viewer-specific buildability mapThe proposed breadth outran current evidence; its supported capability categories were folded into Idea 2.
2Standalone run-capability preflightStrong but duplicate; merged into the exact-payer billing semantics in Idea 3.
3Usage-driver narrativeReduced public logs do not support detailed workflow attribution without crossing payer-sensitive boundaries.
4Standalone source hierarchyStrong but inseparable from ambient context design; merged into Idea 1.
5Intent-gated private-tool revealRequest-time permission filtering already exists; extra progressive revelation lacked demonstrated value.
6Standalone deep-link behaviorValuable response behavior rather than a product direction; merged into Idea 4.
7Repeated context, access, billing, and incident variantsFive independent lenses converged; duplicates were combined into the strongest source-aware forms above.
-
- -
Composed by ce-ideate from the platform-agent enhancement prompt and the active Sim/Mothership worktrees.
-
- - diff --git a/scripts/sync-docs-manifest.ts b/scripts/sync-docs-manifest.ts index 7373a72e26c..35a240bd836 100644 --- a/scripts/sync-docs-manifest.ts +++ b/scripts/sync-docs-manifest.ts @@ -66,12 +66,11 @@ function toDocsPath(mdxPath: string): string | null { function render(paths: string[]): string { const entries = paths.map((path) => ` '${path}',`).join('\n') - return `// AUTO-GENERATED FILE. DO NOT EDIT. -// Generated from apps/docs/content/docs/en by scripts/sync-docs-manifest.ts -// Run: bun run docs-manifest:generate -// - -/** + return `/** + * AUTO-GENERATED FILE. DO NOT EDIT. + * Generated from apps/docs/content/docs/en by scripts/sync-docs-manifest.ts. + * Run: bun run docs-manifest:generate. + * * Every page in the copilot's read-only \`docs/\` VFS tree, as a path that is * simultaneously the \`docs/\`-relative VFS path and the docs.sim.ai URL path * (so \`docs/workflows/blocks/agent.mdx\` reads From 4805cf3684fc4eb663155416fb29049305fab410 Mon Sep 17 00:00:00 2001 From: Justin Blumencranz <96924014+j15z@users.noreply.github.com> Date: Wed, 12 Aug 2026 17:18:46 -0700 Subject: [PATCH 27/32] improvement(copilot): preserve docs path casing in read labels --- .../lib/copilot/tools/client/store-utils.test.ts | 8 ++++---- apps/sim/lib/copilot/tools/client/store-utils.ts | 14 +++++--------- 2 files changed, 9 insertions(+), 13 deletions(-) diff --git a/apps/sim/lib/copilot/tools/client/store-utils.test.ts b/apps/sim/lib/copilot/tools/client/store-utils.test.ts index fa6de4c0b14..de756b58182 100644 --- a/apps/sim/lib/copilot/tools/client/store-utils.test.ts +++ b/apps/sim/lib/copilot/tools/client/store-utils.test.ts @@ -49,24 +49,24 @@ describe('resolveToolDisplay', () => { ).toBe('Read RET XYZ') }) - it('formats docs corpus reads as Section/page', () => { + it('formats docs corpus reads as section/page', () => { expect( resolveToolDisplay(ReadTool.id, ClientToolCallState.success, { path: 'docs/workflows/blocks/agent.mdx', })?.text - ).toBe('Read Workflows/agent') + ).toBe('Read workflows/agent') expect( resolveToolDisplay(ReadTool.id, ClientToolCallState.executing, { path: 'docs/integrations/gmail.mdx', })?.text - ).toBe('Reading Integrations/gmail') + ).toBe('Reading integrations/gmail') expect( resolveToolDisplay(ReadTool.id, ClientToolCallState.error, { path: 'docs/getting-started.mdx', })?.text - ).toBe('Attempted to read Getting-started') + ).toBe('Attempted to read getting-started') }) it('decodes percent-encoded VFS path segments for display', () => { diff --git a/apps/sim/lib/copilot/tools/client/store-utils.ts b/apps/sim/lib/copilot/tools/client/store-utils.ts index 1a448d75e5d..5240d0629e6 100644 --- a/apps/sim/lib/copilot/tools/client/store-utils.ts +++ b/apps/sim/lib/copilot/tools/client/store-utils.ts @@ -145,20 +145,16 @@ function describeFileReadTarget(segments: string[]): string { } /** - * Labels a docs/ corpus read as `
/` (e.g. `Workflows/agent` for - * docs/workflows/blocks/agent.mdx). Top-level pages show just their capitalized - * name (e.g. `Getting-started` for docs/getting-started.mdx). + * Labels a docs/ corpus read as `
/` (e.g. `workflows/agent` for + * docs/workflows/blocks/agent.mdx). Top-level pages show just their name (e.g. + * `getting-started` for docs/getting-started.mdx). */ function describeDocsReadTarget(segments: string[]): string { const rest = segments.slice(1) if (rest.length === 0) return 'docs' const leaf = stripExtension(rest[rest.length - 1]) - if (rest.length === 1) return capitalizeFirst(leaf) - return `${capitalizeFirst(rest[0])}/${leaf}` -} - -function capitalizeFirst(value: string): string { - return value.charAt(0).toUpperCase() + value.slice(1) + if (rest.length === 1) return leaf + return `${rest[0]}/${leaf}` } function getLeafResourceSegment(segments: string[]): string { From a16a5933ecd807beb8a105fd68cd0819be769ffb Mon Sep 17 00:00:00 2001 From: Justin Blumencranz <96924014+j15z@users.noreply.github.com> Date: Wed, 12 Aug 2026 17:43:43 -0700 Subject: [PATCH 28/32] improvement(copilot): keep @Docs on search_docs --- .../app/api/mothership/execute/route.test.ts | 14 ++- apps/sim/app/api/mothership/execute/route.ts | 22 +++-- .../chat-context-kind-registry.tsx | 1 + .../components/chip-clipboard-codec.ts | 4 +- .../user-input/components/constants.ts | 6 +- .../prompt-editor/use-prompt-editor.ts | 4 +- .../components/resource-context.test.ts | 4 - .../[workspaceId]/home/hooks/use-chat.ts | 2 + .../components/user-input/constants.ts | 17 +++- .../hooks/use-mention-insert-handlers.ts | 34 ++++++- .../user-input/hooks/use-mention-keyboard.ts | 33 ++++++- .../user-input/hooks/use-mention-menu.ts | 2 +- .../copilot/components/user-input/utils.ts | 2 + .../lib/copilot/chat/display-message.test.ts | 6 +- .../copilot/chat/persisted-message.test.ts | 6 +- apps/sim/lib/copilot/chat/post.ts | 22 ++++- .../lib/copilot/chat/process-contents.test.ts | 98 ++++++++++++++++++- apps/sim/lib/copilot/chat/process-contents.ts | 78 ++++++++++++++- apps/sim/stores/panel/types.ts | 1 + 19 files changed, 313 insertions(+), 43 deletions(-) diff --git a/apps/sim/app/api/mothership/execute/route.test.ts b/apps/sim/app/api/mothership/execute/route.test.ts index 513c4ea3de4..43893921a35 100644 --- a/apps/sim/app/api/mothership/execute/route.test.ts +++ b/apps/sim/app/api/mothership/execute/route.test.ts @@ -224,7 +224,7 @@ describe('mothership private trace provenance transport', () => { { ...requestBody, messages: [{ role: 'user', content: 'secret-value __var_FOREIGN' }], - contexts: [{ kind: 'knowledge', knowledgeId: 'knowledge-1', label: 'Docs' }], + contexts: [{ kind: 'docs', label: 'Docs' }], }, { Authorization: 'Bearer internal', 'x-sim-billing-attribution': 'billing' }, 'http://localhost:3000/api/mothership/execute' @@ -235,9 +235,15 @@ describe('mothership private trace provenance transport', () => { expect(mockProcessContextsServer).toHaveBeenCalledWith( expect.any(Array), 'user-1', + 'secret-value __var_FOREIGN', 'workspace-1', - 'chat-1' + 'chat-1', + expect.any(Object) ) + + const contextRegistry = mockProcessContextsServer.mock.calls.at(-1)?.[5] + const lifecycleOptions = mockRunHeadlessCopilotLifecycle.mock.calls.at(-1)?.[1] + expect(contextRegistry).toBe(lifecycleOptions.environmentContext?.resolvedSecretTraceRegistry) }) it('keeps context routing and display inputs raw until the lifecycle boundary', async () => { @@ -287,8 +293,10 @@ describe('mothership private trace provenance transport', () => { }, ], 'user-1', + 'hello', 'workspace-1', - 'chat-1' + 'chat-1', + expect.any(Object) ) }) diff --git a/apps/sim/app/api/mothership/execute/route.ts b/apps/sim/app/api/mothership/execute/route.ts index fc583885765..e01f727f591 100644 --- a/apps/sim/app/api/mothership/execute/route.ts +++ b/apps/sim/app/api/mothership/execute/route.ts @@ -211,6 +211,7 @@ export const POST = withRouteHandler(async (req: NextRequest) => { workflowId, executionId, }) + const lastUserMessage = messages.filter((message) => message.role === 'user').at(-1)?.content // double-cast-allowed: the contract validates contexts as open kind/label objects; processContextsServer narrows on `kind` at runtime const agentMentions = contexts as unknown as ChatContext[] | undefined const taggedMcpServerIds = (agentMentions ?? []).flatMap((context) => @@ -238,14 +239,19 @@ export const POST = withRouteHandler(async (req: NextRequest) => { buildIntegrationToolSchemas(userId, messageId, undefined, workspaceId), mothershipToolsPromise, computeWorkspaceEntitlements(workspaceId, userId), - processContextsServer(nonMcpAgentMentions, userId, workspaceId, effectiveChatId).catch( - (error) => { - reqLogger.warn('Failed to resolve agent contexts for execution', { - error: toError(error).message, - }) - return [] - } - ), + processContextsServer( + nonMcpAgentMentions, + userId, + lastUserMessage, + workspaceId, + effectiveChatId, + activeResolvedSecretTraceRegistry + ).catch((error) => { + reqLogger.warn('Failed to resolve agent contexts for execution', { + error: toError(error).message, + }) + return [] + }), ]) const requestPayload: Record = { messages, diff --git a/apps/sim/app/workspace/[workspaceId]/home/components/chat-context-kind-registry/chat-context-kind-registry.tsx b/apps/sim/app/workspace/[workspaceId]/home/components/chat-context-kind-registry/chat-context-kind-registry.tsx index 1d6d2ad210f..1a251e0bc4a 100644 --- a/apps/sim/app/workspace/[workspaceId]/home/components/chat-context-kind-registry/chat-context-kind-registry.tsx +++ b/apps/sim/app/workspace/[workspaceId]/home/components/chat-context-kind-registry/chat-context-kind-registry.tsx @@ -110,6 +110,7 @@ export const CHAT_CONTEXT_KIND_REGISTRY: Record , }, + docs: { label: 'Docs', renderIcon: () => null }, slash_command: { label: 'Command', renderIcon: () => null }, integration: { label: 'Integration', renderIcon: renderIntegrationTile }, skill: { diff --git a/apps/sim/app/workspace/[workspaceId]/home/components/user-input/components/chip-clipboard-codec.ts b/apps/sim/app/workspace/[workspaceId]/home/components/user-input/components/chip-clipboard-codec.ts index 378092fac2e..73eb6eff658 100644 --- a/apps/sim/app/workspace/[workspaceId]/home/components/user-input/components/chip-clipboard-codec.ts +++ b/apps/sim/app/workspace/[workspaceId]/home/components/user-input/components/chip-clipboard-codec.ts @@ -19,8 +19,8 @@ const CHIP_LINK_SCHEME = 'sim' * string>>` keeps it union-synced: rename a kind's id field and this stops * type-checking. * - * Kinds absent from this map have no portable single-id representation and - * degrade to plain text. + * Excluded kinds (`current_workflow`, `blocks`, `workflow_block`, `docs`) carry + * no single portable id (an array / two ids / none) and degrade to plain text. */ const PORTABLE_KIND_TO_ID_FIELD = { table: 'tableId', diff --git a/apps/sim/app/workspace/[workspaceId]/home/components/user-input/components/constants.ts b/apps/sim/app/workspace/[workspaceId]/home/components/user-input/components/constants.ts index a0ffd98df46..f24b1890ee7 100644 --- a/apps/sim/app/workspace/[workspaceId]/home/components/user-input/components/constants.ts +++ b/apps/sim/app/workspace/[workspaceId]/home/components/user-input/components/constants.ts @@ -113,7 +113,7 @@ export const SPEECH_RECOGNITION_LANG = 'en-US' // inner tab. The singleton ids ask the agent to inspect the whole resource; // every other id is a precise live-tab pointer. const RESOURCE_TO_CONTEXT: Record< - Exclude, + MothershipResourceType, (resource: MothershipResource) => ChatContext > = { browser: (r) => ({ kind: 'browser_tab', tabId: r.id, label: r.title }), @@ -127,9 +127,9 @@ const RESOURCE_TO_CONTEXT: Record< task: (r) => ({ kind: 'past_chat', chatId: r.id, label: r.title }), log: (r) => ({ kind: 'logs', executionId: r.id, label: r.title }), integration: (r) => ({ kind: 'integration', blockType: r.id, label: r.title }), + generic: (r) => ({ kind: 'docs', label: r.title }), } -export function mapResourceToContext(resource: MothershipResource): ChatContext | null { - if (resource.type === 'generic') return null +export function mapResourceToContext(resource: MothershipResource): ChatContext { return RESOURCE_TO_CONTEXT[resource.type](resource) } diff --git a/apps/sim/app/workspace/[workspaceId]/home/components/user-input/components/prompt-editor/use-prompt-editor.ts b/apps/sim/app/workspace/[workspaceId]/home/components/user-input/components/prompt-editor/use-prompt-editor.ts index 74f25c7f237..f86f69f24a2 100644 --- a/apps/sim/app/workspace/[workspaceId]/home/components/user-input/components/prompt-editor/use-prompt-editor.ts +++ b/apps/sim/app/workspace/[workspaceId]/home/components/user-input/components/prompt-editor/use-prompt-editor.ts @@ -407,9 +407,6 @@ export function usePromptEditor({ const insertResource = useCallback( (resource: MothershipResource) => { - const context = mapResourceToContext(resource) - if (!context) return - const textarea = textareaRef.current if (textarea) { const currentValue = valueRef.current @@ -445,6 +442,7 @@ export function usePromptEditor({ setValueState(newValue) } + const context = mapResourceToContext(resource) addContextNotified(context) }, [textareaRef, addContextNotified] diff --git a/apps/sim/app/workspace/[workspaceId]/home/components/user-input/components/resource-context.test.ts b/apps/sim/app/workspace/[workspaceId]/home/components/user-input/components/resource-context.test.ts index 3441bd0ed61..47e0216319f 100644 --- a/apps/sim/app/workspace/[workspaceId]/home/components/user-input/components/resource-context.test.ts +++ b/apps/sim/app/workspace/[workspaceId]/home/components/user-input/components/resource-context.test.ts @@ -47,8 +47,4 @@ describe('mapResourceToContext', () => { label: 'Leads', }) }) - - it('does not turn a synthetic panel into a chat context', () => { - expect(mapResourceToContext(resource({ type: 'generic', title: 'Results' }))).toBeNull() - }) }) diff --git a/apps/sim/app/workspace/[workspaceId]/home/hooks/use-chat.ts b/apps/sim/app/workspace/[workspaceId]/home/hooks/use-chat.ts index 26cc3ca9fb3..acbea0bd61f 100644 --- a/apps/sim/app/workspace/[workspaceId]/home/hooks/use-chat.ts +++ b/apps/sim/app/workspace/[workspaceId]/home/hooks/use-chat.ts @@ -458,6 +458,8 @@ function isChatContext(value: unknown): value is ChatContext { return typeof value.folderId === 'string' case 'filefolder': return typeof value.fileFolderId === 'string' + case 'docs': + return true case 'slash_command': return typeof value.command === 'string' case 'integration': diff --git a/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/copilot/components/user-input/constants.ts b/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/copilot/components/user-input/constants.ts index 7860b326ae7..d9cdf9702ac 100644 --- a/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/copilot/components/user-input/constants.ts +++ b/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/copilot/components/user-input/constants.ts @@ -12,6 +12,11 @@ export type MentionFolderId = | 'logs' | 'integrations' +/** + * Menu item category types for mention menu (includes folders + docs item) + */ +export type MentionCategory = MentionFolderId | 'docs' + /** * Configuration interface for folder types */ @@ -179,9 +184,17 @@ export const FOLDER_ORDER: MentionFolderId[] = [ ] /** - * Total number of items in the root menu. + * Docs item configuration (special case - not a folder) + */ +export const DOCS_CONFIG = { + getLabel: () => 'Docs', + buildContext: (): ChatContext => ({ kind: 'docs', label: 'Docs' }), +} as const + +/** + * Total number of items in root menu (folders + docs) */ -export const ROOT_MENU_ITEM_COUNT = FOLDER_ORDER.length +export const ROOT_MENU_ITEM_COUNT = FOLDER_ORDER.length + 1 /** * Slash command configuration diff --git a/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/copilot/components/user-input/hooks/use-mention-insert-handlers.ts b/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/copilot/components/user-input/hooks/use-mention-insert-handlers.ts index 8a67a524458..75eb4f7ec50 100644 --- a/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/copilot/components/user-input/hooks/use-mention-insert-handlers.ts +++ b/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/copilot/components/user-input/hooks/use-mention-insert-handlers.ts @@ -1,5 +1,6 @@ import { useCallback, useMemo } from 'react' import { + DOCS_CONFIG, FOLDER_CONFIGS, type FolderConfig, } from '@/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/copilot/components/user-input/constants' @@ -88,6 +89,36 @@ export function useMentionInsertHandlers({ ] ) + /** + * Special handler for Docs (no item parameter, uses DOCS_CONFIG) + */ + const insertDocsMention = useCallback(() => { + const label = DOCS_CONFIG.getLabel() + const context = DOCS_CONFIG.buildContext() + + // Prevent duplicate insertion + if (isContextAlreadySelected(context, selectedContexts)) { + resetActiveMentionQuery() + closeMenus() + return + } + + // Docs uses fallback insertion + if (!replaceActiveMentionWith(label)) { + insertAtCursor(` @${label} `) + } + + onContextAdd(context) + closeMenus() + }, [ + selectedContexts, + replaceActiveMentionWith, + insertAtCursor, + onContextAdd, + resetActiveMentionQuery, + closeMenus, + ]) + const handlers = useMemo( () => ({ insertPastChatMention: createInsertHandler(FOLDER_CONFIGS.chats), @@ -97,8 +128,9 @@ export function useMentionInsertHandlers({ insertWorkflowBlockMention: createInsertHandler(FOLDER_CONFIGS['workflow-blocks']), insertLogMention: createInsertHandler(FOLDER_CONFIGS.logs), insertIntegrationMention: createInsertHandler(FOLDER_CONFIGS.integrations), + insertDocsMention, }), - [createInsertHandler] + [createInsertHandler, insertDocsMention] ) return handlers diff --git a/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/copilot/components/user-input/hooks/use-mention-keyboard.ts b/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/copilot/components/user-input/hooks/use-mention-keyboard.ts index 1c7c5d9a5d7..8ab898483ff 100644 --- a/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/copilot/components/user-input/hooks/use-mention-keyboard.ts +++ b/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/copilot/components/user-input/hooks/use-mention-keyboard.ts @@ -29,6 +29,7 @@ interface UseMentionKeyboardProps { insertWorkflowBlockMention: (blk: any) => void insertLogMention: (log: any) => void insertIntegrationMention: (integration: any) => void + insertDocsMention: () => void } /** Folder navigation state exposed from MentionMenu via callback */ mentionFolderNav: MentionFolderNav | null @@ -113,9 +114,9 @@ export function useMentionKeyboard({ * Build aggregated list matching the portal's ordering */ const buildAggregatedList = useCallback( - (query: string): Array<{ type: MentionFolderId; value: any }> => { + (query: string): Array<{ type: MentionFolderId | 'docs'; value: any }> => { const q = query.toLowerCase() - const result: Array<{ type: MentionFolderId; value: any }> = [] + const result: Array<{ type: MentionFolderId | 'docs'; value: any }> = [] for (const folderId of FOLDER_ORDER) { const filtered = filterFolderItems(folderId, q) @@ -124,6 +125,10 @@ export function useMentionKeyboard({ }) } + if ('docs'.includes(q)) { + result.push({ type: 'docs', value: null }) + } + return result }, [filterFolderItems] @@ -210,6 +215,13 @@ export function useMentionKeyboard({ e.preventDefault() + const isDocsSelected = mentionActiveIndex === FOLDER_ORDER.length + if (isDocsSelected) { + resetActiveMentionQuery() + insertHandlers.insertDocsMention() + return true + } + const selectedFolderId = FOLDER_ORDER[mentionActiveIndex] if (selectedFolderId) { const config = FOLDER_CONFIGS[selectedFolderId] @@ -230,6 +242,7 @@ export function useMentionKeyboard({ resetActiveMentionQuery, setSubmenuQueryStart, ensureFolderLoaded, + insertHandlers, ] ) @@ -270,8 +283,12 @@ export function useMentionKeyboard({ const idx = Math.max(0, Math.min(submenuActiveIndex, aggregated.length - 1)) const chosen = aggregated[idx] if (chosen) { - const handler = insertHandlerMap[chosen.type] - handler(chosen.value) + if (chosen.type === 'docs') { + insertHandlers.insertDocsMention() + } else { + const handler = insertHandlerMap[chosen.type] + handler(chosen.value) + } } return true } @@ -289,6 +306,13 @@ export function useMentionKeyboard({ return true } + const isDocsSelected = mentionActiveIndex === FOLDER_ORDER.length + if (isDocsSelected) { + resetActiveMentionQuery() + insertHandlers.insertDocsMention() + return true + } + const selectedFolderId = FOLDER_ORDER[mentionActiveIndex] if (selectedFolderId && mentionFolderNav) { const config = FOLDER_CONFIGS[selectedFolderId] @@ -318,6 +342,7 @@ export function useMentionKeyboard({ setSubmenuActiveIndex, setSubmenuQueryStart, ensureFolderLoaded, + insertHandlers, ] ) diff --git a/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/copilot/components/user-input/hooks/use-mention-menu.ts b/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/copilot/components/user-input/hooks/use-mention-menu.ts index fd9d826c6cf..3e9a390f5ac 100644 --- a/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/copilot/components/user-input/hooks/use-mention-menu.ts +++ b/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/copilot/components/user-input/hooks/use-mention-menu.ts @@ -229,7 +229,7 @@ export function useMentionMenu({ /** * Inserts text at the current cursor position * - * @param text - Text to insert at the current cursor position + * @param text - Text to insert (e.g., " @Docs ") */ const insertAtCursor = useCallback( (text: string) => { diff --git a/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/copilot/components/user-input/utils.ts b/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/copilot/components/user-input/utils.ts index c1e87d5a5ab..3e8c4d8be5d 100644 --- a/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/copilot/components/user-input/utils.ts +++ b/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/copilot/components/user-input/utils.ts @@ -305,6 +305,8 @@ export function areContextsEqual(c: ChatContext, context: ChatContext): boolean const ctx = context as IntegrationContext return c.blockType === ctx.blockType } + case 'docs': + return true // Only one docs context allowed case 'slash_command': { const ctx = context as SlashCommandContext return c.command === ctx.command diff --git a/apps/sim/lib/copilot/chat/display-message.test.ts b/apps/sim/lib/copilot/chat/display-message.test.ts index 907dd2e650e..e70a32314a4 100644 --- a/apps/sim/lib/copilot/chat/display-message.test.ts +++ b/apps/sim/lib/copilot/chat/display-message.test.ts @@ -150,12 +150,12 @@ describe('display-message', () => { const display = toDisplayMessage({ id: 'msg-selection', role: 'user', - content: '@Guide @Terminal', + content: '@Docs @Terminal', timestamp: '2024-01-01T00:00:00.000Z', contexts: [ { kind: 'browser_tab', - label: 'Guide', + label: 'Docs', tabId: 'tab-1', selection: { text: 'Selected browser text', @@ -179,7 +179,7 @@ describe('display-message', () => { expect(display.contexts).toEqual([ { kind: 'browser_tab', - label: 'Guide', + label: 'Docs', tabId: 'tab-1', selection: { text: 'Selected browser text', diff --git a/apps/sim/lib/copilot/chat/persisted-message.test.ts b/apps/sim/lib/copilot/chat/persisted-message.test.ts index fe2ffff91c7..304a9dcfce7 100644 --- a/apps/sim/lib/copilot/chat/persisted-message.test.ts +++ b/apps/sim/lib/copilot/chat/persisted-message.test.ts @@ -280,11 +280,11 @@ describe('persisted-message', () => { it('round-trips browser and terminal selection snapshots', () => { const persisted = buildPersistedUserMessage({ id: 'user-selection', - content: '@Guide @Terminal', + content: '@Docs @Terminal', contexts: [ { kind: 'browser_tab', - label: 'Guide', + label: 'Docs', tabId: 'tab-1', selection: { text: 'Selected browser text', @@ -310,7 +310,7 @@ describe('persisted-message', () => { expect(normalized.contexts).toEqual([ { kind: 'browser_tab', - label: 'Guide', + label: 'Docs', tabId: 'tab-1', selection: { text: 'Selected browser text', diff --git a/apps/sim/lib/copilot/chat/post.ts b/apps/sim/lib/copilot/chat/post.ts index d696cae7133..710ea9ad544 100644 --- a/apps/sim/lib/copilot/chat/post.ts +++ b/apps/sim/lib/copilot/chat/post.ts @@ -205,6 +205,7 @@ const ChatContextSchema = z 'logs', 'workflow_block', 'knowledge', + 'docs', 'table', 'table_selection', 'file', @@ -457,11 +458,22 @@ async function resolveAgentContexts(params: { contexts?: UnifiedChatRequest['contexts'] resourceAttachments?: UnifiedChatRequest['resourceAttachments'] userId: string + message: string workspaceId?: string chatId?: string + resolvedSecretTraceRegistry?: ExecutionContext['resolvedSecretTraceRegistry'] requestId: string }): Promise> { - const { contexts, resourceAttachments, userId, workspaceId, chatId, requestId } = params + const { + contexts, + resourceAttachments, + userId, + message, + workspaceId, + chatId, + resolvedSecretTraceRegistry, + requestId, + } = params let agentContexts: Array<{ type: string; content: string; tag?: string; path?: string }> = [] @@ -470,8 +482,10 @@ async function resolveAgentContexts(params: { agentContexts = await processContextsServer( contexts as ChatContext[], userId, + message, workspaceId, - chatId + chatId, + resolvedSecretTraceRegistry ) } catch (error) { logger.error(`[${requestId}] Failed to process contexts`, error) @@ -1264,7 +1278,7 @@ export async function handleUnifiedChatPost(req: NextRequest) { }), activeOtelRoot.context ) - const agentContextsPromise = executionContextPromise.then(() => { + const agentContextsPromise = executionContextPromise.then((executionContext) => { return withCopilotSpan( TraceSpan.CopilotChatResolveAgentContexts, { @@ -1276,8 +1290,10 @@ export async function handleUnifiedChatPost(req: NextRequest) { contexts: normalizedContexts, resourceAttachments: body.resourceAttachments, userId: authenticatedUserId, + message: body.message, workspaceId, chatId: actualChatId, + resolvedSecretTraceRegistry: executionContext.resolvedSecretTraceRegistry, requestId, }), activeOtelRoot.context diff --git a/apps/sim/lib/copilot/chat/process-contents.test.ts b/apps/sim/lib/copilot/chat/process-contents.test.ts index 03d0b0d4706..73bc3692ea6 100644 --- a/apps/sim/lib/copilot/chat/process-contents.test.ts +++ b/apps/sim/lib/copilot/chat/process-contents.test.ts @@ -10,6 +10,7 @@ import { MAX_TABLE_SELECTION_ROWS, } from '@/lib/copilot/chat/selection-context' import { DelegatedWorkspaceAuthorizationError } from '@/lib/core/application' +import { ResolvedSecretTraceRegistry } from '@/executor/utils/resolved-secret-trace-registry' import type { ChatContext } from '@/stores/panel' const { @@ -25,6 +26,7 @@ const { readKnowledgeBase, getBlockVisibilityForCopilot, isIntegrationDeploymentAvailable, + searchDocsExecute, } = vi.hoisted(() => ({ discoverServerTools: vi.fn(), getBlock: vi.fn(), @@ -38,6 +40,7 @@ const { readKnowledgeBase: vi.fn(), getBlockVisibilityForCopilot: vi.fn(async () => null), isIntegrationDeploymentAvailable: vi.fn(() => true), + searchDocsExecute: vi.fn(), })) vi.mock('@/blocks/registry', () => ({ getBlock, getBlockRegistry })) @@ -57,6 +60,9 @@ vi.mock('@/lib/table/rows/service', () => ({ getRowsByIds })) vi.mock('@/lib/knowledge/application/knowledge-bases', () => ({ readKnowledgeBase: { execute: readKnowledgeBase }, })) +vi.mock('@/lib/copilot/tools/server/docs/search-docs', () => ({ + searchDocsServerTool: { execute: searchDocsExecute }, +})) /** * Overrides the global `@sim/db` mock: the logs-context tests below need @@ -75,8 +81,9 @@ describe('processContextsServer - knowledge contexts', () => { it('reads through the fixed application query with a trusted chat principal', async () => { const result = await processContextsServer( - [{ kind: 'knowledge', knowledgeId: 'knowledge-1', label: 'Product KB' } as ChatContext], + [{ kind: 'knowledge', knowledgeId: 'knowledge-1', label: 'Docs' } as ChatContext], 'dual-workspace-user', + 'hello', 'workspace-a', 'chat-1' ) @@ -97,7 +104,7 @@ describe('processContextsServer - knowledge contexts', () => { expect(result).toEqual([ { type: 'knowledge', - tag: '@Product KB', + tag: '@Docs', content: '', path: 'knowledgebases/Product%20docs/meta.json', }, @@ -111,6 +118,7 @@ describe('processContextsServer - knowledge contexts', () => { processContextsServer( [{ kind: 'knowledge', knowledgeId: 'knowledge-b', label: 'Hidden' } as ChatContext], 'dual-workspace-user', + 'hello', 'workspace-a', 'chat-1' ) @@ -124,6 +132,7 @@ describe('processContextsServer - knowledge contexts', () => { processContextsServer( [{ kind: 'knowledge', knowledgeId: 'knowledge-b', label: 'Hidden' } as ChatContext], 'dual-workspace-user', + 'hello', 'workspace-a', 'chat-1' ) @@ -156,6 +165,7 @@ describe('processContextsServer - block contexts', () => { { kind: 'blocks', blockIds: ['notion'], label: 'Notion' } as ChatContext, ], 'user-1', + 'hello', 'workspace-1' ) @@ -186,6 +196,7 @@ describe('processContextsServer - skill contexts', () => { const result = await processContextsServer( [{ kind: 'skill', skillId: 'sk-1', label: 'My Skill — PostHog' } as ChatContext], 'user-1', + 'hello', 'ws-1' ) @@ -212,6 +223,7 @@ describe('processContextsServer - skill contexts', () => { const result = await processContextsServer( [{ kind: 'skill', skillId, label: 'Skill' } as ChatContext], 'user-1', + 'hello', 'ws-1' ) @@ -234,6 +246,7 @@ describe('processContextsServer - skill contexts', () => { const result = await processContextsServer( [{ kind: 'skill', skillId: 'missing', label: 'x' } as ChatContext], 'user-1', + 'hello', 'ws-1' ) @@ -244,6 +257,7 @@ describe('processContextsServer - skill contexts', () => { const result = await processContextsServer( [{ kind: 'skill', skillId: 'sk-1', label: 'x' } as ChatContext], 'user-1', + 'hello', undefined ) @@ -258,6 +272,7 @@ describe('processContextsServer - skill contexts', () => { const result = await processContextsServer( [{ kind: 'skill', skillId, label: 'Skill 1' } as ChatContext], 'user-1', + 'hello', 'ws-1' ) @@ -273,6 +288,70 @@ describe('processContextsServer - skill contexts', () => { }) }) +describe('processContextsServer - docs contexts', () => { + beforeEach(() => { + vi.clearAllMocks() + }) + + it('routes @Docs to an unscoped search_docs query', async () => { + const resolvedSecretTraceRegistry = new ResolvedSecretTraceRegistry() + const results = [ + { + path: 'docs/workflows/loops.mdx', + url: 'https://docs.sim.ai/workflows/loops', + title: 'Loops', + content: 'Use a loop block to iterate.', + similarity: 0.9, + }, + ] + searchDocsExecute.mockResolvedValue({ results, query: 'how do loops work?', totalResults: 1 }) + + const result = await processContextsServer( + [{ kind: 'docs', label: 'Docs' }], + 'user-1', + '@Docs how do loops work?', + 'ws-1', + undefined, + resolvedSecretTraceRegistry + ) + + expect(searchDocsExecute).toHaveBeenCalledWith( + { query: 'how do loops work?' }, + { + userId: 'user-1', + workspaceId: 'ws-1', + chatId: undefined, + resolvedSecretTraceRegistry, + } + ) + expect(result).toEqual([ + { + type: 'docs', + tag: '@Docs', + content: JSON.stringify(results), + }, + ]) + }) + + it('uses the Docs label when the message only contains the mention', async () => { + searchDocsExecute.mockResolvedValue({ results: [], query: 'Docs', totalResults: 0 }) + + await processContextsServer( + [{ kind: 'docs', label: 'Docs' }], + 'user-1', + '@Docs', + 'ws-1', + 'chat-1', + new ResolvedSecretTraceRegistry() + ) + + expect(searchDocsExecute).toHaveBeenCalledWith( + { query: 'Docs' }, + expect.objectContaining({ workspaceId: 'ws-1', chatId: 'chat-1' }) + ) + }) +}) + describe('processContextsServer - MCP contexts', () => { beforeEach(() => { vi.clearAllMocks() @@ -292,6 +371,7 @@ describe('processContextsServer - MCP contexts', () => { const result = await processContextsServer( [{ kind: 'mcp', serverId: 'mcp-server-1', label: 'Docs' }], 'user-1', + '/Docs find auth docs', 'ws-1' ) @@ -452,6 +532,7 @@ describe('processContextsServer - logs contexts', () => { const result = await processContextsServer( [{ kind: 'logs', executionId: 'exec-1', label: 'My Flow' } as ChatContext], 'user-1', + 'hello', 'ws-1' ) @@ -519,6 +600,7 @@ describe('processContextsServer - logs contexts', () => { const result = await processContextsServer( [{ kind: 'logs', executionId: 'exec-1', label: 'My Flow' } as ChatContext], 'user-1', + 'hello', 'ws-1' ) @@ -552,6 +634,7 @@ describe('processContextsServer - logs contexts', () => { const result = await processContextsServer( [{ kind: 'logs', executionId: 'exec-1', label: 'My Flow' } as ChatContext], 'user-1', + 'hello', 'ws-1' ) @@ -581,6 +664,7 @@ describe('processContextsServer - logs contexts', () => { const result = await processContextsServer( [{ kind: 'logs', executionId: 'exec-1', label: 'My Flow' } as ChatContext], 'user-1', + 'hello', 'ws-1' ) @@ -615,6 +699,7 @@ describe('processContextsServer - file_selection contexts', () => { } as ChatContext, ], 'user-1', + 'explain this', 'ws-1' ) @@ -641,6 +726,7 @@ describe('processContextsServer - file_selection contexts', () => { } as ChatContext, ], 'user-1', + 'hello', 'ws-1' ) @@ -663,6 +749,7 @@ describe('processContextsServer - file_selection contexts', () => { } as ChatContext, ], 'user-1', + 'explain', 'ws-1' ) @@ -709,6 +796,7 @@ describe('processContextsServer - table_selection contexts', () => { } as ChatContext, ], 'user-1', + 'summarize', 'ws-1' ) @@ -741,6 +829,7 @@ describe('processContextsServer - table_selection contexts', () => { } as ChatContext, ], 'user-1', + 'hello', 'ws-1' ) @@ -768,6 +857,7 @@ describe('processContextsServer - table_selection contexts', () => { } as ChatContext, ], 'user-1', + 'summarize', 'ws-1' ) @@ -802,6 +892,7 @@ describe('processContextsServer - table_selection contexts', () => { } as ChatContext, ], 'user-1', + 'summarize', 'ws-1' ) @@ -842,6 +933,7 @@ describe('processContextsServer - table_selection contexts', () => { } as ChatContext, ], 'user-1', + 'summarize', 'ws-1' ) @@ -879,6 +971,7 @@ describe('processContextsServer - table_selection contexts', () => { } as ChatContext, ], 'user-1', + 'summarize', 'ws-1' ) @@ -907,6 +1000,7 @@ describe('processContextsServer - table_selection contexts', () => { } as ChatContext, ], 'user-1', + 'summarize', 'ws-1' ) diff --git a/apps/sim/lib/copilot/chat/process-contents.ts b/apps/sim/lib/copilot/chat/process-contents.ts index 2d7a47d63ab..0f6dcf00ecc 100644 --- a/apps/sim/lib/copilot/chat/process-contents.ts +++ b/apps/sim/lib/copilot/chat/process-contents.ts @@ -48,6 +48,8 @@ import { listFolders } from '@/lib/workflows/utils' import { readWorkspaceFileMetadata } from '@/lib/workspace-files/application/read-workspace-file-metadata' import { parseWorkspaceFileFolderDisplayPath } from '@/lib/workspace-files/folder-display-path' import { getUserPermissionConfig } from '@/ee/access-control/utils/permission-check' +import { escapeRegExp } from '@/executor/constants' +import type { ResolvedSecretTraceRegistry } from '@/executor/utils/resolved-secret-trace-registry' import type { BrowserTextSelection, ChatContext, TerminalTextSelection } from '@/stores/panel' type AgentContextType = @@ -62,6 +64,7 @@ type AgentContextType = | 'file' | 'file_selection' | 'workflow_block' + | 'docs' | 'folder' | 'filefolder' | 'active_resource' @@ -120,8 +123,10 @@ function formatTerminalSelection(selection: TerminalTextSelection): string { export async function processContextsServer( contexts: ChatContext[] | undefined, userId: string, + userMessage?: string, currentWorkspaceId?: string, - chatId?: string + chatId?: string, + resolvedSecretTraceRegistry?: ResolvedSecretTraceRegistry ): Promise { if (!Array.isArray(contexts) || contexts.length === 0) return [] const tasks = contexts.map(async (ctx) => { @@ -309,6 +314,30 @@ export async function processContextsServer( path: result.path, } } + if (ctx.kind === 'docs') { + try { + const { searchDocsServerTool } = await import( + '@/lib/copilot/tools/server/docs/search-docs' + ) + const rawQuery = (userMessage || '').trim() || ctx.label || 'Sim documentation' + const query = + sanitizeMessageForDocs(rawQuery, contexts) || ctx.label || 'Sim documentation' + const res = await searchDocsServerTool.execute( + { query }, + { + userId, + workspaceId: currentWorkspaceId, + chatId, + resolvedSecretTraceRegistry, + } + ) + const content = JSON.stringify(res?.results || []) + return { type: 'docs', tag: ctx.label ? `@${ctx.label}` : '@', content } + } catch (e) { + logger.error('Failed to process docs context', e) + return null + } + } return null } catch (error) { logger.error('Failed processing context (server)', { ctx, error }) @@ -330,6 +359,53 @@ export async function processContextsServer( return filtered } +function sanitizeMessageForDocs(rawMessage: string, contexts: ChatContext[] | undefined): string { + if (!rawMessage) return '' + if (!Array.isArray(contexts) || contexts.length === 0) { + // No context mapping; conservatively strip all @mentions-like tokens + const stripped = rawMessage + .replace(/(^|\s)@([^\s]+)/g, ' ') + .replace(/\s{2,}/g, ' ') + .trim() + return stripped + } + + // Gather labels by kind + const blockLabels = new Set( + contexts + .filter((c) => c.kind === 'blocks') + .map((c) => c.label) + .filter((l): l is string => typeof l === 'string' && l.length > 0) + ) + const nonBlockLabels = new Set( + contexts + .filter((c) => c.kind !== 'blocks') + .map((c) => c.label) + .filter((l): l is string => typeof l === 'string' && l.length > 0) + ) + + let result = rawMessage + + // 1) Remove all non-block mentions entirely + for (const label of nonBlockLabels) { + const pattern = new RegExp(`(^|\\s)@${escapeRegExp(label)}(?!\\S)`, 'g') + result = result.replace(pattern, ' ') + } + + // 2) For block mentions, strip the '@' but keep the block name + for (const label of blockLabels) { + const pattern = new RegExp(`@${escapeRegExp(label)}(?!\\S)`, 'g') + result = result.replace(pattern, label) + } + + // 3) Remove any remaining @mentions (unknown or not in contexts) + result = result.replace(/(^|\s)@([^\s]+)/g, ' ') + + // Normalize whitespace + result = result.replace(/\s{2,}/g, ' ').trim() + return result +} + async function processSkillFromDb( skillId: string, workspaceId: string, diff --git a/apps/sim/stores/panel/types.ts b/apps/sim/stores/panel/types.ts index f5ff7aaa54c..42c4a8cfd54 100644 --- a/apps/sim/stores/panel/types.ts +++ b/apps/sim/stores/panel/types.ts @@ -77,6 +77,7 @@ export type ChatContext = } | { kind: 'folder'; folderId: string; label: string } | { kind: 'filefolder'; fileFolderId: string; label: string } + | { kind: 'docs'; label: string } /** * A tab in the desktop browser or terminal panel, dragged into the input to * say "this one". Resource tags remain live pointers; tags created from an From 2d020432b797a09851fcabf4e5a4e0195bdee15d Mon Sep 17 00:00:00 2001 From: Justin Blumencranz <96924014+j15z@users.noreply.github.com> Date: Wed, 12 Aug 2026 17:51:35 -0700 Subject: [PATCH 29/32] fix(copilot): preserve docs search guidance (#6389) --- .../lib/copilot/chat/process-contents.test.ts | 25 ++++++++++++++++++- apps/sim/lib/copilot/chat/process-contents.ts | 5 +++- 2 files changed, 28 insertions(+), 2 deletions(-) diff --git a/apps/sim/lib/copilot/chat/process-contents.test.ts b/apps/sim/lib/copilot/chat/process-contents.test.ts index 73bc3692ea6..0f0c7593d0e 100644 --- a/apps/sim/lib/copilot/chat/process-contents.test.ts +++ b/apps/sim/lib/copilot/chat/process-contents.test.ts @@ -328,7 +328,30 @@ describe('processContextsServer - docs contexts', () => { { type: 'docs', tag: '@Docs', - content: JSON.stringify(results), + content: JSON.stringify({ results }), + }, + ]) + }) + + it('preserves the search note when @Docs has no relevant matches', async () => { + const note = + 'No relevant matches. This does NOT mean the docs lack this topic. Rephrase the query.' + searchDocsExecute.mockResolvedValue({ results: [], query: 'new topic', totalResults: 0, note }) + + const result = await processContextsServer( + [{ kind: 'docs', label: 'Docs' }], + 'user-1', + '@Docs new topic', + 'ws-1', + undefined, + new ResolvedSecretTraceRegistry() + ) + + expect(result).toEqual([ + { + type: 'docs', + tag: '@Docs', + content: JSON.stringify({ results: [], note }), }, ]) }) diff --git a/apps/sim/lib/copilot/chat/process-contents.ts b/apps/sim/lib/copilot/chat/process-contents.ts index 0f6dcf00ecc..73db8db8db0 100644 --- a/apps/sim/lib/copilot/chat/process-contents.ts +++ b/apps/sim/lib/copilot/chat/process-contents.ts @@ -331,7 +331,10 @@ export async function processContextsServer( resolvedSecretTraceRegistry, } ) - const content = JSON.stringify(res?.results || []) + const content = JSON.stringify({ + results: res?.results || [], + ...(res?.note ? { note: res.note } : {}), + }) return { type: 'docs', tag: ctx.label ? `@${ctx.label}` : '@', content } } catch (e) { logger.error('Failed to process docs context', e) From 935edc4c2af72adb584dca379e099fc8d51ae973 Mon Sep 17 00:00:00 2001 From: Justin Blumencranz <96924014+j15z@users.noreply.github.com> Date: Wed, 12 Aug 2026 17:58:14 -0700 Subject: [PATCH 30/32] docs(copilot): document VFS grep routing --- apps/sim/lib/copilot/tools/handlers/vfs.ts | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/apps/sim/lib/copilot/tools/handlers/vfs.ts b/apps/sim/lib/copilot/tools/handlers/vfs.ts index e46d1f15e31..af6568e25bd 100644 --- a/apps/sim/lib/copilot/tools/handlers/vfs.ts +++ b/apps/sim/lib/copilot/tools/handlers/vfs.ts @@ -163,6 +163,13 @@ function truncateDocsPageToInlineCap(page: { content: string; totalLines: number return null } +/** + * Routes grep by content source. `docs/` uses one network-backed docs + * page; `uploads/` uses one chat-scoped upload; workspace file paths use + * one authorized file; all remaining paths use the materialized in-memory VFS. + * External and dynamic file contents are therefore opt-in and single-target, + * while an unscoped grep searches only static VFS resources and metadata. + */ export async function executeVfsGrep( params: Record, context: ExecutionContext From a82622f66593cce0ad59a0962817b31aa9d51596 Mon Sep 17 00:00:00 2001 From: Justin Blumencranz <96924014+j15z@users.noreply.github.com> Date: Thu, 13 Aug 2026 11:54:46 -0700 Subject: [PATCH 31/32] fix(copilot): harden docs context retrieval --- apps/sim/lib/copilot/chat/post.test.ts | 6 +- .../lib/copilot/chat/process-contents.test.ts | 28 ++++++++ apps/sim/lib/copilot/chat/process-contents.ts | 9 ++- apps/sim/lib/copilot/docs/docs-corpus.test.ts | 70 +++++++++++++++---- apps/sim/lib/copilot/docs/docs-corpus.ts | 65 +++++++++++++---- .../lib/copilot/tools/handlers/vfs.test.ts | 24 ++++++- apps/sim/lib/copilot/tools/handlers/vfs.ts | 4 +- .../copilot/tools/server/docs/search-docs.ts | 5 +- 8 files changed, 177 insertions(+), 34 deletions(-) diff --git a/apps/sim/lib/copilot/chat/post.test.ts b/apps/sim/lib/copilot/chat/post.test.ts index 4f8efd52029..f7f71a24733 100644 --- a/apps/sim/lib/copilot/chat/post.test.ts +++ b/apps/sim/lib/copilot/chat/post.test.ts @@ -384,7 +384,8 @@ describe('handleUnifiedChatPost', () => { 'user-1', 'Hello', 'ws-1', - expect.anything() + expect.anything(), + expect.any(ResolvedSecretTraceRegistry) ) }) @@ -448,7 +449,8 @@ describe('handleUnifiedChatPost', () => { 'user-1', 'Explain these selections', 'ws-1', - 'chat-1' + 'chat-1', + expect.any(ResolvedSecretTraceRegistry) ) }) diff --git a/apps/sim/lib/copilot/chat/process-contents.test.ts b/apps/sim/lib/copilot/chat/process-contents.test.ts index 0f0c7593d0e..3e29c8b4046 100644 --- a/apps/sim/lib/copilot/chat/process-contents.test.ts +++ b/apps/sim/lib/copilot/chat/process-contents.test.ts @@ -373,6 +373,34 @@ describe('processContextsServer - docs contexts', () => { expect.objectContaining({ workspaceId: 'ws-1', chatId: 'chat-1' }) ) }) + + it('preserves an explicit unavailable note when docs search fails', async () => { + searchDocsExecute.mockRejectedValue(new Error('embedding service unavailable')) + + const result = await processContextsServer( + [{ kind: 'docs', label: 'Docs' }], + 'user-1', + '@Docs explain schedules', + 'ws-1', + 'chat-1', + new ResolvedSecretTraceRegistry() + ) + + expect(result).toEqual([ + { + type: 'docs', + tag: '@Docs', + content: JSON.stringify({ + results: [], + note: 'Documentation search is temporarily unavailable. Do not infer that the docs lack this topic; retry search_docs or browse docs/** later.', + }), + }, + ]) + expect(mockProcessContentsLogger.error).toHaveBeenCalledWith( + 'Failed to process docs context', + expect.any(Error) + ) + }) }) describe('processContextsServer - MCP contexts', () => { diff --git a/apps/sim/lib/copilot/chat/process-contents.ts b/apps/sim/lib/copilot/chat/process-contents.ts index 73db8db8db0..3ee1367159b 100644 --- a/apps/sim/lib/copilot/chat/process-contents.ts +++ b/apps/sim/lib/copilot/chat/process-contents.ts @@ -338,7 +338,14 @@ export async function processContextsServer( return { type: 'docs', tag: ctx.label ? `@${ctx.label}` : '@', content } } catch (e) { logger.error('Failed to process docs context', e) - return null + return { + type: 'docs', + tag: ctx.label ? `@${ctx.label}` : '@', + content: JSON.stringify({ + results: [], + note: 'Documentation search is temporarily unavailable. Do not infer that the docs lack this topic; retry search_docs or browse docs/** later.', + }), + } } } return null diff --git a/apps/sim/lib/copilot/docs/docs-corpus.test.ts b/apps/sim/lib/copilot/docs/docs-corpus.test.ts index e1222c9ab36..54764c35625 100644 --- a/apps/sim/lib/copilot/docs/docs-corpus.test.ts +++ b/apps/sim/lib/copilot/docs/docs-corpus.test.ts @@ -3,8 +3,12 @@ */ import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest' +const { mockSleep } = vi.hoisted(() => ({ + mockSleep: vi.fn(() => Promise.resolve()), +})) + vi.mock('@sim/utils/helpers', () => ({ - sleep: vi.fn(() => Promise.resolve()), + sleep: mockSleep, })) import { @@ -19,6 +23,15 @@ import { DOCS_MANIFEST } from '@/lib/copilot/generated/docs-manifest' const SAMPLE_PAGE = DOCS_MANIFEST.find((path) => path === 'workflows/blocks/agent.mdx') +function fetchResponse(status: number, content = '', headers: HeadersInit = {}) { + return { + ok: status >= 200 && status < 300, + status, + headers: new Headers(headers), + text: async () => content, + } +} + describe('docs corpus scoping', () => { it('recognizes docs paths', () => { expect(isDocsPath('docs/workflows.mdx')).toBe(true) @@ -75,6 +88,8 @@ describe('readDocsPage', () => { beforeEach(() => { fetchMock.mockReset() + mockSleep.mockReset() + mockSleep.mockResolvedValue(undefined) vi.stubGlobal('fetch', fetchMock) }) @@ -84,7 +99,7 @@ describe('readDocsPage', () => { it('fetches the manifest path verbatim from the docs site', async () => { expect(SAMPLE_PAGE).toBeDefined() - fetchMock.mockResolvedValue({ ok: true, status: 200, text: async () => '# Agent\n\nbody' }) + fetchMock.mockResolvedValue(fetchResponse(200, '# Agent\n\nbody')) const page = await readDocsPage(`docs/${SAMPLE_PAGE}`) @@ -104,7 +119,7 @@ describe('readDocsPage', () => { }) it('surfaces a docs-site outage as a retryable error after exhausting retries', async () => { - fetchMock.mockResolvedValue({ ok: false, status: 502, text: async () => '' }) + fetchMock.mockResolvedValue(fetchResponse(502)) await expect(readDocsPage(`docs/${SAMPLE_PAGE}`)).rejects.toThrow(/could not be reached/) expect(fetchMock).toHaveBeenCalledTimes(3) }) @@ -118,7 +133,7 @@ describe('readDocsPage', () => { it('recovers when a transient failure clears on retry', async () => { fetchMock .mockRejectedValueOnce(new Error('socket hang up')) - .mockResolvedValue({ ok: true, status: 200, text: async () => '# Agent\n\nbody' }) + .mockResolvedValue(fetchResponse(200, '# Agent\n\nbody')) const page = await readDocsPage(`docs/${SAMPLE_PAGE}`) @@ -127,7 +142,7 @@ describe('readDocsPage', () => { }) it('reports a page the site no longer serves as permanent, without retrying', async () => { - fetchMock.mockResolvedValue({ ok: false, status: 404, text: async () => '' }) + fetchMock.mockResolvedValue(fetchResponse(404)) const error = await readDocsPage(`docs/${SAMPLE_PAGE}`).catch((e) => e) expect(error).toBeInstanceOf(DocsCorpusError) expect(error.message).toMatch(/does not serve it/) @@ -136,17 +151,50 @@ describe('readDocsPage', () => { expect(fetchMock).toHaveBeenCalledOnce() }) - it('still treats 429 as retryable rather than permanent', async () => { - fetchMock.mockResolvedValue({ ok: false, status: 429, text: async () => '' }) + it('honors Retry-After while retrying a 429 response', async () => { + fetchMock.mockResolvedValue(fetchResponse(429, '', { 'Retry-After': '7' })) await expect(readDocsPage(`docs/${SAMPLE_PAGE}`)).rejects.toThrow(/could not be reached/) expect(fetchMock).toHaveBeenCalledTimes(3) + expect(mockSleep).toHaveBeenNthCalledWith(1, 7_000) + expect(mockSleep).toHaveBeenNthCalledWith(2, 7_000) }) it('treats 408 as retryable rather than a missing page', async () => { - fetchMock.mockResolvedValue({ ok: false, status: 408, text: async () => '' }) + fetchMock.mockResolvedValue(fetchResponse(408)) await expect(readDocsPage(`docs/${SAMPLE_PAGE}`)).rejects.toThrow(/could not be reached/) expect(fetchMock).toHaveBeenCalledTimes(3) }) + + it('aborts an in-flight fetch without retrying', async () => { + const controller = new AbortController() + fetchMock.mockImplementation((_url: string, init: RequestInit) => { + const signal = init.signal as AbortSignal + return new Promise((_resolve, reject) => { + signal.addEventListener('abort', () => reject(signal.reason), { once: true }) + }) + }) + + const request = readDocsPage(`docs/${SAMPLE_PAGE}`, controller.signal) + await vi.waitFor(() => expect(fetchMock).toHaveBeenCalledOnce()) + controller.abort(new Error('user stopped docs read')) + + await expect(request).rejects.toThrow('user stopped docs read') + expect(fetchMock).toHaveBeenCalledOnce() + expect(mockSleep).not.toHaveBeenCalled() + }) + + it('aborts retry backoff before starting another fetch', async () => { + const controller = new AbortController() + fetchMock.mockResolvedValue(fetchResponse(502)) + mockSleep.mockImplementationOnce(() => new Promise(() => {})) + + const request = readDocsPage(`docs/${SAMPLE_PAGE}`, controller.signal) + await vi.waitFor(() => expect(mockSleep).toHaveBeenCalledOnce()) + controller.abort(new Error('user stopped docs retry')) + + await expect(request).rejects.toThrow('user stopped docs retry') + expect(fetchMock).toHaveBeenCalledOnce() + }) }) describe('grepDocs', () => { @@ -163,11 +211,7 @@ describe('grepDocs', () => { }) it('greps exactly one page for a page path', async () => { - fetchMock.mockResolvedValue({ - ok: true, - status: 200, - text: async () => 'intro line\nsystemPrompt matters\ntail', - }) + fetchMock.mockResolvedValue(fetchResponse(200, 'intro line\nsystemPrompt matters\ntail')) const matches = await grepDocs(`docs/${SAMPLE_PAGE}`, 'systemPrompt') diff --git a/apps/sim/lib/copilot/docs/docs-corpus.ts b/apps/sim/lib/copilot/docs/docs-corpus.ts index 27e249b1ac7..e8eca75761d 100644 --- a/apps/sim/lib/copilot/docs/docs-corpus.ts +++ b/apps/sim/lib/copilot/docs/docs-corpus.ts @@ -1,7 +1,7 @@ import { createLogger } from '@sim/logger' import { toError } from '@sim/utils/errors' import { sleep } from '@sim/utils/helpers' -import { backoffWithJitter } from '@sim/utils/retry' +import { backoffWithJitter, parseRetryAfter } from '@sim/utils/retry' import { foldDocsIndexPath } from '@/lib/copilot/docs/docs-path' import { DOCS_MANIFEST } from '@/lib/copilot/generated/docs-manifest' import type { GrepCountEntry, GrepMatch, GrepOptions } from '@/lib/copilot/vfs/operations' @@ -121,12 +121,43 @@ type DocsFetchResult = /** The site will not serve this path however many times we ask. */ | { outcome: 'missing' } /** Transient: 5xx, 429, network error, or timeout. */ - | { outcome: 'unavailable' } + | { outcome: 'unavailable'; retryAfterMs: number | null } + +function throwIfAborted(signal?: AbortSignal): void { + if (signal?.aborted) { + throw toError(signal.reason ?? 'Docs request aborted') + } +} + +async function sleepForRetry(delayMs: number, signal?: AbortSignal): Promise { + if (!signal) { + await sleep(delayMs) + return + } + + throwIfAborted(signal) + let abortListener: (() => void) | undefined + const aborted = new Promise((_resolve, reject) => { + abortListener = () => reject(toError(signal.reason ?? 'Docs request aborted')) + signal.addEventListener('abort', abortListener, { once: true }) + if (signal.aborted) abortListener() + }) + + try { + await Promise.race([sleep(delayMs), aborted]) + } finally { + if (abortListener) signal.removeEventListener('abort', abortListener) + } +} + +async function fetchDocsPageOnce(url: string, signal?: AbortSignal): Promise { + throwIfAborted(signal) + const timeoutSignal = AbortSignal.timeout(FETCH_ATTEMPT_TIMEOUT_MS) + const requestSignal = signal ? AbortSignal.any([signal, timeoutSignal]) : timeoutSignal -async function fetchDocsPageOnce(url: string): Promise { try { const response = await fetch(url, { - signal: AbortSignal.timeout(FETCH_ATTEMPT_TIMEOUT_MS), + signal: requestSignal, headers: { Accept: 'text/markdown, text/plain' }, }) if (!response.ok) { @@ -136,23 +167,30 @@ async function fetchDocsPageOnce(url: string): Promise { response.status < 500 && response.status !== 408 && response.status !== 429 - return { outcome: permanent ? 'missing' : 'unavailable' } + if (permanent) return { outcome: 'missing' } + return { + outcome: 'unavailable', + retryAfterMs: parseRetryAfter(response.headers.get('retry-after')), + } } return { outcome: 'ok', content: await response.text() } } catch (err) { + throwIfAborted(signal) logger.warn('Docs page fetch failed', { url, error: toError(err).message }) - return { outcome: 'unavailable' } + return { outcome: 'unavailable', retryAfterMs: null } } } -async function fetchDocsPage(path: string): Promise { +async function fetchDocsPage(path: string, signal?: AbortSignal): Promise { const key = normalizeDocsPath(path) if (!docsKeyView.has(key)) return { outcome: 'missing' } const url = `${DOCS_BASE_URL}/${key.slice(DOCS_PREFIX.length)}` for (let attempt = 1; ; attempt++) { - const result = await fetchDocsPageOnce(url) + throwIfAborted(signal) + const result = await fetchDocsPageOnce(url, signal) + throwIfAborted(signal) if (result.outcome !== 'unavailable' || attempt >= FETCH_MAX_ATTEMPTS) return result - await sleep(backoffWithJitter(attempt, null)) + await sleepForRetry(backoffWithJitter(attempt, result.retryAfterMs), signal) } } @@ -161,7 +199,7 @@ async function fetchDocsPage(path: string): Promise { * conditions (directory path, unknown page, site unreachable) so the handler can * surface the message verbatim. */ -export async function readDocsPage(path: string): Promise { +export async function readDocsPage(path: string, signal?: AbortSignal): Promise { const key = normalizeDocsPath(path) if (!docsKeyView.has(key)) { if (isDocsDir(key)) { @@ -172,7 +210,7 @@ export async function readDocsPage(path: string): Promise { `Docs page not found: ${path}. Use glob("docs/**") to list the docs corpus.` ) } - const result = await fetchDocsPage(key) + const result = await fetchDocsPage(key, signal) if (result.outcome === 'missing') { throw new DocsCorpusError( `${key} is in the docs index but ${DOCS_BASE_URL} does not serve it — the page was likely moved or removed. Use glob("docs/**") to find the current path; retrying will not help.` @@ -194,7 +232,8 @@ export async function readDocsPage(path: string): Promise { export async function grepDocs( path: string, pattern: string, - options?: GrepOptions + options?: GrepOptions, + signal?: AbortSignal ): Promise { const key = normalizeDocsPath(path) if (!docsKeyView.has(key)) { @@ -207,6 +246,6 @@ export async function grepDocs( `"${path}" is not a docs page. Use glob("docs/**") to list the docs corpus.` ) } - const page = await readDocsPage(key) + const page = await readDocsPage(key, signal) return grepReadResult(key, page, pattern, key, options) } diff --git a/apps/sim/lib/copilot/tools/handlers/vfs.test.ts b/apps/sim/lib/copilot/tools/handlers/vfs.test.ts index f858cc57436..b360fd5b2af 100644 --- a/apps/sim/lib/copilot/tools/handlers/vfs.test.ts +++ b/apps/sim/lib/copilot/tools/handlers/vfs.test.ts @@ -726,7 +726,12 @@ describe('vfs handlers docs corpus routing', () => { }) it('reads a docs page via the live-site fetch, not the workspace VFS', async () => { - fetchMock.mockResolvedValue({ ok: true, status: 200, text: async () => 'line one\nline two' }) + fetchMock.mockResolvedValue({ + ok: true, + status: 200, + headers: new Headers(), + text: async () => 'line one\nline two', + }) const result = await executeVfsRead({ path: DOCS_PAGE }, GREP_CTX) @@ -750,6 +755,7 @@ describe('vfs handlers docs corpus routing', () => { fetchMock.mockResolvedValue({ ok: true, status: 200, + headers: new Headers(), text: async () => 'alpha\ncron beta\ngamma', }) @@ -776,6 +782,7 @@ describe('vfs handlers docs corpus routing', () => { fetchMock.mockResolvedValue({ ok: true, status: 200, + headers: new Headers(), text: async () => Array.from({ length: totalLines }, () => line).join('\n'), }) @@ -794,6 +801,7 @@ describe('vfs handlers docs corpus routing', () => { fetchMock.mockResolvedValue({ ok: true, status: 200, + headers: new Headers(), text: async () => 'z'.repeat(TOOL_RESULT_MAX_INLINE_CHARS + 1000), }) @@ -809,6 +817,7 @@ describe('vfs handlers docs corpus routing', () => { fetchMock.mockResolvedValue({ ok: true, status: 200, + headers: new Headers(), text: async () => Array.from({ length: totalLines }, () => line).join('\n'), }) @@ -817,4 +826,17 @@ describe('vfs handlers docs corpus routing', () => { expect(result.success).toBe(false) expect(result.error).toContain('still too large over the requested window') }) + + it('forwards caller cancellation to docs read and grep without fetching', async () => { + const controller = new AbortController() + controller.abort(new Error('user stopped docs tool')) + const context = { ...GREP_CTX, abortSignal: controller.signal } + + const read = await executeVfsRead({ path: DOCS_PAGE }, context) + const grep = await executeVfsGrep({ pattern: 'agent', path: DOCS_PAGE }, context) + + expect(read).toEqual({ success: false, error: 'user stopped docs tool' }) + expect(grep).toEqual({ success: false, error: 'user stopped docs tool' }) + expect(fetchMock).not.toHaveBeenCalled() + }) }) diff --git a/apps/sim/lib/copilot/tools/handlers/vfs.ts b/apps/sim/lib/copilot/tools/handlers/vfs.ts index af6568e25bd..1d07c8aa751 100644 --- a/apps/sim/lib/copilot/tools/handlers/vfs.ts +++ b/apps/sim/lib/copilot/tools/handlers/vfs.ts @@ -199,7 +199,7 @@ export async function executeVfsGrep( let result: GrepMatch[] | string[] | GrepCountEntry[] let provenanceFile: WorkspaceFileSecretProvenanceIdentity | undefined if (rawPath !== undefined && isDocsPath(rawPath)) { - result = await grepDocs(rawPath, pattern, grepOptions) + result = await grepDocs(rawPath, pattern, grepOptions, context.abortSignal) } else if (isChatUploadGrepPath(rawPath)) { if (!context.chatId) { return { success: false, error: 'No chat context available for uploads/' } @@ -369,7 +369,7 @@ export async function executeVfsRead( } if (isDocsPath(path)) { - const page = await readDocsPage(path) + const page = await readDocsPage(path, context.abortSignal) const windowed = applyWindow(page) if (serializedResultSize(windowed) > TOOL_RESULT_MAX_INLINE_CHARS) { if (offset !== undefined || limit !== undefined) { diff --git a/apps/sim/lib/copilot/tools/server/docs/search-docs.ts b/apps/sim/lib/copilot/tools/server/docs/search-docs.ts index a95e3be3a79..7603bc9e6b2 100644 --- a/apps/sim/lib/copilot/tools/server/docs/search-docs.ts +++ b/apps/sim/lib/copilot/tools/server/docs/search-docs.ts @@ -52,8 +52,9 @@ function shortfallNote(outcome: Awaited>): string /** * Vector search over Sim's product documentation, scoped to the same pages the - * agent can `read` from the `docs/` VFS tree. Search-agent only; the corpus - * logic lives in `@/lib/copilot/docs/docs-search`. + * agent can `read` from the `docs/` VFS tree. Normal delegation exposes it to + * the platform agent; the `@Docs` compatibility path also invokes it directly. + * Corpus logic lives in `@/lib/copilot/docs/docs-search`. */ export const searchDocsServerTool: BaseServerTool = { name: SearchDocs.id, From eb2867f1081c0704225638190c7f53fef5ce477b Mon Sep 17 00:00:00 2001 From: Justin Blumencranz <96924014+j15z@users.noreply.github.com> Date: Thu, 13 Aug 2026 12:05:16 -0700 Subject: [PATCH 32/32] chore(copilot): sync search context contract --- apps/sim/lib/copilot/generated/tool-catalog-v1.ts | 2 +- apps/sim/lib/copilot/generated/tool-schemas-v1.ts | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/apps/sim/lib/copilot/generated/tool-catalog-v1.ts b/apps/sim/lib/copilot/generated/tool-catalog-v1.ts index 2930c2ca0a3..d4d2df7141d 100644 --- a/apps/sim/lib/copilot/generated/tool-catalog-v1.ts +++ b/apps/sim/lib/copilot/generated/tool-catalog-v1.ts @@ -4538,7 +4538,7 @@ export const Search: ToolCatalogEntry = { properties: { task: { description: - "A fully self-contained task — the search agent sees none of this conversation, so include the question plus every name, id, constraint, and prior finding it needs. Example: 'find current Stripe metered-billing API limits' or 'count how many rows in the leads table have invalid emails'.", + "One short scoping sentence — the search agent has full conversation context. Example: 'find current Stripe metered-billing API limits' or 'count how many rows in the leads table have invalid emails'.", type: 'string', }, }, diff --git a/apps/sim/lib/copilot/generated/tool-schemas-v1.ts b/apps/sim/lib/copilot/generated/tool-schemas-v1.ts index 6ef9d8f2e09..6654dc277b5 100644 --- a/apps/sim/lib/copilot/generated/tool-schemas-v1.ts +++ b/apps/sim/lib/copilot/generated/tool-schemas-v1.ts @@ -4387,7 +4387,7 @@ export const TOOL_RUNTIME_SCHEMAS: Record = { properties: { task: { description: - "A fully self-contained task — the search agent sees none of this conversation, so include the question plus every name, id, constraint, and prior finding it needs. Example: 'find current Stripe metered-billing API limits' or 'count how many rows in the leads table have invalid emails'.", + "One short scoping sentence — the search agent has full conversation context. Example: 'find current Stripe metered-billing API limits' or 'count how many rows in the leads table have invalid emails'.", type: 'string', }, },