Skip to content

Clarify executeTool input and schema values #279

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mlmrx wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Clarify executeTool input and schema values #279

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions index.bs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -635,9 +635,29 @@ is a [=model context=] [=struct=] created alongside the {{ModelContext}}.
<dd>
<p>Executes a tool on the document it was registered on. Returns a promise that resolves to the
stringified result of the tool's execution.</p>

<p><var ignore>tool</var> is a {{RegisteredTool}} returned by {{ModelContext/getTools()}}. Its
{{RegisteredTool/inputSchema}} is exposed as a parsed JavaScript object. Callers pass the
structured JavaScript value described by that schema as <var ignore>inputObject</var>; the user
agent serializes and transfers it to the tool's execution context, so callers do not
{{JSON/stringify()}} it first.</p>
</dd>
</dl>

<div class=example id=executing-a-discovered-tool>
The following discovers a tool and executes it with a JavaScript object:

```js
const tools = await document.modelContext.getTools();
const tool = tools.find(({name}) => name === "example_tool");

if (tool) {
console.log(tool.inputSchema.type); // "object"
const result = await document.modelContext.executeTool(tool, {message: "hello"});
}
```
</div>


<div algorithm>
The <dfn method for=ModelContext>registerTool(<var>tool</var>, <var>options</var>)</dfn> method steps are:
Expand Down