This repository was archived by the owner on Apr 17, 2026. It is now read-only.
docs: add tool reference pages - #142
Merged
Merged
Conversation
Add /guides/tool-permissions covering the rule DSL, evaluation order, permission modes, interactive approval wiring, and per-tool checkPermissions. Register the page in the VitePress sidebar between "Add Tools" and "Add Context", and update the dead /guides/tool-permissions link in reference/create-agent-app.md to point to the new guide. Signed-off-by: yai-dev <sunzhenyucn@gmail.com>
Cover the full client-side pattern: consuming permission_request / permission_resolved events from the SSE stream, POSTing the decision to /api/sessions/:id/respond, and building a safe approval component that resets state on consecutive requests and only dismisses after a successful POST. Signed-off-by: yai-dev <sunzhenyucn@gmail.com>
Signed-off-by: yai-dev <sunzhenyucn@gmail.com>
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds a comprehensive Tools section to the documentation, including a guide on tool permissions and reference pages for over twenty built-in tools. It also updates internal file links to absolute GitHub URLs. Feedback identifies inconsistent event naming in the AskUserQuestion documentation, a contradiction in the Bash tool's result schema, and an overly specific artifact path in the Python tool documentation.
Signed-off-by: yai-dev <sunzhenyucn@gmail.com>
yai-dev
added
skip-changeset
Signed-off-by: yai-dev <sunzhenyucn@gmail.com>
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
1 participant
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.
Summary
Validation
pnpm exec prettier --check docs/.vitepress/config.ts docs/examples/deep-research.md docs/examples/playground-server.md docs/examples/playground-ui.md docs/guides/add-context.md docs/guides/build-a-profile.md docs/guides/manage-prompts.md docs/reference/host-primitives.md docs/reference/plugin-contract.md docs/reference/profile-contract.md docs/tools/**/*.mdNotes