Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add new TutorAgent and its prompt template #13

Merged
merged 3 commits into from
Aug 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions agenthub/micro/tutor_agent/agent.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
name: TutorAgent
description: Provides educational explanations and interactive tutoring for codebases
inputs:
codebase: string
questions: string
outputs:
explanations: string
28 changes: 28 additions & 0 deletions agenthub/micro/tutor_agent/prompt.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Task
You are a software tutor. Your primary goal is to provide educational explanations and interactive tutoring for the following codebase:

{{ state.inputs.codebase }}

## User Questions
The user has the following questions about the codebase:
{{ state.inputs.questions }}

## Instructions
1. Parse the source code provided in the codebase.
2. Generate human-readable explanations for the functions, algorithms, and overall project architecture.
3. Provide detailed explanations and clarifications for any specific questions the user has about the code or concepts.
4. Interact with the user through a chat interface to answer their questions and provide further explanations as needed.

## Available Actions
{{ instructions.actions.message }}
{{ instructions.actions.read }}
{{ instructions.actions.finish }}

Do NOT finish until you have provided detailed explanations and answered all user questions.

## History
{{ instructions.history_truncated }}
{{ history_to_json(state.history, max_events=20) }}

## Format
{{ instructions.format.action }}
5 changes: 5 additions & 0 deletions tests/integration/mock/ManagerAgent/test_edits/prompt_001.log
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,11 @@ Given a particular task, finds and describes all relevant parts of the codebase
#### Inputs
{"task": "string"}

### TutorAgent
Provides educational explanations and interactive tutoring for codebases
#### Inputs
{"codebase": "string", "questions": "string"}

### TypoFixerAgent
Fixes typos in files in the current working directory
#### Inputs
Expand Down
5 changes: 5 additions & 0 deletions tests/integration/mock/ManagerAgent/test_edits/prompt_006.log
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,11 @@ Given a particular task, finds and describes all relevant parts of the codebase
#### Inputs
{"task": "string"}

### TutorAgent
Provides educational explanations and interactive tutoring for codebases
#### Inputs
{"codebase": "string", "questions": "string"}

### TypoFixerAgent
Fixes typos in files in the current working directory
#### Inputs
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,11 @@ Given a particular task, finds and describes all relevant parts of the codebase
#### Inputs
{"task": "string"}

### TutorAgent
Provides educational explanations and interactive tutoring for codebases
#### Inputs
{"codebase": "string", "questions": "string"}

### TypoFixerAgent
Fixes typos in files in the current working directory
#### Inputs
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,11 @@ Given a particular task, finds and describes all relevant parts of the codebase
#### Inputs
{"task": "string"}

### TutorAgent
Provides educational explanations and interactive tutoring for codebases
#### Inputs
{"codebase": "string", "questions": "string"}

### TypoFixerAgent
Fixes typos in files in the current working directory
#### Inputs
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,11 @@ Given a particular task, finds and describes all relevant parts of the codebase
#### Inputs
{"task": "string"}

### TutorAgent
Provides educational explanations and interactive tutoring for codebases
#### Inputs
{"codebase": "string", "questions": "string"}

### TypoFixerAgent
Fixes typos in files in the current working directory
#### Inputs
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,11 @@ Given a particular task, finds and describes all relevant parts of the codebase
#### Inputs
{"task": "string"}

### TutorAgent
Provides educational explanations and interactive tutoring for codebases
#### Inputs
{"codebase": "string", "questions": "string"}

### TypoFixerAgent
Fixes typos in files in the current working directory
#### Inputs
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,11 @@ Given a particular task, finds and describes all relevant parts of the codebase
#### Inputs
{"task": "string"}

### TutorAgent
Provides educational explanations and interactive tutoring for codebases
#### Inputs
{"codebase": "string", "questions": "string"}

### TypoFixerAgent
Fixes typos in files in the current working directory
#### Inputs
Expand Down
Loading