Python: Add a HarnessAgent with available features and sample (#6041)

* Add a HarnessAgent with available features and sample * Fix formatting * Address PR comments and fix mypy error * Add web search support to HarnessAgent * Fix build warning * Apply suggestions from code review Co-authored-by: Eduard van Valkenburg <eavanvalkenburg@users.noreply.github.com> * Address PR comments * Address PR comments * Address further PR comments. * Fix markdown broken link --------- Co-authored-by: Eduard van Valkenburg <eavanvalkenburg@users.noreply.github.com>
2026-06-16 21:04:09 +08:00 · 2026-05-27 14:54:00 +01:00
parent d5c07f2623
commit ef86fb51d5
11 changed files with 1262 additions and 5 deletions
@@ -0,0 +1,83 @@
+# Harness Agent Samples
+
+This folder demonstrates `create_harness_agent` — a factory function that builds a
+pre-configured, batteries-included agent by assembling the full agent pipeline
+from a chat client.
+
+## What is `create_harness_agent`?
+
+`create_harness_agent` bundles the following features into a single `Agent` instance:
+
+| Feature | Description |
+|---------|-------------|
+| Function invocation | Automatic tool calling loop |
+| Per-service-call persistence | History persisted after every model call |
+| Compaction | Context-window management (sliding window + tool result compaction) |
+| TodoProvider | Todo list management for planning and tracking |
+| AgentModeProvider | Plan/execute mode tracking |
+| MemoryContextProvider | File-based durable memory (when `memory_store` provided) |
+| SkillsProvider | File-based skill discovery and progressive loading |
+| OpenTelemetry | Built-in observability |
+
+Each feature can be disabled or customized via keyword arguments.
+
+## Samples
+
+| File | Description |
+|------|-------------|
+| `harness_research.py` | Interactive research assistant with web search and planning workflow |
+
+## Running
+
+```bash
+# Set your Foundry environment variables
+export FOUNDRY_PROJECT_ENDPOINT="https://your-project.services.ai.azure.com/api/projects/your-project-name"
+export FOUNDRY_MODEL="your-model-deployment-name"
+
+# Authenticate with Azure (required for AzureCliCredential)
+az login
+
+# Run the research sample
+python samples/02-agents/harness/harness_research.py
+```
+
+## Key Concepts
+
+### Minimal Setup
+
+`create_harness_agent` requires only a chat client and token budget parameters:
+
+```python
+from agent_framework import create_harness_agent
+from agent_framework.foundry import FoundryChatClient
+from azure.identity import AzureCliCredential
+
+agent = create_harness_agent(
+    client=FoundryChatClient(credential=AzureCliCredential()),
+    max_context_window_tokens=128_000,
+    max_output_tokens=16_384,
+)
+```
+
+### Customization
+
+Disable or customize any feature:
+
+```python
+agent = create_harness_agent(
+    client=client,
+    max_context_window_tokens=128_000,
+    max_output_tokens=16_384,
+    name="my-agent",
+    agent_instructions="Custom instructions here.",
+    disable_todo=True,          # Skip todo management
+    disable_mode=True,          # Skip plan/execute modes
+    disable_compaction=True,    # Skip compaction
+)
+```
+
+### Plan/Execute Workflow
+
+The `AgentModeProvider` enables a two-phase workflow:
+1. **Plan mode** — Interactive: the agent asks questions, creates todos, gets approval
+2. **Execute mode** — Autonomous: the agent works through todos independently