Skip to content

Commit c495166

Browse files
committed
docs: explain authorized workspace LSP mode
Signed-off-by: Jeremi Joslin <jeremi@joslin.fr>
1 parent fbf110c commit c495166

1 file changed

Lines changed: 11 additions & 2 deletions

File tree

‎crates/registry-language-server/README.md‎

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -151,12 +151,21 @@ cargo run --locked -p registry-language-server
151151
Use `registry-language-server --version` to identify a built binary. The server
152152
version follows the Registry Stack workspace version.
153153

154-
The server communicates over standard input and output and expects the opened workspace (or a
155-
nested directory) to be inside a Registry Stack or Evidence authoring project.
154+
In its default mode, the server communicates over standard input and output and expects the
155+
opened workspace (or a nested directory) to be inside a Registry Stack or Evidence authoring
156+
project.
156157

157158
For a caller-supplied Workspace v1 snapshot, `registry-language-server --workspace-analysis`
158159
reads one `id.registrystack.org/formats/platform/workspace-analysis/v1alpha1` JSON request
159160
from standard input and writes one JSON response. The caller supplies the exact source bytes,
160161
file digests, workspace binding and declarative facts; this mode does not read source paths
161162
from disk. Responses distinguish resolved references and impact from incomplete native or
162163
generated coverage.
164+
165+
For a Studio Workspace v1 draft, `registry-language-server --workspace-lsp` serves LSP over
166+
standard input and output. Each `registryStudio/authorizedQuery` request carries the caller's
167+
authorization; a ready authorization supplies exact snapshot bytes and URI bindings. The server
168+
reads no workspace paths from disk in this mode and retains no snapshot between requests. Direct
169+
definition and references requests have no authorization payload and are refused. The embedding
170+
caller must authorize each query before forwarding it; this process analyzes only the supplied
171+
bytes.

0 commit comments

Comments
 (0)