Skip to content

Commit 19f2440

Browse files
NursidNursid
committed
updated tools docs
1 parent 8d2a088 commit 19f2440

12 files changed

+295
-1
lines changed

‎docs/api/agent/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,5 +13,5 @@ cbapicategory:
1313
link: /docs/api/agent/getAgentsList
1414
description: Lists all available agents of a specific type.
1515
---
16-
# Agent
16+
# agent
1717
<CBAPICategory />

‎docs/api/tool/_category_.json

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"label": "Tools",
3+
"position": 2.5,
4+
"collapsible": true,
5+
"collapsed": true,
6+
"className": "red",
7+
"link": {
8+
"type": "doc",
9+
"id": "api/tool/index"
10+
}
11+
}

‎docs/api/tool/configureToolBox.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
name: configureToolBox
3+
cbbaseinfo:
4+
description: Configures a toolbox with specified settings and parameters.
5+
cbparameters:
6+
parameters:
7+
- name: name
8+
typeName: string
9+
description: The name of the toolbox to configure
10+
- name: config
11+
typeName: any
12+
description: Configuration object for the toolbox
13+
returns:
14+
signatureTypeName: Promise
15+
description: A promise that resolves when configuration is complete
16+
typeArgs:
17+
- type: any
18+
data:
19+
name: configureToolBox
20+
category: tool
21+
link: configureToolBox.md
22+
---
23+
<CBBaseInfo/>
24+
<CBParameters/>
25+
26+
### Example
27+
```js
28+
await codebolt.codebolttools.configureToolBox("analyticsTools", {
29+
apiKey: "12345",
30+
logging: true
31+
});
32+
console.log("Toolbox configured successfully");

‎docs/api/tool/executeTool.md

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
name: executeTool
3+
cbbaseinfo:
4+
description: Executes a specific tool from a configured toolbox with provided parameters.
5+
cbparameters:
6+
parameters:
7+
- name: toolbox
8+
typeName: string
9+
description: The name of the toolbox containing the tool
10+
- name: toolName
11+
typeName: string
12+
description: The name of the tool to execute
13+
- name: params
14+
typeName: object
15+
description: Parameters to pass to the tool execution
16+
returns:
17+
signatureTypeName: Promise
18+
description: A promise that resolves with the tool execution result
19+
typeArgs:
20+
- type: any
21+
data:
22+
name: executeTool
23+
category: tool
24+
link: executeTool.md
25+
---
26+
<CBBaseInfo/>
27+
<CBParameters/>
28+
29+
### Example
30+
```js
31+
const result = await codebolt.codebolttools.executeTool(
32+
"myToolBox",
33+
"dataProcessor",
34+
{ inputData: "test" }
35+
);
36+
console.log("Tool execution result:", result);

‎docs/api/tool/getAvailableToolBoxes.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: getAvailableToolBoxes
3+
cbbaseinfo:
4+
description: Retrieves all available toolboxes from the CodeBolt registry.
5+
cbparameters:
6+
parameters: []
7+
returns:
8+
signatureTypeName: Promise
9+
description: A promise resolving to an array of registry toolbox configurations
10+
typeArgs:
11+
- type: any
12+
data:
13+
name: getAvailableToolBoxes
14+
category: tool
15+
link: getAvailableToolBoxes.md
16+
---
17+
<CBBaseInfo/>
18+
<CBParameters/>
19+
20+
### Example
21+
```js
22+
const availableToolBoxes = await codebolt.codebolttools.getAvailableToolBoxes();
23+
console.log("Available ToolBoxes:", availableToolBoxes);

‎docs/api/tool/getEnabledToolBoxes.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: getEnabledToolBoxes
3+
cbbaseinfo:
4+
description: Retrieves the list of currently enabled toolboxes that are available for use.
5+
cbparameters:
6+
parameters: []
7+
returns:
8+
signatureTypeName: Promise
9+
description: A promise that resolves to an array of enabled toolbox configurations.
10+
typeArgs:
11+
- type: any
12+
data:
13+
name: getEnabledToolBoxes
14+
category: tool
15+
link: getEnabledToolBoxes.md
16+
---
17+
<CBBaseInfo/>
18+
<CBParameters/>
19+
20+
### Example
21+
```js
22+
const enabledToolBoxes = await codebolt.codebolttools.getEnabledToolBoxes();
23+
console.log("Enabled ToolBoxes:", enabledToolBoxes);

‎docs/api/tool/getLocalToolBoxes.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: getLocalToolBoxes
3+
cbbaseinfo:
4+
description: Retrieves toolboxes installed in the local development environment.
5+
cbparameters:
6+
parameters: []
7+
returns:
8+
signatureTypeName: Promise
9+
description: A promise resolving to an array of locally available toolbox configurations
10+
typeArgs:
11+
- type: any
12+
data:
13+
name: getLocalToolBoxes
14+
category: tool
15+
link: getLocalToolBoxes.md
16+
---
17+
<CBBaseInfo/>
18+
<CBParameters/>
19+
20+
### Example
21+
```js
22+
const localToolBoxes = await codebolt.codebolttools.getLocalToolBoxes();
23+
console.log("Local ToolBoxes:", localToolBoxes);

‎docs/api/tool/getMentionedToolBoxes.md

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
name: getMentionedToolBoxes
3+
cbbaseinfo:
4+
description: Extracts toolbox mentions from a user message object.
5+
cbparameters:
6+
parameters:
7+
- name: userMessage
8+
typeName: UserMessage
9+
description: Message object containing user input with toolbox mentions
10+
returns:
11+
signatureTypeName: Promise
12+
description: A promise resolving to an array of mentioned toolbox names
13+
typeArgs:
14+
- type: any
15+
data:
16+
name: getMentionedToolBoxes
17+
category: tool
18+
link: getMentionedToolBoxes.md
19+
---
20+
<CBBaseInfo/>
21+
<CBParameters/>
22+
23+
### Example
24+
```js
25+
const message = {
26+
content: "Please use @analyticsTools and @dataProcessing",
27+
mentionedMCPs: ["analyticsTools", "dataProcessing"]
28+
};
29+
const mentioned = await codebolt.codebolttools.getMentionedToolBoxes(message);
30+
console.log("Mentioned ToolBoxes:", mentioned);

