Function getToolsInstructions

packages/agent-runtime/src/tools/prompts.ts:158–241

(
  tools: readonly string[],
  additionalToolDefinitions: NonNullable<
    z.input<typeof customToolDefinitionsSchema>
  >,
  options?: { availableSkillsXml?: string },
)

}

export const getToolsInstructions = (
  tools: readonly string[],
  additionalToolDefinitions: NonNullable<
    z.input<typeof customToolDefinitionsSchema>
  >,
  options?: { availableSkillsXml?: string },
) => {
  if (
    tools.length === 0 &&
    Object.keys(additionalToolDefinitions).length === 0
  ) {
    return ''
  }

  return `
# Tools

You (Buffy) have access to the following tools. Call them when needed.

## [CRITICAL] Formatting Requirements

Tool calls use a specific XML and JSON-like format. Adhere *precisely* to this nested element structure:

${getToolCallString(
    'tool_name',
    {
      parameter1: 'value1',
      parameter2: 123,
    },
    false,
  )}

### Commentary

Provide commentary *around* your tool calls (explaining your actions).

However, **DO NOT** narrate the tool or parameter names themselves.

### Example

User: can you update the console logs in example/file.ts?
Assistant: Sure thing! Let's update that file!

${getToolCallString(
    'example_editing_tool',
    {
      example_file_path: 'path/to/example/file.ts',
      example_array: [
        {
          old_content_with_newlines:
            "// some context\nconsole.log('Hello world!');\n",
          new_content_with_newlines:
            "// some context\nconsole.log('Hello from Buffy!');\n",
        },
      ],
    },
    false,
  )}