docs(sdk): add runnable examples and tighten README quick start - #185
Merged
Merged
Conversation
Add examples/ with minimal_agent, custom_tool, sessions, and provider_agent plus an equilibrium-style examples/README. Move library cargo add and gated binary cargo install into Quick start before the capability list. Fix malformed Docs section and stale AGENTS.md praefectus version.
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_595ea906-e308-4d3d-9313-f0ab64ca5ff3) |
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.
SDK ergonomics pass for the rx4 embed surface.
cargo addand the gated binarycargo installbefore the capability list; repaired the malformed Docs section.minimal_agent,custom_tool,sessions, andprovider_agent(requiresproviders) plus an equilibrium-styleexamples/README.md.zkr-memory/personalityrows.Validation run locally:
cargo build --examplescargo build --example provider_agent --features providerscargo run --example minimal_agent/custom_tool/sessionscargo clippy --examples --features providerscargo fmt --checkNote
Low Risk
Documentation and example-only changes with no runtime or security behavior changes.
Overview
SDK ergonomics for library hosts: the README now leads with library
cargo add, an updated embed snippet (Policy::workspace_write, pointer toprovider_agent), runnable example commands, a gated-binary install section, a What it exposes capability list, and a cleaned-up docs index.New
examples/: four small programs (minimal_agent,custom_tool,sessions,provider_agent) plusexamples/README.mdwith run instructions;Cargo.tomldeclaresprovider_agentwithrequired-features = ["providers"].AGENTS.md housekeeping: praefectus 0.4.1 → 0.8.0, expanded builtin tool loadout description, and feature-table rows for
zkr-memoryandpersonality.Reviewed by Cursor Bugbot for commit dfc9923. Configure here.