‎docs/api/tool/getTools.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
name: GetTools
3+
cbbaseinfo:
4+
description: Retrieves detailed information about specific tools from their toolboxes.
5+
cbparameters:
6+
parameters:
7+
- name: tools
8+
typeName: "Array<{ toolbox: string, toolName: string }>"
9+
description: Array of tool identifiers to retrieve
10+
returns:
11+
signatureTypeName: Promise
12+
description: A promise resolving to an array of tool configurations
13+
typeArgs:
14+
- type: any[]
15+
data:
16+
name: GetTools
17+
category: tool
18+
link: getTools.md
19+
---
20+
<CBBaseInfo/>
21+
<CBParameters/>
22+
23+
### Example
24+
```js
25+
const toolInfo = await codebolt.codebolttools.getTools([
26+
{ toolbox: "analyticsTools", toolName: "dataAnalyzer" },
27+
{ toolbox: "dataProcessing", toolName: "csvParser" }
28+
]);
29+
console.log("Tool Details:", toolInfo);

‎docs/api/tool/index.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
cbapicategory:
3+
- name: getEnabledToolBoxes
4+
link: /docs/api/tool/getEnabledToolBoxes
5+
description: Retrieves the list of currently enabled toolboxes.
6+
- name: getLocalToolBoxes
7+
link: /docs/api/tool/getLocalToolBoxes
8+
description: Gets toolboxes available in the local environment.
9+
- name: getMentionedToolBoxes
10+
link: /docs/api/tool/getMentionedToolBoxes
11+
description: Extracts mentioned toolboxes from a user message.
12+
- name: getAvailableToolBoxes
13+
link: /docs/api/tool/getAvailableToolBoxes
14+
description: Retrieves all available toolboxes from the registry.
15+
- name: searchAvailableToolBoxes
16+
link: /docs/api/tool/searchAvailableToolBoxes
17+
description: Searches available toolboxes by name or description.
18+
- name: listToolsFromToolBoxes
19+
link: /docs/api/tool/listToolsFromToolBoxes
20+
description: Lists all tools contained in specified toolboxes.
21+
- name: configureToolBox
22+
link: /docs/api/tool/configureToolBox
23+
description: Configures settings for a specific toolbox.
24+
- name: getTools
25+
link: /docs/api/tool/getTools
26+
description: Retrieves detailed information about specific tools.
27+
- name: executeTool
28+
link: /docs/api/tool/executeTool
29+
description: Executes a specific tool from a toolbox.
30+
---
31+
# codebolttools
32+
<CBAPICategory />

‎docs/api/tool/listToolsFromToolBoxes.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
name: listToolsFromToolBoxes
3+
cbbaseinfo:
4+
description: Lists all tools contained within specified toolboxes.
5+
cbparameters:
6+
parameters:
7+
- name: toolBoxes
8+
typeName: string[]
9+
description: Array of toolbox names to inspect
10+
returns:
11+
signatureTypeName: Promise
12+
description: A promise resolving to an object mapping toolboxes to their tools
13+
typeArgs:
14+
- type: any
15+
data:
16+
name: listToolsFromToolBoxes
17+
category: tool
18+
link: listToolsFromToolBoxes.md
19+
---
20+
<CBBaseInfo/>
21+
<CBParameters/>
22+
23+
### Example
24+
```js
25+
const toolsList = await codebolt.codebolttools.listToolsFromToolBoxes([
26+
"analyticsTools",
27+
"dataProcessing"
28+
]);
29+
console.log("Toolbox Contents:", toolsList);

‎docs/api/tool/searchAvailableToolBoxes.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
name: SearchAvailableToolBoxes
3+
cbbaseinfo:
4+
description: Searches available toolboxes by name or description.
5+
cbparameters:
6+
parameters:
7+
- name: query
8+
typeName: string
9+
description: Search string to match against toolbox metadata
10+
returns:
11+
signatureTypeName: Promise
12+
description: A promise resolving to an array of matching toolbox configurations
13+
typeArgs:
14+
- type: any
15+
data:
16+
name: SearchAvailableToolBoxes
17+
category: tool
18+
link: searchAvailableToolBoxes.md
19+
---
20+
<CBBaseInfo/>
21+
<CBParameters/>
22+
23+
### Example
24+
```js
25+
const results = await codebolt.codebolttools.searchAvailableToolBoxes("data");
26+
console.log("Search Results:", results);

0 commit comments

Comments
 (0)