Tools

from browser_use import Agent, Tools

tools = Tools()
PRICES = {'A-100': 19.99, 'B-200': 4.50}


@tools.action('Look up our internal price for a SKU')
def get_price(sku: str) -> str:
    if sku not in PRICES:
        raise KeyError(f'unknown SKU {sku}')  # the model sees the error and can recover
    return f'{PRICES[sku]} USD'


agent = Agent('What is our internal price for SKU A-100? Use the get_price tool, no browsing needed.', tools=tools)
print(agent.run_sync().final_result())

​

Return values

​

Errors

• A tool that raises does not end the run. The model gets the error and can recover.
• Raise pydantic_ai.ModelRetry('...') to ask the model to call the tool again with better arguments.

​

param_model

from pydantic import BaseModel

from browser_use import ActionResult, Agent, Tools

tools = Tools()


class Ticket(BaseModel):
    title: str
    priority: int


@tools.action('File a ticket in our tracker', param_model=Ticket)
async def file_ticket(params: Ticket) -> ActionResult:
    return ActionResult(extracted_content=f'Filed ticket #42: {params.title} (P{params.priority})')


agent = Agent('File a P2 ticket titled "example.com is up" after checking https://example.com loads', tools=tools)
print(agent.run_sync().final_result())

​

Rules

• Use @tools.action('description') with parentheses.
• Names must match [a-zA-Z0-9_-]{1,64}. python, finish and finish_from_repl are taken.
• A tool gets only the arguments the model passes. The 0.x injected parameters (browser_session, page_extraction_llm, file_system, …) raise.
• ActionResult(is_done=True, ...), success=, attachments=[...] and images=[...] raise: the model ends the run with finish, and saves files in the workspace. A function that returns one raises a TypeError when @tools.action registers it, before any browser starts. include_in_memory and include_extracted_content_only_once log a warning and are ignored: every result stays in the conversation.
• Registering a name again replaces the earlier tool, as in 0.x.
• domains=, allowed_domains=, page_filter=, requires_browser= and terminates_sequence= raise. Limit navigation with Browser(allowed_domains=...).
• A <secret>name</secret> placeholder in a tool’s arguments is not replaced: the tool does not run and the model gets an error. Secrets are typed in the browser with type_secret(name).
• Controller is an alias of Tools.

​

No built-in actions