User guide / Agent access to workspace context

How agents use it

Development reference · View source

  • Start with find_resources, optionally selecting a workspace and searching buffer or terminal names and contents. Use the returned exact handle with read_buffer, read_terminal, append_buffer, edit_buffer, or propose_terminal_text. Repeated names remain separate candidates.
  • list_workspaces checks permissions without reading source text. find_resources can read content to match a query; match_in="name" restricts matching to names. Search is bounded and may return partial results.
  • terminal_proposal_status and cancel_terminal_proposal operate on the proposal handle. Let the person review a proposal rather than polling for approval.
  • These are the nine MCP tools. Pane listing, selection and viewport reads, and immutable snapshots are not exposed by the MCP adapter.
  • Granted detached persistent workspaces and running ide-mode editors are discoverable without attaching a TUI or changing focus. Terminal approval needs an attached native frontend.
  • After permission changes, run find_resources again. Handles belong to one MCP process and connection generation; they expire on revocation, connection renewal, eviction, or host restart. Never retry an outcome_unknown mutation automatically.

See the MCP guide for the complete catalog and discovery bounds.

Discovery for tools. runyte --context-list --json gives bounded, versioned endpoint metadata for live enabled endpoints in the current environment; --include-hidden adds other environments. Listing does not grant content access: the adapter authenticates each target separately. A slow or unavailable host does not block discovery of the others. On Windows, use the absolute runyte.exe path in client configuration; let the adapter discover its named-pipe endpoint and host process identity rather than copying them.