docs: SDK ergonomics for Praefectus - #52
Merged
Merged
Conversation
Lead the README with a one-line pitch and runnable Quick Start before the protocol essay, add an agent layout guide, and ship a credential-free library example that prints capabilities and missing-operation status. Co-authored-by: Max Carter 祁明思 <max@tsc.hk>
undivisible
marked this pull request as ready for review
September 11, 2026 19:21
Bugbot couldn't run - usage limit reachedBugbot is counted against Cursor usage for this user or team, and this run hit a usage or spend limit. A user or team admin can review and increase usage limits in the Cursor dashboard. (requestId: serverGenReqId_b0ca9f84-a95d-4861-aeab-34138048254d) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Lead the README with a one-line pitch and a runnable Quick Start before the protocol essay, add
AGENTS.mdfor layout and non-invented APIs, and ship a credential-free library example.Changes
## Quick Start(cargo build/cargo test,capabilities/surfaces/status,cargo run --example capabilities) before the trust-model and protocol essay. Existing CLI/library/protocol text is unchanged aside from the new top matter and a Development example command. The stale0.7.0version label is dropped so the crate version inCargo.tomlstays the source of truth.executeCLI, no secrets, no remote CDP, no host approval ledgers).capabilities.rsconstructsEnginewithNativeExecutorandDenyAuthority, prints capabilities, and reads status for a missing operation ID.examples/README.mdfollows the equilibrium name / run / Demonstrates layout.[[example]]plus/examples/**ininclude.No runtime behavior changes.
Verification
Ran on this branch:
cargo fmt --all -- --checkcargo clippy --all-targets --all-features -- -D warningscargo clippy --all-targets -- -D warningscargo check --all-targets --all-featurescargo test --all-features(one pre-existing env failure, see below)cargo run --example capabilities→platform=linux backend=praefectus-linux status=nonecargo run -- capabilities→ok: truecargo run -- surfaces→observation_error/ exit 3 (no AT-SPI desktop)cargo run -- status --ledger ./operations.jsonl example-missing-operation→{"data":null,"ok":true}cargo package --listincludesexamples/capabilities.rsandexamples/README.mdnative_executor_routes_coordinate_effectsfails on this agent VM becauseDISPLAY=:1is set, so the Linux early-return does not apply,moveis advertised, and global input is refused asNoEffect. That assertion is unchanged onmainand is outside this docs-only PR. GitHub Actions Ubuntu has noDISPLAY/WAYLAND_DISPLAYand skips that path.