microsoft / microsoft/Agent-Framework-Samples
Question about Planner Agent configuration: Description vs Instructions
Nobody has claimed this yet.
- Dominant language
- Jupyter Notebook
- Stars
- 378
- Forks
- 147
- PR merge metrics
- No merged PRs in 30d
Description
Hi, I have a question regarding the agent configuration in 00.ForBeginners/07-planning-design/code_samples/dotnet-agent-framrwork-ghmodel-planningdesign.
In the current code, the detailed prompt is assigned to the Description property:
Description = AGENT_INSTRUCTIONS, // Contains detailed system prompt
However, based on standard usage, I expected the prompt to be assigned to ChatOptions.Instructions:
ChatOptions = new() { Instructions = AGENT_INSTRUCTIONS }
I noticed that when I moved the prompt to Instructions, the model returned the correct response as expected.
Is this a mistake in the example code?
Or is there a specific design reason here where Description is used instead of Instructions?
Thanks!
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start in 00.ForBeginners/07-planning-design/code_samples/dotnet-agent-framrwork-ghmodel-planningdesign and compare the sample's Description assignment with ChatOptions.Instructions. Run the sample and check the Agent Framework configuration behavior; done means the example uses the correct property or clearly explains why Description is intentional.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp
- Domain
- ai
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100