Keep file tool prompts relative-first

Author: jahooma

common/src/templates/initial-agents-dir/types/tools.ts

@@ -353,7 +353,7 @@ export interface SpawnAgentsParams {
  * Replace strings in a file with new strings.
  */
 export interface StrReplaceParams {
-  /** The path to the file to edit, either relative to the project root or an absolute path inside the project. */
+  /** The path to the file to edit. */
   path: string
   /** Array of replacements to make. */
   replacements: {
@@ -411,7 +411,7 @@ export interface WebSearchParams {
  * Create or edit a file with the given content.
  */
 export interface WriteFileParams {
-  /** Path to the file, either relative to the project root or an absolute path inside the project. */
+  /** Path to the file relative to the **project root** */
   path: string
   /** What the change is intended to do in only one sentence. */
   instructions: string

common/src/tools/params/tool/str-replace.ts

@@ -28,9 +28,7 @@ const inputSchema = z
     path: z
       .string()
       .min(1, 'Path cannot be empty')
-      .describe(
-        `The path to the file to edit, either relative to the project root or an absolute path inside the project.`,
-      ),
+      .describe(`The path to the file to edit.`),
     replacements: z
       .preprocess(
         coerceToArray,

common/src/tools/params/tool/write-file.ts

@@ -12,9 +12,7 @@ const inputSchema = z
     path: z
       .string()
       .min(1, 'Path cannot be empty')
-      .describe(
-        `Path to the file, either relative to the project root or an absolute path inside the project.`,
-      ),
+      .describe(`Path to the file relative to the **project root**`),
     instructions: z
       .string()
       .describe('What the change is intended to do in only one sentence.'),

sdk/src/__tests__/change-file.test.ts

@@ -36,7 +36,7 @@ describe('changeFile', () => {
     )
   })
 
-  test('accepts absolute paths inside the project for string replacements', async () => {
+  test('tolerates absolute paths inside the project for string replacements', async () => {
     const fs = createMockFs({
       files: {
         '/repo/src/file.ts': 'const value = 1\n',
@@ -94,7 +94,7 @@ describe('changeFile', () => {
     )
   })
 
-  test('accepts absolute paths inside the project for file writes', async () => {
+  test('tolerates absolute paths inside the project for file writes', async () => {
     const fs = createMockFs()
 
     const result = await changeFile({

sdk/src/__tests__/path-utils.test.ts

@@ -1,6 +1,9 @@
 import { describe, expect, test } from 'bun:test'
 
-import { resolveFilePathWithinProject } from '../tools/path-utils'
+import {
+  getProjectPathLookupKeys,
+  resolveFilePathWithinProject,
+} from '../tools/path-utils'
 
 describe('resolveFilePathWithinProject', () => {
   test('normalizes relative paths to full and project-relative paths', () => {
@@ -32,3 +35,24 @@ describe('resolveFilePathWithinProject', () => {
     ).toBeNull()
   })
 })
+
+describe('getProjectPathLookupKeys', () => {
+  test('returns the normalized relative key before the original absolute key', () => {
+    expect(getProjectPathLookupKeys('/repo', '/repo/src/file.ts')).toEqual([
+      'src/file.ts',
+      '/repo/src/file.ts',
+    ])
+  })
+
+  test('dedupes relative paths that are already normalized', () => {
+    expect(getProjectPathLookupKeys('/repo', 'src/file.ts')).toEqual([
+      'src/file.ts',
+    ])
+  })
+
+  test('returns only the original key for paths outside the project', () => {
+    expect(getProjectPathLookupKeys('/repo', '/outside.ts')).toEqual([
+      '/outside.ts',
+    ])
+  })
+})

sdk/src/__tests__/run-file-filter.test.ts

@@ -312,7 +312,7 @@ describe('CodebuffClientOptions fileFilter', () => {
     expect(optionalFileResult).toBeNull()
   })
 
-  it('should resolve absolute requestOptionalFile paths inside cwd', async () => {
+  it('should tolerate absolute requestOptionalFile paths inside cwd', async () => {
     spyOn(databaseModule, 'getUserInfoFromApiKey').mockResolvedValue({
       id: 'user-123',
       email: 'test@example.com',

sdk/src/run.ts

@@ -27,7 +27,7 @@ import { applyPatchTool } from './tools/apply-patch'
 import { codeSearch } from './tools/code-search'
 import { glob } from './tools/glob'
 import { listDirectory } from './tools/list-directory'
-import { resolveFilePathWithinProject } from './tools/path-utils'
+import { getProjectPathLookupKeys } from './tools/path-utils'
 import { getFiles } from './tools/read-files'
 import { runTerminalCommand } from './tools/run-terminal-command'
 
@@ -435,11 +435,11 @@ async function runOnce({
         cwd,
         fs,
       })
-      const lookupPath = cwd
-        ? (resolveFilePathWithinProject(cwd, filePath)?.relativePath ??
-          filePath)
-        : filePath
-      return toOptionalFile(files[lookupPath] ?? files[filePath] ?? null)
+      const lookupKeys = cwd
+        ? getProjectPathLookupKeys(cwd, filePath)
+        : [filePath]
+      const fileKey = lookupKeys.find((key) => key in files)
+      return toOptionalFile(fileKey === undefined ? null : files[fileKey]!)
     },
     sendAction: ({ action }) => {
       if (action.type === 'action-error') {

sdk/src/tools/path-utils.ts

@@ -29,3 +29,13 @@ export function resolveFilePathWithinProject(
 
   return { fullPath, relativePath }
 }
+
+export function getProjectPathLookupKeys(
+  projectRoot: string,
+  filePath: string,
+): string[] {
+  const resolvedPath = resolveFilePathWithinProject(projectRoot, filePath)
+  const keys = resolvedPath ? [resolvedPath.relativePath, filePath] : [filePath]
+
+  return [...new Set(keys)]
+}