* claim: #3654 * Control channel: control.running lists what the app is running, across connections (#3654) control.pending answers only for the connection that asks, so a second client, the MCP bridge after a reconnect or a script saw {"pending": null} while the app was busy. control.running answers for the whole app, the same on every connection and at once (the connection's own thread answers it, also while it is busy with a timed-out request): every request the app has been sent and not answered yet, oldest first, with its connection, id, method, command id (or a batch's step count), seconds since it arrived and whether it still waits its turn. A timed-out request stays listed until the app answers it, also after its connection closed. Parameters are never shown. The window marks a request started when it takes it (ControlRequest.started), which tells queued from running. The MCP server gets a read-only `running` tool. --------- Co-authored-by: MateuszSychXpl <151755914+MateuszSychXpl@users.noreply.github.com>
This commit is contained in:
@@ -59,6 +59,25 @@ with `control.pending`: `{"pending": <id>, "method": …, "done": false}` while
|
||||
connection is refused at once with `{"ok": false, "busy": true, "error": "busy: …"}` and not
|
||||
run, so nothing is queued to apply unseen behind it.
|
||||
|
||||
`control.pending` answers only for its own connection. `control.running` answers for the whole
|
||||
app, the same on every connection, at once (it never waits behind a running request, and a
|
||||
connection may ask it while it is `busy`): every request the app has been sent and has not
|
||||
answered yet, oldest first, from any connection, including a timed-out one whose connection has
|
||||
since closed:
|
||||
|
||||
```text
|
||||
{"id":1,"method":"control.running","token":"…"}
|
||||
→ {"id":1,"ok":true,"result":{"running":[
|
||||
{"connection":3,"id":17,"method":"engine.execute","command":"file.export","running_s":312.4,"queued":false},
|
||||
{"connection":5,"id":2,"method":"engine.batch","steps":12,"running_s":4.1,"queued":true,"self":true}]}}
|
||||
```
|
||||
|
||||
`running_s` counts seconds since the request arrived; `queued` is true while it still waits its
|
||||
turn behind another. `command` is the command id of `engine.execute` (a known one only) and
|
||||
`steps` the length of `engine.batch` or `engine.script`; parameters are never shown, so file
|
||||
paths and expressions stay with the connection that sent them. `self` marks the asking
|
||||
connection's own request. `{"running": []}` when the app is idle.
|
||||
|
||||
Any request's `params` may carry `allow_paths: ["/abs/folder", …]`: every file that request
|
||||
reads, writes or deletes (command paths such as `file.export`'s `path` or `doc.recovery_*`'s
|
||||
`dir`, `ui.render`, `ui.screenshot`) must then lie inside one of those folders after `..` and
|
||||
|
||||
@@ -164,6 +164,7 @@ They cover the workflow, the command shapes, how to verify with `measure`, and t
|
||||
| `export` | `path`, `format?` (step, 3mf, 3mf-tagged, stl, stla, obj, urdf), `bodies?`, `mesh_prefix?`, `effort?`, `velocity?` | STEP, 3MF or mesh export; URDF writes the whole assembly with its meshes next to it (`docs/urdf.md`). |
|
||||
| `undo`, `redo` | — | Undo / redo one change. |
|
||||
| `crash_reports` | `id?`, `limit?` | The crash reports on this computer, newest first; with `id`, the whole report (backtrace, command, recent commands, `design_path`/`replay_path`). See [crash-reports.md](crash-reports.md). |
|
||||
| `running` | - | What the app is running or has queued, for every client (`control.running`, see [control-protocol.md](control-protocol.md#limits)): each request's connection and id, method, command id or a batch's step count, `running_s` and `queued`, never its parameters. Answers at once while the app is busy: ask it when a call timed out before sending a change again. Headless: always `{"running": []}`. |
|
||||
| `new_design` | `name?` | Start an empty design. |
|
||||
| `open` | `path` | Open a `.solidcraft` design, a STEP file (`.step`/`.stp`) as a new design holding its bodies (an Import base feature), or a 3MF/STL file as mesh bodies. |
|
||||
| `save` | `path?` | Save the design (to its current file without `path`). |
|
||||
|
||||
Reference in New Issue
Block a user