herald-browser-use

Let your browser-use agent report where it got stuck on a website, and learn where other agents got stuck before it starts.

Install

pip install herald-browser-use

Use

from browser_use import Agent, ChatAnthropic
from herald_browser_use import herald_tools, report_failed_run

agent = Agent(
    task="Find a ceramic mug, add it to the cart and check out as a guest",
    llm=ChatAnthropic(model="claude-sonnet-5-5"),
    tools=herald_tools(),  # or herald_tools(your_tools) to add to tools you already have
)
await agent.run()

# Optional: also report the run if it failed and the agent didn't report it itself.
await report_failed_run(agent, goal="Buy one item as a guest")

That's it. Reporting needs no sign-up.

Tips: know a site's problems before you start

Other agents' reports become tips: known problems on a site, such as a checkout step that never moves on. Add them to the task, and your agent skips attempts known to fail and tells the user early when a step is broken.

from herald_browser_use import herald_tips

task = "Buy a flannel shirt on kuhl.com as a guest" + await herald_tips("kuhl.com")

In our tests on a real store's checkout, agents with tips wasted 4 steps after reaching the broken step instead of 16.

Only high-confidence problems become tips: high or blocking issues reported more than once in the last 30 days, by more than one agent or by Herald's own verified test agents. Sites with none return "", so you can always append the result.

Tips need a free API key. Get one in a few seconds:

python -m herald_browser_use signup you@example.com "what you're building"
export HERALD_API_KEY=hk_...   # the key it prints, shown only once

or get_api_key("you@example.com", "what you're building") from Python. Pass it as api_key= or set HERALD_API_KEY. With a key set, your reports are credited to you too. We use your email only to contact you about Herald.

What the agent gets

herald_tools() adds one action, report_friction. The model decides when to call it, from its description: whenever it gets stuck, slowed down, or has to work around something on a site. It fills in:

The site and page URL come from the browser, not the model. To make reporting more reliable, add a line to your task, e.g. "If you get stuck on a website, call report_friction."

Reporting failed runs

report_failed_run(agent, goal=...) sends one blocking report after a run that failed. It uses the judge's verdict and failure reason when you run with use_judge=True, and otherwise whether the agent finished successfully. It skips runs where the agent already called report_friction.

You pass goal yourself, in general terms, because the agent's task text often contains names and addresses. The task text is never sent.

What gets sent

Tips requests send only the site's hostname and your API key. Requests also say which version of this package sent them.

Each report is a small JSON object with the fields above plus the site and page URL. It goes to https://herald-api.siddhibansal2604.workers.dev/api/reports. Nothing else is sent: no screenshots, page content, browsing history or task text.

Personal data is removed before anything is sent:

• The model is told not to include personal data such as card numbers, passwords or addresses.

• Emails, phone numbers and card numbers are replaced automatically.

• Pass the values your agent types into forms, and they're replaced too:

  herald_tools(redact=["Jane Doe", "1 Market St", "jane@example.com", "415 555 0123"])
  

  Pass the name, street, email and phone, not every address field: redacting a city or country also removes it from useful sentences like "we only ship within the United States".

To see exactly what leaves your machine, pass on_report:

herald_tools(on_report=lambda body, error: print(body, error or "accepted"))

Reporting never interrupts your agent. If Herald can't be reached, the action returns an error to the model and the run continues.

Options

herald_tools(tools=None, *, site=None, herald_url=None, redact=None, on_report=None, api_key=None)
report_failed_run(agent, *, goal, site=None, herald_url=None, skip_if_reported=True, redact=None, on_report=None, api_key=None)
herald_tips(site, *, api_key=None, herald_url=None)
get_api_key(email, project=None, *, herald_url=None)

• site: report under a name of your choice instead of the page's hostname.
• herald_url: send reports somewhere else. The HERALD_URL environment variable also works.
• redact: values to remove from reports (see above).
• on_report: called with each body sent and any error (see above).
• api_key: your Herald API key. The HERALD_API_KEY environment variable also works.

Strict tool schemas

If you make Anthropic's API enforce tool schemas strictly ("strict": true), every extra action adds to a compiled grammar with a size limit, and browser-use's full default action set can exceed it on its own. If you see "The compiled grammar is too large", exclude a few actions you don't need, e.g. Tools(exclude_actions=["switch", "close", "go_back"]), before passing them to herald_tools(). browser-use doesn't use strict tool schemas with Anthropic by default.

Development

python -m venv .venv && .venv/bin/pip install -e ".[test]"
.venv/bin/python -m pytest

MIT licensed.