Skip to content

AGENTS.md

Latest commit

 

History

History
80 lines (61 loc) · 4.02 KB

AGENTS.md

File metadata and controls

80 lines (61 loc) · 4.02 KB
Raw

Declarative Package (agent-framework-declarative)

YAML/JSON-based declarative agent and workflow definitions.

Main Classes

  • AgentFactory - Creates agents from declarative definitions
  • WorkflowFactory - Creates workflows from declarative definitions
  • WorkflowState - Standalone state management and expression evaluation; factory-created workflows use the internal, checkpoint-backed DeclarativeWorkflowState instead
  • ProviderTypeMapping - Maps provider types to implementations
  • HttpRequestHandler / DefaultHttpRequestHandler - Pluggable HTTP transport for the HttpRequestAction declarative action (configured via WorkflowFactory(http_request_handler=...))
  • MCPToolHandler / DefaultMCPToolHandler - Pluggable MCP transport for the InvokeMcpTool declarative action (configured via WorkflowFactory(mcp_tool_handler=...))
  • DeclarativeLoaderError / ProviderLookupError / DeclarativeWorkflowError / DeclarativeActionError - Error types

Both state classes validate object attribute names but leave dictionary keys unchanged.

DefaultHttpRequestHandler(max_response_body_bytes=...) defaults to a 10 MiB wire and decoded-stage body limit, including redirect and authentication responses. It supports identity, gzip, and deflate, rejects unsupported or incomplete encodings, and closes response streams without closing caller-owned clients. HTTPX is constrained to the 0.27 and 0.28 series; focused CI checks both series because response caching and default-header integration use its internals.

MCP Handler Lifetimes

DefaultMCPToolHandler caches/coalesces sessions only without a client_provider. With a provider, every invocation (including tools/list) gets a fresh tool/session, even if the provider returns None or a shared HTTP client. Invocation cleanup closes the session and any internally owned fallback client, never caller-owned HTTP clients. Shutdown waits for active provider-backed invocations to clean up. Calling aclose() from an active invocation's context (including inherited child tasks and cleanup) raises RuntimeError before changing handler state; shutdown must run outside that context or after invocation completion.

Per-invocation sessions intentionally add connection overhead and lose server session continuity between invocations; shared session ownership requires an explicitly scoped custom MCPToolHandler.

MCP Approval Context

InvokeMcpToolActionExecutor binds evaluated headers to each request with a workflow-local HMAC key held separately in trusted host checkpoint state. Only the opaque binding and header names enter the approval payload; raw headers are not checkpointed. Changed or unverifiable headers produce a replacement request for the same pinned operation, with a fresh request ID and no dispatch. Fresh executors verify unchanged approvals using the checkpointed key; legacy requests or missing verification state require reapproval for non-empty headers. Custom handlers remain responsible for identity changes in credentials they resolve outside the action's headers.

InvokeAzureAgent uses Core's executor-ready kwargs conversion for both modern and legacy state, without copying workflow/client kwargs into additional tool arguments. Explicit caller tool arguments in options are preserved.

External Input Handling

  • ExternalInputRequest / ExternalInputResponse - Human-in-the-loop support
  • AgentExternalInputRequest / AgentExternalInputResponse - Agent-level input requests

Usage

from agent_framework.declarative import AgentFactory, WorkflowFactory

# Create agent from YAML file
agent_factory = AgentFactory()
agent = agent_factory.create_agent_from_yaml_path("agent.yaml")

# Create workflow from YAML file
workflow_factory = WorkflowFactory()
workflow = workflow_factory.create_workflow_from_yaml_path("workflow.yaml")

Import Path

from agent_framework.declarative import AgentFactory, WorkflowFactory
# or directly:
from agent_framework_declarative import AgentFactory