Skip to content

docs: add openInConnectionBrowser and Invocation API to ToolBox API reference#33

Merged
Power-Maverick merged 2 commits into
mainfrom
copilot/update-api-references-utils
May 24, 2026
Merged

docs: add openInConnectionBrowser and Invocation API to ToolBox API reference#33
Power-Maverick merged 2 commits into
mainfrom
copilot/update-api-references-utils

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented May 24, 2026

Two APIs introduced in 1.2.2 / 1.2.2-beta were absent from the ToolBox API reference docs.

Changes

  • Utils — added toolboxAPI.utils.openInConnectionBrowser(url, connectionTarget?) (1.2.2): opens a URL in the browser profile associated with the active connection for seamless authenticated access; falls back to system default browser
  • Invocation API — new section (1.2.2-beta) covering inter-tool launch flow:
    • toolboxAPI.invocation.launchTool(targetToolId, prefillData?, options?) — launch another tool and await its return value
    • toolboxAPI.invocation.getLaunchContext() — read prefill data passed by the caller
    • toolboxAPI.invocation.returnData(data) — resolve the caller's awaited promise
  • Updated the page sections index to include Invocation API

Example

// Caller (Tool A)
const result = await toolboxAPI.invocation.launchTool(
  '@my-org/entity-picker',
  { entityName: 'account' },
)
console.log(result?.selectedId)

// Callee (Tool B)
const ctx = await toolboxAPI.invocation.getLaunchContext()
// ...user picks something...
await toolboxAPI.invocation.returnData({ selectedId, selectedName })

@vercel
Copy link
Copy Markdown

vercel Bot commented May 24, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs-web Ready Ready Preview, Comment May 24, 2026 5:02pm

@Power-Maverick Power-Maverick marked this pull request as ready for review May 24, 2026 17:05
Copilot AI review requested due to automatic review settings May 24, 2026 17:05
@Power-Maverick Power-Maverick merged commit c0eea10 into main May 24, 2026
2 of 3 checks passed
@Power-Maverick Power-Maverick deleted the copilot/update-api-references-utils branch May 24, 2026 17:07
Copilot AI review requested due to automatic review settings May 24, 2026 17:30
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