Skip to content

Commit 2a8fd05

Browse files
committed
updated tools, agents, sdk doc
1 parent 28620f9 commit 2a8fd05

20 files changed

+6806
-164
lines changed

docs/developer/agents/1_agentIntroduction.md

Lines changed: 0 additions & 31 deletions
This file was deleted.

docs/developer/agents/2_usingagents/2_quickstart.md

Lines changed: 0 additions & 3 deletions
This file was deleted.
Lines changed: 236 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,236 @@
1+
---
2+
sidebar_position: 1
3+
sidebar_label: Introduction
4+
---
5+
6+
# Agent Introduction
7+
8+
Codebolt is an extremely powerful platform for AI-driven code editing and generation. The core strength of Codebolt lies in its agent-based architecture, where specialized AI agents handle different aspects of software development, from code generation to testing and deployment.
9+
10+
## What is a Codebolt Agent?
11+
12+
A Codebolt Agent is a custom AI-powered application that connects to the Codebolt platform to execute specific development tasks. Think of agents as specialized developers with unique skills - one might excel at React component generation, another at API development, and yet another at testing automation.
13+
14+
### Key Characteristics
15+
16+
- **Specialized**: Each agent focuses on specific development tasks or domains
17+
- **Autonomous**: Agents can make decisions and take actions using LLM reasoning
18+
- **Connected**: Agents integrate seamlessly with the Codebolt application
19+
- **Extensible**: Agents can use tools and call other agents for complex workflows
20+
- **Reusable**: Once created, agents can be shared and used across projects
21+
22+
## How Agents Work
23+
24+
Codebolt agents operate through an agentic process flow that combines:
25+
26+
1. **User Intent Understanding**: Parsing and interpreting user requests
27+
2. **Task Planning**: Breaking down complex tasks into actionable steps
28+
3. **Tool Utilization**: Using available tools and APIs to accomplish tasks
29+
4. **Code Manipulation**: Reading, writing, and modifying code files
30+
5. **Decision Making**: Using LLM reasoning to make intelligent choices
31+
6. **Result Delivery**: Providing feedback and results to users
32+
33+
## Agent Architecture
34+
35+
```mermaid
36+
graph TB
37+
subgraph "Codebolt Application"
38+
A[Codebolt Editor]
39+
B[Agent Orchestrator]
40+
C[Universal Agent Router]
41+
D[Tool Registry]
42+
E[File System]
43+
end
44+
45+
subgraph "Agent Runtime"
46+
F[Custom Agent]
47+
G[CodeboltJS Library]
48+
H[Agent Logic]
49+
I[System Prompts]
50+
J[Task Instructions]
51+
end
52+
53+
subgraph "External Services"
54+
K[LLM Providers]
55+
L[External APIs]
56+
M[Tool Services]
57+
end
58+
59+
A --> B
60+
B --> C
61+
C --> F
62+
F --> G
63+
G --> H
64+
H --> I
65+
H --> J
66+
67+
G <--> A
68+
G <--> D
69+
G <--> E
70+
71+
H --> K
72+
H --> L
73+
H --> M
74+
75+
F --> B
76+
```
77+
78+
## Agent Connection Flow
79+
80+
Codebolt agents connect to the platform using the **CodeboltJS library**, which provides a comprehensive set of functions for:
81+
82+
### 1. Communication Layer
83+
```javascript
84+
// WebSocket connection for real-time communication
85+
codebolt.chat.onActionMessage().on("userMessage", async (req, response) => {
86+
// Handle user messages and respond
87+
});
88+
```
89+
90+
### 2. Tool Integration
91+
```javascript
92+
// Access to platform tools and external services
93+
const tools = await codebolt.tools.listToolsFromToolBoxes(["codebolt", "custom"]);
94+
```
95+
96+
### 3. File System Access
97+
```javascript
98+
// Read, write, and manipulate project files
99+
const fileContent = await codebolt.fs.readFile("./src/component.js");
100+
await codebolt.fs.writeFile("./src/newComponent.js", generatedCode);
101+
```
102+
103+
### 4. LLM Integration
104+
```javascript
105+
// Interact with various LLM providers
106+
const response = await codebolt.llm.chat(messages, tools);
107+
```
108+
109+
## Agent Types and Use Cases
110+
111+
### 1. **Code Generation Agents**
112+
- Generate React components, API endpoints, database models
113+
- Create boilerplate code and project structures
114+
- Implement design patterns and best practices
115+
116+
### 2. **Testing Agents**
117+
- Write unit tests, integration tests, and end-to-end tests
118+
- Generate test data and mock objects
119+
- Analyze code coverage and suggest improvements
120+
121+
### 3. **Deployment Agents**
122+
- Deploy applications to various platforms (Vercel, AWS, etc.)
123+
- Configure CI/CD pipelines
124+
- Manage environment variables and secrets
125+
126+
### 4. **Code Review Agents**
127+
- Analyze code quality and suggest improvements
128+
- Check for security vulnerabilities
129+
- Ensure coding standards compliance
130+
131+
### 5. **Documentation Agents**
132+
- Generate API documentation
133+
- Create README files and user guides
134+
- Maintain code comments and inline documentation
135+
136+
## Agent Lifecycle
137+
138+
### Development Phase
139+
1. **Create**: Use CLI to scaffold agent structure
140+
2. **Configure**: Define SDLC steps, actions, and routing
141+
3. **Implement**: Write agent logic using CodeboltJS
142+
4. **Test**: Run locally and test with Codebolt application
143+
144+
### Deployment Phase
145+
1. **Publish**: Upload to Codebolt registry
146+
2. **Share**: Make available to community or team
147+
3. **Version**: Manage updates and backward compatibility
148+
149+
### Runtime Phase
150+
1. **Discovery**: Users find agents through registry
151+
2. **Installation**: Clone or install agents in projects
152+
3. **Execution**: Agents handle user requests and tasks
153+
4. **Monitoring**: Track performance and usage
154+
155+
## Agent Communication Protocol
156+
157+
Agents communicate with Codebolt through a structured protocol:
158+
159+
```javascript
160+
// Message Structure
161+
{
162+
type: "userMessage",
163+
content: "Generate a React component for user profile",
164+
context: {
165+
projectPath: "/path/to/project",
166+
currentFile: "src/App.js",
167+
selectedText: "...",
168+
metadata: {...}
169+
}
170+
}
171+
172+
// Response Structure
173+
{
174+
success: true,
175+
message: "Created UserProfile component successfully",
176+
actions: [
177+
{
178+
type: "fileCreate",
179+
path: "src/components/UserProfile.js",
180+
content: "..."
181+
}
182+
]
183+
}
184+
```
185+
186+
## Benefits of Agent-Based Architecture
187+
188+
### For Developers
189+
- **Specialization**: Focus on specific domains and use cases
190+
- **Reusability**: Create once, use across multiple projects
191+
- **Collaboration**: Share agents with team and community
192+
- **Extensibility**: Build on existing agents and tools
193+
194+
### For Users
195+
- **Efficiency**: Automated complex development tasks
196+
- **Consistency**: Standardized approaches across projects
197+
- **Learning**: Discover new patterns and best practices
198+
- **Flexibility**: Choose the right agent for each task
199+
200+
### For Organizations
201+
- **Standardization**: Enforce coding standards and practices
202+
- **Knowledge Sharing**: Capture and distribute expertise
203+
- **Productivity**: Accelerate development workflows
204+
- **Quality**: Consistent, tested approaches to common tasks
205+
206+
## Getting Started
207+
208+
Ready to create your first agent? Here's what you need:
209+
210+
1. **Prerequisites**: Node.js, Codebolt CLI, and basic JavaScript knowledge
211+
2. **Quick Start**: Follow our [QuickStart Guide](./quickstart.md) for a 10-minute setup
212+
3. **Deep Dive**: Explore [Agent Architecture](./1_agentarchitecture.md) for detailed concepts
213+
4. **Examples**: Check out [Custom Agents](./3_customagents.md) for real-world examples
214+
215+
## Agent Ecosystem
216+
217+
The Codebolt agent ecosystem includes:
218+
219+
- **Official Agents**: Maintained by the Codebolt team
220+
- **Community Agents**: Created and shared by developers
221+
- **Private Agents**: Custom agents for specific organizations
222+
- **Tool Integration**: Agents that wrap external services and APIs
223+
224+
## Next Steps
225+
226+
- **[QuickStart Guide](./quickstart.md)** - Create your first agent in 10 minutes
227+
- **[Agent Architecture](./1_agentarchitecture.md)** - Understand the technical details
228+
- **[Using Agents](./2_usingagents.md)** - Learn how to effectively use agents
229+
- **[Custom Agents](./3_customagents.md)** - Build specialized agents for your needs
230+
231+
---
232+
233+
Codebolt agents represent the future of AI-assisted development - intelligent, specialized, and collaborative tools that amplify human creativity and productivity in software development.
234+
235+
236+

docs/developer/agents/multi-agent.md

Whitespace-only changes.

0 commit comments

Comments
 (0)