Document create-time visible_to_clients on tool creates#416
Conversation
The Create a tool endpoint now accepts a top-level visible_to_clients boolean. It takes effect for the tool types that manage their own client visibility — Chat::Transcript and Kanban::Board — which otherwise start hidden, letting you create one already visible to clients in a single request. Other tool types inherit the project's default and ignore it.
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 3726cde7c4
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
There was a problem hiding this comment.
Pull request overview
Updates the Tools API documentation to describe a new visible_to_clients boolean accepted by the Create a tool endpoint, intended to control initial client visibility for tool types that manage their own visibility.
Changes:
- Documented the optional
visible_to_clientsparameter for tool creation, including behavioral constraints by tool type. - Updated the example JSON request and cURL snippet to include
visible_to_clients: true. - Added a reference link to the client visibility documentation section.
Tip
If you aren't ready for review, convert to a draft PR.
Click "Convert to draft" or run gh pr ready --undo.
Click "Ready for review" or run gh pr ready to reengage.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
The Create a tool endpoint now accepts a top-level
visible_to_clientsboolean.It takes effect for the tool types that manage their own client visibility —
Chat::TranscriptandKanban::Board— which otherwise start hidden from clients. Passingtruelets you create one already visible in a single request, instead of creating it and then updating its visibility. Every other tool type inherits the project's default and ignores the parameter, and it only affects newly created tools — re-enabling an existing tool keeps its current visibility.