Skip to content

Commit c005d2c

Browse files
NursidNursid
committed
updated
1 parent 51efc42 commit c005d2c

13 files changed

+286
-6
lines changed

‎docs/api/agent/getAgent.md

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
name: getAgent
3+
cbbaseinfo:
4+
description: Retrieves an agent based on the specified task.
5+
cbparameters:
6+
parameters:
7+
- name: task
8+
typeName: string
9+
description: The task for which an agent is needed.
10+
returns:
11+
signatureTypeName: Promise
12+
description: A promise that resolves with the agent details.
13+
typeArgs:
14+
- type: reference
15+
name: any
16+
data:
17+
name: getAgent
18+
category: agent
19+
link: getAgent.md
20+
---
21+
<CBBaseInfo/>
22+
<CBParameters/>
23+
24+
### Example
25+
26+
```js
27+
// Example: Retrieving an agent for a task
28+
const agentDetails = await codebolt.agent.getAgent("dataProcessing");
29+
console.log("Agent Details:", agentDetails);
30+
```

‎docs/api/agent/index.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
cbapicategory:
3+
- name: getAgent
4+
link: /docs/api/agent/getAgent
5+
description: Retrieves an agent based on the specified task via WebSocket.
6+
- name: startAgent
7+
link: /docs/api/agent/startAgent
8+
description: Starts an agent for the specified task via WebSocket.
9+
---
10+
# Agent
11+
<CBAPICategory />

‎docs/api/agent/startAgent.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
name: startAgent
3+
cbbaseinfo:
4+
description: Starts an agent for the specified task.
5+
cbparameters:
6+
parameters:
7+
- name: task
8+
typeName: string
9+
description: The task for which the agent should be started.
10+
returns:
11+
signatureTypeName: Promise
12+
description: A promise that resolves when the agent has been successfully started.
13+
typeArgs:
14+
- type: reference
15+
name: any
16+
data:
17+
name: startAgent
18+
category: agent
19+
link: startAgent.md
20+
---
21+
<CBBaseInfo/>
22+
<CBParameters/>
23+
24+
### Example
25+
26+
```js
27+
// Example: Starting an agent for a task
28+
const startResponse = await codebolt.agent.startAgent("dataProcessing");
29+
console.log("Agent Start Response:", startResponse);
30+
31+
```

‎docs/api/mcp/_category_.json

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

‎docs/api/mcp/executeTool.md

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
name: executeTool
3+
cbbaseinfo:
4+
description: Executes a specified tool with the provided parameters.
5+
cbparameters:
6+
parameters:
7+
- name: toolName
8+
typeName: string
9+
description: The name of the tool to execute.
10+
- name: params
11+
typeName: any
12+
description: Parameters required for executing the tool.
13+
- name: mcpServer
14+
typeName: string (optional)
15+
description: The MCP server to use for execution.
16+
returns:
17+
signatureTypeName: Promise
18+
description: A promise that resolves with the tool execution result.
19+
typeArgs:
20+
- type: reference
21+
name: any
22+
data:
23+
name: executeTool
24+
category: mcp
25+
link: executeTool.md
26+
---
27+
<CBBaseInfo/>
28+
<CBParameters/>
29+
30+
### Example
31+
32+
```js
33+
// Example: Executing a tool
34+
const result = await codebolt.mcp.executeTool("imageProcessor", { imageUrl: "https://example.com/image.jpg" });
35+
console.log("Tool Execution Result:", result);
36+
37+
```

‎docs/api/mcp/getAllMCPTools.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
name: getAllMCPTools
3+
cbbaseinfo:
4+
description: Retrieves all available MCP tools for a given MCP instance.
5+
cbparameters:
6+
parameters:
7+
- name: mpcName
8+
typeName: string
9+
description: The name of the MCP instance.
10+
returns:
11+
signatureTypeName: Promise
12+
description: A promise that resolves with a list of all MCP tools.
13+
typeArgs:
14+
- type: reference
15+
name: any
16+
data:
17+
name: getAllMCPTools
18+
category: mcp
19+
link: getAllMCPTools.md
20+
---
21+
<CBBaseInfo/>
22+
<CBParameters/>
23+
24+
### Example
25+
26+
```js
27+
// Example: Retrieving all MCP tools
28+
const allTools = await codebolt.mcp.getAllMCPTools("mainMCP");
29+
console.log("All MCP Tools:", allTools);
30+
31+
```

