Skip to content

Add debugging member to ToolAnnotations #253

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
beaufortfrancois wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add debugging member to ToolAnnotations #253

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
16 changes: 14 additions & 2 deletions index.bs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,9 @@ An <dfn>annotations</dfn> is a [=struct=] with the following [=struct/items=]:

: <dfn>untrusted content hint</dfn>
:: a [=boolean=], initially false.

: <dfn>debugging</dfn>
:: a [=boolean=], initially false.
</dl>

<h3 id="pending-tool-executions">Pending tool executions</h3>
Expand Down Expand Up @@ -758,6 +761,9 @@ The <dfn method for=ModelContext>registerTool(<var>tool</var>, <var>options</var
: [=annotations/untrusted content hint=]
:: |tool|'s {{ModelContextTool/annotations}}'s {{ToolAnnotations/untrustedContentHint}}

: [=annotations/debugging=]
:: |tool|'s {{ModelContextTool/annotations}}'s {{ToolAnnotations/debugging}}

: [=tool definition/exposed origins=]
:: |exposed origins|

Expand Down Expand Up @@ -874,9 +880,11 @@ The <dfn method for=ModelContext>getTools(<var>options</var>)</dfn> method steps
: {{RegisteredTool/annotations}}
:: if |tool definition|'s [=tool definition/annotations=] is not null, a
{{ToolAnnotations}} dictionary whose {{ToolAnnotations/readOnlyHint}} is |tool
definition|'s [=tool definition/annotations=]'s [=annotations/read-only hint=] and
definition|'s [=tool definition/annotations=]'s [=annotations/read-only hint=],
{{ToolAnnotations/untrustedContentHint}} is |tool definition|'s [=tool
definition/annotations=]'s [=annotations/untrusted content hint=].
definition/annotations=]'s [=annotations/untrusted content hint=], and
{{ToolAnnotations/debugging}} is |tool definition|'s [=tool
definition/annotations=]'s [=annotations/debugging=].

1. [=list/Append=] |registeredTool| to |tools|.

Expand Down Expand Up @@ -1068,6 +1076,7 @@ dictionary ModelContextTool {
dictionary ToolAnnotations {
boolean readOnlyHint = false;
boolean untrustedContentHint = false;
boolean debugging = false;
};

dictionary ToolExecuteCallbackOptions {
Expand Down Expand Up @@ -1124,6 +1133,9 @@ The {{ToolAnnotations}} dictionary provides optional metadata about a tool:

: <code><var ignore>annotations</var>["{{ToolAnnotations/untrustedContentHint}}"]</code>
:: If true, indicates that the tool's output contains data that is untrusted, from the perspective of the author registering the tool.

: <code><var ignore>annotations</var>["{{ToolAnnotations/debugging}}"]</code>
:: If true, indicates that the tool is intended for debugging and developer tooling rather than end-user interactions.
</dl>

<h4 id="tool-execute-callback-options">ToolExecuteCallbackOptions Dictionary</h4>
Expand Down
Loading