@breadstone/archipel-mcp 0.0.6 → 0.0.8

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

@@ -0,0 +1,27 @@
+---
+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

@@ -0,0 +1,27 @@
+---
+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

@@ -0,0 +1,32 @@
+---
+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

@@ -0,0 +1,35 @@
+---
+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:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceArtifact.ts#L22)
+
+The structured data payload of the artifact.
+
+---
+
+### type
+
+```ts
+readonly type: string;
+```
+
+Defined in: [contracts/IIntelligenceArtifact.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceArtifact.ts#L15)
+
+The artifact type discriminator.

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

@@ -0,0 +1,72 @@
+---
+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:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapability.ts#L25)
+
+Metadata describing the capability for orchestration and analytics purposes.
+
+## Methods
+
+### canHandle()
+
+```ts
+canHandle(intent, context): boolean;
+```
+
+Defined in: [contracts/IIntelligenceCapability.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapability.ts#L39)
+
+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:48](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapability.ts#L48)
+
+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

@@ -0,0 +1,71 @@
+---
+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:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapabilityMetadata.ts#L29)
+
+A brief description of what the capability does.
+
+---
+
+### id
+
+```ts
+readonly id: string;
+```
+
+Defined in: [contracts/IIntelligenceCapabilityMetadata.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapabilityMetadata.ts#L15)
+
+Unique identifier for the capability.
+
+---
+
+### intentName
+
+```ts
+readonly intentName: string;
+```
+
+Defined in: [contracts/IIntelligenceCapabilityMetadata.ts:43](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapabilityMetadata.ts#L43)
+
+The intent name this capability is designed to handle.
+
+---
+
+### name
+
+```ts
+readonly name: string;
+```
+
+Defined in: [contracts/IIntelligenceCapabilityMetadata.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapabilityMetadata.ts#L22)
+
+Human-readable name of the capability.
+
+---
+
+### priority
+
+```ts
+readonly priority: number;
+```
+
+Defined in: [contracts/IIntelligenceCapabilityMetadata.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapabilityMetadata.ts#L36)
+
+Evaluation priority (lower values are evaluated first).

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

@@ -0,0 +1,47 @@
+---
+title: 'Interface: IIntelligenceCapabilityPayload'
+generated: true
+editUrl: false
+---
+
+# Interface: IIntelligenceCapabilityPayload
+
+Defined in: [contracts/IIntelligenceCapabilityPayload.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapabilityPayload.ts#L13)
+
+Payload forwarded to capabilities for execution.
+
+## Properties
+
+### context
+
+```ts
+readonly context: IIntelligenceContext;
+```
+
+Defined in: [contracts/IIntelligenceCapabilityPayload.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapabilityPayload.ts#L29)
+
+The aggregated context for the request.
+
+---
+
+### intent
+
+```ts
+readonly intent: IIntelligenceIntent;
+```
+
+Defined in: [contracts/IIntelligenceCapabilityPayload.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapabilityPayload.ts#L22)
+
+The structured intent resolved from the user message.
+
+---
+
+### userMessage
+
+```ts
+readonly userMessage: string;
+```
+
+Defined in: [contracts/IIntelligenceCapabilityPayload.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapabilityPayload.ts#L36)
+
+The raw user message that triggered the capability.

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

@@ -0,0 +1,79 @@
+---
+title: 'Interface: IIntelligenceCapabilityRegistry'
+generated: true
+editUrl: false
+---
+
+# Interface: IIntelligenceCapabilityRegistry
+
+Defined in: [interfaces/IIntelligenceCapabilityRegistry.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceCapabilityRegistry.ts#L14)
+
+Registry abstraction responsible for resolving capabilities.
+
+## Methods
+
+### list()
+
+```ts
+list(): readonly IIntelligenceCapability[];
+```
+
+Defined in: [interfaces/IIntelligenceCapabilityRegistry.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceCapabilityRegistry.ts#L42)
+
+Returns a read-only snapshot of all registered capabilities.
+
+#### Returns
+
+readonly [`IIntelligenceCapability`](Interface.IIntelligenceCapability)[]
+
+A defensive copy of the registered capabilities.
+
+---
+
+### register()
+
+```ts
+register(capability): void;
+```
+
+Defined in: [interfaces/IIntelligenceCapabilityRegistry.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceCapabilityRegistry.ts#L24)
+
+Registers a capability in the registry.
+
+#### Parameters
+
+| Parameter    | Type                                                           | Description                 |
+| ------------ | -------------------------------------------------------------- | --------------------------- |
+| `capability` | [`IIntelligenceCapability`](Interface.IIntelligenceCapability) | The capability to register. |
+
+#### Returns
+
+`void`
+
+---
+
+### resolve()
+
+```ts
+resolve(intent, context):
+  | IIntelligenceCapability
+  | null;
+```
+
+Defined in: [interfaces/IIntelligenceCapabilityRegistry.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceCapabilityRegistry.ts#L34)
+
+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.

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

@@ -0,0 +1,47 @@
+---
+title: 'Interface: IIntelligenceCapabilityResult'
+generated: true
+editUrl: false
+---
+
+# Interface: IIntelligenceCapabilityResult
+
+Defined in: [contracts/IIntelligenceCapabilityResult.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapabilityResult.ts#L14)
+
+Represents the outcome produced by a capability execution.
+
+## Properties
+
+### artifacts
+
+```ts
+readonly artifacts: readonly IIntelligenceArtifact[];
+```
+
+Defined in: [contracts/IIntelligenceCapabilityResult.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapabilityResult.ts#L30)
+
+Structured artifacts produced alongside the messages.
+
+---
+
+### followUps
+
+```ts
+readonly followUps: readonly IIntelligenceFollowUpQuestion[];
+```
+
+Defined in: [contracts/IIntelligenceCapabilityResult.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapabilityResult.ts#L37)
+
+Suggested follow-up questions to continue the dialogue.
+
+---
+
+### messages
+
+```ts
+readonly messages: readonly IIntelligenceResponseMessage[];
+```
+
+Defined in: [contracts/IIntelligenceCapabilityResult.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapabilityResult.ts#L23)
+
+The assistant messages produced by the capability.

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

@@ -0,0 +1,47 @@
+---
+title: 'Interface: IIntelligenceCompletionUsage'
+generated: true
+editUrl: false
+---
+
+# Interface: IIntelligenceCompletionUsage
+
+Defined in: [contracts/IIntelligenceCompletionUsage.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCompletionUsage.ts#L6)
+
+Captures usage telemetry returned by the intelligence provider.
+
+## Properties
+
+### completionTokens
+
+```ts
+readonly completionTokens: number | null;
+```
+
+Defined in: [contracts/IIntelligenceCompletionUsage.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCompletionUsage.ts#L22)
+
+The number of tokens generated in the completion.
+
+---
+
+### promptTokens
+
+```ts
+readonly promptTokens: number | null;
+```
+
+Defined in: [contracts/IIntelligenceCompletionUsage.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCompletionUsage.ts#L15)
+
+The number of tokens consumed by the prompt.
+
+---
+
+### totalTokens
+
+```ts
+readonly totalTokens: number | null;
+```
+
+Defined in: [contracts/IIntelligenceCompletionUsage.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCompletionUsage.ts#L29)
+
+The total number of tokens (prompt + completion).

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

@@ -0,0 +1,73 @@
+---
+title: 'Interface: IIntelligenceContext'
+generated: true
+editUrl: false
+---
+
+# Interface: IIntelligenceContext
+
+Defined in: [contracts/IIntelligenceContext.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceContext.ts#L12)
+
+Describes the context aggregated before routing a request to a capability.
+
+## Properties
+
+### conversationId
+
+```ts
+readonly conversationId: string | null;
+```
+
+Defined in: [contracts/IIntelligenceContext.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceContext.ts#L28)
+
+The conversation identifier, or `null` for a new conversation.
+
+---
+
+### conversationPreview
+
+```ts
+readonly conversationPreview:
+  | IIntelligenceConversationSnapshot
+  | null;
+```
+
+Defined in: [contracts/IIntelligenceContext.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceContext.ts#L35)
+
+A lightweight preview of the conversation history, or `null` when unavailable.
+
+---
+
+### nutritionSnapshot?
+
+```ts
+readonly optional nutritionSnapshot?: Record<string, unknown> | null;
+```
+
+Defined in: [contracts/IIntelligenceContext.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceContext.ts#L49)
+
+Optional nutrition snapshot for context enrichment.
+
+---
+
+### userId
+
+```ts
+readonly userId: string;
+```
+
+Defined in: [contracts/IIntelligenceContext.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceContext.ts#L21)
+
+The identifier of the requesting user.
+
+---
+
+### workoutSummary?
+
+```ts
+readonly optional workoutSummary?: Record<string, unknown> | null;
+```
+
+Defined in: [contracts/IIntelligenceContext.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceContext.ts#L42)
+
+Optional workout summary for context enrichment.

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

@@ -0,0 +1,36 @@
+---
+title: 'Interface: IIntelligenceContextBuilder'
+generated: true
+editUrl: false
+---
+
+# Interface: IIntelligenceContextBuilder
+
+Defined in: [contracts/IIntelligenceContextBuilder.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceContextBuilder.ts#L12)
+
+Responsible for composing the context supplied to capabilities.
+
+## Methods
+
+### build()
+
+```ts
+build(userId, conversationId): Promise<IIntelligenceContext>;
+```
+
+Defined in: [contracts/IIntelligenceContextBuilder.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceContextBuilder.ts#L24)
+
+Builds the aggregated context for the given user and conversation.
+
+#### Parameters
+
+| Parameter        | Type               | Description                                                    |
+| ---------------- | ------------------ | -------------------------------------------------------------- |
+| `userId`         | `string`           | The identifier of the requesting user.                         |
+| `conversationId` | `string` \| `null` | The conversation identifier, or `null` for a new conversation. |
+
+#### Returns
+
+`Promise`\<[`IIntelligenceContext`](Interface.IIntelligenceContext)\>
+
+The composed context instance.

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

@@ -0,0 +1,71 @@
+---
+title: 'Interface: IIntelligenceConversationMessageSnapshot'
+generated: true
+editUrl: false
+---
+
+# Interface: IIntelligenceConversationMessageSnapshot
+
+Defined in: [contracts/IIntelligenceConversationMessageSnapshot.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceConversationMessageSnapshot.ts#L12)
+
+Represents a single message returned within a conversation snapshot.
+
+## Properties
+
+### content
+
+```ts
+readonly content: string;
+```
+
+Defined in: [contracts/IIntelligenceConversationMessageSnapshot.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceConversationMessageSnapshot.ts#L35)
+
+The textual content of the message.
+
+---
+
+### createdAt
+
+```ts
+readonly createdAt: Date;
+```
+
+Defined in: [contracts/IIntelligenceConversationMessageSnapshot.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceConversationMessageSnapshot.ts#L42)
+
+The timestamp when the message was created.
+
+---
+
+### id
+
+```ts
+readonly id: string;
+```
+
+Defined in: [contracts/IIntelligenceConversationMessageSnapshot.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceConversationMessageSnapshot.ts#L21)
+
+Unique identifier of the message.
+
+---
+
+### metadata?
+
+```ts
+readonly optional metadata?: unknown;
+```
+
+Defined in: [contracts/IIntelligenceConversationMessageSnapshot.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceConversationMessageSnapshot.ts#L49)
+
+Optional metadata attached to the message.
+
+---
+
+### role
+
+```ts
+readonly role: IntelligenceConversationMessageRole;
+```
+
+Defined in: [contracts/IIntelligenceConversationMessageSnapshot.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceConversationMessageSnapshot.ts#L28)
+
+The role of the message author.