Spec the executeTool() API#226
Draft
domfarolino wants to merge 5 commits into
Draft
Conversation
This CL introduces the `executeTool()` method to the `ModelContext` interface in the WebMCP specification. This aligns the spec with the C++ implementation in Blink. Key changes: - Adds `executeTool()` and `ExecuteToolOptions` IDL definitions. - Specifies the `executeTool()` algorithm, detailing cross-document tool lookup, origin visibility checks, and asynchronous invocation in the target document`s realm. - Clarifies the execution callback arguments and JSON serialization. - Incorporates `AbortSignal` handling for tool cancellation, dispatching a `toolcancel` event in the target document. - Fires `toolactivated` event in the target document. - Updates IDL member access syntax to use idiomatic Bikeshed style. Small things Fix some things Don't serialize Object argument enforcement Add AbortSignal issue Small things
| 1. If |invokingDocument| is not [=Document/fully active=], then return [=a promise rejected with=] | ||
| an "{{InvalidStateError}}" {{DOMException}}. | ||
|
|
||
| 1. If this's [=surrounding agent=]'s [=agent cluster=]'s [=is origin-keyed=] is false and this's |
Contributor
There was a problem hiding this comment.
Suggested change
| 1. If this's [=surrounding agent=]'s [=agent cluster=]'s [=is origin-keyed=] is false and this's | |
| 1. If [=this=]'s [=surrounding agent=]'s [=agent cluster=]'s [=is origin-keyed=] is false and [=this=]'s |
This suggestion applies as well to getTools and registerTool.
| 1. Let |expectedTargetOriginURL| be the result of [=URL parser|parsing=] |tool|'s | ||
| {{RegisteredTool/origin}}. | ||
|
|
||
| 1. If |expectedTargetOriginURL| is failure, then return [=a promise rejected with=] a |
Contributor
There was a problem hiding this comment.
How about using NotSupportedError instead and return a rejected promise in both cases?
- expectedTargetOriginURL is a failure
- expectedTargetOrigin is opaque
| 1. If |targetDocument|'s [=node navigable=]'s [=navigable/traversable navigable=] is not | ||
| |invokingDocument|'s [=node navigable=]'s [=navigable/traversable navigable=], then [=queue a | ||
| global task=] on the [=webmcp task source=] given |invokingDocument|'s [=relevant global | ||
| object=] to [=reject=] |promise| with an "{{UnknownError}}" {{DOMException}}, and abort these |
Contributor
There was a problem hiding this comment.
UnknownError feels weird to me in these cases. Maybe InvalidStateError?
| <dt><code><var ignore>document</var>.{{Document/modelContext}}.{{ModelContext/executeTool(tool, inputArguments, options)}}</code></dt> | ||
| <dd> | ||
| <p>Executes a tool on the document it was registered on. Returns a promise that resolves to the | ||
| result of the tool's execution.</p> |
Contributor
There was a problem hiding this comment.
Maybe extends that it's a stringified result only for now.
| </div> | ||
|
|
||
| <div algorithm> | ||
| The <dfn method for=ModelContext>executeTool(<var>tool</var>, <var>inputArguments</var>, |
Contributor
There was a problem hiding this comment.
A JS example of how to execute a tool from a cross-origin iframe may come handy in this spec. See previous comment at #223 (comment)
beaufortfrancois
left a comment
beaufortfrancois
left a comment
Contributor
There was a problem hiding this comment.
We should update README as well: https://github.com/webmachinelearning/webmcp#discovering-and-running-tools
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
3 participants
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.
This PR specifies the
executeTool()API onModelContext.Closes #57.
Closes #117.
Closes #159.
Closes #160.
Preview | Diff