@breadstone/archipel-mcp 0.0.13 → 0.0.14

package/data/packages/platform-intelligence/api/Class.IntelligenceCapabilityRegistrarBase.md

@@ -1,94 +0,0 @@
----
-title: 'Abstract Class: IntelligenceCapabilityRegistrarBase'
-generated: true
-editUrl: false
----
-# Abstract Class: IntelligenceCapabilityRegistrarBase
-
-Defined in: [abstracts/IntelligenceCapabilityRegistrarBase.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/abstracts/IntelligenceCapabilityRegistrarBase.ts#L15)
-
-Provides a reusable registration flow that allows feature modules to contribute
-capabilities to the global intelligence registry while keeping their implementation details private.
-
-## Implements
-
-- `OnModuleInit`
-
-## Constructors
-
-### Constructor
-
-```ts
-protected new IntelligenceCapabilityRegistrarBase(registry): IntelligenceCapabilityRegistrarBase;
-```
-
-Defined in: [abstracts/IntelligenceCapabilityRegistrarBase.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/abstracts/IntelligenceCapabilityRegistrarBase.ts#L30)
-
-Initializes a new instance of the IntelligenceCapabilityRegistrarBase class.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `registry` | [`IntelligenceCapabilityRegistry`](Class.IntelligenceCapabilityRegistry) | Registry instance that receives contributed capabilities. |
-
-#### Returns
-
-`IntelligenceCapabilityRegistrarBase`
-
-## Accessors
-
-### registry
-
-#### Get Signature
-
-```ts
-get protected registry(): IntelligenceCapabilityRegistry;
-```
-
-Defined in: [abstracts/IntelligenceCapabilityRegistrarBase.ts:44](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/abstracts/IntelligenceCapabilityRegistrarBase.ts#L44)
-
-Gets the registry instance that should be used to register capabilities.
-
-##### Returns
-
-[`IntelligenceCapabilityRegistry`](Class.IntelligenceCapabilityRegistry)
-
-## Methods
-
-### getCapabilities()
-
-```ts
-abstract protected getCapabilities(): readonly IIntelligenceCapability[];
-```
-
-Defined in: [abstracts/IntelligenceCapabilityRegistrarBase.ts:74](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/abstracts/IntelligenceCapabilityRegistrarBase.ts#L74)
-
-Returns the capabilities that should be registered for the module.
-
-#### Returns
-
-readonly [`IIntelligenceCapability`](Interface.IIntelligenceCapability)[]
-
-***
-
-### onModuleInit()
-
-```ts
-onModuleInit(): void;
-```
-
-Defined in: [abstracts/IntelligenceCapabilityRegistrarBase.ts:58](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/abstracts/IntelligenceCapabilityRegistrarBase.ts#L58)
-
-Template method invoked by NestJS once the provider has been instantiated.
-Registers all capabilities returned by [getCapabilities](#getcapabilities).
-
-#### Returns
-
-`void`
-
-#### Implementation of
-
-```ts
-OnModuleInit.onModuleInit
-```

package/data/packages/platform-intelligence/api/Class.IntelligenceCapabilityRegistry.md

@@ -1,106 +0,0 @@
----
-title: 'Class: IntelligenceCapabilityRegistry'
-generated: true
-editUrl: false
----
-# Class: IntelligenceCapabilityRegistry
-
-Defined in: [IntelligenceCapabilityRegistry.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceCapabilityRegistry.ts#L15)
-
-Central registry responsible for resolving intelligence capabilities based on intent metadata.
-
-## Implements
-
-- [`IIntelligenceCapabilityRegistry`](Interface.IIntelligenceCapabilityRegistry)
-
-## Constructors
-
-### Constructor
-
-```ts
-new IntelligenceCapabilityRegistry(): IntelligenceCapabilityRegistry;
-```
-
-#### Returns
-
-`IntelligenceCapabilityRegistry`
-
-## Methods
-
-### list()
-
-```ts
-list(): readonly IIntelligenceCapability[];
-```
-
-Defined in: [IntelligenceCapabilityRegistry.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceCapabilityRegistry.ts#L36)
-
-Returns a read-only snapshot of all registered capabilities.
-
-#### Returns
-
-readonly [`IIntelligenceCapability`](Interface.IIntelligenceCapability)[]
-
-A defensive copy of the registered capabilities.
-
-#### Implementation of
-
-[`IIntelligenceCapabilityRegistry`](Interface.IIntelligenceCapabilityRegistry).[`list`](Interface.IIntelligenceCapabilityRegistry#list)
-
-***
-
-### register()
-
-```ts
-register(capability): void;
-```
-
-Defined in: [IntelligenceCapabilityRegistry.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceCapabilityRegistry.ts#L25)
-
-Registers a capability in the registry.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `capability` | [`IIntelligenceCapability`](Interface.IIntelligenceCapability) | The capability to register. |
-
-#### Returns
-
-`void`
-
-#### Implementation of
-
-[`IIntelligenceCapabilityRegistry`](Interface.IIntelligenceCapabilityRegistry).[`register`](Interface.IIntelligenceCapabilityRegistry#register)
-
-***
-
-### resolve()
-
-```ts
-resolve(intent, context): 
-  | IIntelligenceCapability
-  | null;
-```
-
-Defined in: [IntelligenceCapabilityRegistry.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceCapabilityRegistry.ts#L31)
-
-Resolves the most suitable capability for the given intent and context.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `intent` | [`IIntelligenceIntent`](Interface.IIntelligenceIntent) | The structured intent to match against. |
-| `context` | [`IIntelligenceContext`](Interface.IIntelligenceContext) | The aggregated context for the request. |
-
-#### Returns
-
-  \| [`IIntelligenceCapability`](Interface.IIntelligenceCapability)
-  \| `null`
-
-The matching capability, or `null` if none qualifies.
-
-#### Implementation of
-
-[`IIntelligenceCapabilityRegistry`](Interface.IIntelligenceCapabilityRegistry).[`resolve`](Interface.IIntelligenceCapabilityRegistry#resolve)

package/data/packages/platform-intelligence/api/Class.IntelligenceModule.md

@@ -1,22 +0,0 @@
----
-title: 'Class: IntelligenceModule'
-generated: true
-editUrl: false
----
-# Class: IntelligenceModule
-
-Defined in: [IntelligenceModule.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceModule.ts#L18)
-
-Core module exposing the shared intelligence infrastructure to feature modules.
-
-## Constructors
-
-### Constructor
-
-```ts
-new IntelligenceModule(): IntelligenceModule;
-```
-
-#### Returns
-
-`IntelligenceModule`

package/data/packages/platform-intelligence/api/Class.IntelligenceTextGenerator.md

@@ -1,81 +0,0 @@
----
-title: 'Class: IntelligenceTextGenerator'
-generated: true
-editUrl: false
----
-# Class: IntelligenceTextGenerator
-
-Defined in: [IntelligenceTextGenerator.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L37)
-
-Executes text completions using the configured intelligence provider.
-
-## Implements
-
-- [`IIntelligenceTextGenerator`](Interface.IIntelligenceTextGenerator)
-
-## Constructors
-
-### Constructor
-
-```ts
-new IntelligenceTextGenerator(configService): IntelligenceTextGenerator;
-```
-
-Defined in: [IntelligenceTextGenerator.ts:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L50)
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `configService` | `ConfigService` |
-
-#### Returns
-
-`IntelligenceTextGenerator`
-
-## Methods
-
-### generateText()
-
-```ts
-generateText(prompt, options?): Promise<IIntelligenceTextCompletion>;
-```
-
-Defined in: [IntelligenceTextGenerator.ts:70](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L70)
-
-Generates a completion using the configured provider.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `prompt` | [`IIntelligencePrompt`](Interface.IIntelligencePrompt) | The assembled prompt payload. |
-| `options?` | [`IIntelligenceTextGenerationOptions`](Interface.IIntelligenceTextGenerationOptions) | Optional overrides for the text generation request. |
-
-#### Returns
-
-`Promise`\<[`IIntelligenceTextCompletion`](Interface.IIntelligenceTextCompletion)\>
-
-#### Implementation of
-
-[`IIntelligenceTextGenerator`](Interface.IIntelligenceTextGenerator).[`generateText`](Interface.IIntelligenceTextGenerator#generatetext)
-
-***
-
-### getConfiguration()
-
-```ts
-getConfiguration(): IIntelligenceProviderConfiguration;
-```
-
-Defined in: [IntelligenceTextGenerator.ts:103](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L103)
-
-Returns the resolved provider configuration.
-
-#### Returns
-
-[`IIntelligenceProviderConfiguration`](Interface.IIntelligenceProviderConfiguration)
-
-#### Implementation of
-
-[`IIntelligenceTextGenerator`](Interface.IIntelligenceTextGenerator).[`getConfiguration`](Interface.IIntelligenceTextGenerator#getconfiguration)

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

@@ -1,26 +0,0 @@
----
-title: 'Function: createProviderOptions()'
-generated: true
-editUrl: false
----
-# Function: createProviderOptions()
-
-```ts
-function createProviderOptions(configuration): Record<string, unknown>;
-```
-
-Defined in: [providers/createProviderOptions.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/createProviderOptions.ts#L14)
-
-Creates the provider options object consumed by the AI SDK model factories.
-
-## Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `configuration` | [`IIntelligenceProviderConfiguration`](Interface.IIntelligenceProviderConfiguration) | The resolved provider configuration. |
-
-## Returns
-
-`Record`\<`string`, `unknown`\>
-
-The options record containing `apiKey` and optionally `baseURL`.

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

@@ -1,26 +0,0 @@
----
-title: 'Function: loadAnthropicLanguageModel()'
-generated: true
-editUrl: false
----
-# Function: loadAnthropicLanguageModel()
-
-```ts
-function loadAnthropicLanguageModel(configuration): Promise<LanguageModelV2>;
-```
-
-Defined in: [providers/loadAnthropicLanguageModel.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/loadAnthropicLanguageModel.ts#L17)
-
-Loads the Anthropic language model based on the resolved provider configuration.
-
-## Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `configuration` | [`IIntelligenceProviderConfiguration`](Interface.IIntelligenceProviderConfiguration) | The resolved provider configuration. |
-
-## Returns
-
-`Promise`\<`LanguageModelV2`\>
-
-The configured language model instance.

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

@@ -1,26 +0,0 @@
----
-title: 'Function: loadGoogleLanguageModel()'
-generated: true
-editUrl: false
----
-# Function: loadGoogleLanguageModel()
-
-```ts
-function loadGoogleLanguageModel(configuration): Promise<LanguageModelV2>;
-```
-
-Defined in: [providers/loadGoogleLanguageModel.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/loadGoogleLanguageModel.ts#L17)
-
-Loads the Google (Gemini) language model based on the resolved provider configuration.
-
-## Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `configuration` | [`IIntelligenceProviderConfiguration`](Interface.IIntelligenceProviderConfiguration) | The resolved provider configuration. |
-
-## Returns
-
-`Promise`\<`LanguageModelV2`\>
-
-The configured language model instance.

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

@@ -1,26 +0,0 @@
----
-title: 'Function: loadGrokLanguageModel()'
-generated: true
-editUrl: false
----
-# Function: loadGrokLanguageModel()
-
-```ts
-function loadGrokLanguageModel(configuration): Promise<LanguageModelV2>;
-```
-
-Defined in: [providers/loadGrokLanguageModel.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/loadGrokLanguageModel.ts#L17)
-
-Loads the Grok (xAI) language model based on the resolved provider configuration.
-
-## Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `configuration` | [`IIntelligenceProviderConfiguration`](Interface.IIntelligenceProviderConfiguration) | The resolved provider configuration. |
-
-## Returns
-
-`Promise`\<`LanguageModelV2`\>
-
-The configured language model instance.

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

@@ -1,26 +0,0 @@
----
-title: 'Function: loadOpenAILanguageModel()'
-generated: true
-editUrl: false
----
-# Function: loadOpenAILanguageModel()
-
-```ts
-function loadOpenAILanguageModel(configuration): Promise<LanguageModelV2>;
-```
-
-Defined in: [providers/loadOpenAILanguageModel.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/loadOpenAILanguageModel.ts#L17)
-
-Loads the OpenAI compatible language model based on the resolved provider configuration.
-
-## Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `configuration` | [`IIntelligenceProviderConfiguration`](Interface.IIntelligenceProviderConfiguration) | The resolved provider configuration. |
-
-## Returns
-
-`Promise`\<`LanguageModelV2`\>
-
-The configured language model instance.

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

@@ -1,31 +0,0 @@
----
-title: 'Function: loadProviderFactory()'
-generated: true
-editUrl: false
----
-# Function: loadProviderFactory()
-
-```ts
-function loadProviderFactory(moduleName, exportName): Promise<(model, options) => LanguageModelV2>;
-```
-
-Defined in: [providers/ProviderFactoryLoader.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/ProviderFactoryLoader.ts#L16)
-
-Dynamically loads an AI SDK provider factory and returns the exported function reference.
-
-## Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `moduleName` | `string` | The module that exports the factory function. |
-| `exportName` | `string` | The named export containing the factory function. |
-
-## Returns
-
-`Promise`\<(`model`, `options`) => `LanguageModelV2`\>
-
-The resolved factory function.
-
-## Throws
-
-When the module cannot be imported or the export is not a function.

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

@@ -1,34 +0,0 @@
----
-title: 'Interface: IIntelligenceArtifact'
-generated: true
-editUrl: false
----
-# Interface: IIntelligenceArtifact
-
-Defined in: [contracts/IIntelligenceArtifact.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceArtifact.ts#L6)
-
-Represents a structured artifact returned by a capability.
-
-## Properties
-
-### data
-
-```ts
-readonly data: Record<string, unknown>;
-```
-
-Defined in: [contracts/IIntelligenceArtifact.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceArtifact.ts#L21)
-
-The structured data payload of the artifact.
-
-***
-
-### type
-
-```ts
-readonly type: string;
-```
-
-Defined in: [contracts/IIntelligenceArtifact.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceArtifact.ts#L14)
-
-The artifact type discriminator.

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

@@ -1,71 +0,0 @@
----
-title: 'Interface: IIntelligenceCapability'
-generated: true
-editUrl: false
----
-# Interface: IIntelligenceCapability
-
-Defined in: [contracts/IIntelligenceCapability.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapability.ts#L16)
-
-Abstraction implemented by all capability providers.
-
-## Properties
-
-### metadata
-
-```ts
-readonly metadata: IIntelligenceCapabilityMetadata;
-```
-
-Defined in: [contracts/IIntelligenceCapability.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapability.ts#L24)
-
-Metadata describing the capability for orchestration and analytics purposes.
-
-## Methods
-
-### canHandle()
-
-```ts
-canHandle(intent, context): boolean;
-```
-
-Defined in: [contracts/IIntelligenceCapability.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapability.ts#L38)
-
-Determines whether this capability can handle the given intent and context.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `intent` | [`IIntelligenceIntent`](Interface.IIntelligenceIntent) | The structured intent to evaluate. |
-| `context` | [`IIntelligenceContext`](Interface.IIntelligenceContext) | The aggregated context for the request. |
-
-#### Returns
-
-`boolean`
-
-`true` if the capability can handle the intent; otherwise `false`.
-
-***
-
-### execute()
-
-```ts
-execute(payload): Promise<IIntelligenceCapabilityResult>;
-```
-
-Defined in: [contracts/IIntelligenceCapability.ts:47](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapability.ts#L47)
-
-Executes the capability with the given payload.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `payload` | [`IIntelligenceCapabilityPayload`](Interface.IIntelligenceCapabilityPayload) | The payload forwarded for execution. |
-
-#### Returns
-
-`Promise`\<[`IIntelligenceCapabilityResult`](Interface.IIntelligenceCapabilityResult)\>
-
-The capability execution result.

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

@@ -1,70 +0,0 @@
----
-title: 'Interface: IIntelligenceCapabilityMetadata'
-generated: true
-editUrl: false
----
-# Interface: IIntelligenceCapabilityMetadata
-
-Defined in: [contracts/IIntelligenceCapabilityMetadata.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapabilityMetadata.ts#L6)
-
-Metadata describing a capability for orchestration and analytics purposes.
-
-## Properties
-
-### description
-
-```ts
-readonly description: string;
-```
-
-Defined in: [contracts/IIntelligenceCapabilityMetadata.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapabilityMetadata.ts#L28)
-
-A brief description of what the capability does.
-
-***
-
-### id
-
-```ts
-readonly id: string;
-```
-
-Defined in: [contracts/IIntelligenceCapabilityMetadata.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapabilityMetadata.ts#L14)
-
-Unique identifier for the capability.
-
-***
-
-### intentName
-
-```ts
-readonly intentName: string;
-```
-
-Defined in: [contracts/IIntelligenceCapabilityMetadata.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapabilityMetadata.ts#L42)
-
-The intent name this capability is designed to handle.
-
-***
-
-### name
-
-```ts
-readonly name: string;
-```
-
-Defined in: [contracts/IIntelligenceCapabilityMetadata.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapabilityMetadata.ts#L21)
-
-Human-readable name of the capability.
-
-***
-
-### priority
-
-```ts
-readonly priority: number;
-```
-
-Defined in: [contracts/IIntelligenceCapabilityMetadata.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapabilityMetadata.ts#L35)
-
-Evaluation priority (lower values are evaluated first).