@breadstone/archipel-mcp 0.0.15 → 0.0.16

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

@@ -0,0 +1,70 @@
+---
+title: 'Interface: IIntelligenceMessageModel'
+generated: true
+editUrl: false
+---
+# Interface: IIntelligenceMessageModel
+
+Defined in: [contracts/IIntelligenceMessageModel.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceMessageModel.ts#L12)
+
+Represents a normalized message stored in persistence.
+
+## Properties
+
+### content
+
+```ts
+readonly content: string;
+```
+
+Defined in: [contracts/IIntelligenceMessageModel.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceMessageModel.ts#L34)
+
+The textual content of the message.
+
+***
+
+### createdAt
+
+```ts
+readonly createdAt: Date;
+```
+
+Defined in: [contracts/IIntelligenceMessageModel.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceMessageModel.ts#L41)
+
+The timestamp when the message was created.
+
+***
+
+### id
+
+```ts
+readonly id: string;
+```
+
+Defined in: [contracts/IIntelligenceMessageModel.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceMessageModel.ts#L20)
+
+Unique identifier of the persisted message.
+
+***
+
+### metadata?
+
+```ts
+readonly optional metadata?: unknown;
+```
+
+Defined in: [contracts/IIntelligenceMessageModel.ts:48](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceMessageModel.ts#L48)
+
+Optional metadata attached to the message.
+
+***
+
+### role
+
+```ts
+readonly role: IntelligenceConversationMessageRole;
+```
+
+Defined in: [contracts/IIntelligenceMessageModel.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceMessageModel.ts#L27)
+
+The role of the message author.

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

@@ -0,0 +1,34 @@
+---
+title: 'Interface: IIntelligenceMessagePayload'
+generated: true
+editUrl: false
+---
+# Interface: IIntelligenceMessagePayload
+
+Defined in: [contracts/IIntelligenceMessagePayload.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceMessagePayload.ts#L6)
+
+Carries the payload submitted when messaging the intelligence entrypoint.
+
+## Properties
+
+### conversationId
+
+```ts
+readonly conversationId: string | null;
+```
+
+Defined in: [contracts/IIntelligenceMessagePayload.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceMessagePayload.ts#L14)
+
+The conversation identifier, or `null` to start a new conversation.
+
+***
+
+### message
+
+```ts
+readonly message: string;
+```
+
+Defined in: [contracts/IIntelligenceMessagePayload.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceMessagePayload.ts#L21)
+
+The user message to process.

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

@@ -0,0 +1,34 @@
+---
+title: 'Interface: IIntelligencePrompt'
+generated: true
+editUrl: false
+---
+# Interface: IIntelligencePrompt
+
+Defined in: [contracts/IIntelligencePrompt.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligencePrompt.ts#L12)
+
+Represents the input supplied to the intelligence text generator.
+
+## Properties
+
+### messages
+
+```ts
+readonly messages: readonly IIntelligencePromptMessage[];
+```
+
+Defined in: [contracts/IIntelligencePrompt.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligencePrompt.ts#L27)
+
+The ordered list of messages forming the prompt.
+
+***
+
+### systemPrompt
+
+```ts
+readonly systemPrompt: string | null;
+```
+
+Defined in: [contracts/IIntelligencePrompt.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligencePrompt.ts#L20)
+
+The optional system-level prompt prepended to the conversation.

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

@@ -0,0 +1,34 @@
+---
+title: 'Interface: IIntelligencePromptMessage'
+generated: true
+editUrl: false
+---
+# Interface: IIntelligencePromptMessage
+
+Defined in: [contracts/IIntelligencePromptMessage.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligencePromptMessage.ts#L12)
+
+Describes a normalized message used for text generation prompts.
+
+## Properties
+
+### content
+
+```ts
+readonly content: string;
+```
+
+Defined in: [contracts/IIntelligencePromptMessage.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligencePromptMessage.ts#L27)
+
+The textual content of the message.
+
+***
+
+### role
+
+```ts
+readonly role: IntelligenceConversationMessageRole;
+```
+
+Defined in: [contracts/IIntelligencePromptMessage.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligencePromptMessage.ts#L20)
+
+The role of the message author.

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

@@ -0,0 +1,94 @@
+---
+title: 'Interface: IIntelligenceProviderConfiguration'
+generated: true
+editUrl: false
+---
+# Interface: IIntelligenceProviderConfiguration
+
+Defined in: [contracts/IIntelligenceProviderConfiguration.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceProviderConfiguration.ts#L12)
+
+Describes the resolved configuration for the intelligence provider.
+
+## Properties
+
+### apiKey
+
+```ts
+readonly apiKey: string;
+```
+
+Defined in: [contracts/IIntelligenceProviderConfiguration.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceProviderConfiguration.ts#L34)
+
+The API key used to authenticate with the provider.
+
+***
+
+### baseUrl
+
+```ts
+readonly baseUrl: string | null;
+```
+
+Defined in: [contracts/IIntelligenceProviderConfiguration.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceProviderConfiguration.ts#L41)
+
+An optional base URL override for the provider API.
+
+***
+
+### maxOutputTokens
+
+```ts
+readonly maxOutputTokens: number;
+```
+
+Defined in: [contracts/IIntelligenceProviderConfiguration.ts:62](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceProviderConfiguration.ts#L62)
+
+The maximum number of output tokens per completion.
+
+***
+
+### model
+
+```ts
+readonly model: string;
+```
+
+Defined in: [contracts/IIntelligenceProviderConfiguration.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceProviderConfiguration.ts#L27)
+
+The model identifier to use for text generation.
+
+***
+
+### provider
+
+```ts
+readonly provider: IntelligenceProviderName;
+```
+
+Defined in: [contracts/IIntelligenceProviderConfiguration.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceProviderConfiguration.ts#L20)
+
+The resolved provider identifier.
+
+***
+
+### temperature
+
+```ts
+readonly temperature: number;
+```
+
+Defined in: [contracts/IIntelligenceProviderConfiguration.ts:48](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceProviderConfiguration.ts#L48)
+
+The sampling temperature used for text generation.
+
+***
+
+### topP
+
+```ts
+readonly topP: number;
+```
+
+Defined in: [contracts/IIntelligenceProviderConfiguration.ts:55](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceProviderConfiguration.ts#L55)
+
+The top-p (nucleus) sampling parameter.

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

@@ -0,0 +1,34 @@
+---
+title: 'Interface: IIntelligenceResponseMessage'
+generated: true
+editUrl: false
+---
+# Interface: IIntelligenceResponseMessage
+
+Defined in: [contracts/IIntelligenceResponseMessage.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceResponseMessage.ts#L6)
+
+Represents a single assistant message returned by a capability.
+
+## Properties
+
+### content
+
+```ts
+readonly content: string;
+```
+
+Defined in: [contracts/IIntelligenceResponseMessage.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceResponseMessage.ts#L14)
+
+The textual content of the assistant response.
+
+***
+
+### metadata?
+
+```ts
+readonly optional metadata?: Record<string, unknown>;
+```
+
+Defined in: [contracts/IIntelligenceResponseMessage.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceResponseMessage.ts#L21)
+
+Optional metadata attached to the response message.

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

@@ -0,0 +1,60 @@
+---
+title: 'Interface: IIntelligenceTextCompletion'
+generated: true
+editUrl: false
+---
+# Interface: IIntelligenceTextCompletion
+
+Defined in: [contracts/IIntelligenceTextCompletion.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L13)
+
+Represents the normalized completion result produced by the intelligence provider.
+
+## Properties
+
+### model
+
+```ts
+readonly model: string;
+```
+
+Defined in: [contracts/IIntelligenceTextCompletion.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L35)
+
+The model identifier used for the completion.
+
+***
+
+### provider
+
+```ts
+readonly provider: IntelligenceProviderName;
+```
+
+Defined in: [contracts/IIntelligenceTextCompletion.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L28)
+
+The provider that produced the completion.
+
+***
+
+### text
+
+```ts
+readonly text: string;
+```
+
+Defined in: [contracts/IIntelligenceTextCompletion.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L21)
+
+The generated text content.
+
+***
+
+### usage
+
+```ts
+readonly usage: 
+  | IIntelligenceCompletionUsage
+  | null;
+```
+
+Defined in: [contracts/IIntelligenceTextCompletion.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L42)
+
+Token usage telemetry, or `null` when the provider does not report usage.

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

@@ -0,0 +1,59 @@
+---
+title: 'Interface: IIntelligenceTextGenerationOptions'
+generated: true
+editUrl: false
+---
+# Interface: IIntelligenceTextGenerationOptions
+
+Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextGenerationOptions.ts#L6)
+
+Options that can be supplied when generating text with the intelligence provider.
+
+## Properties
+
+### maxOutputTokens?
+
+```ts
+readonly optional maxOutputTokens?: number;
+```
+
+Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextGenerationOptions.ts#L28)
+
+Optional maximum output tokens override.
+
+***
+
+### temperature?
+
+```ts
+readonly optional temperature?: number;
+```
+
+Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextGenerationOptions.ts#L14)
+
+Optional sampling temperature override.
+
+***
+
+### timeoutMs?
+
+```ts
+readonly optional timeoutMs?: number;
+```
+
+Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextGenerationOptions.ts#L36)
+
+Optional timeout in milliseconds for the LLM request.
+Defaults to 30000 (30 seconds) if not specified.
+
+***
+
+### topP?
+
+```ts
+readonly optional topP?: number;
+```
+
+Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextGenerationOptions.ts#L21)
+
+Optional top-p (nucleus) sampling override.

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

@@ -0,0 +1,53 @@
+---
+title: 'Interface: IIntelligenceTextGenerator'
+generated: true
+editUrl: false
+---
+# Interface: IIntelligenceTextGenerator
+
+Defined in: [interfaces/IIntelligenceTextGenerator.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceTextGenerator.ts#L15)
+
+Abstraction responsible for executing text completions using the configured provider.
+
+## Methods
+
+### generateText()
+
+```ts
+generateText(prompt, options?): Promise<IIntelligenceTextCompletion>;
+```
+
+Defined in: [interfaces/IIntelligenceTextGenerator.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceTextGenerator.ts#L26)
+
+Generates a text completion using the configured intelligence 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)\>
+
+The normalized text completion result.
+
+***
+
+### getConfiguration()
+
+```ts
+getConfiguration(): IIntelligenceProviderConfiguration;
+```
+
+Defined in: [interfaces/IIntelligenceTextGenerator.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceTextGenerator.ts#L37)
+
+Returns the currently resolved provider configuration.
+
+#### Returns
+
+[`IIntelligenceProviderConfiguration`](Interface.IIntelligenceProviderConfiguration)
+
+The active provider configuration.

package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceConversationMessageRole.md

@@ -0,0 +1,14 @@
+---
+title: 'Type Alias: IntelligenceConversationMessageRole'
+generated: true
+editUrl: false
+---
+# Type Alias: IntelligenceConversationMessageRole
+
+```ts
+type IntelligenceConversationMessageRole = typeof IntelligenceConversationMessageRoles[keyof typeof IntelligenceConversationMessageRoles];
+```
+
+Defined in: [contracts/IntelligenceConversationMessageRoles.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IntelligenceConversationMessageRoles.ts#L17)
+
+Represents the union of supported conversation message roles.

package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceLanguageModelLoader.md

@@ -0,0 +1,24 @@
+---
+title: 'Type Alias: IntelligenceLanguageModelLoader'
+generated: true
+editUrl: false
+---
+# Type Alias: IntelligenceLanguageModelLoader
+
+```ts
+type IntelligenceLanguageModelLoader = (configuration) => Promise<LanguageModelV2>;
+```
+
+Defined in: [providers/IntelligenceLanguageModelLoader.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/IntelligenceLanguageModelLoader.ts#L13)
+
+Represents a factory responsible for resolving a configured language model instance.
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `configuration` | [`IIntelligenceProviderConfiguration`](Interface.IIntelligenceProviderConfiguration) |
+
+## Returns
+
+`Promise`\<`LanguageModelV2`\>

package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceProviderName.md

@@ -0,0 +1,14 @@
+---
+title: 'Type Alias: IntelligenceProviderName'
+generated: true
+editUrl: false
+---
+# Type Alias: IntelligenceProviderName
+
+```ts
+type IntelligenceProviderName = typeof IntelligenceProviderNames[keyof typeof IntelligenceProviderNames];
+```
+
+Defined in: [contracts/IntelligenceProviderNames.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IntelligenceProviderNames.ts#L18)
+
+Represents the union of supported intelligence provider identifiers.

package/data/packages/platform-intelligence/api/Variable.ANTHROPIC_API_KEY.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: ANTHROPIC\_API\_KEY'
+generated: true
+editUrl: false
+---
+# Variable: ANTHROPIC\_API\_KEY
+
+```ts
+const ANTHROPIC_API_KEY: IConfigKey<string>;
+```
+
+Defined in: [env.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/env.ts#L39)
+
+Anthropic-specific API key.

package/data/packages/platform-intelligence/api/Variable.ANTHROPIC_BASE_URL.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: ANTHROPIC\_BASE\_URL'
+generated: true
+editUrl: false
+---
+# Variable: ANTHROPIC\_BASE\_URL
+
+```ts
+const ANTHROPIC_BASE_URL: IConfigKey<string>;
+```
+
+Defined in: [env.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/env.ts#L42)
+
+Anthropic-specific base URL.

package/data/packages/platform-intelligence/api/Variable.GEMINI_API_KEY.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: GEMINI\_API\_KEY'
+generated: true
+editUrl: false
+---
+# Variable: GEMINI\_API\_KEY
+
+```ts
+const GEMINI_API_KEY: IConfigKey<string>;
+```
+
+Defined in: [env.ts:48](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/env.ts#L48)
+
+Google-specific Gemini API key.

package/data/packages/platform-intelligence/api/Variable.GOOGLE_API_KEY.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: GOOGLE\_API\_KEY'
+generated: true
+editUrl: false
+---
+# Variable: GOOGLE\_API\_KEY
+
+```ts
+const GOOGLE_API_KEY: IConfigKey<string>;
+```
+
+Defined in: [env.ts:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/env.ts#L45)
+
+Google-specific API key.

package/data/packages/platform-intelligence/api/Variable.GOOGLE_BASE_URL.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: GOOGLE\_BASE\_URL'
+generated: true
+editUrl: false
+---
+# Variable: GOOGLE\_BASE\_URL
+
+```ts
+const GOOGLE_BASE_URL: IConfigKey<string>;
+```
+
+Defined in: [env.ts:51](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/env.ts#L51)
+
+Google-specific base URL.

package/data/packages/platform-intelligence/api/Variable.GROK_API_KEY.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: GROK\_API\_KEY'
+generated: true
+editUrl: false
+---
+# Variable: GROK\_API\_KEY
+
+```ts
+const GROK_API_KEY: IConfigKey<string>;
+```
+
+Defined in: [env.ts:54](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/env.ts#L54)
+
+Grok-specific API key.

package/data/packages/platform-intelligence/api/Variable.GROK_BASE_URL.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: GROK\_BASE\_URL'
+generated: true
+editUrl: false
+---
+# Variable: GROK\_BASE\_URL
+
+```ts
+const GROK_BASE_URL: IConfigKey<string>;
+```
+
+Defined in: [env.ts:60](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/env.ts#L60)
+
+Grok-specific base URL.

package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_API_KEY.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: INTELLIGENCE\_API\_KEY'
+generated: true
+editUrl: false
+---
+# Variable: INTELLIGENCE\_API\_KEY
+
+```ts
+const INTELLIGENCE_API_KEY: IConfigKey<string>;
+```
+
+Defined in: [env.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/env.ts#L27)
+
+Global API key override for the intelligence provider.

package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_BASE_URL.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: INTELLIGENCE\_BASE\_URL'
+generated: true
+editUrl: false
+---
+# Variable: INTELLIGENCE\_BASE\_URL
+
+```ts
+const INTELLIGENCE_BASE_URL: IConfigKey<string>;
+```
+
+Defined in: [env.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/env.ts#L30)
+
+Global base URL override for the intelligence provider.