Refresh README to match code and presentation#37
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the repository README to match the current code and to align the repo narrative with the “Host your agents on Foundry” livestream presentation, emphasizing the staged progression from local agent to Foundry-hosted agent and workflow.
Changes:
- Reframed the README around the livestream companion context and added a stage-by-stage map of the sample structure (agents and workflows).
- Added guidance for testing the deployed agent/workflow (CLI, SDK example, and test scripts) and expanded evaluation guidance to include traffic generation (batch + Locust).
- Updated/cleaned README content that was out of sync (removed obsolete architecture details; corrected observability reference; refreshed environment variable documentation).
Show a summary per file
| File | Description |
|---|---|
| README.md | Refreshes documentation to match the current staged code structure and adds deployment/testing/evaluation guidance aligned to the livestream presentation. |
Review details
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 1/1 changed files
- Comments generated: 2
- Review effort level: Low
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Reviews the README against the current code and reframes it around the accompanying Host your agents on Foundry: Microsoft Agent Framework presentation.
Fixes (README was out of sync with code)
FOUNDRY_IQ_CONTEXT_MODEvariable andcontext_provider/kb_mcp_endpointmodes — that variable and code path no longer exist. The deployed agent uses a singleFoundryToolboxMCP tool.agents/stage4_foundry_hosted.pyinstead of a nonexistentmain.py.FOUNDRY_IQ_CONTEXT_MODE, addedAZURE_OPENAI_ENDPOINTandCUSTOM_FOUNDRY_AGENT_TOOLBOX_NAME, and re-scopedAZURE_AI_SEARCH_KNOWLEDGE_BASE_NAME.Reframing (to match the presentation)
workflows/service deployed alongside the agent.New content
azd ai agent invoke, thecall_foundry_hosted.pySDK example, and thetest_agent.sh/test_workflow.sh/test_kb_mcp.shscripts.send_requests.pyandlocustfile.pyin the evaluation section for generating sample traces before continuous evaluation.