@breadstone/archipel-mcp 0.0.7 → 0.0.8

package/data/packages/platform-intelligence/api/index.md

@@ -0,0 +1,70 @@
+---
+title: '@breadstone/archipel-platform-intelligence'
+generated: true
+editUrl: false
+---
+
+# @breadstone/archipel-platform-intelligence
+
+## Classes
+
+| Class                                                                            | Description                                                                                                                                                                          |
+| -------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| [IntelligenceCapabilityRegistrarBase](Class.IntelligenceCapabilityRegistrarBase) | Provides a reusable registration flow that allows feature modules to contribute capabilities to the global intelligence registry while keeping their implementation details private. |
+| [IntelligenceCapabilityRegistry](Class.IntelligenceCapabilityRegistry)           | Central registry responsible for resolving intelligence capabilities based on intent metadata.                                                                                       |
+| [IntelligenceModule](Class.IntelligenceModule)                                   | Core module exposing the shared intelligence infrastructure to feature modules.                                                                                                      |
+| [IntelligenceTextGenerator](Class.IntelligenceTextGenerator)                     | Executes text completions using the configured intelligence provider.                                                                                                                |
+
+## Interfaces
+
+| Interface                                                                                      | Description                                                                           |
+| ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
+| [IIntelligenceArtifact](Interface.IIntelligenceArtifact)                                       | Represents a structured artifact returned by a capability.                            |
+| [IIntelligenceCapability](Interface.IIntelligenceCapability)                                   | Abstraction implemented by all capability providers.                                  |
+| [IIntelligenceCapabilityMetadata](Interface.IIntelligenceCapabilityMetadata)                   | Metadata describing a capability for orchestration and analytics purposes.            |
+| [IIntelligenceCapabilityPayload](Interface.IIntelligenceCapabilityPayload)                     | Payload forwarded to capabilities for execution.                                      |
+| [IIntelligenceCapabilityRegistry](Interface.IIntelligenceCapabilityRegistry)                   | Registry abstraction responsible for resolving capabilities.                          |
+| [IIntelligenceCapabilityResult](Interface.IIntelligenceCapabilityResult)                       | Represents the outcome produced by a capability execution.                            |
+| [IIntelligenceCompletionUsage](Interface.IIntelligenceCompletionUsage)                         | Captures usage telemetry returned by the intelligence provider.                       |
+| [IIntelligenceContext](Interface.IIntelligenceContext)                                         | Describes the context aggregated before routing a request to a capability.            |
+| [IIntelligenceContextBuilder](Interface.IIntelligenceContextBuilder)                           | Responsible for composing the context supplied to capabilities.                       |
+| [IIntelligenceConversationMessageSnapshot](Interface.IIntelligenceConversationMessageSnapshot) | Represents a single message returned within a conversation snapshot.                  |
+| [IIntelligenceConversationSnapshot](Interface.IIntelligenceConversationSnapshot)               | Represents a lightweight snapshot of a conversation used for context building.        |
+| [IIntelligenceFollowUpQuestion](Interface.IIntelligenceFollowUpQuestion)                       | Represents a follow-up question suggested to keep the dialogue active.                |
+| [IIntelligenceIntent](Interface.IIntelligenceIntent)                                           | Represents the structured intent resolved from a user message.                        |
+| [IIntelligenceIntentEntity](Interface.IIntelligenceIntentEntity)                               | Represents an entity extracted from a resolved intelligence intent.                   |
+| [IIntelligenceMessageModel](Interface.IIntelligenceMessageModel)                               | Represents a normalized message stored in persistence.                                |
+| [IIntelligenceMessagePayload](Interface.IIntelligenceMessagePayload)                           | Carries the payload submitted when messaging the intelligence entrypoint.             |
+| [IIntelligencePrompt](Interface.IIntelligencePrompt)                                           | Represents the input supplied to the intelligence text generator.                     |
+| [IIntelligencePromptMessage](Interface.IIntelligencePromptMessage)                             | Describes a normalized message used for text generation prompts.                      |
+| [IIntelligenceProviderConfiguration](Interface.IIntelligenceProviderConfiguration)             | Describes the resolved configuration for the intelligence provider.                   |
+| [IIntelligenceResponseMessage](Interface.IIntelligenceResponseMessage)                         | Represents a single assistant message returned by a capability.                       |
+| [IIntelligenceTextCompletion](Interface.IIntelligenceTextCompletion)                           | Represents the normalized completion result produced by the intelligence provider.    |
+| [IIntelligenceTextGenerationOptions](Interface.IIntelligenceTextGenerationOptions)             | Options that can be supplied when generating text with the intelligence provider.     |
+| [IIntelligenceTextGenerator](Interface.IIntelligenceTextGenerator)                             | Abstraction responsible for executing text completions using the configured provider. |
+
+## Type Aliases
+
+| Type Alias                                                                           | Description                                                                          |
+| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
+| [IntelligenceConversationMessageRole](TypeAlias.IntelligenceConversationMessageRole) | Represents the union of supported conversation message roles.                        |
+| [IntelligenceLanguageModelLoader](TypeAlias.IntelligenceLanguageModelLoader)         | Represents a factory responsible for resolving a configured language model instance. |
+| [IntelligenceProviderName](TypeAlias.IntelligenceProviderName)                       | Represents the union of supported intelligence provider identifiers.                 |
+
+## Variables
+
+| Variable                                                                              | Description                                                                   |
+| ------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
+| [IntelligenceConversationMessageRoles](Variable.IntelligenceConversationMessageRoles) | Enumerates the conversation roles used for contextual snapshots and messages. |
+| [IntelligenceProviderNames](Variable.IntelligenceProviderNames)                       | Enumerates the supported model providers powering the intelligence pipeline.  |
+
+## Functions
+
+| Function                                                          | Description                                                                               |
+| ----------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
+| [createProviderOptions](Function.createProviderOptions)           | Creates the provider options object consumed by the AI SDK model factories.               |
+| [loadAnthropicLanguageModel](Function.loadAnthropicLanguageModel) | Loads the Anthropic language model based on the resolved provider configuration.          |
+| [loadGoogleLanguageModel](Function.loadGoogleLanguageModel)       | Loads the Google (Gemini) language model based on the resolved provider configuration.    |
+| [loadGrokLanguageModel](Function.loadGrokLanguageModel)           | Loads the Grok (xAI) language model based on the resolved provider configuration.         |
+| [loadOpenAILanguageModel](Function.loadOpenAILanguageModel)       | Loads the OpenAI compatible language model based on the resolved provider configuration.  |
+| [loadProviderFactory](Function.loadProviderFactory)               | Dynamically loads an AI SDK provider factory and returns the exported function reference. |

