docs(sdk): add ask-human tool example - #161
Draft
MagMueller wants to merge 1 commit into
Draft
Conversation
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.
What changed
Adds a host-supplied callback recipe for an
ask_humantool requested by an integration partner. The example wraps the host callback in a typed SDK tool and shows scoped registration throughopencode.tools.register.Verification
bun test test/ask-human-example.test.ts: 1 passed, 0 failedbun run typecheck: passedgit diff --check: passedThe public example does not name or quote the private partner conversation.
Summary by cubic
Documents how to register a host callback as an agent tool in
@opencode-ai/sdk-nextwith a newask_humanexample. Previously the README described tool registration but gave no concrete callback-based tool; now it shows a complete pattern hosts can copy.makeAskHumaninpackages/sdk-next/examples/ask-human.ts, which wraps a(question: string) => Promise<string>callback in a typedTooland maps failures to aTool.Failure.packages/sdk-next/test/ask-human-example.test.ts, which settles the tool with a host answer and asserts the callback receives the question.tools.register(...)snippet.Written for commit 7a0e9b3. Summary will update on new commits.