docs(dataapp-developer): document Kai tool restrictions - #90
Draft
claude[bot] wants to merge 1 commit into
Draft
Conversation
kai-client now exposes a ToolRestrictions model and a tool_restrictions param on send_message, letting data-app embeds allowlist/denylist tools or force read-only mode. Document the three fields, the first-message-wins persistence behavior, and Python + JS-proxy usage in the kai-integration reference so app authors can scope what Kai may do in an embedded chat. Refs keboola/kai-client#46, AI-3600.
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.
Requested by Jordan Burger · Slack thread
What / Before → After
Before: The
kai-integration.mdreference showed how to embed Kai and stream responses viasend_message(Python) or the/api/chatSSE proxy (JS), but there was no way documented to constrain what Kai could actually do inside an embedded chat. App authors had no guidance for building a read-only assistant or scoping it to a narrow set of tools.After: The reference gains a "Restricting tools" section documenting the new
ToolRestrictionsmodel /tool_restrictionsparam just added to thekeboola/kai-clientPython SDK. It explains the three optional, independent fields —allowed_tools(allowlist),disallowed_tools(denylist), andread_only_mode— the first-message-wins persistence behavior (the backend keeps restrictions from a chat's first message and ignores them on follow-ups), and shows both a Python example and the equivalenttoolRestrictionsJSON body for the JS proxy path. The section is also added to the file's Contents list.How
Docs-only change. Added one focused section to
plugins/dataapp-developer/skills/dataapp-development/references/kai-integration.md, mirroring the file's existing heading style, code-fence conventions, and density, and wired it into the top-of-file Contents list. No plugin version bump, since this expands an existing reference rather than adding a new command/agent/skill. No markdown lint / prettier config exists in the repo, so there was no docs check to run.Pairs with SDK PR keboola/kai-client#46 and backend PR keboola/ui#6267 (already merged). Linear: AI-3600.
Generated by Claude Code