Skip to content

Refresh README to match code and presentation#37

Merged
pamelafox merged 4 commits into
mainfrom
docs/readme-refresh
Jul 7, 2026
Merged

Refresh README to match code and presentation#37
pamelafox merged 4 commits into
mainfrom
docs/readme-refresh

Conversation

@pamelafox

Copy link
Copy Markdown
Contributor

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)

  • Removed the stale "Architecture" section describing a FOUNDRY_IQ_CONTEXT_MODE variable and context_provider/kb_mcp_endpoint modes — that variable and code path no longer exist. The deployed agent uses a single FoundryToolbox MCP tool.
  • Fixed the Observability section to reference agents/stage4_foundry_hosted.py instead of a nonexistent main.py.
  • Corrected the environment variables table: dropped FOUNDRY_IQ_CONTEXT_MODE, added AZURE_OPENAI_ENDPOINT and CUSTOM_FOUNDRY_AGENT_TOOLBOX_NAME, and re-scoped AZURE_AI_SEARCH_KNOWLEDGE_BASE_NAME.

Reframing (to match the presentation)

  • Retitled and positioned the repo as the livestream companion, with a link to the annotated write-up.
  • Added a "How the sample is structured" section mapping each stage file (agent stages 0–4, workflow stages 1–4) to the capability it adds.
  • Surfaced the workflows/ service deployed alongside the agent.

New content

  • Added a "Test the deployed agent" section: azd ai agent invoke, the call_foundry_hosted.py SDK example, and the test_agent.sh / test_workflow.sh / test_kb_mcp.sh scripts.
  • Documented send_requests.py and locustfile.py in the evaluation section for generating sample traces before continuous evaluation.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Comment thread README.md Outdated
Comment thread README.md Outdated

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review details

  • Files reviewed: 1/1 changed files
  • Comments generated: 2
  • Review effort level: Low

Comment thread README.md Outdated
Comment thread README.md Outdated

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review details

  • Files reviewed: 1/1 changed files
  • Comments generated: 2
  • Review effort level: Low

Comment thread README.md
Comment thread README.md Outdated

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review details

  • Files reviewed: 2/2 changed files
  • Comments generated: 1
  • Review effort level: Low

Comment thread README.md
@pamelafox pamelafox merged commit d5ec262 into main Jul 7, 2026
2 checks passed
@pamelafox pamelafox deleted the docs/readme-refresh branch July 7, 2026 05:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants