Skip to content

Commit d846e61

Browse files
charlesliencharleslien
committed
move tool definitions into tool params
1 parent 078aed6 commit d846e61

62 files changed

Lines changed: 1594 additions & 1596 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎common/src/tools/compile-tool-definitions.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
import z from 'zod/v4'
22

33
import { publishedTools } from './constants'
4-
import { $toolParams } from './list'
4+
import { toolParams } from './list'
55

66
/**
77
* Compiles all tool definitions into a single TypeScript definition file content.
88
* This generates type definitions for all available tools and their parameters.
99
*/
1010
export function compileToolDefinitions(): string {
1111
const toolEntries = publishedTools.map(
12-
(toolName) => [toolName, $toolParams[toolName]] as const,
12+
(toolName) => [toolName, toolParams[toolName]] as const,
1313
)
1414

1515
const toolInterfaces = toolEntries

‎common/src/tools/constants.ts‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,8 +75,12 @@ export const publishedTools = [
7575
export type ToolName = (typeof toolNames)[number]
7676
export type PublishedToolName = (typeof publishedTools)[number]
7777

78+
/** Only used for validating tool definitions */
7879
export type $ToolParams<T extends ToolName = ToolName> = Required<
79-
Pick<Tool<any, ToolResultOutput[]>, 'inputSchema' | 'outputSchema'>
80+
Pick<
81+
Tool<any, ToolResultOutput[]>,
82+
'description' | 'inputSchema' | 'outputSchema'
83+
>
8084
> & {
8185
toolName: T
8286
endsAgentStep: boolean

‎common/src/tools/list.ts‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ import type { $ToolParams, PublishedToolName, ToolName } from './constants'
3232
import type { ToolMessage } from '../types/messages/codebuff-message'
3333
import type { ToolCallPart } from '../types/messages/content-part'
3434

35-
export const $toolParams = {
35+
export const toolParams = {
3636
add_message: addMessageParams,
3737
add_subgoal: addSubgoalParams,
3838
browser_logs: browserLogsParams,
@@ -67,13 +67,13 @@ export const $toolParams = {
6767
export type CodebuffToolCall<T extends ToolName = ToolName> = {
6868
[K in ToolName]: {
6969
toolName: K
70-
input: z.infer<(typeof $toolParams)[K]['inputSchema']>
70+
input: z.infer<(typeof toolParams)[K]['inputSchema']>
7171
} & Omit<ToolCallPart, 'type'>
7272
}[T]
7373

7474
export type CodebuffToolOutput<T extends ToolName = ToolName> = {
7575
[K in ToolName]: K extends ToolName
76-
? z.infer<(typeof $toolParams)[K]['outputSchema']>
76+
? z.infer<(typeof toolParams)[K]['outputSchema']>
7777
: never
7878
}[T]
7979

@@ -85,31 +85,31 @@ export type CodebuffToolMessage<T extends ToolName = ToolName> = ToolMessage & {
8585
export const clientToolCallSchema = z.discriminatedUnion('toolName', [
8686
z.object({
8787
toolName: z.literal('browser_logs'),
88-
input: $toolParams.browser_logs.inputSchema,
88+
input: toolParams.browser_logs.inputSchema,
8989
}),
9090
z.object({
9191
toolName: z.literal('code_search'),
92-
input: $toolParams.code_search.inputSchema,
92+
input: toolParams.code_search.inputSchema,
9393
}),
9494
z.object({
9595
toolName: z.literal('create_plan'),
9696
input: FileChangeSchema,
9797
}),
9898
z.object({
9999
toolName: z.literal('glob'),
100-
input: $toolParams.glob.inputSchema,
100+
input: toolParams.glob.inputSchema,
101101
}),
102102
z.object({
103103
toolName: z.literal('list_directory'),
104-
input: $toolParams.list_directory.inputSchema,
104+
input: toolParams.list_directory.inputSchema,
105105
}),
106106
z.object({
107107
toolName: z.literal('run_file_change_hooks'),
108-
input: $toolParams.run_file_change_hooks.inputSchema,
108+
input: toolParams.run_file_change_hooks.inputSchema,
109109
}),
110110
z.object({
111111
toolName: z.literal('run_terminal_command'),
112-
input: $toolParams.run_terminal_command.inputSchema.and(
112+
input: toolParams.run_terminal_command.inputSchema.and(
113113
z.object({ mode: z.enum(['assistant', 'user']) }),
114114
),
115115
}),

‎common/src/tools/params/tool/add-message.ts‎

Lines changed: 26 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,36 @@
11
import z from 'zod/v4'
22

3+
import { $getToolCallString, emptyToolResultSchema } from '../utils'
4+
35
import type { $ToolParams } from '../../constants'
46

57
const toolName = 'add_message'
68
const endsAgentStep = true
9+
const inputSchema = z
10+
.object({
11+
role: z.enum(['user', 'assistant']),
12+
content: z.string(),
13+
})
14+
.describe(
15+
`Add a new message to the conversation history. To be used for complex requests that can't be solved in a single step, as you may forget what happened!`,
16+
)
17+
const description = `
18+
Example:
19+
${$getToolCallString({
20+
toolName,
21+
inputSchema,
22+
input: {
23+
role: 'user',
24+
content: 'Hello, how are you?',
25+
},
26+
endsAgentStep,
27+
})}
28+
`.trim()
29+
730
export const addMessageParams = {
831
toolName,
932
endsAgentStep,
10-
inputSchema: z
11-
.object({
12-
role: z.enum(['user', 'assistant']),
13-
content: z.string(),
14-
})
15-
.describe(
16-
`Add a new message to the conversation history. To be used for complex requests that can't be solved in a single step, as you may forget what happened!`,
17-
),
18-
outputSchema: z.tuple([]),
33+
description,
34+
inputSchema,
35+
outputSchema: emptyToolResultSchema(),
1936
} satisfies $ToolParams

‎common/src/tools/params/tool/add-subgoal.ts‎

Lines changed: 45 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,57 @@
11
import z from 'zod/v4'
22

3+
import { $getToolCallString, jsonToolResultSchema } from '../utils'
4+
35
import type { $ToolParams } from '../../constants'
46

57
const toolName = 'add_subgoal'
68
const endsAgentStep = false
9+
const inputSchema = z
10+
.object({
11+
id: z
12+
.string()
13+
.min(1, 'Id cannot be empty')
14+
.describe(
15+
`A unique identifier for the subgoal. Try to choose the next sequential integer that is not already in use.`,
16+
),
17+
objective: z
18+
.string()
19+
.min(1, 'Objective cannot be empty')
20+
.describe(`The objective of the subgoal, concisely and clearly stated.`),
21+
status: z
22+
.enum(['NOT_STARTED', 'IN_PROGRESS', 'COMPLETE', 'ABORTED'])
23+
.describe(`The status of the subgoal.`),
24+
plan: z.string().optional().describe('A plan for the subgoal.'),
25+
log: z
26+
.string()
27+
.optional()
28+
.describe('A log message for the subgoal progress.'),
29+
})
30+
.describe(
31+
`Add a new subgoal for tracking progress. To be used for complex requests that can't be solved in a single step, as you may forget what happened!`,
32+
)
33+
const description = `
34+
Example:
35+
${$getToolCallString({
36+
toolName,
37+
inputSchema,
38+
input: {
39+
id: '1',
40+
objective: 'Add a new "deploy api" subgoal',
41+
status: 'IN_PROGRESS',
42+
},
43+
endsAgentStep,
44+
})}
45+
`.trim()
46+
747
export const addSubgoalParams = {
848
toolName,
949
endsAgentStep,
10-
inputSchema: z
11-
.object({
12-
id: z
13-
.string()
14-
.min(1, 'Id cannot be empty')
15-
.describe(
16-
`A unique identifier for the subgoal. Try to choose the next sequential integer that is not already in use.`,
17-
),
18-
objective: z
19-
.string()
20-
.min(1, 'Objective cannot be empty')
21-
.describe(
22-
`The objective of the subgoal, concisely and clearly stated.`,
23-
),
24-
status: z
25-
.enum(['NOT_STARTED', 'IN_PROGRESS', 'COMPLETE', 'ABORTED'])
26-
.describe(`The status of the subgoal.`),
27-
plan: z.string().optional().describe('A plan for the subgoal.'),
28-
log: z
29-
.string()
30-
.optional()
31-
.describe('A log message for the subgoal progress.'),
32-
})
33-
.describe(
34-
`Add a new subgoal for tracking progress. To be used for complex requests that can't be solved in a single step, as you may forget what happened!`,
35-
),
36-
outputSchema: z.tuple([
50+
description,
51+
inputSchema,
52+
outputSchema: jsonToolResultSchema(
3753
z.object({
38-
type: z.literal('json'),
39-
value: z.object({
40-
message: z.string(),
41-
}),
54+
message: z.string(),
4255
}),
43-
]),
56+
),
4457
} satisfies $ToolParams

‎common/src/tools/params/tool/browser-logs.ts‎

Lines changed: 73 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,85 @@
11
import z from 'zod/v4'
22

33
import { BrowserResponseSchema } from '../../../browser-actions'
4+
import { $getToolCallString, jsonToolResultSchema } from '../utils'
45

56
import type { $ToolParams } from '../../constants'
67

78
const toolName = 'browser_logs'
89
const endsAgentStep = true
10+
const inputSchema = z.object({
11+
type: z
12+
.string()
13+
.min(1, 'Type cannot be empty')
14+
.describe('The type of browser action to perform (e.g., "navigate").'),
15+
url: z
16+
.string()
17+
.min(1, 'URL cannot be empty')
18+
.describe('The URL to navigate to.'),
19+
waitUntil: z
20+
.enum(['load', 'domcontentloaded', 'networkidle0'])
21+
.optional()
22+
.describe("When to consider navigation successful. Defaults to 'load'."),
23+
})
24+
const description = `
25+
Purpose: Use this tool to check the output of console.log or errors in order to debug issues, test functionality, or verify expected behavior.
26+
27+
IMPORTANT: Assume the user's development server is ALREADY running and active, unless you see logs indicating otherwise. Never start the user's development server for them, unless they ask you to do so.
28+
Never offer to interact with the website aside from reading them (see available actions below). The user will manipulate the website themselves and bring you to the UI they want you to interact with.
29+
30+
### Response Analysis
31+
32+
After each action, you'll receive:
33+
1. Success/failure status
34+
2. New console logs since last action
35+
3. Network requests and responses
36+
4. JavaScript errors with stack traces
37+
38+
Use this data to:
39+
- Verify expected behavior
40+
- Debug issues
41+
- Guide next actions
42+
- Make informed decisions about fixes
43+
44+
### Best Practices
45+
46+
**Workflow**
47+
- Navigate to the user's website, probably on localhost, but you can compare with the production site if you want.
48+
- Scroll to the relevant section
49+
- Take screenshots and analyze confirm changes
50+
- Check network requests for anomalies
51+
52+
**Debugging Flow**
53+
- Start with minimal reproduction steps
54+
- Collect data at each step
55+
- Analyze results before next action
56+
- Take screenshots to track your changes after each UI change you make
57+
58+
There is currently only one type of browser action available:
59+
Navigate:
60+
- Load a new URL in the current browser window and get the logs after page load.
61+
Params:
62+
- \`type\`: (required) Must be equal to 'navigate'
63+
- \`url\`: (required) The URL to navigate to.
64+
- \`waitUntil\`: (required) One of 'load', 'domcontentloaded', 'networkidle0'
65+
66+
Example:
67+
${$getToolCallString({
68+
toolName,
69+
inputSchema,
70+
input: {
71+
type: 'navigate',
72+
url: 'localhost:3000',
73+
waitUntil: 'domcontentloaded',
74+
},
75+
endsAgentStep,
76+
})}
77+
`.trim()
78+
979
export const browserLogsParams = {
1080
toolName,
1181
endsAgentStep,
12-
inputSchema: z.object({
13-
type: z
14-
.string()
15-
.min(1, 'Type cannot be empty')
16-
.describe('The type of browser action to perform (e.g., "navigate").'),
17-
url: z
18-
.string()
19-
.min(1, 'URL cannot be empty')
20-
.describe('The URL to navigate to.'),
21-
waitUntil: z
22-
.enum(['load', 'domcontentloaded', 'networkidle0'])
23-
.optional()
24-
.describe("When to consider navigation successful. Defaults to 'load'."),
25-
}),
26-
outputSchema: z.tuple([
27-
z.object({
28-
type: z.literal('json'),
29-
value: BrowserResponseSchema,
30-
}),
31-
]),
82+
description,
83+
inputSchema,
84+
outputSchema: jsonToolResultSchema(BrowserResponseSchema),
3285
} satisfies $ToolParams

0 commit comments

Comments
 (0)