docs

Author: tripolskypetr

docs/classes/ClientCompute.md

@@ -21,16 +21,16 @@ constructor(params: IComputeParams<Compute>);
 params: IComputeParams<Compute>
 ```
 
-### __@DISPOSE_SLOT_FN_SYMBOL@3110
+### __@DISPOSE_SLOT_FN_SYMBOL@3114
 
 ```ts
-__@DISPOSE_SLOT_FN_SYMBOL@3110: any
+__@DISPOSE_SLOT_FN_SYMBOL@3114: any
 ```
 
-### __@GET_COMPUTE_DATA_FN_SYMBOL@3111
+### __@GET_COMPUTE_DATA_FN_SYMBOL@3115
 
 ```ts
-__@GET_COMPUTE_DATA_FN_SYMBOL@3111: any
+__@GET_COMPUTE_DATA_FN_SYMBOL@3115: any
 ```
 
 ## Methods

docs/classes/ClientSwarm.md

@@ -101,7 +101,7 @@ Returns the current busy state of the swarm.
 Used to check if the swarm is currently processing an operation (e.g., waiting for output or switching agents).
 Supports debugging and flow control in client applications.
 
-### __@SET_BUSY_FN@1567
+### __@SET_BUSY_FN@1571
 
 ```ts
 [SET_BUSY_FN](isBusy: boolean): void;

docs/classes/SchemaUtils.md

@@ -16,10 +16,10 @@ constructor();
 
 ## Properties
 
-### __@PERSIST_WRITE_SYMBOL@4306
+### __@PERSIST_WRITE_SYMBOL@4310
 
 ```ts
-__@PERSIST_WRITE_SYMBOL@4306: any
+__@PERSIST_WRITE_SYMBOL@4310: any
 ```
 
 ### writeSessionMemory

docs/functions/validate.md

@@ -0,0 +1,13 @@
+---
+title: docs/api-reference/function/validate
+group: docs
+---
+
+# validate
+
+```ts
+declare function validate(): void;
+```
+
+Validates all swarms, agents, and outlines in the system.
+This function is idempotent and will only perform validation once per process.

docs/index.md

@@ -201,6 +201,7 @@ group: docs
 - [changeToAgent](functions/changeToAgent.md)
 - [changeToPrevAgent](functions/changeToPrevAgent.md)
 - [changeToDefaultAgent](functions/changeToDefaultAgent.md)
+- [validate](functions/validate.md)
 
 ## Interfaces
 
@@ -270,7 +271,8 @@ group: docs
 - [IHistory](interfaces/IHistory.md)
 - [IHistoryParams](interfaces/IHistoryParams.md)
 - [IHistorySchema](interfaces/IHistorySchema.md)
-- [IOutlineFormat](interfaces/IOutlineFormat.md)
+- [IOutlineSchemaFormat](interfaces/IOutlineSchemaFormat.md)
+- [IOutlineObjectFormat](interfaces/IOutlineObjectFormat.md)
 - [IOutlineCallbacks](interfaces/IOutlineCallbacks.md)
 - [IOutlineMessage](interfaces/IOutlineMessage.md)
 - [IOutlineHistory](interfaces/IOutlineHistory.md)
@@ -375,6 +377,7 @@ group: docs
 - [THistoryMemoryInstance](types/THistoryMemoryInstance.md)
 - [IOutlineParam](types/IOutlineParam.md)
 - [IOutlineData](types/IOutlineData.md)
+- [IOutlineFormat](types/IOutlineFormat.md)
 - [OutlineName](types/OutlineName.md)
 - [CompletionName](types/CompletionName.md)
 - [WikiName](types/WikiName.md)

docs/interfaces/IOutlineObjectFormat.md

@@ -0,0 +1,39 @@
+---
+title: docs/api-reference/interface/IOutlineObjectFormat
+group: docs
+---
+
+# IOutlineObjectFormat
+
+Interface representing the format/schema definition for outline data.
+Specifies the structure, required fields, and property metadata for outline operations.
+Used to enforce and document the expected shape of outline data.
+
+## Properties
+
+### type
+
+```ts
+type: string
+```
+
+The root type of the outline format (e.g., "object").
+If openai used Should be "json_object" for partial JSON schemas or "json_schema" for full matching schemas.
+If ollama or `toJsonSchema` function used should just pass "object"
+
+### required
+
+```ts
+required: string[]
+```
+
+Array of property names that are required in the outline data.
+
+### properties
+
+```ts
+properties: { [key: string]: { type: string; description: string; enum?: string[]; }; }
+```
+
+An object mapping property names to their type, description, and optional enum values.
+Each property describes a field in the outline data.

docs/interfaces/IOutlineSchemaFormat.md

@@ -0,0 +1,28 @@
+---
+title: docs/api-reference/interface/IOutlineSchemaFormat
+group: docs
+---
+
+# IOutlineSchemaFormat
+
+Interface representing a format definition using a JSON schema.
+Specifies the type and the associated JSON schema object for validation.
+Used when the outline format is defined by a complete JSON schema.
+
+## Properties
+
+### type
+
+```ts
+type: string
+```
+
+The type of the outline format (e.g., "json_schema").
+
+### json_schema
+
+```ts
+json_schema: object
+```
+
+The JSON schema object defining the structure and validation rules.

docs/types/IOutlineFormat.md

@@ -0,0 +1,12 @@
+---
+title: docs/api-reference/type/IOutlineFormat
+group: docs
+---
+
+# IOutlineFormat
+
+```ts
+type IOutlineFormat = IOutlineSchemaFormat | IOutlineObjectFormat;
+```
+
+