Skip to content

Commit 50ecbb6

Browse files
committed
updated agentlib
1 parent 19f2440 commit 50ecbb6

File tree

3 files changed

+111
-0
lines changed

3 files changed

+111
-0
lines changed

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,4 @@ npm-debug.log*
1919
yarn-debug.log*
2020
yarn-error.log*
2121
.codeboltAgents
22+
.qodo

docs/api/agentlib/taskInstructions.md

+63
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
name: TaskInstruction
3+
cbbaseinfo:
4+
description: Encapsulates task instructions and their metadata, handling loading/processing from YAML files.
5+
cbparameters:
6+
parameters:
7+
- name: tools
8+
typeName: Tools
9+
description: Object containing tool definitions with descriptions and usage examples
10+
- name: userMessage
11+
typeName: UserMessage
12+
description: User message content handler for prompt generation
13+
- name: filepath
14+
typeName: string
15+
description: Path to YAML file containing task definitions
16+
- name: refsection
17+
typeName: string
18+
description: Specific section key to load from the YAML file
19+
returns:
20+
signatureTypeName: TaskInstruction
21+
description: New TaskInstruction instance configured with provided parameters
22+
typeArgs: []
23+
data:
24+
name: TaskInstruction
25+
category: task-management
26+
link: TaskInstruction.md
27+
---
28+
<CBBaseInfo/>
29+
<CBParameters/>
30+
31+
### Example
32+
33+
```js
34+
import { TaskInstruction } from './task-instruction';
35+
import { UserMessage } from './usermessage';
36+
37+
// Sample tools configuration
38+
const tools = {
39+
fileProcessor: {
40+
description: "Handles file operations",
41+
usage: "processFile(filename)",
42+
example: "processFile('data.txt')"
43+
}
44+
};
45+
46+
// Create a UserMessage instance
47+
const userMsg = new UserMessage(/* message configuration */);
48+
49+
// Initialize task instruction loader
50+
const taskInstruction = new TaskInstruction(
51+
tools,
52+
userMsg,
53+
"./tasks/data_processing.yml",
54+
"data_cleanup"
55+
);
56+
57+
// Generate prompts with task details
58+
try {
59+
const prompts = await taskInstruction.toPrompt();
60+
console.log("Generated prompts:", prompts);
61+
} catch (error) {
62+
console.error("Failed to process task:", error);
63+
}

docs/api/agentlib/usermessage.md

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
name: UserMessage
3+
cbbaseinfo:
4+
description: Handles user message processing with file/environment context attachment
5+
cbparameters:
6+
parameters:
7+
- name: message
8+
typeName: Message
9+
description: Message object containing user input and file/MCP references
10+
- name: promptOverride
11+
typeName: boolean
12+
description: Flag to enable custom prompt rendering (default false)
13+
returns:
14+
signatureTypeName: UserMessage
15+
description: Configured message processor with context attachment capabilities
16+
typeArgs: []
17+
data:
18+
name: UserMessage
19+
category: message-processing
20+
link: UserMessage.md
21+
---
22+
<CBBaseInfo/>
23+
<CBParameters/>
24+
25+
### Example
26+
27+
```js
28+
import { UserMessage } from './usermessage';
29+
30+
// Create a message with file references
31+
const message = {
32+
userMessage: "Please analyze these config files",
33+
mentionedFiles: ["/src/config/app.json"],
34+
mentionedMCPs: ["config-validator"]
35+
};
36+
37+
// Initialize processor
38+
const userMsgProcessor = new UserMessage(message);
39+
40+
// Generate full context prompt
41+
const fullPrompt = await userMsgProcessor.toPrompt(
42+
true, // Attach files
43+
false, // Skip images
44+
true // Include environment
45+
);
46+
47+
console.log("Context-rich prompt:", fullPrompt);

0 commit comments

Comments
 (0)