Skip to content

Python: correct harness file-memory configuration guidance - #9670

Open
LI (ktz03) wants to merge 1 commit into
microsoft:mainfrom
ktz03:docs/harness-file-memory-guide-20261024
Open

LI (ktz03) wants to merge 1 commit into
microsoft:mainfrom
ktz03:docs/harness-file-memory-guide-20261024

Conversation

@ktz03

Copy link
Copy Markdown
Contributor

Motivation & Context

The harness sample overview describes file memory as an optional MemoryContextProvider enabled by passing memory_store. The current factory adds FileMemoryProvider by default and exposes file_memory_store and disable_file_memory instead.

Description & Review Guide

  • What are the major changes? Correct the feature-table entry and document the default store root, custom-store parameter, and disable flag.
  • What is the impact of these changes? Documentation only. It describes the existing factory configuration without changing memory, storage, or runtime behavior.
  • What do you want reviewers to focus on? Agreement with the current create_harness_agent signature and file-memory provider assembly. Static source/documentation checks were performed; no harness run, filesystem behavior test, build, or model call was executed.

Related Issue

N/A - trivial change. This corrects stale provider and configuration names and documents defaults already specified by the existing factory.

AI Assistance

  • No material AI assistance was used.
  • This is an AI-assisted contribution. I reviewed, understood, and verified all submitted content and accept responsibility for it.

AI assistance details: Codex: documentation and this PR description.

Contribution Checklist

  • The code builds clean without any errors or warnings
  • All unit tests pass, and I have added new tests where possible
  • The PR follows the Contribution Guidelines
  • This PR links to an agreed issue with no competing open PR, or the Related Issue section documents a trivial-change or repository-automation exception.
  • This is not a breaking change. If it is a breaking change, add the breaking change label (or add "[BREAKING]" to the title prefix, before or after any language prefix) — a workflow keeps the label and title prefix in sync automatically.

Copilot AI balanced review requested due to automatic review settings October 24, 2026 12:51
@ktz03
LI (ktz03) deployed to github-app-auth October 24, 2026 12:51 — with GitHub Actions Active
@ktz03
LI (ktz03) deployed to github-app-auth October 24, 2026 12:51 — with GitHub Actions Active
@agent-framework-automation agent-framework-automation Bot added documentation Usage: [Issues, PRs], Target: documentation in the code base and learn docs python Usage: [Issues, PRs], Target: Python labels Oct 24, 2026

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.

🟢 Approval recommended

The documentation matches the existing factory configuration and session-scoping behavior, with no unresolved issues.

No open issues 🎉

What changed in this PR

Corrects the harness sample’s file-memory guidance to match the existing factory configuration. This is documentation-only; runtime behavior is unchanged.

Changes:

  • Replaces the stale provider name with FileMemoryProvider and clarifies that it is enabled by default.
  • Documents the default {cwd}/agent-file-memory store root, file_memory_store parameter, and disable_file_memory flag.
File Description
python/​samples/​02-agents/​harness/​README.md Corrects the file-memory feature entry and configuration guidance.

Review effort: Balanced

This branch was successfully deployed

1 active deployment
github-app-auth — d8d348a5 Deployed Oct 24, 2026 by ktz03 via team_check #7391
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Usage: [Issues, PRs], Target: documentation in the code base and learn docs python Usage: [Issues, PRs], Target: Python

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants