ToolArgument

struct ToolArgument : struct ToolArgument

struct [source] ¶

struct [source] ¶

struct ToolArgument

Bases:

• Sendable
• Hashable
• SendableMetatype
• Equatable

One argument of a tool, in enough detail to generate its schema.

The schema and the reader are generated from the same declaration, which is what keeps a documented argument from being one the tool cannot actually receive.

Members

• Kind enum
• !=(_:_:) function Returns a Boolean value indicating whether two values are not equal.
• allowed property The only values accepted, when there is a fixed set. Reaches the schema as enum, so a client can offer them rather than guess.
• defaultValue property What the tool does when the argument is omitted, stated in the schema so a caller need not send it to find out.
• isRequired property
• kind property
• maximum property
• maximumItems property The most entries accepted in an array argument.
• minimum property Inclusive numeric bounds, enforced by the reader and published in the schema.
• name property
• summary property