<!--
 ⚠️  AUTO-GENERATED FILE - DO NOT EDIT MANUALLY
 This file is automatically generated by scripts/docs-generator.js
 To make changes, edit the source TypeScript files or update the generator script
-->

[agents](../../) / [Exports](../modules) / IParameterSchema

# Interface: IParameterSchema

Parameter schema for tools

## Table of contents

### Properties

- [type](IParameterSchema#type)
- [description](IParameterSchema#description)
- [enum](IParameterSchema#enum)
- [items](IParameterSchema#items)
- [properties](IParameterSchema#properties)
- [minimum](IParameterSchema#minimum)
- [maximum](IParameterSchema#maximum)
- [pattern](IParameterSchema#pattern)
- [format](IParameterSchema#format)
- [default](IParameterSchema#default)

## Properties

### type

• **type**: [`TJSONSchemaType`](../modules#tjsonschematype)

#### Defined in

[packages/agents/src/interfaces/provider.ts:46](https://github.com/woojubb/robota/blob/4f4c8a3197e92ddd43d12dc9186b0771983054c9/packages/agents/src/interfaces/provider.ts#L46)

---

### description

• `Optional` **description**: `string`

#### Defined in

[packages/agents/src/interfaces/provider.ts:47](https://github.com/woojubb/robota/blob/4f4c8a3197e92ddd43d12dc9186b0771983054c9/packages/agents/src/interfaces/provider.ts#L47)

---

### enum

• `Optional` **enum**: [`TJSONSchemaEnum`](../modules#tjsonschemaenum)

#### Defined in

[packages/agents/src/interfaces/provider.ts:48](https://github.com/woojubb/robota/blob/4f4c8a3197e92ddd43d12dc9186b0771983054c9/packages/agents/src/interfaces/provider.ts#L48)

---

### items

• `Optional` **items**: [`IParameterSchema`](IParameterSchema)

#### Defined in

[packages/agents/src/interfaces/provider.ts:49](https://github.com/woojubb/robota/blob/4f4c8a3197e92ddd43d12dc9186b0771983054c9/packages/agents/src/interfaces/provider.ts#L49)

---

### properties

• `Optional` **properties**: `Record`\<`string`, [`IParameterSchema`](IParameterSchema)\>

#### Defined in

[packages/agents/src/interfaces/provider.ts:50](https://github.com/woojubb/robota/blob/4f4c8a3197e92ddd43d12dc9186b0771983054c9/packages/agents/src/interfaces/provider.ts#L50)

---

### minimum

• `Optional` **minimum**: `number`

#### Defined in

[packages/agents/src/interfaces/provider.ts:51](https://github.com/woojubb/robota/blob/4f4c8a3197e92ddd43d12dc9186b0771983054c9/packages/agents/src/interfaces/provider.ts#L51)

---

### maximum

• `Optional` **maximum**: `number`

#### Defined in

[packages/agents/src/interfaces/provider.ts:52](https://github.com/woojubb/robota/blob/4f4c8a3197e92ddd43d12dc9186b0771983054c9/packages/agents/src/interfaces/provider.ts#L52)

---

### pattern

• `Optional` **pattern**: `string`

#### Defined in

[packages/agents/src/interfaces/provider.ts:53](https://github.com/woojubb/robota/blob/4f4c8a3197e92ddd43d12dc9186b0771983054c9/packages/agents/src/interfaces/provider.ts#L53)

---

### format

• `Optional` **format**: `string`

#### Defined in

[packages/agents/src/interfaces/provider.ts:54](https://github.com/woojubb/robota/blob/4f4c8a3197e92ddd43d12dc9186b0771983054c9/packages/agents/src/interfaces/provider.ts#L54)

---

### default

• `Optional` **default**: [`TParameterDefaultValue`](../modules#tparameterdefaultvalue)

#### Defined in

[packages/agents/src/interfaces/provider.ts:55](https://github.com/woojubb/robota/blob/4f4c8a3197e92ddd43d12dc9186b0771983054c9/packages/agents/src/interfaces/provider.ts#L55)
