Skip to content

Commit e80c736

Browse files
committed
updated
1 parent 4a4f0df commit e80c736

File tree

8 files changed

+103
-28
lines changed

8 files changed

+103
-28
lines changed

docs/api/apiaccess/debug/debug.md renamed to docs/api/apiaccess/debug/debugLog.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ cbparameters:
1919
data:
2020
name: debug
2121
category: debug
22-
link: debug.md
22+
link: debugLog.md
2323
---
2424
<CBBaseInfo/>
2525
<CBParameters/>
@@ -32,7 +32,7 @@ data:
3232
const error = "error log"
3333

3434
//// Calling the `codebolt.debug.debug` method to log the error with its type (e.g., "warning", "error", etc.)
35-
const fileData = await codebolt.debug.debug(error, "error")
35+
const fileData = await codebolt.debug.debuglog(error, "error")
3636

3737
//after executing this command then show the error in debug section on coltbolt.
3838

docs/api/apiaccess/debug/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
cbapicategory:
33
- name: debug
4-
link: /docs/api/apiaccess/debug/debug
4+
link: /docs/api/apiaccess/debug/debug-method
55
description: Sends a log message to the debug websocket and waits for a response.
66
- name: openDebugBrowser
77
link: /docs/api/apiaccess/debug/openDebugBrowser

docs/api/apiaccess/index.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -3,76 +3,76 @@ sidebar_label: API Overview
33
sidebar_position: 1
44
cbapicategory:
55
- name: Agent
6-
link: /docs/api/apiaccess/apiaccess/agent
6+
link: /docs/api/apiaccess/agent
77
description: This module provides functionalities for creating customized, high-performance agents tailored to specific needs.
88
- name: Browser
9-
link: /docs/api/apiaccess/apiaccess/browser
9+
link: /docs/api/apiaccess/browser
1010
description: The browser module provides functions for interacting with the browser.
1111
- name: Cbstate
12-
link: /docs/api/apiaccess/apiaccess/cbstate
12+
link: /docs/api/apiaccess/cbstate
1313
description: This is a state module that gives the current state. The state is being continuously updated by the application based on various actions.
1414
- name: Chat
15-
link: /docs/api/apiaccess/apiaccess/chat
15+
link: /docs/api/apiaccess/chat
1616
description: This has various chat related functionalities where the agent can send chat to user and get the user response
1717
- name: CodeParsers
18-
link: /docs/api/apiaccess/apiaccess/codeparsers
18+
link: /docs/api/apiaccess/codeparsers
1919
description: This is a module that parses the code and returns the code tree.
2020
- name: CodeUtils
21-
link: /docs/api/apiaccess/apiaccess/codeutils
21+
link: /docs/api/apiaccess/codeutils
2222
description: This is a module that provides various utilities for parsing and manipulating code.
2323
- name: Crawler
24-
link: /docs/api/apiaccess/apiaccess/crawler
24+
link: /docs/api/apiaccess/crawler
2525
description: This is a module that crawls the web and returns the crawled data.
2626
- name: DbMemory
27-
link: /docs/api/apiaccess/apiaccess/dbmemory
27+
link: /docs/api/apiaccess/dbmemory
2828
description: This is a module that provides memory based database functionalities.
2929
- name: Debug
30-
link: /docs/api/apiaccess/apiaccess/debug
30+
link: /docs/api/apiaccess/debug
3131
description: This is a module that provides various debug functionalities.
3232
- name: DocUtils
33-
link: /docs/api/apiaccess/apiaccess/docutils
33+
link: /docs/api/apiaccess/docutils
3434
description: This is a module that provides various utilities for parsing and manipulating markdown.
3535
- name: Fs
36-
link: /docs/api/apiaccess/apiaccess/fs
36+
link: /docs/api/apiaccess/fs
3737
description: This is a module that provides various file system functionalities.
3838
- name: Git
39-
link: /docs/api/apiaccess/apiaccess/git
39+
link: /docs/api/apiaccess/git
4040
description: This is a module that provides various git functionalities.
4141
- name: History
42-
link: /docs/api/apiaccess/apiaccess/history
42+
link: /docs/api/apiaccess/history
4343
description: This module provides chat history management and summarization functionality for maintaining conversation context.
4444
- name: Knowledge
45-
link: /docs/api/apiaccess/apiaccess/knowledge
45+
link: /docs/api/apiaccess/knowledge
4646
description: This is a module that provides various knowledge related functionalities.
4747
- name: LLM
48-
link: /docs/api/apiaccess/apiaccess/llm
48+
link: /docs/api/apiaccess/llm
4949
description: This is a module that provides various LLM related functionalities.
5050
- name: OutputParsers
51-
link: /docs/api/apiaccess/apiaccess/outputparsers
51+
link: /docs/api/apiaccess/outputparsers
5252
description: This is a module that parses the output and returns the output tree.
5353
- name: Project
54-
link: /docs/api/apiaccess/apiaccess/project
54+
link: /docs/api/apiaccess/project
5555
description: This is a module that provides various project related functionalities.
5656
- name: Rag
57-
link: /docs/api/apiaccess/apiaccess/rag
57+
link: /docs/api/apiaccess/rag
5858
description: This is a module that provides various RAG related functionalities.
5959
- name: TaskPlanner
60-
link: /docs/api/apiaccess/apiaccess/taskplaner
60+
link: /docs/api/apiaccess/taskplaner
6161
description: This is a module that provides various task planner related functionalities.
6262
- name: Terminal
63-
link: /docs/api/apiaccess/apiaccess/terminal
63+
link: /docs/api/apiaccess/terminal
6464
description: Handle Terminal Related Functionalities like Running Commands and Getting Output. Supports handling multiple terminals and long running code executions like Servers.
6565
- name: Tokenizer
66-
link: /docs/api/apiaccess/apiaccess/tokenizer
66+
link: /docs/api/apiaccess/tokenizer
6767
description: Tokenization related Functionalities are provided so that the code can be tokenized and the tokens can be used to perform and measure various operations.
6868
- name: ToolBox
69-
link: /docs/api/apiaccess/apiaccess/toolbox
69+
link: /docs/api/apiaccess/toolbox
7070
description: MCP (Model Context Protocol) framework for creating and managing modular tools and services with support for resources, prompts, and session management.
7171
- name: VectorDB
72-
link: /docs/api/apiaccess/apiaccess/vectordb
72+
link: /docs/api/apiaccess/vectordb
7373
description: Provides Vector DB related Functionalities for Storing and Managing of Vector Embedding
7474
- name: MCP
75-
link: /docs/api/apiaccess/apiaccess/mcp
75+
link: /docs/api/apiaccess/mcp
7676
description: Manages modular tools and services through WebSocket communication. Execute tools, retrieve tool details, and monitor enabled MCP instances in real-time
7777

