@breadstone/archipel-mcp 0.0.44 → 0.0.45

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 (13) hide show
  1. package/data/guides/ai-text-generation.md +6 -5
  2. package/data/packages/platform-intelligence/api/Function.createGrokCodeExecutionTool.md +26 -0
  3. package/data/packages/platform-intelligence/api/Function.createGrokFileSearchTool.md +26 -0
  4. package/data/packages/platform-intelligence/api/Function.createGrokMcpServerTool.md +26 -0
  5. package/data/packages/platform-intelligence/api/Function.createGrokViewImageTool.md +26 -0
  6. package/data/packages/platform-intelligence/api/Function.createGrokViewXVideoTool.md +26 -0
  7. package/data/packages/platform-intelligence/api/Function.createGrokWebSearchTool.md +26 -0
  8. package/data/packages/platform-intelligence/api/Function.createGrokXSearchTool.md +26 -0
  9. package/data/packages/platform-intelligence/api/Function.loadGrokLanguageModel.md +1 -1
  10. package/data/packages/platform-intelligence/api/Variable.GrokIntelligenceToolNames.md +34 -0
  11. package/data/packages/platform-intelligence/api/index.md +9 -1
  12. package/data/packages/platform-intelligence/index.md +3 -1
  13. package/package.json +1 -1
package/data/guides/ai-text-generation.md CHANGED
@@ -23,14 +23,15 @@ Install the AI SDK provider package for the model you want to use:
23
23
  | **OpenAI** | `@ai-sdk/openai` |
24
24
  | **Anthropic** | `@ai-sdk/anthropic` |
25
25
  | **Google** | `@ai-sdk/google` |
26
- | **Grok (xAI)** | `@ai-sdk/openai` |
26
+ | **Grok (xAI)** | `@ai-sdk/xai` |
27
27
 
28
28
  ```bash
29
29
  # Example: OpenAI
30
30
  yarn add @ai-sdk/openai
31
- ```
32
31
 
33
- > Grok uses the OpenAI-compatible endpoint, so it shares the `@ai-sdk/openai` package.
32
+ # Example: Grok / xAI
33
+ yarn add @ai-sdk/xai
34
+ ```
34
35
 
35
36
  ---
36
37
 
@@ -80,7 +81,7 @@ INTELLIGENCE_BASE_URL= # optional — override for custom endpoints
80
81
  | `openai` | `gpt-4o-mini` | OpenAI API |
81
82
  | `anthropic` | `claude-sonnet-4-20250514` | Anthropic API |
82
83
  | `google` | `gemini-2.0-flash` | Google Gemini API |
83
- | `grok` | `grok-3-mini-fast` | xAI Grok via OpenAI-compatible API |
84
+ | `grok` | `grok-3-mini` | xAI Grok API |
84
85
 
85
86
  Each provider resolves its API key and base URL from dedicated environment variables when the generic `INTELLIGENCE_API_KEY` is not set:
86
87
 
@@ -259,7 +260,7 @@ import { createOpenAIWebSearchTool } from '@breadstone/archipel-platform-intelli
259
260
  export class SearchModule {}
260
261
  ```
261
262
 
262
- OpenAI, Google, and Anthropic provider subpaths expose wrappers for their built-in web search, file search, code execution, URL context, shell, MCP, and versioned tool families where supported by the underlying SDK.
263
+ OpenAI, Google, Anthropic, and Grok provider subpaths expose wrappers for their built-in web search, file search, code execution, URL context, shell, MCP, X search, image/video understanding, and versioned tool families where supported by the underlying SDK.
263
264
 
264
265
  ### Native AI SDK Passthrough
265
266
 
