Read frame runtime state
read_frame_stateRead frontend hooks, stores or storage from an authorized private frame-browser session, live Bloom tab, or comment capture. Overview returns a bounded map; storageKey/valuePath and cursors select detailed values. Truncated strings include prefix and omittedCharacters. Results include payloadHash. Scope: project:read.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"path": "<path>",
"from": "<from>"
},
"name": "read_frame_state"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| from | Yes | Where the state lives. `"browser"`: your own `browse_frame` session on the frame. `{ contextId }`: the state one of YOUR Bloom tabs holds now — each fresh call asks that tab for a new complete capture (reusing one still in flight), so call again while `completeArtifact.status` is 'materializing'. `{ captureKey }`: the state a comment captured. | |
| path | Yes | The canonical Frame path: bloom:file/<Page>/<Filename>.tsx. | |
| limit | No | Max entries an overview, read or search returns. | |
| query | No | Text to find when `operation` is search. | |
| range | No | Slice of a large array, object or string when reading a value. | |
| cursor | No | Continuation cursor a prior read or search returned. | |
| readRef | No | `from: { contextId }` only: the complete-artifact read lease a prior call returned. Pass it back to keep reading the same immutable capture. | |
| branchId | No | Target branch id. Omit it — Bloom derives the branch from the frames you name, from the token's narrowing, or from your only readable branch, and enumerates the candidates if it genuinely cannot. | |
| operation | No | overview (default) returns a bounded map of the state, read expands one `storageKey` + `valuePath` (or continues a `cursor`), search finds values matching `query`. | |
| valuePath | No | Path inside `storageKey` to expand, e.g. ['hooks', 0, 'value']. | |
| storageKey | No | Storage slot to expand, as an overview names it. |