package/data/packages/platform-intelligence/index.md

@@ -0,0 +1,131 @@
+---
+title: platform-intelligence
+description: Multi-provider AI text generation with capability registry and intent-based orchestration.
+order: 16
+tags: [intelligence, ai, openai, anthropic, google, grok, text-generation, capability-registry]
+package: '@breadstone/archipel-platform-intelligence'
+---
+
+# platform-intelligence
+
+Multi-provider AI text generation library supporting OpenAI, Anthropic, Google Generative AI, and Grok. Features a capability registry that maps business intents to provider-specific configurations, enabling intent-based orchestration without coupling consumers to a specific LLM.
+
+**Package:** `@breadstone/archipel-platform-intelligence`
+
+## Quick Start
+
+```typescript
+import { Module } from '@nestjs/common';
+import { IntelligenceModule } from '@breadstone/archipel-platform-intelligence';
+
+@Module({
+  imports: [IntelligenceModule],
+})
+export class AppModule {}
+```
+
+---
+
+## Provider Packages
+
+Install only the providers you need:
+
+| Provider  | Package                                                |
+| --------- | ------------------------------------------------------ |
+| OpenAI    | `@breadstone/archipel-platform-intelligence/openai`    |
+| Anthropic | `@breadstone/archipel-platform-intelligence/anthropic` |
+| Google    | `@breadstone/archipel-platform-intelligence/google`    |
+| Grok      | `@breadstone/archipel-platform-intelligence/grok`      |
+
+---
+
+## Text Generation
+
+Inject `IntelligenceTextGenerator` and call `generateText()`:
+
+```typescript
+import { Injectable } from '@nestjs/common';
+import { IntelligenceTextGenerator, IIntelligencePrompt } from '@breadstone/archipel-platform-intelligence';
+
+@Injectable()
+export class SummaryService {
+  constructor(private readonly _textGenerator: IntelligenceTextGenerator) {}
+
+  async summarize(content: string): Promise<string> {
+    const prompt: IIntelligencePrompt = {
+      system: 'You are a concise summarizer.',
+      messages: [{ role: 'user', content }],
+    };
+
+    const result = await this._textGenerator.generateText(prompt, {
+      provider: 'openai',
+      model: 'gpt-4o',
+      temperature: 0.3,
+    });
+
+    return result.text;
+  }
+}
+```
+
+---
+
+## Capability Registry
+
+The capability registry decouples consumers from specific providers and models by mapping business intents to configurations.
+
+### Defining Capabilities
+
+```typescript
+import { IIntelligenceCapability } from '@breadstone/archipel-platform-intelligence';
+
+const SUMMARIZE_CAPABILITY: IIntelligenceCapability = {
+  intent: 'summarize',
+  provider: 'openai',
+  model: 'gpt-4o',
+  temperature: 0.3,
+  maxTokens: 1024,
+};
+```
+
+### Registering via IntelligenceCapabilityRegistrarBase
+
+```typescript
+import { Injectable } from '@nestjs/common';
+import {
+  IntelligenceCapabilityRegistrarBase,
+  IIntelligenceCapabilityRegistry,
+} from '@breadstone/archipel-platform-intelligence';
+
+@Injectable()
+export class AppCapabilityRegistrar extends IntelligenceCapabilityRegistrarBase {
+  protected registerCapabilities(registry: IIntelligenceCapabilityRegistry): void {
+    registry.register(SUMMARIZE_CAPABILITY);
+    registry.register(TRANSLATE_CAPABILITY);
+  }
+}
+```
+
+### Resolving at Runtime
+
+```typescript
+const capability = this._registry.resolve('summarize');
+const result = await this._textGenerator.generateText(prompt, capability);
+```
+
+---
+
+## Environment Variables
+
+| Variable                         | Description                  | Required           |
+| -------------------------------- | ---------------------------- | ------------------ |
+| `INTELLIGENCE_OPENAI_API_KEY`    | OpenAI API key               | If using OpenAI    |
+| `INTELLIGENCE_ANTHROPIC_API_KEY` | Anthropic API key            | If using Anthropic |
+| `INTELLIGENCE_GOOGLE_API_KEY`    | Google Generative AI API key | If using Google    |
+| `INTELLIGENCE_GROK_API_KEY`      | Grok / xAI API key           | If using Grok      |
+
+---
+
+## API Reference
+
+See the full [API documentation](./api/) for all exported types, interfaces, and classes.