package/data/packages/platform-intelligence/api/Function.createGrokCodeExecutionTool.md ADDED
@@ -0,0 +1,26 @@
1
+ ---
2
+ title: 'Function: createGrokCodeExecutionTool()'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Function: createGrokCodeExecutionTool()
7
+
8
+ ```ts
9
+ function createGrokCodeExecutionTool(options?): IIntelligenceTool;
10
+ ```
11
+
12
+ Defined in: [providers/grok/tools/createGrokCodeExecutionTool.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/grok/tools/createGrokCodeExecutionTool.ts#L18)
13
+
14
+ Creates a Grok code-execution tool registration.
15
+
16
+ ## Parameters
17
+
18
+ | Parameter | Type | Description |
19
+ | ------ | ------ | ------ |
20
+ | `options` | \| `object` & \{ \} \| `undefined` | Grok code-execution tool options. |
21
+
22
+ ## Returns
23
+
24
+ [`IIntelligenceTool`](Interface.IIntelligenceTool)
25
+
26
+ Tool registration compatible with the intelligence tool registry.
package/data/packages/platform-intelligence/api/Function.createGrokFileSearchTool.md ADDED
@@ -0,0 +1,26 @@
1
+ ---
2
+ title: 'Function: createGrokFileSearchTool()'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Function: createGrokFileSearchTool()
7
+
8
+ ```ts
9
+ function createGrokFileSearchTool(options): IIntelligenceTool;
10
+ ```
11
+
12
+ Defined in: [providers/grok/tools/createGrokFileSearchTool.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/grok/tools/createGrokFileSearchTool.ts#L18)
13
+
14
+ Creates a Grok file-search tool registration.
15
+
16
+ ## Parameters
17
+
18
+ | Parameter | Type | Description |
19
+ | ------ | ------ | ------ |
20
+ | `options` | \{ \} & \{ \} | Grok file-search tool options. |
21
+
22
+ ## Returns
23
+
24
+ [`IIntelligenceTool`](Interface.IIntelligenceTool)
25
+
26
+ Tool registration compatible with the intelligence tool registry.
package/data/packages/platform-intelligence/api/Function.createGrokMcpServerTool.md ADDED
@@ -0,0 +1,26 @@
1
+ ---
2
+ title: 'Function: createGrokMcpServerTool()'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Function: createGrokMcpServerTool()
7
+
8
+ ```ts
9
+ function createGrokMcpServerTool(options): IIntelligenceTool;
10
+ ```
11
+
12
+ Defined in: [providers/grok/tools/createGrokMcpServerTool.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/grok/tools/createGrokMcpServerTool.ts#L18)
13
+
14
+ Creates a Grok MCP server tool registration.
15
+
16
+ ## Parameters
17
+
18
+ | Parameter | Type | Description |
19
+ | ------ | ------ | ------ |
20
+ | `options` | \{ \} & \{ \} | Grok MCP server tool options. |
21
+
22
+ ## Returns
23
+
24
+ [`IIntelligenceTool`](Interface.IIntelligenceTool)
25
+
26
+ Tool registration compatible with the intelligence tool registry.
package/data/packages/platform-intelligence/api/Function.createGrokViewImageTool.md ADDED
@@ -0,0 +1,26 @@
1
+ ---
2
+ title: 'Function: createGrokViewImageTool()'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Function: createGrokViewImageTool()
7
+
8
+ ```ts
9
+ function createGrokViewImageTool(options?): IIntelligenceTool;
10
+ ```
11
+
12
+ Defined in: [providers/grok/tools/createGrokViewImageTool.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/grok/tools/createGrokViewImageTool.ts#L18)
13
+
14
+ Creates a Grok image-understanding tool registration.
15
+
16
+ ## Parameters
17
+
18
+ | Parameter | Type | Description |
19
+ | ------ | ------ | ------ |
20
+ | `options` | \| `object` & \{ \} \| `undefined` | Grok image-understanding tool options. |
21
+
22
+ ## Returns
23
+
24
+ [`IIntelligenceTool`](Interface.IIntelligenceTool)
25
+
26
+ Tool registration compatible with the intelligence tool registry.
package/data/packages/platform-intelligence/api/Function.createGrokViewXVideoTool.md ADDED
@@ -0,0 +1,26 @@
1
+ ---
2
+ title: 'Function: createGrokViewXVideoTool()'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Function: createGrokViewXVideoTool()
7
+
8
+ ```ts
9
+ function createGrokViewXVideoTool(options?): IIntelligenceTool;
10
+ ```
11
+
12
+ Defined in: [providers/grok/tools/createGrokViewXVideoTool.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/grok/tools/createGrokViewXVideoTool.ts#L18)
13
+
14
+ Creates a Grok X-video understanding tool registration.
15
+
16
+ ## Parameters
17
+
18
+ | Parameter | Type | Description |
19
+ | ------ | ------ | ------ |
20
+ | `options` | \| `object` & \{ \} \| `undefined` | Grok X-video understanding tool options. |
21
+
22
+ ## Returns
23
+
24
+ [`IIntelligenceTool`](Interface.IIntelligenceTool)
25
+
26
+ Tool registration compatible with the intelligence tool registry.
package/data/packages/platform-intelligence/api/Function.createGrokWebSearchTool.md ADDED
@@ -0,0 +1,26 @@
1
+ ---
2
+ title: 'Function: createGrokWebSearchTool()'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Function: createGrokWebSearchTool()
7
+
8
+ ```ts
9
+ function createGrokWebSearchTool(options?): IIntelligenceTool;
10
+ ```
11
+
12
+ Defined in: [providers/grok/tools/createGrokWebSearchTool.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/grok/tools/createGrokWebSearchTool.ts#L18)
13
+
14
+ Creates a Grok web-search tool registration.
15
+
16
+ ## Parameters
17
+
18
+ | Parameter | Type | Description |
19
+ | ------ | ------ | ------ |
20
+ | `options` | \| \{ \} & \{ \} \| `undefined` | Grok web-search tool options. |
21
+
22
+ ## Returns
23
+
24
+ [`IIntelligenceTool`](Interface.IIntelligenceTool)
25
+
26
+ Tool registration compatible with the intelligence tool registry.
package/data/packages/platform-intelligence/api/Function.createGrokXSearchTool.md ADDED
@@ -0,0 +1,26 @@
1
+ ---
2
+ title: 'Function: createGrokXSearchTool()'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Function: createGrokXSearchTool()
7
+
8
+ ```ts
9
+ function createGrokXSearchTool(options?): IIntelligenceTool;
10
+ ```
11
+
12
+ Defined in: [providers/grok/tools/createGrokXSearchTool.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/grok/tools/createGrokXSearchTool.ts#L18)
13
+
14
+ Creates a Grok X-search tool registration.
15
+
16
+ ## Parameters
17
+
18
+ | Parameter | Type | Description |
19
+ | ------ | ------ | ------ |
20
+ | `options` | \| \{ \} & \{ \} \| `undefined` | Grok X-search tool options. |
21
+
22
+ ## Returns
23
+
24
+ [`IIntelligenceTool`](Interface.IIntelligenceTool)
25
+
26
+ Tool registration compatible with the intelligence tool registry.
package/data/packages/platform-intelligence/api/Function.loadGrokLanguageModel.md CHANGED
@@ -11,7 +11,7 @@ function loadGrokLanguageModel(configuration): LanguageModelV3;
11
11
 
12
12
  Defined in: [providers/grok/loadGrokLanguageModel.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/grok/loadGrokLanguageModel.ts#L17)
13
13
 
14
- Creates the Grok language model through the OpenAI-compatible xAI endpoint.
14
+ Creates the Grok language model through the native xAI provider.
15
15
 
16
16
  ## Parameters
17
17
 
package/data/packages/platform-intelligence/api/Variable.GrokIntelligenceToolNames.md ADDED
@@ -0,0 +1,34 @@
1
+ ---
2
+ title: 'Variable: GrokIntelligenceToolNames'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Variable: GrokIntelligenceToolNames
7
+
8
+ ```ts
9
+ const GrokIntelligenceToolNames: {
10
+ CodeExecution: "code_execution";
11
+ FileSearch: "file_search";
12
+ Mcp: "mcp";
13
+ ViewImage: "view_image";
14
+ ViewXVideo: "view_x_video";
15
+ WebSearch: "web_search";
16
+ XSearch: "x_search";
17
+ };
18
+ ```
19
+
20
+ Defined in: [providers/grok/GrokIntelligenceToolNames.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/grok/GrokIntelligenceToolNames.ts#L6)
21
+
22
+ Grok provider-defined tool names exposed through Archipel.
23
+
24
+ ## Type Declaration
25
+
26
+ | Name | Type | Default value | Defined in |
27
+ | ------ | ------ | ------ | ------ |
28
+ | <a id="property-codeexecution"></a> `CodeExecution` | `"code_execution"` | `'code_execution'` | [providers/grok/GrokIntelligenceToolNames.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/grok/GrokIntelligenceToolNames.ts#L7) |
29
+ | <a id="property-filesearch"></a> `FileSearch` | `"file_search"` | `'file_search'` | [providers/grok/GrokIntelligenceToolNames.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/grok/GrokIntelligenceToolNames.ts#L8) |
30
+ | <a id="property-mcp"></a> `Mcp` | `"mcp"` | `'mcp'` | [providers/grok/GrokIntelligenceToolNames.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/grok/GrokIntelligenceToolNames.ts#L9) |
31
+ | <a id="property-viewimage"></a> `ViewImage` | `"view_image"` | `'view_image'` | [providers/grok/GrokIntelligenceToolNames.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/grok/GrokIntelligenceToolNames.ts#L10) |
32
+ | <a id="property-viewxvideo"></a> `ViewXVideo` | `"view_x_video"` | `'view_x_video'` | [providers/grok/GrokIntelligenceToolNames.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/grok/GrokIntelligenceToolNames.ts#L11) |
33
+ | <a id="property-websearch"></a> `WebSearch` | `"web_search"` | `'web_search'` | [providers/grok/GrokIntelligenceToolNames.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/grok/GrokIntelligenceToolNames.ts#L12) |
34
+ | <a id="property-xsearch"></a> `XSearch` | `"x_search"` | `'x_search'` | [providers/grok/GrokIntelligenceToolNames.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/grok/GrokIntelligenceToolNames.ts#L13) |
package/data/packages/platform-intelligence/api/index.md CHANGED
@@ -57,6 +57,7 @@ editUrl: false
57
57
  | [GROK\_API\_KEY](Variable.GROK_API_KEY) | Grok-specific API key. |
58
58
  | [GROK\_BASE\_URL](Variable.GROK_BASE_URL) | Grok-specific base URL. |
59
59
  | [GROK\_CONFIG\_ENTRIES](Variable.GROK_CONFIG_ENTRIES) | Configuration entries used by the Grok intelligence provider. |
60
+ | [GrokIntelligenceToolNames](Variable.GrokIntelligenceToolNames) | Grok provider-defined tool names exposed through Archipel. |
60
61
  | [INTELLIGENCE\_API\_KEY](Variable.INTELLIGENCE_API_KEY) | Global API key override for the intelligence provider. |
61
62
  | [INTELLIGENCE\_BASE\_URL](Variable.INTELLIGENCE_BASE_URL) | Global base URL override for the intelligence provider. |
62
63
  | [INTELLIGENCE\_MAX\_OUTPUT\_TOKENS](Variable.INTELLIGENCE_MAX_OUTPUT_TOKENS) | Maximum number of output tokens for the AI model. |
@@ -104,6 +105,13 @@ editUrl: false
104
105
  | [createGoogleGoogleSearchTool](Function.createGoogleGoogleSearchTool) | Creates a Google Search grounding tool registration. |
105
106
  | [createGoogleUrlContextTool](Function.createGoogleUrlContextTool) | Creates a Google URL context tool registration. |
106
107
  | [createGoogleVertexRagStoreTool](Function.createGoogleVertexRagStoreTool) | Creates a Google Vertex RAG Store tool registration. |
108
+ | [createGrokCodeExecutionTool](Function.createGrokCodeExecutionTool) | Creates a Grok code-execution tool registration. |
109
+ | [createGrokFileSearchTool](Function.createGrokFileSearchTool) | Creates a Grok file-search tool registration. |
110
+ | [createGrokMcpServerTool](Function.createGrokMcpServerTool) | Creates a Grok MCP server tool registration. |
111
+ | [createGrokViewImageTool](Function.createGrokViewImageTool) | Creates a Grok image-understanding tool registration. |
112
+ | [createGrokViewXVideoTool](Function.createGrokViewXVideoTool) | Creates a Grok X-video understanding tool registration. |
113
+ | [createGrokWebSearchTool](Function.createGrokWebSearchTool) | Creates a Grok web-search tool registration. |
114
+ | [createGrokXSearchTool](Function.createGrokXSearchTool) | Creates a Grok X-search tool registration. |
107
115
  | [createIntelligenceTool](Function.createIntelligenceTool) | Adapts a native AI SDK tool to the Archipel intelligence tool schema. |
108
116
  | [createOpenAIApplyPatchTool](Function.createOpenAIApplyPatchTool) | Creates an OpenAI apply-patch tool registration. |
109
117
  | [createOpenAICodeInterpreterTool](Function.createOpenAICodeInterpreterTool) | Creates an OpenAI code-interpreter tool registration. |
@@ -119,5 +127,5 @@ editUrl: false
119
127
  | [createProviderOptions](Function.createProviderOptions) | Creates the provider options object consumed by the AI SDK model factories. |
120
128
  | [loadAnthropicLanguageModel](Function.loadAnthropicLanguageModel) | Creates the Anthropic language model from the resolved provider configuration. |
121
129
  | [loadGoogleLanguageModel](Function.loadGoogleLanguageModel) | Creates the Google Gemini language model from the resolved provider configuration. |
122
- | [loadGrokLanguageModel](Function.loadGrokLanguageModel) | Creates the Grok language model through the OpenAI-compatible xAI endpoint. |
130
+ | [loadGrokLanguageModel](Function.loadGrokLanguageModel) | Creates the Grok language model through the native xAI provider. |
123
131
  | [loadOpenAILanguageModel](Function.loadOpenAILanguageModel) | Creates the OpenAI language model from the resolved provider configuration. |
package/data/packages/platform-intelligence/index.md CHANGED
@@ -46,6 +46,8 @@ Import only the providers you need:
46
46
  | Google | `@breadstone/archipel-platform-intelligence/providers/google` |
47
47
  | Grok | `@breadstone/archipel-platform-intelligence/providers/grok` |
48
48
 
49
+ Provider-native tool wrappers are exported through matching `/tools` subpaths, for example `@breadstone/archipel-platform-intelligence/providers/grok/tools`.
50
+
49
51
  ---
50
52
 
51
53
  ## Tool Registration
@@ -120,7 +122,7 @@ import { createOpenAIWebSearchTool } from '@breadstone/archipel-platform-intelli
120
122
  export class AppModule {}
121
123
  ```
122
124
 
123
- Provider-native wrappers cover OpenAI web search, file search, code interpreter, image generation, shell, MCP, and tool search; Google Search, Enterprise Web Search, URL Context, Code Execution, File Search, Maps, and Vertex RAG Store; and versioned Anthropic web search, web fetch, code execution, bash, text editor, computer, memory, tool search, and advisor tools.
125
+ Provider-native wrappers cover OpenAI web search, file search, code interpreter, image generation, shell, MCP, and tool search; Google Search, Enterprise Web Search, URL Context, Code Execution, File Search, Maps, and Vertex RAG Store; versioned Anthropic web search, web fetch, code execution, bash, text editor, computer, memory, tool search, and advisor tools; and Grok web search, X search, file search, code execution, MCP, image understanding, and X-video understanding.
124
126
 
125
127
  The detailed AI text generation guide includes OpenAI recipes for spreadsheet analysis with Code Interpreter, image generation with generated files, deferred tool loading via Tool Search, and grammar-constrained custom tools. In the currently installed OpenAI SDK, `customTool()` constrains provider output but does not run a local `execute` callback; use a normal `tool()` when local execution is required.
126
128
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@breadstone/archipel-mcp",
3
- "version": "0.0.44",
3
+ "version": "0.0.45",
4
4
  "description": "MCP server providing Archipel platform knowledge - documentation, query patterns, and coding conventions - to AI development tools.",
5
5
  "type": "commonjs",
6
6
  "main": "./src/main.js",