@breadstone/archipel-mcp 0.0.43 → 0.0.44

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (112) hide show
  1. package/data/guides/ai-text-generation.md +397 -107
  2. package/data/packages/platform-intelligence/api/Class.IntelligenceHealthIndicator.md +5 -5
  3. package/data/packages/platform-intelligence/api/Class.IntelligenceModule.md +26 -2
  4. package/data/packages/platform-intelligence/api/Class.IntelligenceTextGenerator.md +43 -9
  5. package/data/packages/platform-intelligence/api/Class.IntelligenceToolBase.md +93 -0
  6. package/data/packages/platform-intelligence/api/Class.IntelligenceToolRegistry.md +217 -0
  7. package/data/packages/platform-intelligence/api/Function.createAnthropicAdvisor20260301Tool.md +26 -0
  8. package/data/packages/platform-intelligence/api/Function.createAnthropicBash20241022Tool.md +26 -0
  9. package/data/packages/platform-intelligence/api/Function.createAnthropicBash20250124Tool.md +26 -0
  10. package/data/packages/platform-intelligence/api/Function.createAnthropicCodeExecution20250522Tool.md +26 -0
  11. package/data/packages/platform-intelligence/api/Function.createAnthropicCodeExecution20250825Tool.md +26 -0
  12. package/data/packages/platform-intelligence/api/Function.createAnthropicCodeExecution20260120Tool.md +26 -0
  13. package/data/packages/platform-intelligence/api/Function.createAnthropicComputer20241022Tool.md +26 -0
  14. package/data/packages/platform-intelligence/api/Function.createAnthropicComputer20250124Tool.md +26 -0
  15. package/data/packages/platform-intelligence/api/Function.createAnthropicComputer20251124Tool.md +26 -0
  16. package/data/packages/platform-intelligence/api/Function.createAnthropicMemory20250818Tool.md +26 -0
  17. package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20241022Tool.md +26 -0
  18. package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20250124Tool.md +26 -0
  19. package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20250429Tool.md +26 -0
  20. package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20250728Tool.md +26 -0
  21. package/data/packages/platform-intelligence/api/Function.createAnthropicToolSearchBM2520251119Tool.md +26 -0
  22. package/data/packages/platform-intelligence/api/Function.createAnthropicToolSearchRegex20251119Tool.md +26 -0
  23. package/data/packages/platform-intelligence/api/Function.createAnthropicWebFetch20250910Tool.md +26 -0
  24. package/data/packages/platform-intelligence/api/Function.createAnthropicWebFetch20260209Tool.md +26 -0
  25. package/data/packages/platform-intelligence/api/Function.createAnthropicWebSearch20250305Tool.md +26 -0
  26. package/data/packages/platform-intelligence/api/Function.createAnthropicWebSearch20260209Tool.md +26 -0
  27. package/data/packages/platform-intelligence/api/Function.createGoogleCodeExecutionTool.md +26 -0
  28. package/data/packages/platform-intelligence/api/Function.createGoogleEnterpriseWebSearchTool.md +26 -0
  29. package/data/packages/platform-intelligence/api/Function.createGoogleFileSearchTool.md +26 -0
  30. package/data/packages/platform-intelligence/api/Function.createGoogleGoogleMapsTool.md +26 -0
  31. package/data/packages/platform-intelligence/api/Function.createGoogleGoogleSearchTool.md +26 -0
  32. package/data/packages/platform-intelligence/api/Function.createGoogleUrlContextTool.md +26 -0
  33. package/data/packages/platform-intelligence/api/Function.createGoogleVertexRagStoreTool.md +26 -0
  34. package/data/packages/platform-intelligence/api/Function.createIntelligenceTool.md +27 -0
  35. package/data/packages/platform-intelligence/api/Function.createOpenAIApplyPatchTool.md +26 -0
  36. package/data/packages/platform-intelligence/api/Function.createOpenAICodeInterpreterTool.md +26 -0
  37. package/data/packages/platform-intelligence/api/Function.createOpenAICustomTool.md +27 -0
  38. package/data/packages/platform-intelligence/api/Function.createOpenAIFileSearchTool.md +26 -0
  39. package/data/packages/platform-intelligence/api/Function.createOpenAIImageGenerationTool.md +26 -0
  40. package/data/packages/platform-intelligence/api/Function.createOpenAILocalShellTool.md +26 -0
  41. package/data/packages/platform-intelligence/api/Function.createOpenAIMcpTool.md +26 -0
  42. package/data/packages/platform-intelligence/api/Function.createOpenAIShellTool.md +26 -0
  43. package/data/packages/platform-intelligence/api/Function.createOpenAIToolSearchTool.md +26 -0
  44. package/data/packages/platform-intelligence/api/Function.createOpenAIWebSearchPreviewTool.md +26 -0
  45. package/data/packages/platform-intelligence/api/Function.createOpenAIWebSearchTool.md +26 -0
  46. package/data/packages/platform-intelligence/api/Function.createProviderOptions.md +15 -2
  47. package/data/packages/platform-intelligence/api/Function.loadAnthropicLanguageModel.md +4 -4
  48. package/data/packages/platform-intelligence/api/Function.loadGoogleLanguageModel.md +4 -4
  49. package/data/packages/platform-intelligence/api/Function.loadGrokLanguageModel.md +4 -4
  50. package/data/packages/platform-intelligence/api/Function.loadOpenAILanguageModel.md +4 -4
  51. package/data/packages/platform-intelligence/api/Interface.IIntelligenceModuleOptions.md +79 -0
  52. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextCompletion.md +30 -6
  53. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerationOptions.md +106 -5
  54. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerator.md +29 -4
  55. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextStreamingOptions.md +183 -0
  56. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTool.md +39 -0
  57. package/data/packages/platform-intelligence/api/Interface.IIntelligenceToolRegistry.md +146 -0
  58. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceLanguageModelLoader.md +3 -3
  59. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceLanguageModelLoaders.md +14 -0
  60. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceTextStream.md +14 -0
  61. package/data/packages/platform-intelligence/api/Variable.ANTHROPIC_API_KEY.md +1 -1
  62. package/data/packages/platform-intelligence/api/Variable.ANTHROPIC_BASE_URL.md +1 -1
  63. package/data/packages/platform-intelligence/api/Variable.ANTHROPIC_CONFIG_ENTRIES.md +14 -0
  64. package/data/packages/platform-intelligence/api/Variable.AnthropicIntelligenceToolNames.md +42 -0
  65. package/data/packages/platform-intelligence/api/Variable.GEMINI_API_KEY.md +2 -2
  66. package/data/packages/platform-intelligence/api/Variable.GOOGLE_API_KEY.md +1 -1
  67. package/data/packages/platform-intelligence/api/Variable.GOOGLE_BASE_URL.md +1 -1
  68. package/data/packages/platform-intelligence/api/Variable.GOOGLE_CONFIG_ENTRIES.md +14 -0
  69. package/data/packages/platform-intelligence/api/Variable.GROK_API_KEY.md +1 -1
  70. package/data/packages/platform-intelligence/api/Variable.GROK_BASE_URL.md +1 -1
  71. package/data/packages/platform-intelligence/api/Variable.GROK_CONFIG_ENTRIES.md +14 -0
  72. package/data/packages/platform-intelligence/api/Variable.GoogleIntelligenceToolNames.md +34 -0
  73. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_API_KEY.md +1 -1
  74. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_BASE_URL.md +1 -1
  75. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_MAX_OUTPUT_TOKENS.md +1 -1
  76. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_MODEL.md +1 -1
  77. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_PROVIDER.md +1 -1
  78. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_TEMPERATURE.md +1 -1
  79. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_TOP_P.md +1 -1
  80. package/data/packages/platform-intelligence/api/Variable.OPENAI_API_KEY.md +1 -1
  81. package/data/packages/platform-intelligence/api/Variable.OPENAI_BASE_URL.md +1 -1
  82. package/data/packages/platform-intelligence/api/Variable.OPENAI_CONFIG_ENTRIES.md +14 -0
  83. package/data/packages/platform-intelligence/api/Variable.OpenAIIntelligenceToolNames.md +40 -0
  84. package/data/packages/platform-intelligence/api/Variable.PLATFORM_INTELLIGENCE_CONFIG_ENTRIES.md +1 -1
  85. package/data/packages/platform-intelligence/api/Variable.XAI_API_KEY.md +2 -2
  86. package/data/packages/platform-intelligence/api/Variable.XAI_BASE_URL.md +2 -2
  87. package/data/packages/platform-intelligence/api/index.md +64 -33
  88. package/data/packages/platform-intelligence/index.md +278 -69
  89. package/package.json +1 -1
  90. package/data/packages/platform-intelligence/api/Class.IntelligenceCapabilityRegistrarBase.md +0 -94
  91. package/data/packages/platform-intelligence/api/Class.IntelligenceCapabilityRegistry.md +0 -106
  92. package/data/packages/platform-intelligence/api/Function.loadProviderFactory.md +0 -31
  93. package/data/packages/platform-intelligence/api/Interface.IIntelligenceArtifact.md +0 -34
  94. package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapability.md +0 -71
  95. package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityMetadata.md +0 -70
  96. package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityPayload.md +0 -46
  97. package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityRegistry.md +0 -78
  98. package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityResult.md +0 -46
  99. package/data/packages/platform-intelligence/api/Interface.IIntelligenceContext.md +0 -72
  100. package/data/packages/platform-intelligence/api/Interface.IIntelligenceContextBuilder.md +0 -35
  101. package/data/packages/platform-intelligence/api/Interface.IIntelligenceConversationMessageSnapshot.md +0 -70
  102. package/data/packages/platform-intelligence/api/Interface.IIntelligenceConversationSnapshot.md +0 -58
  103. package/data/packages/platform-intelligence/api/Interface.IIntelligenceFollowUpQuestion.md +0 -46
  104. package/data/packages/platform-intelligence/api/Interface.IIntelligenceIntent.md +0 -46
  105. package/data/packages/platform-intelligence/api/Interface.IIntelligenceIntentEntity.md +0 -34
  106. package/data/packages/platform-intelligence/api/Interface.IIntelligenceMessageModel.md +0 -70
  107. package/data/packages/platform-intelligence/api/Interface.IIntelligenceMessagePayload.md +0 -34
  108. package/data/packages/platform-intelligence/api/Interface.IIntelligencePrompt.md +0 -34
  109. package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptMessage.md +0 -34
  110. package/data/packages/platform-intelligence/api/Interface.IIntelligenceResponseMessage.md +0 -34
  111. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceConversationMessageRole.md +0 -14
  112. package/data/packages/platform-intelligence/api/Variable.IntelligenceConversationMessageRoles.md +0 -26
@@ -8,7 +8,7 @@ editUrl: false
8
8
  Defined in: [health/IntelligenceHealthIndicator.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/health/IntelligenceHealthIndicator.ts#L17)
9
9
 
10
10
  Health indicator for the intelligence infrastructure.
11
- Verifies that at least one intelligence capability is registered.
11
+ Verifies that the intelligence provider configuration can be resolved.
12
12
 
13
13
  ## Implements
14
14
 
@@ -19,7 +19,7 @@ Verifies that at least one intelligence capability is registered.
19
19
  ### Constructor
20
20
 
21
21
  ```ts
22
- new IntelligenceHealthIndicator(registry?): IntelligenceHealthIndicator;
22
+ new IntelligenceHealthIndicator(textGenerator?): IntelligenceHealthIndicator;
23
23
  ```
24
24
 
25
25
  Defined in: [health/IntelligenceHealthIndicator.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/health/IntelligenceHealthIndicator.ts#L26)
@@ -28,7 +28,7 @@ Defined in: [health/IntelligenceHealthIndicator.ts:26](https://github.com/RueDeR
28
28
 
29
29
  | Parameter | Type |
30
30
  | ------ | ------ |
31
- | `registry?` | [`IntelligenceCapabilityRegistry`](Class.IntelligenceCapabilityRegistry) |
31
+ | `textGenerator?` | [`IntelligenceTextGenerator`](Class.IntelligenceTextGenerator) |
32
32
 
33
33
  #### Returns
34
34
 
@@ -62,8 +62,8 @@ check(): HealthIndicatorResult<string>;
62
62
 
63
63
  Defined in: [health/IntelligenceHealthIndicator.ts:47](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/health/IntelligenceHealthIndicator.ts#L47)
64
64
 
65
- Verifies that the capability registry contains at least one registered capability.
66
- Returns disabled status when no registry is configured.
65
+ Verifies that the provider configuration can be resolved.
66
+ Returns disabled status when no text generator is configured.
67
67
 
68
68
  #### Returns
69
69
 
@@ -5,9 +5,9 @@ editUrl: false
5
5
  ---
6
6
  # Class: IntelligenceModule
7
7
 
8
- Defined in: [IntelligenceModule.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceModule.ts#L21)
8
+ Defined in: [IntelligenceModule.ts:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceModule.ts#L45)
9
9
 
10
- Core module exposing the shared intelligence infrastructure to feature modules.
10
+ Core module exposing the shared intelligence infrastructure.
11
11
 
12
12
  ## Constructors
13
13
 
@@ -20,3 +20,27 @@ new IntelligenceModule(): IntelligenceModule;
20
20
  #### Returns
21
21
 
22
22
  `IntelligenceModule`
23
+
24
+ ## Methods
25
+
26
+ ### register()
27
+
28
+ ```ts
29
+ static register(options?): DynamicModule;
30
+ ```
31
+
32
+ Defined in: [IntelligenceModule.ts:56](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceModule.ts#L56)
33
+
34
+ Registers the intelligence module and optional class-based tools.
35
+
36
+ #### Parameters
37
+
38
+ | Parameter | Type | Description |
39
+ | ------ | ------ | ------ |
40
+ | `options` | [`IIntelligenceModuleOptions`](Interface.IIntelligenceModuleOptions) | Intelligence module configuration. |
41
+
42
+ #### Returns
43
+
44
+ `DynamicModule`
45
+
46
+ A configured dynamic module definition.
@@ -19,16 +19,23 @@ Executes text completions using the configured intelligence provider.
19
19
  ### Constructor
20
20
 
21
21
  ```ts
22
- new IntelligenceTextGenerator(configService): IntelligenceTextGenerator;
22
+ new IntelligenceTextGenerator(
23
+ configService,
24
+ toolRegistry,
25
+ providerLoaders,
26
+ validateOnModuleInit?): IntelligenceTextGenerator;
23
27
  ```
24
28
 
25
- Defined in: [IntelligenceTextGenerator.ts:67](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L67)
29
+ Defined in: [IntelligenceTextGenerator.ts:69](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L69)
26
30
 
27
31
  #### Parameters
28
32
 
29
- | Parameter | Type |
30
- | ------ | ------ |
31
- | `configService` | `ConfigService` |
33
+ | Parameter | Type | Default value |
34
+ | ------ | ------ | ------ |
35
+ | `configService` | `ConfigService` | `undefined` |
36
+ | `toolRegistry` | [`IntelligenceToolRegistry`](Class.IntelligenceToolRegistry) | `undefined` |
37
+ | `providerLoaders` | [`IntelligenceLanguageModelLoaders`](TypeAlias.IntelligenceLanguageModelLoaders) | `undefined` |
38
+ | `validateOnModuleInit` | `boolean` | `true` |
32
39
 
33
40
  #### Returns
34
41
 
@@ -42,7 +49,7 @@ Defined in: [IntelligenceTextGenerator.ts:67](https://github.com/RueDeRennes/arc
42
49
  generateText(prompt, options?): Promise<IIntelligenceTextCompletion>;
43
50
  ```
44
51
 
45
- Defined in: [IntelligenceTextGenerator.ts:99](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L99)
52
+ Defined in: [IntelligenceTextGenerator.ts:110](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L110)
46
53
 
47
54
  Generates a completion using the configured provider.
48
55
 
@@ -50,7 +57,7 @@ Generates a completion using the configured provider.
50
57
 
51
58
  | Parameter | Type | Description |
52
59
  | ------ | ------ | ------ |
53
- | `prompt` | [`IIntelligencePrompt`](Interface.IIntelligencePrompt) | The assembled prompt payload. |
60
+ | `prompt` | `Prompt` | The assembled prompt payload. |
54
61
  | `options?` | [`IIntelligenceTextGenerationOptions`](Interface.IIntelligenceTextGenerationOptions) | Optional overrides for the text generation request. |
55
62
 
56
63
  #### Returns
@@ -69,7 +76,7 @@ Generates a completion using the configured provider.
69
76
  getConfiguration(): IIntelligenceProviderConfiguration;
70
77
  ```
71
78
 
72
- Defined in: [IntelligenceTextGenerator.ts:206](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L206)
79
+ Defined in: [IntelligenceTextGenerator.ts:290](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L290)
73
80
 
74
81
  Returns the resolved provider configuration with the API key redacted.
75
82
 
@@ -89,7 +96,7 @@ Returns the resolved provider configuration with the API key redacted.
89
96
  onModuleInit(): void;
90
97
  ```
91
98
 
92
- Defined in: [IntelligenceTextGenerator.ts:86](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L86)
99
+ Defined in: [IntelligenceTextGenerator.ts:94](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L94)
93
100
 
94
101
  Eagerly resolves configuration at startup to fail fast on missing keys.
95
102
 
@@ -102,3 +109,30 @@ Eagerly resolves configuration at startup to fail fast on missing keys.
102
109
  ```ts
103
110
  OnModuleInit.onModuleInit
104
111
  ```
112
+
113
+ ***
114
+
115
+ ### streamText()
116
+
117
+ ```ts
118
+ streamText(prompt, options?): Promise<StreamTextResult<ToolSet, Output<string, string, never>>>;
119
+ ```
120
+
121
+ Defined in: [IntelligenceTextGenerator.ts:216](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L216)
122
+
123
+ Streams a completion using the configured provider.
124
+
125
+ #### Parameters
126
+
127
+ | Parameter | Type | Description |
128
+ | ------ | ------ | ------ |
129
+ | `prompt` | `Prompt` | The assembled prompt payload. |
130
+ | `options?` | [`IIntelligenceTextStreamingOptions`](Interface.IIntelligenceTextStreamingOptions) | Optional overrides for the streaming request. |
131
+
132
+ #### Returns
133
+
134
+ `Promise`\<`StreamTextResult`\<`ToolSet`, `Output`\<`string`, `string`, `never`\>\>\>
135
+
136
+ #### Implementation of
137
+
138
+ [`IIntelligenceTextGenerator`](Interface.IIntelligenceTextGenerator).[`streamText`](Interface.IIntelligenceTextGenerator#streamtext)
@@ -0,0 +1,93 @@
1
+ ---
2
+ title: 'Abstract Class: IntelligenceToolBase\<_TInput, _TOutput\>'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Abstract Class: IntelligenceToolBase\<_TInput, _TOutput\>
7
+
8
+ Defined in: [abstracts/IntelligenceToolBase.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/abstracts/IntelligenceToolBase.ts#L39)
9
+
10
+ Base class for class-based AI SDK tools.
11
+
12
+ Archipel keeps tool registration object-oriented while leaving the actual tool
13
+ definition fully owned by the AI SDK. Concrete tools expose a stable registry
14
+ name and return a native Tool definition, which may be created with
15
+ `tool()`, provider-defined tool factories, or any other AI SDK-supported API.
16
+
17
+ ## Example
18
+
19
+ ```typescript
20
+ export class CustomerSearchTool extends IntelligenceToolBase<ICustomerSearchInput, ICustomerSearchResult> {
21
+ public override get name(): string {
22
+ return 'searchCustomers';
23
+ }
24
+
25
+ public override get tool(): Tool<ICustomerSearchInput, ICustomerSearchResult> {
26
+ return tool({
27
+ description: 'Searches customers by name, email, or company.',
28
+ inputSchema: z.object({
29
+ query: z.string().describe('Customer search query'),
30
+ }),
31
+ execute: async (input) => this._customerService.search(input.query),
32
+ });
33
+ }
34
+ }
35
+ ```
36
+
37
+ ## Type Parameters
38
+
39
+ | Type Parameter | Default type | Description |
40
+ | ------ | ------ | ------ |
41
+ | `_TInput` | `unknown` | The input type accepted by the AI SDK tool. |
42
+ | `_TOutput` | `unknown` | The output type produced by the AI SDK tool. |
43
+
44
+ ## Constructors
45
+
46
+ ### Constructor
47
+
48
+ ```ts
49
+ new IntelligenceToolBase<_TInput, _TOutput>(): IntelligenceToolBase<_TInput, _TOutput>;
50
+ ```
51
+
52
+ #### Returns
53
+
54
+ `IntelligenceToolBase`\<`_TInput`, `_TOutput`\>
55
+
56
+ ## Accessors
57
+
58
+ ### name
59
+
60
+ #### Get Signature
61
+
62
+ ```ts
63
+ get abstract name(): string;
64
+ ```
65
+
66
+ Defined in: [abstracts/IntelligenceToolBase.ts:59](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/abstracts/IntelligenceToolBase.ts#L59)
67
+
68
+ Gets the unique registry name for the tool.
69
+
70
+ The name becomes the key in the AI SDK tool set passed to `generateText()`
71
+ or `streamText()`.
72
+
73
+ ##### Returns
74
+
75
+ `string`
76
+
77
+ ***
78
+
79
+ ### tool
80
+
81
+ #### Get Signature
82
+
83
+ ```ts
84
+ get abstract tool(): Tool<_TInput, _TOutput>;
85
+ ```
86
+
87
+ Defined in: [abstracts/IntelligenceToolBase.ts:67](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/abstracts/IntelligenceToolBase.ts#L67)
88
+
89
+ Gets the native AI SDK tool definition.
90
+
91
+ ##### Returns
92
+
93
+ `Tool`\<`_TInput`, `_TOutput`\>
@@ -0,0 +1,217 @@
1
+ ---
2
+ title: 'Class: IntelligenceToolRegistry'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Class: IntelligenceToolRegistry
7
+
8
+ Defined in: [IntelligenceToolRegistry.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceToolRegistry.ts#L20)
9
+
10
+ Registry for class-based intelligence tools.
11
+
12
+ The registry keeps the Archipel side class-based while exposing tools as a
13
+ native AI SDK `ToolSet` for `generateText()` and `streamText()`.
14
+
15
+ ## Implements
16
+
17
+ - [`IIntelligenceToolRegistry`](Interface.IIntelligenceToolRegistry)
18
+
19
+ ## Constructors
20
+
21
+ ### Constructor
22
+
23
+ ```ts
24
+ new IntelligenceToolRegistry(): IntelligenceToolRegistry;
25
+ ```
26
+
27
+ #### Returns
28
+
29
+ `IntelligenceToolRegistry`
30
+
31
+ ## Accessors
32
+
33
+ ### count
34
+
35
+ #### Get Signature
36
+
37
+ ```ts
38
+ get count(): number;
39
+ ```
40
+
41
+ Defined in: [IntelligenceToolRegistry.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceToolRegistry.ts#L41)
42
+
43
+ Gets the number of registered tools.
44
+
45
+ ##### Returns
46
+
47
+ `number`
48
+
49
+ Gets the number of registered tools.
50
+
51
+ #### Implementation of
52
+
53
+ [`IIntelligenceToolRegistry`](Interface.IIntelligenceToolRegistry).[`count`](Interface.IIntelligenceToolRegistry#count)
54
+
55
+ ## Methods
56
+
57
+ ### get()
58
+
59
+ ```ts
60
+ get(name): IIntelligenceTool | undefined;
61
+ ```
62
+
63
+ Defined in: [IntelligenceToolRegistry.ts:85](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceToolRegistry.ts#L85)
64
+
65
+ Gets a tool by name.
66
+
67
+ #### Parameters
68
+
69
+ | Parameter | Type | Description |
70
+ | ------ | ------ | ------ |
71
+ | `name` | `string` | The name of the tool to retrieve. |
72
+
73
+ #### Returns
74
+
75
+ [`IIntelligenceTool`](Interface.IIntelligenceTool) \| `undefined`
76
+
77
+ The tool instance, or `undefined` if not found.
78
+
79
+ #### Implementation of
80
+
81
+ [`IIntelligenceToolRegistry`](Interface.IIntelligenceToolRegistry).[`get`](Interface.IIntelligenceToolRegistry#get)
82
+
83
+ ***
84
+
85
+ ### has()
86
+
87
+ ```ts
88
+ has(name): boolean;
89
+ ```
90
+
91
+ Defined in: [IntelligenceToolRegistry.ts:97](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceToolRegistry.ts#L97)
92
+
93
+ Checks whether a tool with the given name is registered.
94
+
95
+ #### Parameters
96
+
97
+ | Parameter | Type | Description |
98
+ | ------ | ------ | ------ |
99
+ | `name` | `string` | The tool name to check. |
100
+
101
+ #### Returns
102
+
103
+ `boolean`
104
+
105
+ `true` if the tool exists; otherwise `false`.
106
+
107
+ #### Implementation of
108
+
109
+ [`IIntelligenceToolRegistry`](Interface.IIntelligenceToolRegistry).[`has`](Interface.IIntelligenceToolRegistry#has)
110
+
111
+ ***
112
+
113
+ ### list()
114
+
115
+ ```ts
116
+ list(): readonly IIntelligenceTool[];
117
+ ```
118
+
119
+ Defined in: [IntelligenceToolRegistry.ts:107](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceToolRegistry.ts#L107)
120
+
121
+ Returns all registered tools as a readonly array.
122
+
123
+ #### Returns
124
+
125
+ readonly [`IIntelligenceTool`](Interface.IIntelligenceTool)[]
126
+
127
+ Array of all registered tool instances.
128
+
129
+ #### Implementation of
130
+
131
+ [`IIntelligenceToolRegistry`](Interface.IIntelligenceToolRegistry).[`list`](Interface.IIntelligenceToolRegistry#list)
132
+
133
+ ***
134
+
135
+ ### listNames()
136
+
137
+ ```ts
138
+ listNames(): readonly string[];
139
+ ```
140
+
141
+ Defined in: [IntelligenceToolRegistry.ts:117](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceToolRegistry.ts#L117)
142
+
143
+ Returns all registered tool names.
144
+
145
+ #### Returns
146
+
147
+ readonly `string`[]
148
+
149
+ Array of tool names.
150
+
151
+ #### Implementation of
152
+
153
+ [`IIntelligenceToolRegistry`](Interface.IIntelligenceToolRegistry).[`listNames`](Interface.IIntelligenceToolRegistry#listnames)
154
+
155
+ ***
156
+
157
+ ### register()
158
+
159
+ ```ts
160
+ register(tool): void;
161
+ ```
162
+
163
+ Defined in: [IntelligenceToolRegistry.ts:58](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceToolRegistry.ts#L58)
164
+
165
+ Registers a tool with the registry.
166
+
167
+ Tools with duplicate names replace the existing registration.
168
+
169
+ #### Parameters
170
+
171
+ | Parameter | Type | Description |
172
+ | ------ | ------ | ------ |
173
+ | `tool` | [`IIntelligenceTool`](Interface.IIntelligenceTool) | The tool instance to register. |
174
+
175
+ #### Returns
176
+
177
+ `void`
178
+
179
+ #### Implementation of
180
+
181
+ [`IIntelligenceToolRegistry`](Interface.IIntelligenceToolRegistry).[`register`](Interface.IIntelligenceToolRegistry#register)
182
+
183
+ ***
184
+
185
+ ### toToolSet()
186
+
187
+ ```ts
188
+ toToolSet(): ToolSet;
189
+ ```
190
+
191
+ Defined in: [IntelligenceToolRegistry.ts:140](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceToolRegistry.ts#L140)
192
+
193
+ Converts all registered tools to the AI SDK's native tool set format.
194
+
195
+ This record can be passed directly to `generateText()` or `streamText()`
196
+ as the `tools` parameter.
197
+
198
+ #### Returns
199
+
200
+ `ToolSet`
201
+
202
+ A record mapping tool names to Tool definitions.
203
+
204
+ #### Example
205
+
206
+ ```typescript
207
+ const tools = registry.toToolSet();
208
+ const result = await generateText({
209
+ model: openai('gpt-4o'),
210
+ tools,
211
+ prompt: 'Find user John Doe',
212
+ });
213
+ ```
214
+
215
+ #### Implementation of
216
+
217
+ [`IIntelligenceToolRegistry`](Interface.IIntelligenceToolRegistry).[`toToolSet`](Interface.IIntelligenceToolRegistry#totoolset)
@@ -0,0 +1,26 @@
1
+ ---
2
+ title: 'Function: createAnthropicAdvisor20260301Tool()'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Function: createAnthropicAdvisor20260301Tool()
7
+
8
+ ```ts
9
+ function createAnthropicAdvisor20260301Tool(options): IIntelligenceTool;
10
+ ```
11
+
12
+ Defined in: [providers/anthropic/tools/createAnthropicAdvisor20260301Tool.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/anthropic/tools/createAnthropicAdvisor20260301Tool.ts#L18)
13
+
14
+ Creates an Anthropic advisor tool registration.
15
+
16
+ ## Parameters
17
+
18
+ | Parameter | Type | Description |
19
+ | ------ | ------ | ------ |
20
+ | `options` | \{ \} & \{ \} | Anthropic advisor tool options. |
21
+
22
+ ## Returns
23
+
24
+ [`IIntelligenceTool`](Interface.IIntelligenceTool)
25
+
26
+ Tool registration compatible with the intelligence tool registry.
@@ -0,0 +1,26 @@
1
+ ---
2
+ title: 'Function: createAnthropicBash20241022Tool()'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Function: createAnthropicBash20241022Tool()
7
+
8
+ ```ts
9
+ function createAnthropicBash20241022Tool(options?): IIntelligenceTool;
10
+ ```
11
+
12
+ Defined in: [providers/anthropic/tools/createAnthropicBash20241022Tool.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/anthropic/tools/createAnthropicBash20241022Tool.ts#L18)
13
+
14
+ Creates an Anthropic bash tool registration for the 2024-10-22 version.
15
+
16
+ ## Parameters
17
+
18
+ | Parameter | Type | Description |
19
+ | ------ | ------ | ------ |
20
+ | `options` | \{ \} | Anthropic bash tool options. |
21
+
22
+ ## Returns
23
+
24
+ [`IIntelligenceTool`](Interface.IIntelligenceTool)
25
+
26
+ Tool registration compatible with the intelligence tool registry.
@@ -0,0 +1,26 @@
1
+ ---
2
+ title: 'Function: createAnthropicBash20250124Tool()'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Function: createAnthropicBash20250124Tool()
7
+
8
+ ```ts
9
+ function createAnthropicBash20250124Tool(options?): IIntelligenceTool;
10
+ ```
11
+
12
+ Defined in: [providers/anthropic/tools/createAnthropicBash20250124Tool.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/anthropic/tools/createAnthropicBash20250124Tool.ts#L18)
13
+
14
+ Creates an Anthropic bash tool registration for the 2025-01-24 version.
15
+
16
+ ## Parameters
17
+
18
+ | Parameter | Type | Description |
19
+ | ------ | ------ | ------ |
20
+ | `options` | \{ \} | Anthropic bash tool options. |
21
+
22
+ ## Returns
23
+
24
+ [`IIntelligenceTool`](Interface.IIntelligenceTool)
25
+
26
+ Tool registration compatible with the intelligence tool registry.
@@ -0,0 +1,26 @@
1
+ ---
2
+ title: 'Function: createAnthropicCodeExecution20250522Tool()'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Function: createAnthropicCodeExecution20250522Tool()
7
+
8
+ ```ts
9
+ function createAnthropicCodeExecution20250522Tool(options?): IIntelligenceTool;
10
+ ```
11
+
12
+ Defined in: [providers/anthropic/tools/createAnthropicCodeExecution20250522Tool.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/anthropic/tools/createAnthropicCodeExecution20250522Tool.ts#L18)
13
+
14
+ Creates an Anthropic code-execution tool registration for the 2025-05-22 version.
15
+
16
+ ## Parameters
17
+
18
+ | Parameter | Type | Description |
19
+ | ------ | ------ | ------ |
20
+ | `options` | \| \{ \} \| `undefined` | Anthropic code-execution tool options. |
21
+
22
+ ## Returns
23
+
24
+ [`IIntelligenceTool`](Interface.IIntelligenceTool)
25
+
26
+ Tool registration compatible with the intelligence tool registry.
@@ -0,0 +1,26 @@
1
+ ---
2
+ title: 'Function: createAnthropicCodeExecution20250825Tool()'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Function: createAnthropicCodeExecution20250825Tool()
7
+
8
+ ```ts
9
+ function createAnthropicCodeExecution20250825Tool(options?): IIntelligenceTool;
10
+ ```
11
+
12
+ Defined in: [providers/anthropic/tools/createAnthropicCodeExecution20250825Tool.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/anthropic/tools/createAnthropicCodeExecution20250825Tool.ts#L18)
13
+
14
+ Creates an Anthropic code-execution tool registration for the 2025-08-25 version.
15
+
16
+ ## Parameters
17
+
18
+ | Parameter | Type | Description |
19
+ | ------ | ------ | ------ |
20
+ | `options` | \| \{ \} \| `undefined` | Anthropic code-execution tool options. |
21
+
22
+ ## Returns
23
+
24
+ [`IIntelligenceTool`](Interface.IIntelligenceTool)
25
+
26
+ Tool registration compatible with the intelligence tool registry.
@@ -0,0 +1,26 @@
1
+ ---
2
+ title: 'Function: createAnthropicCodeExecution20260120Tool()'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Function: createAnthropicCodeExecution20260120Tool()
7
+
8
+ ```ts
9
+ function createAnthropicCodeExecution20260120Tool(options?): IIntelligenceTool;
10
+ ```
11
+
12
+ Defined in: [providers/anthropic/tools/createAnthropicCodeExecution20260120Tool.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/anthropic/tools/createAnthropicCodeExecution20260120Tool.ts#L18)
13
+
14
+ Creates an Anthropic code-execution tool registration for the 2026-01-20 version.
15
+
16
+ ## Parameters
17
+
18
+ | Parameter | Type | Description |
19
+ | ------ | ------ | ------ |
20
+ | `options` | \| \{ \} \| `undefined` | Anthropic code-execution tool options. |
21
+
22
+ ## Returns
23
+
24
+ [`IIntelligenceTool`](Interface.IIntelligenceTool)
25
+
26
+ Tool registration compatible with the intelligence tool registry.
@@ -0,0 +1,26 @@
1
+ ---
2
+ title: 'Function: createAnthropicComputer20241022Tool()'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Function: createAnthropicComputer20241022Tool()
7
+
8
+ ```ts
9
+ function createAnthropicComputer20241022Tool(options): IIntelligenceTool;
10
+ ```
11
+
12
+ Defined in: [providers/anthropic/tools/createAnthropicComputer20241022Tool.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/anthropic/tools/createAnthropicComputer20241022Tool.ts#L18)
13
+
14
+ Creates an Anthropic computer-use tool registration for the 2024-10-22 version.
15
+
16
+ ## Parameters
17
+
18
+ | Parameter | Type | Description |
19
+ | ------ | ------ | ------ |
20
+ | `options` | \{ \} & \{ \} | Anthropic computer-use tool options. |
21
+
22
+ ## Returns
23
+
24
+ [`IIntelligenceTool`](Interface.IIntelligenceTool)
25
+
26
+ Tool registration compatible with the intelligence tool registry.