package/data/packages/platform-telemetry/api/Class.TelemetryCacheMetricsRecorder.md

@@ -49,9 +49,9 @@ Records a cache eviction.
 
 #### Parameters
 
-| Parameter | Type     | Description          |
-| --------- | -------- | -------------------- |
-| `cache`   | `string` | The cache name/label |
+| Parameter | Type     | Description             |
+| --------- | -------- | ----------------------- |
+| `cache`   | `string` | The cache name / label. |
 
 #### Returns
 
@@ -77,9 +77,9 @@ Records a cache hit.
 
 #### Parameters
 
-| Parameter | Type     | Description          |
-| --------- | -------- | -------------------- |
-| `cache`   | `string` | The cache name/label |
+| Parameter | Type     | Description             |
+| --------- | -------- | ----------------------- |
+| `cache`   | `string` | The cache name / label. |
 
 #### Returns
 
@@ -105,9 +105,9 @@ Records a failed cache load.
 
 #### Parameters
 
-| Parameter | Type     | Description          |
-| --------- | -------- | -------------------- |
-| `cache`   | `string` | The cache name/label |
+| Parameter | Type     | Description             |
+| --------- | -------- | ----------------------- |
+| `cache`   | `string` | The cache name / label. |
 
 #### Returns
 
@@ -133,9 +133,9 @@ Records a successful cache load.
 
 #### Parameters
 
