Skip to content

Document create-time visible_to_clients on tool creates#416

Merged
jeremy merged 1 commit into
masterfrom
document-create-time-visible-to-clients-on-tools
Jul 23, 2026
Merged

Document create-time visible_to_clients on tool creates#416
jeremy merged 1 commit into
masterfrom
document-create-time-visible-to-clients-on-tools

Conversation

@jeremy

@jeremy jeremy commented Jul 23, 2026

Copy link
Copy Markdown
Member

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 visibilityChat::Transcript and Kanban::Board — which otherwise start hidden from clients. Passing true lets 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.


Synced from bc3 doc/api/ by script/api/sync_to_bc3_api — not a hand-edit.

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.
Copilot AI review requested due to automatic review settings July 23, 2026 01:16

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 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".

Comment thread sections/tools.md

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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_clients parameter 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.

Comment thread sections/tools.md
@jeremy
jeremy merged commit 9858b3b into master Jul 23, 2026
1 check passed
@jeremy
jeremy deleted the document-create-time-visible-to-clients-on-tools branch July 23, 2026 05:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants