@breadstone/archipel-mcp 0.0.43 → 0.0.45

package/data/packages/platform-intelligence/api/Function.createGrokViewXVideoTool.md

@@ -0,0 +1,26 @@
+---
+title: 'Function: createGrokViewXVideoTool()'
+generated: true
+editUrl: false
+---
+# Function: createGrokViewXVideoTool()
+
+```ts
+function createGrokViewXVideoTool(options?): IIntelligenceTool;
+```
+
+Defined in: [providers/grok/tools/createGrokViewXVideoTool.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/grok/tools/createGrokViewXVideoTool.ts#L18)
+
+Creates a Grok X-video understanding tool registration.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `options` | \| `object` & \{ \} \| `undefined` | Grok X-video understanding tool options. |
+
+## Returns
+
+[`IIntelligenceTool`](Interface.IIntelligenceTool)
+
+Tool registration compatible with the intelligence tool registry.

package/data/packages/platform-intelligence/api/Function.createGrokWebSearchTool.md

@@ -0,0 +1,26 @@
+---
+title: 'Function: createGrokWebSearchTool()'
+generated: true
+editUrl: false
+---
+# Function: createGrokWebSearchTool()
+
+```ts
+function createGrokWebSearchTool(options?): IIntelligenceTool;
+```
+
+Defined in: [providers/grok/tools/createGrokWebSearchTool.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/grok/tools/createGrokWebSearchTool.ts#L18)
+
+Creates a Grok web-search tool registration.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `options` | \| \{ \} & \{ \} \| `undefined` | Grok web-search tool options. |
+
+## Returns
+
+[`IIntelligenceTool`](Interface.IIntelligenceTool)
+
+Tool registration compatible with the intelligence tool registry.

package/data/packages/platform-intelligence/api/Function.createGrokXSearchTool.md

@@ -0,0 +1,26 @@
+---
+title: 'Function: createGrokXSearchTool()'
+generated: true
+editUrl: false
+---
+# Function: createGrokXSearchTool()
+
+```ts
+function createGrokXSearchTool(options?): IIntelligenceTool;
+```
+
+Defined in: [providers/grok/tools/createGrokXSearchTool.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/grok/tools/createGrokXSearchTool.ts#L18)
+
+Creates a Grok X-search tool registration.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `options` | \| \{ \} & \{ \} \| `undefined` | Grok X-search tool options. |
+
+## Returns
+
+[`IIntelligenceTool`](Interface.IIntelligenceTool)
+
+Tool registration compatible with the intelligence tool registry.

package/data/packages/platform-intelligence/api/Function.createIntelligenceTool.md

@@ -0,0 +1,27 @@
+---
+title: 'Function: createIntelligenceTool()'
+generated: true
+editUrl: false
+---
+# Function: createIntelligenceTool()
+
+```ts
+function createIntelligenceTool(name, tool): IIntelligenceTool;
+```
+
+Defined in: [tools/createIntelligenceTool.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/tools/createIntelligenceTool.ts#L17)
+
+Adapts a native AI SDK tool to the Archipel intelligence tool schema.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `name` | `string` | Tool name used as key in the AI SDK tool set. |
+| `tool` | Tool\<never, never\> \| Tool\<any, any\> \| Tool\<any, never\> \| Tool\<never, any\> & `Pick`\<`Tool`\<`any`, `any`\>, \| `"execute"` \| `"needsApproval"` \| `"onInputStart"` \| `"onInputDelta"` \| `"onInputAvailable"`\> | Native AI SDK tool definition. |
+
+## Returns
+
+[`IIntelligenceTool`](Interface.IIntelligenceTool)
+
+Tool registration compatible with [IIntelligenceToolRegistry](Interface.IIntelligenceToolRegistry).

package/data/packages/platform-intelligence/api/Function.createOpenAIApplyPatchTool.md

@@ -0,0 +1,26 @@
+---
+title: 'Function: createOpenAIApplyPatchTool()'
+generated: true
+editUrl: false
+---
+# Function: createOpenAIApplyPatchTool()
+
+```ts
+function createOpenAIApplyPatchTool(options?): IIntelligenceTool;
+```
+
+Defined in: [providers/openai/tools/createOpenAIApplyPatchTool.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/openai/tools/createOpenAIApplyPatchTool.ts#L18)
+
+Creates an OpenAI apply-patch tool registration.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `options` | \{ \} | OpenAI apply-patch tool options. |
+
+## Returns
+
+[`IIntelligenceTool`](Interface.IIntelligenceTool)
+
+Tool registration compatible with the intelligence tool registry.

package/data/packages/platform-intelligence/api/Function.createOpenAICodeInterpreterTool.md

@@ -0,0 +1,26 @@
+---
+title: 'Function: createOpenAICodeInterpreterTool()'
+generated: true
+editUrl: false
+---
+# Function: createOpenAICodeInterpreterTool()
+
+```ts
+function createOpenAICodeInterpreterTool(options?): IIntelligenceTool;
+```
+
+Defined in: [providers/openai/tools/createOpenAICodeInterpreterTool.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/openai/tools/createOpenAICodeInterpreterTool.ts#L18)
+
+Creates an OpenAI code-interpreter tool registration.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `options` | \| \{ \} \| `undefined` | OpenAI code-interpreter tool options. |
+
+## Returns
+
+[`IIntelligenceTool`](Interface.IIntelligenceTool)
+
+Tool registration compatible with the intelligence tool registry.

package/data/packages/platform-intelligence/api/Function.createOpenAICustomTool.md

@@ -0,0 +1,27 @@
+---
+title: 'Function: createOpenAICustomTool()'
+generated: true
+editUrl: false
+---
+# Function: createOpenAICustomTool()
+
+```ts
+function createOpenAICustomTool(options, name?): IIntelligenceTool;
+```
+
+Defined in: [providers/openai/tools/createOpenAICustomTool.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/openai/tools/createOpenAICustomTool.ts#L18)
+
+Creates an OpenAI custom provider-defined tool registration.
+
+## Parameters
+
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `options` | \{ \} & \{ \} | `undefined` | OpenAI custom tool options. |
+| `name` | `string` | `options.name` | Optional Archipel registry name. Defaults to the provider tool name. |
+
+## Returns
+
+[`IIntelligenceTool`](Interface.IIntelligenceTool)
+
+Tool registration compatible with the intelligence tool registry.

package/data/packages/platform-intelligence/api/Function.createOpenAIFileSearchTool.md

@@ -0,0 +1,26 @@
+---
+title: 'Function: createOpenAIFileSearchTool()'
+generated: true
+editUrl: false
+---
+# Function: createOpenAIFileSearchTool()
+
+```ts
+function createOpenAIFileSearchTool(options): IIntelligenceTool;
+```
+
+Defined in: [providers/openai/tools/createOpenAIFileSearchTool.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/openai/tools/createOpenAIFileSearchTool.ts#L18)
+
+Creates an OpenAI file-search tool registration.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `options` | \{ \} & \{ \} | OpenAI file-search tool options. |
+
+## Returns
+
+[`IIntelligenceTool`](Interface.IIntelligenceTool)
+
+Tool registration compatible with the intelligence tool registry.

package/data/packages/platform-intelligence/api/Function.createOpenAIImageGenerationTool.md

@@ -0,0 +1,26 @@
+---
+title: 'Function: createOpenAIImageGenerationTool()'
+generated: true
+editUrl: false
+---
+# Function: createOpenAIImageGenerationTool()
+
+```ts
+function createOpenAIImageGenerationTool(options?): IIntelligenceTool;
+```
+
+Defined in: [providers/openai/tools/createOpenAIImageGenerationTool.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/openai/tools/createOpenAIImageGenerationTool.ts#L18)
+
+Creates an OpenAI image-generation tool registration.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `options` | \| \{ \} \| `undefined` | OpenAI image-generation tool options. |
+
+## Returns
+
+[`IIntelligenceTool`](Interface.IIntelligenceTool)
+
+Tool registration compatible with the intelligence tool registry.

package/data/packages/platform-intelligence/api/Function.createOpenAILocalShellTool.md

@@ -0,0 +1,26 @@
+---
+title: 'Function: createOpenAILocalShellTool()'
+generated: true
+editUrl: false
+---
+# Function: createOpenAILocalShellTool()
+
+```ts
+function createOpenAILocalShellTool(options?): IIntelligenceTool;
+```
+
+Defined in: [providers/openai/tools/createOpenAILocalShellTool.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/openai/tools/createOpenAILocalShellTool.ts#L18)
+
+Creates an OpenAI local-shell tool registration.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `options` | \{ \} | OpenAI local-shell tool options. |
+
+## Returns
+
+[`IIntelligenceTool`](Interface.IIntelligenceTool)
+
+Tool registration compatible with the intelligence tool registry.

package/data/packages/platform-intelligence/api/Function.createOpenAIMcpTool.md

@@ -0,0 +1,26 @@
+---
+title: 'Function: createOpenAIMcpTool()'
+generated: true
+editUrl: false
+---
+# Function: createOpenAIMcpTool()
+
+```ts
+function createOpenAIMcpTool(options): IIntelligenceTool;
+```
+
+Defined in: [providers/openai/tools/createOpenAIMcpTool.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/openai/tools/createOpenAIMcpTool.ts#L18)
+
+Creates an OpenAI MCP connector tool registration.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `options` | \{ \} | OpenAI MCP tool options. |
+
+## Returns
+
+[`IIntelligenceTool`](Interface.IIntelligenceTool)
+
+Tool registration compatible with the intelligence tool registry.

package/data/packages/platform-intelligence/api/Function.createOpenAIShellTool.md

@@ -0,0 +1,26 @@
+---
+title: 'Function: createOpenAIShellTool()'
+generated: true
+editUrl: false
+---
+# Function: createOpenAIShellTool()
+
+```ts
+function createOpenAIShellTool(options?): IIntelligenceTool;
+```
+
+Defined in: [providers/openai/tools/createOpenAIShellTool.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/openai/tools/createOpenAIShellTool.ts#L18)
+
+Creates an OpenAI shell tool registration.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `options` | \{ \} & \{ \} | OpenAI shell tool options. |
+
+## Returns
+
+[`IIntelligenceTool`](Interface.IIntelligenceTool)
+
+Tool registration compatible with the intelligence tool registry.

package/data/packages/platform-intelligence/api/Function.createOpenAIToolSearchTool.md

@@ -0,0 +1,26 @@
+---
+title: 'Function: createOpenAIToolSearchTool()'
+generated: true
+editUrl: false
+---
+# Function: createOpenAIToolSearchTool()
+
+```ts
+function createOpenAIToolSearchTool(options?): IIntelligenceTool;
+```
+
+Defined in: [providers/openai/tools/createOpenAIToolSearchTool.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/openai/tools/createOpenAIToolSearchTool.ts#L18)
+
+Creates an OpenAI tool-search tool registration.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `options` | \| \{ \} & \{ \} \| `undefined` | OpenAI tool-search options. |
+
+## Returns
+
+[`IIntelligenceTool`](Interface.IIntelligenceTool)
+
+Tool registration compatible with the intelligence tool registry.

package/data/packages/platform-intelligence/api/Function.createOpenAIWebSearchPreviewTool.md

@@ -0,0 +1,26 @@
+---
+title: 'Function: createOpenAIWebSearchPreviewTool()'
+generated: true
+editUrl: false
+---
+# Function: createOpenAIWebSearchPreviewTool()
+
+```ts
+function createOpenAIWebSearchPreviewTool(options?): IIntelligenceTool;
+```
+
+Defined in: [providers/openai/tools/createOpenAIWebSearchPreviewTool.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/openai/tools/createOpenAIWebSearchPreviewTool.ts#L18)
+
+Creates an OpenAI web-search-preview tool registration.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `options` | \{ \} & \{ \} | OpenAI web-search-preview tool options. |
+
+## Returns
+
+[`IIntelligenceTool`](Interface.IIntelligenceTool)
+
+Tool registration compatible with the intelligence tool registry.

package/data/packages/platform-intelligence/api/Function.createOpenAIWebSearchTool.md

@@ -0,0 +1,26 @@
+---
+title: 'Function: createOpenAIWebSearchTool()'
+generated: true
+editUrl: false
+---
+# Function: createOpenAIWebSearchTool()
+
+```ts
+function createOpenAIWebSearchTool(options?): IIntelligenceTool;
+```
+
+Defined in: [providers/openai/tools/createOpenAIWebSearchTool.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/openai/tools/createOpenAIWebSearchTool.ts#L18)
+
+Creates an OpenAI web-search tool registration.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `options` | \| \{ \} & \{ \} \| `undefined` | OpenAI web-search tool options. |
+
+## Returns
+
+[`IIntelligenceTool`](Interface.IIntelligenceTool)
+
+Tool registration compatible with the intelligence tool registry.

package/data/packages/platform-intelligence/api/Function.createProviderOptions.md

@@ -6,7 +6,10 @@ editUrl: false
 # Function: createProviderOptions()
 
 ```ts
-function createProviderOptions(configuration): Record<string, unknown>;
+function createProviderOptions(configuration): {
+  apiKey: string;
+  baseURL?: string;
+};
 ```
 
 Defined in: [providers/createProviderOptions.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/createProviderOptions.ts#L14)
@@ -21,6 +24,16 @@ Creates the provider options object consumed by the AI SDK model factories.
 
 ## Returns
 
-`Record`\<`string`, `unknown`\>
+```ts
+{
+  apiKey: string;
+  baseURL?: string;
+}
+```
 
 The options record containing `apiKey` and optionally `baseURL`.
+
+| Name | Type | Defined in |
+| ------ | ------ | ------ |
+| `apiKey` | `string` | [providers/createProviderOptions.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/createProviderOptions.ts#L14) |
+| `baseURL?` | `string` | [providers/createProviderOptions.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/createProviderOptions.ts#L14) |

package/data/packages/platform-intelligence/api/Function.loadAnthropicLanguageModel.md

@@ -6,12 +6,12 @@ editUrl: false
 # Function: loadAnthropicLanguageModel()
 
 ```ts
-function loadAnthropicLanguageModel(configuration): Promise<LanguageModelV2>;
+function loadAnthropicLanguageModel(configuration): LanguageModelV3;
 ```
 
-Defined in: [providers/loadAnthropicLanguageModel.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/loadAnthropicLanguageModel.ts#L17)
+Defined in: [providers/anthropic/loadAnthropicLanguageModel.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/anthropic/loadAnthropicLanguageModel.ts#L17)
 
-Loads the Anthropic language model based on the resolved provider configuration.
+Creates the Anthropic language model from the resolved provider configuration.
 
 ## Parameters
 
@@ -21,6 +21,6 @@ Loads the Anthropic language model based on the resolved provider configuration.
 
 ## Returns
 
-`Promise`\<`LanguageModelV2`\>
+`LanguageModelV3`
 
 The configured language model instance.

package/data/packages/platform-intelligence/api/Function.loadGoogleLanguageModel.md

@@ -6,12 +6,12 @@ editUrl: false
 # Function: loadGoogleLanguageModel()
 
 ```ts
-function loadGoogleLanguageModel(configuration): Promise<LanguageModelV2>;
+function loadGoogleLanguageModel(configuration): LanguageModelV3;
 ```
 
-Defined in: [providers/loadGoogleLanguageModel.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/loadGoogleLanguageModel.ts#L17)
+Defined in: [providers/google/loadGoogleLanguageModel.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/google/loadGoogleLanguageModel.ts#L17)
 
-Loads the Google (Gemini) language model based on the resolved provider configuration.
+Creates the Google Gemini language model from the resolved provider configuration.
 
 ## Parameters
 
@@ -21,6 +21,6 @@ Loads the Google (Gemini) language model based on the resolved provider configur
 
 ## Returns
 
-`Promise`\<`LanguageModelV2`\>
+`LanguageModelV3`
 
 The configured language model instance.

package/data/packages/platform-intelligence/api/Function.loadGrokLanguageModel.md

@@ -6,12 +6,12 @@ editUrl: false
 # Function: loadGrokLanguageModel()
 
 ```ts
-function loadGrokLanguageModel(configuration): Promise<LanguageModelV2>;
+function loadGrokLanguageModel(configuration): LanguageModelV3;
 ```
 
-Defined in: [providers/loadGrokLanguageModel.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/loadGrokLanguageModel.ts#L17)
+Defined in: [providers/grok/loadGrokLanguageModel.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/grok/loadGrokLanguageModel.ts#L17)
 
-Loads the Grok (xAI) language model based on the resolved provider configuration.
+Creates the Grok language model through the native xAI provider.
 
 ## Parameters
 
@@ -21,6 +21,6 @@ Loads the Grok (xAI) language model based on the resolved provider configuration
 
 ## Returns
 
-`Promise`\<`LanguageModelV2`\>
+`LanguageModelV3`
 
 The configured language model instance.

package/data/packages/platform-intelligence/api/Function.loadOpenAILanguageModel.md

@@ -6,12 +6,12 @@ editUrl: false
 # Function: loadOpenAILanguageModel()
 
 ```ts
-function loadOpenAILanguageModel(configuration): Promise<LanguageModelV2>;
+function loadOpenAILanguageModel(configuration): LanguageModelV3;
 ```
 
-Defined in: [providers/loadOpenAILanguageModel.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/loadOpenAILanguageModel.ts#L17)
+Defined in: [providers/openai/loadOpenAILanguageModel.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/openai/loadOpenAILanguageModel.ts#L17)
 
-Loads the OpenAI compatible language model based on the resolved provider configuration.
+Creates the OpenAI language model from the resolved provider configuration.
 
 ## Parameters
 
@@ -21,6 +21,6 @@ Loads the OpenAI compatible language model based on the resolved provider config
 
 ## Returns
 
-`Promise`\<`LanguageModelV2`\>
+`LanguageModelV3`
 
 The configured language model instance.

package/data/packages/platform-intelligence/api/Interface.IIntelligenceModuleOptions.md

@@ -0,0 +1,79 @@
+---
+title: 'Interface: IIntelligenceModuleOptions'
+generated: true
+editUrl: false
+---
+# Interface: IIntelligenceModuleOptions
+
+Defined in: [interfaces/IIntelligenceModuleOptions.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L15)
+
+Options for configuring the intelligence module.
+
+## Properties
+
+### configEntries?
+
+```ts
+readonly optional configEntries?: readonly Omit<IConfigRegistryEntry<unknown>, "module">[];
+```
+
+Defined in: [interfaces/IIntelligenceModuleOptions.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L30)
+
+Provider-specific configuration entries to register with the config module.
+
+***
+
+### isGlobal?
+
+```ts
+readonly optional isGlobal?: boolean;
+```
+
+Defined in: [interfaces/IIntelligenceModuleOptions.ts:57](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L57)
+
+When `true` the module is registered globally.
+
+***
+
+### providerLoaders?
+
+```ts
+readonly optional providerLoaders?: Partial<Record<IntelligenceProviderName, IntelligenceLanguageModelLoader>>;
+```
+
+Defined in: [interfaces/IIntelligenceModuleOptions.ts:40](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L40)
+
+Tree-shakable language model loaders keyed by provider name.
+
+Import these from provider-specific subpaths such as
+`@breadstone/archipel-platform-intelligence/providers/openai`.
+
+***
+
+### tools?
+
+```ts
+readonly optional tools?: readonly (
+  | IIntelligenceTool
+  | Type<IIntelligenceTool>
+  | Provider<IIntelligenceTool>)[];
+```
+
+Defined in: [interfaces/IIntelligenceModuleOptions.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L23)
+
+Tool instances, class providers, or custom Nest providers registered at bootstrap.
+
+***
+
+### validateOnModuleInit?
+
+```ts
+readonly optional validateOnModuleInit?: boolean;
+```
+
+Defined in: [interfaces/IIntelligenceModuleOptions.ts:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L50)
+
+When `true`, provider configuration is resolved during module initialization.
+
+Set this to `false` for fully request-driven use cases that always pass a
+native AI SDK model through `generateText()` or `streamText()` options.