docs

Author: tripolskypetr

docs/classes/ClientCompute.md

@@ -21,16 +21,16 @@ constructor(params: IComputeParams<Compute>);
 params: IComputeParams<Compute>
 ```
 
-### __@DISPOSE_SLOT_FN_SYMBOL@3078
+### __@DISPOSE_SLOT_FN_SYMBOL@3100
 
 ```ts
-__@DISPOSE_SLOT_FN_SYMBOL@3078: any
+__@DISPOSE_SLOT_FN_SYMBOL@3100: any
 ```
 
-### __@GET_COMPUTE_DATA_FN_SYMBOL@3079
+### __@GET_COMPUTE_DATA_FN_SYMBOL@3101
 
 ```ts
-__@GET_COMPUTE_DATA_FN_SYMBOL@3079: any
+__@GET_COMPUTE_DATA_FN_SYMBOL@3101: 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@1539
+### __@SET_BUSY_FN@1558
 
 ```ts
 [SET_BUSY_FN](isBusy: boolean): void;

docs/classes/DocService.md

@@ -54,6 +54,15 @@ agentValidationService: any
 Agent validation service instance, injected via DI.
 Provides the list of agent names for dumpDocs, ensuring only valid agents are documented.
 
+### outlineValidationService
+
+```ts
+outlineValidationService: any
+```
+
+Outline validation service instance, injected via DI.
+Used for validating and managing agent outline schemas, ensuring agent outlines conform to expected structure and constraints.
+
 ### swarmSchemaService
 
 ```ts
@@ -72,6 +81,15 @@ agentSchemaService: any
 Agent schema service instance, injected via DI.
 Retrieves IAgentSchemaInternal objects for writeAgentDoc and agent descriptions in writeSwarmDoc, providing details like tools and prompts.
 
+### outlineSchemaService
+
+```ts
+outlineSchemaService: any
+```
+
+Outline schema service instance, injected via DI.
+Retrieves and manages outline schema objects for agents, supporting documentation and validation of agent outlines.
+
 ### mcpSchemaService
 
 ```ts
@@ -172,6 +190,21 @@ Writes Markdown documentation for a swarm schema, detailing its name, descriptio
 Executes in a thread pool (THREAD_POOL_SIZE) to manage concurrency, logging via loggerService if GLOBAL_CONFIG.CC_LOGGER_ENABLE_INFO is enabled.
 Outputs to dirName/[swarmName].md, with UML images in dirName/image, and links to agent docs in dirName/agent, sourced from swarmSchemaService.
 
+### writeOutlineDoc
+
+```ts
+writeOutlineDoc: any
+```
+
+Writes Markdown documentation for an outline schema, detailing its name, description, main prompt, output format, and callbacks.
+Executes in a thread pool (THREAD_POOL_SIZE) to manage concurrency, logging via loggerService if GLOBAL_CONFIG.CC_LOGGER_ENABLE_INFO is enabled.
+Outputs to dirName/[outlineName].md, sourced from outlineSchemaService.
+
+- The Markdown includes YAML frontmatter, outline name, description, prompt(s), output format (with types, descriptions, enums, and required fields), and callbacks.
+- Handles both string and function-based prompts, and supports array or string prompt types.
+- Output format section documents each property, its type, description, enum values, and required status.
+- Callback section lists all callback names used by the outline.
+
 ### writeAgentDoc
 
 ```ts

docs/index.md

@@ -298,6 +298,7 @@ group: docs
 - [IOperatorParams](interfaces/IOperatorParams.md)
 - [IPipelineSchema](interfaces/IPipelineSchema.md)
 - [IPipelineCallbacks](interfaces/IPipelineCallbacks.md)
+- [IOutlineFormat](interfaces/IOutlineFormat.md)
 - [IOutlineCallbacks](interfaces/IOutlineCallbacks.md)
 - [IOutlineMessage](interfaces/IOutlineMessage.md)
 - [IOutlineHistory](interfaces/IOutlineHistory.md)

docs/interfaces/IAgentTool.md

@@ -26,6 +26,15 @@ toolName: string
 
 The unique name of the tool, used for identification within the agent swarm.
 
+### isAvailable
+
+```ts
+isAvailable: (clientId: string, agentName: string, toolName: string) => boolean | Promise<boolean>
+```
+
+Checks if the tool is available for execution.
+This method can be used to determine if the tool can be executed based on the current context.
+
 ### validate
 
 ```ts

docs/interfaces/IOutlineArgs.md

@@ -28,6 +28,14 @@ attempt: number
 The current attempt number for the outline operation.
 Tracks the number of retries or iterations, useful for validation or retry logic.
 
+### format
+
+```ts
+format: IOutlineFormat
+```
+
+Format of output taken from outline schema
+
 ### history
 
 ```ts

docs/interfaces/IOutlineFormat.md

@@ -0,0 +1,37 @@
+---
+title: docs/api-reference/interface/IOutlineFormat
+group: docs
+---
+
+# IOutlineFormat
+
+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").
+
+### 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/IOutlineSchema.md

@@ -10,6 +10,17 @@ Defines the structure and behavior of an outline, including data generation and
 
 ## Properties
 
+### prompt
+
+```ts
+prompt: string | string[] | ((outlineName: string) => string | string[] | Promise<string | string[]>)
+```
+
+The prompt or prompt generator for the outline operation.
+Can be a string, an array of strings, or a function that returns a string, array of strings, or a promise resolving to either.
+If a function is provided, it receives the outline name and can return a prompt dynamically.
+Used as the initial instruction or context for the outline process.
+
 ### docDescription
 
 ```ts
@@ -37,6 +48,15 @@ validations: (IOutlineValidation<Data, Param> | IOutlineValidationFn<Data, Param
 Array of validation functions or configurations to apply to the outline data.
 Supports both direct validation functions and structured validation configurations.
 
+### format
+
+```ts
+format: IOutlineFormat
+```
+
+The format/schema definition for the outline data.
+Specifies the expected structure, required fields, and property metadata for validation and documentation.
+
 ### maxAttempts
 
 ```ts