-| Parameter | Type     | Description          |
-| --------- | -------- | -------------------- |
-| `cache`   | `string` | The cache name/label |
+| Parameter | Type     | Description             |
+| --------- | -------- | ----------------------- |
+| `cache`   | `string` | The cache name / label. |
 
 #### Returns
 
@@ -161,9 +161,9 @@ Records a cache miss.
 
 #### Parameters
 
-| Parameter | Type     | Description          |
-| --------- | -------- | -------------------- |
-| `cache`   | `string` | The cache name/label |
+| Parameter | Type     | Description             |
+| --------- | -------- | ----------------------- |
+| `cache`   | `string` | The cache name / label. |
 
 #### Returns
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@breadstone/archipel-mcp",
-  "version": "0.0.7",
+  "version": "0.0.8",
   "description": "MCP server providing Archipel platform knowledge — documentation, query patterns, and coding conventions — to AI development tools.",
   "type": "commonjs",
   "main": "./src/main.js",

package/data/packages/platform-core/api/Class.BcryptService.md

@@ -1,69 +0,0 @@
----
-title: 'Class: BcryptService'
-generated: true
-editUrl: false
----
-
-# Class: BcryptService
-
-Defined in: [services/BcryptService.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/BcryptService.ts#L15)
-
-The `BcryptService` class.
-Represents the service that provides bcrypt operations.
-
-## Constructors
-
-### Constructor
-
-```ts
-new BcryptService(): BcryptService;
-```
-
-#### Returns
-
-`BcryptService`
-
-## Methods
-
-### compare()
-
-```ts
-compare(data, encrypted): Promise<boolean>;
-```
-
-Defined in: [services/BcryptService.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/BcryptService.ts#L37)
-
-Compares the given data with the encrypted data.
-
-#### Parameters
-
-| Parameter   | Type     | Description                       |
-| ----------- | -------- | --------------------------------- |
-| `data`      | `string` | The data to be compared           |
-| `encrypted` | `string` | The encrypted data to be compared |
-
-#### Returns
-
-`Promise`\<`boolean`\>
-
----
-
-### hash()
-
-```ts
-hash(data): Promise<string>;
-```
-
-Defined in: [services/BcryptService.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/BcryptService.ts#L25)
-
-Hashes the given data.
-
-#### Parameters
-
-| Parameter | Type     | Description           |
-| --------- | -------- | --------------------- |
-| `data`    | `string` | The data to be hashed |
-
-#### Returns
-
-`Promise`\<`string`\>

package/data/packages/platform-core/api/Class.CryptoService.md

@@ -1,50 +0,0 @@
----
-title: 'Class: CryptoService'
-generated: true
-editUrl: false
----
-
-# Class: CryptoService
-
-Defined in: [services/CryptoService.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/CryptoService.ts#L15)
-
-The `CryptoService` class.
-Represents the service that provides cryptographic operations.
-
-## Constructors
-
-### Constructor
-
-```ts
-new CryptoService(): CryptoService;
-```
-
-Defined in: [services/CryptoService.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/CryptoService.ts#L22)
-
-Initializes a new instance of the `CryptoService` class.
-
-#### Returns
-
-`CryptoService`
-
-## Methods
-
-### getRandomGuid()
-
-```ts
-getRandomGuid(prefix): string;
-```
-
-Defined in: [services/CryptoService.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/CryptoService.ts#L36)
-
-Hashes the given data.
-
-#### Parameters
-
-| Parameter | Type     |
-| --------- | -------- |
-| `prefix`  | `string` |
-
-#### Returns
-
-`string`

package/data/packages/platform-core/api/Class.NoopCacheMetricsRecorder.md

@@ -1,157 +0,0 @@
----
-title: 'Class: NoopCacheMetricsRecorder'
-generated: true
-editUrl: false
----
-
-# Class: NoopCacheMetricsRecorder
-
-Defined in: [cache/NoopCacheMetricsRecorder.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/NoopCacheMetricsRecorder.ts#L12)
-
-No-op implementation used when no metrics backend is configured.
-
-## Implements
-
-- [`ICacheMetricsRecorder`](Interface.ICacheMetricsRecorder)
-
-## Constructors
-
-### Constructor
-
-```ts
-new NoopCacheMetricsRecorder(): NoopCacheMetricsRecorder;
-```
-
-#### Returns
-
-`NoopCacheMetricsRecorder`
-
-## Methods
-
-### recordEviction()?
-
-```ts
-optional recordEviction(_cache): void;
-```
-
-Defined in: [cache/NoopCacheMetricsRecorder.ts:62](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/NoopCacheMetricsRecorder.ts#L62)
-
-Records a cache eviction.
-
-#### Parameters
-
-| Parameter | Type     | Description          |
-| --------- | -------- | -------------------- |
-| `_cache`  | `string` | The cache name/label |
-
-#### Returns
-
-`void`
-
-#### Implementation of
-
-[`ICacheMetricsRecorder`](Interface.ICacheMetricsRecorder).[`recordEviction`](Interface.ICacheMetricsRecorder#recordeviction)
-
----
-
-### recordHit()
-
-```ts
-recordHit(_cache): void;
-```
-
-Defined in: [cache/NoopCacheMetricsRecorder.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/NoopCacheMetricsRecorder.ts#L22)
-
-Records a cache hit.
-
-#### Parameters
-
-| Parameter | Type     | Description          |
-| --------- | -------- | -------------------- |
-| `_cache`  | `string` | The cache name/label |
-
-#### Returns
-
-`void`
-
-#### Implementation of
-
-[`ICacheMetricsRecorder`](Interface.ICacheMetricsRecorder).[`recordHit`](Interface.ICacheMetricsRecorder#recordhit)
-
----
-
-### recordLoadError()
-
-```ts
-recordLoadError(_cache): void;
-```
-
-Defined in: [cache/NoopCacheMetricsRecorder.ts:52](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/NoopCacheMetricsRecorder.ts#L52)
-
-Records a failed cache load.
-
-#### Parameters
-
-| Parameter | Type     | Description          |
-| --------- | -------- | -------------------- |
-| `_cache`  | `string` | The cache name/label |
-
-#### Returns
-
-`void`
-
-#### Implementation of
-
-[`ICacheMetricsRecorder`](Interface.ICacheMetricsRecorder).[`recordLoadError`](Interface.ICacheMetricsRecorder#recordloaderror)
-
----
-
-### recordLoadSuccess()
-
-```ts
-recordLoadSuccess(_cache): void;
-```
-
-Defined in: [cache/NoopCacheMetricsRecorder.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/NoopCacheMetricsRecorder.ts#L42)
-
-Records a successful cache load.
-
-#### Parameters
-
-| Parameter | Type     | Description          |
-| --------- | -------- | -------------------- |
-| `_cache`  | `string` | The cache name/label |
-
-#### Returns
-
-`void`
-
-#### Implementation of
-
-[`ICacheMetricsRecorder`](Interface.ICacheMetricsRecorder).[`recordLoadSuccess`](Interface.ICacheMetricsRecorder#recordloadsuccess)
-
----
-
-### recordMiss()
-
-```ts
-recordMiss(_cache): void;
-```
-
-Defined in: [cache/NoopCacheMetricsRecorder.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/NoopCacheMetricsRecorder.ts#L32)
-
-Records a cache miss.
-
-#### Parameters
-
-| Parameter | Type     | Description          |
-| --------- | -------- | -------------------- |
-| `_cache`  | `string` | The cache name/label |
-
-#### Returns
-
-`void`
-
-#### Implementation of
-
-[`ICacheMetricsRecorder`](Interface.ICacheMetricsRecorder).[`recordMiss`](Interface.ICacheMetricsRecorder#recordmiss)