Skip to content

Commit df252b9

Browse files
committed
Fix reference to agent config
1 parent 63b3ce7 commit df252b9

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

sdk/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ Runs a Codebuff agent with the specified options.
138138

139139
#### Parameters
140140

141-
- **`agent`** (string, required): The agent to run. Use `'base'` for the default agent, or specify a custom agent ID if you made your own agent config.
141+
- **`agent`** (string, required): The agent to run. Use `'base'` for the default agent, or specify a custom agent ID if you made your own agent definition (passed with the `agentDefinitions` param).
142142

143143
- **`prompt`** (string, required): The user prompt describing what you want the agent to do.
144144

@@ -152,7 +152,7 @@ Runs a Codebuff agent with the specified options.
152152

153153
- **`knowledgeFiles`** (object, optional): Knowledge files to inject into every `run()` call. Uses the same schema as `projectFiles` - keys are file paths and values are file contents. These files are added directly to the agent's context.
154154

155-
- **`agentDefinitions`** (array, optional): Array of custom agent configurations. Each object should satisfy the AgentConfig type.
155+
- **`agentDefinitions`** (array, optional): Array of custom agent definitions. Each object should satisfy the AgentDefinition type.
156156

157157
- **`customToolDefinitions`** (array, optional): Array of custom tool definitions that extend the agent's capabilities. Each tool definition includes a name, Zod schema for input validation, and a handler function. These tools can be called by the agent during execution.
158158

0 commit comments

Comments
 (0)