‎docs/api/mcp/getEnabledMCPS.md

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
name: getEnabledMCPS
3+
cbbaseinfo:
4+
description: Retrieves a list of enabled MCP instances.
5+
cbparameters:
6+
parameters: []
7+
returns:
8+
signatureTypeName: Promise
9+
description: A promise that resolves with the list of enabled MCP instances.
10+
typeArgs:
11+
- type: reference
12+
name: any
13+
data:
14+
name: getEnabledMCPS
15+
category: mcp
16+
link: getEnabledMCPS.md
17+
---
18+
<CBBaseInfo/>
19+
<CBParameters/>
20+
21+
### Example
22+
23+
```js
24+
// Example: Retrieving enabled MCP instances
25+
const enabledMCPS = await codebolt.mcp.getEnabledMCPS();
26+
console.log("Enabled MCPs:", enabledMCPS);
27+
28+
```

‎docs/api/mcp/getMCPTool.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
name: getMCPTool
3+
cbbaseinfo:
4+
description: Retrieves details of a specific MCP tool.
5+
cbparameters:
6+
parameters:
7+
- name: name
8+
typeName: string
9+
description: The name of the MCP tool to retrieve.
10+
returns:
11+
signatureTypeName: Promise
12+
description: A promise that resolves with the MCP tool details.
13+
typeArgs:
14+
- type: reference
15+
name: any
16+
data:
17+
name: getMCPTool
18+
category: mcp
19+
link: getMCPTool.md
20+
---
21+
<CBBaseInfo/>
22+
<CBParameters/>
23+
24+
### Example
25+
26+
```js
27+
// Example: Retrieving a specific MCP tool
28+
const toolDetails = await codebolt.mcp.getMCPTool("imageProcessor");
29+
console.log("MCP Tool Details:", toolDetails);
30+
31+
```

‎docs/api/mcp/getMcpTools.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
name: getMcpTools
3+
cbbaseinfo:
4+
description: Retrieves a list of specified MCP tools.
5+
cbparameters:
6+
parameters:
7+
- name: tools
8+
typeName: string[]
9+
description: An array of tool names to retrieve.
10+
returns:
11+
signatureTypeName: Promise
12+
description: A promise that resolves with the list of requested MCP tools.
13+
typeArgs:
14+
- type: reference
15+
name: any
16+
data:
17+
name: getMcpTools
18+
category: mcp
19+
link: getMcpTools.md
20+
---
21+
<CBBaseInfo/>
22+
<CBParameters/>
23+
24+
### Example
25+
26+
```js
27+
28+
// Example: Retrieving a list of specific MCP tools
29+
const tools = await codebolt.mcp.getMcpTools(["imageProcessor", "dataAnalyzer"]);
30+
console.log("MCP Tools:", tools);
31+
32+
```

‎docs/api/mcp/index.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
cbapicategory:
3+
- name: executeTool
4+
link: /docs/api/mcp/executeTool
5+
description: Executes a specified tool with the provided parameters via WebSocket.
6+
- name: getMcpTools
7+
link: /docs/api/mcp/getMcpTools
8+
description: Retrieves a list of specified MCP tools via WebSocket.
9+
- name: getAllMCPTools
10+
link: /docs/api/mcp/getAllMCPTools
11+
description: Retrieves all available MCP tools for a given MCP instance via WebSocket.
12+
- name: getMCPTool
13+
link: /docs/api/mcp/getMCPTool
14+
description: Retrieves details of a specific MCP tool via WebSocket.
15+
- name: getEnabledMCPS
16+
link: /docs/api/mcp/getEnabledMCPS
17+
description: Retrieves a list of enabled MCP instances via WebSocket.
18+
---
19+
# MCP
20+
<CBAPICategory />

‎docs/api/vectordb/addVectorItem.md

+7-2
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,11 @@ data:
2121
<CBBaseInfo/>
2222
<CBParameters/>
2323

24-
### Status
24+
### Example
25+
```js
2526

26-
Comming soon...
27+
28+
const addResponse = await codebolt.vectordb.addVectorItem({ id: "123", vector: [0.1, 0.2, 0.3] });
29+
console.log("Add Vector Response:", addResponse);
30+
31+
```

‎docs/api/vectordb/getVector.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,10 @@ data:
2121
<CBBaseInfo/>
2222
<CBParameters/>
2323

24-
### Status
24+
### Example
25+
```js
2526

26-
Comming soon...
27+
const getResponse = await codebolt.vectordb.getVector("123");
28+
console.log("Get Vector Response:", getResponse);
29+
30+
```

‎docs/api/vectordb/queryVectorItem.md

+11-2
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,15 @@ data:
2121
<CBBaseInfo/>
2222
<CBParameters/>
2323

24-
### Status
24+
### Example
25+
```js
2526

26-
Comming soon...
27+
// Example: Querying a single vector item
28+
const queryResponse = await codebolt.vectordb.queryVectorItem("123");
29+
console.log("Query Vector Item Response:", queryResponse);
30+
31+
// Example: Querying multiple vector items
32+
const queryItemsResponse = await codebolt.vectordb.queryVectorItems(["123", "456"], "/database/path");
33+
console.log("Query Vector Items Response:", queryItemsResponse);
34+
35+
```

0 commit comments

Comments
 (0)