Skip to content

Navigation

import { Aside } from ‘@astrojs/starlight/components’;

Navigate the browser to a URL and block until the page has reached a requested load state.

NameTypeRequiredDefaultDescription
urlstringyesAbsolute URL including protocol
waitUntilenumnoloadOne of load, domcontentloaded, networkidle, commit
timeoutMsnumberno30000Maximum time to wait for the navigation to settle
{
"tool": "ptah_browser_navigate",
"arguments": {
"url": "https://docs.ptah.live",
"waitUntil": "networkidle",
"timeoutMs": 15000
}
}
waitUntilUse when
commitYou only need the navigation to start; fastest option
domcontentloadedDOM is ready but subresources may still be loading
loadDefault; the load event has fired and most assets are loaded
networkidlePage has had no network activity for 500 ms; safest for SPAs
ConditionBehavior
Invalid URLReturns an error without launching the browser
Timeout exceededReturns a NavigationTimeout error; browser remains on the previous page
DNS / network failureReturns the underlying Chromium error code (e.g. ERR_NAME_NOT_RESOLVED)

There is no dedicated reload tool — call ptah_browser_navigate with the current URL to force a reload, or use ptah_browser_evaluate with location.reload().