7878
---

docs/api/mcpAPI/_category_.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"label": "MCP Access",
3-
"position": 2,
3+
"position": 3,
44
"collapsible": true,
55
"collapsed": true,
66
"className": "red",

docs/api/mcpAPI/browser.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
mcp.getTools(["codebolt.browser"])
2+
3+
List of Tools:
4+
- "click" - browser.click("test.txt", "utf8")
5+
- "openUrl" - browser.openUrl("test.txt", "Hello, world!")
6+
- "captureScreenshot" - browser.captureScreenshot("test.txt")
7+
8+
Sample Usage:
9+
```javascript
10+
const result = await codeboltMCP.executeTool(
11+
"codebolt.browser",
12+
"click",
13+
{ inputData: "test" }
14+
);
15+
```
16+
17+
18+
:::info
19+
This functionality is similar to the [browser click](/docs/api/apiaccess/browser/click) API, and will produce the same result as calling `codebolt.browser.click("#test");`
20+
:::

docs/api/mcpAPI/codeboltbasic.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
getTools(["codebolt.basic"])
2+
3+
Available Tools:
4+
- fs.readFileSync("test.txt", "utf8")
5+
- fs.writeFileSync("test.txt", "Hello, world!")
6+
- fs.deleteFileSync("test.txt")
7+
- command.execute("ls -l")
8+
9+
10+
11+

docs/api/mcpAPI/index.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
List of MCP APIs available in CodeboltAI.
2+
3+
1. [Codebolt Basic](/docs/api/mcpAPI/codeboltbasic) - codebolt.basic
4+
2. [Browser](/docs/api/mcpAPI/browser) - codebolt.browser
5+
3. [File System](/docs/api/mcpAPI/fstool) - codebolt.fs
6+
7+
:::note
8+
More MCP API documentation is coming soon. The following APIs are available but documentation is being prepared:
9+
- Git (codebolt.git)
10+
- Knowledge (codebolt.knowledge)
11+
- Memory (codebolt.memory)
12+
- Project (codebolt.project)
13+
- RAG (codebolt.rag)
14+
- Terminal (codebolt.terminal)
15+
- Tokenizer (codebolt.tokenizer)
16+
- Toolbox (codebolt.toolbox)
17+
- VectorDB (codebolt.vectordb)
18+
:::
19+
20+
21+
Sample Usage:
22+
23+
const toolsList = await codeboltMCP.listToolsFromToolBoxes([
24+
"codebolt.basic",
25+
"codebolt.browser",
26+
"codebolt.git"
27+
]);

docs/api/overview.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,20 @@ sidebar_position: 1
44
---
55
# CodeboltAI System Interfaces
66

7+
As an AI Agent, you can use the CodeboltAI System Interfaces to interact with the Codebolt application.
8+
9+
CodeboltAI has been built from ground up so that the entire editor can be fully controlled by AI Agents.
10+
11+
There are two types of interfaces that are available to the AI Agents.
12+
13+
1. [Direct API Access](/docs/api/apiaccess/)
14+
2. [MCP Access](/docs/api/mcpAPI/)
15+
16+
## Direct API Access
17+
18+
[Direct API Access](/docs/api/apiaccess/) is the most direct way to interact with the Codebolt application. It is a set of APIs that are available to the AI Agents.
19+
20+
## MCP Access
21+
22+
We have also provided a simplified Interface in the form of [MCP (Model Context Protocol)](/docs/api/mcpAPI/) that can be used to interact with the Codebolt application.
23+
This can be used directly by the LLMs through agents to interact with the Codebolt application.

0 commit comments

Comments
 (0)