> ## Documentation Index
> Fetch the complete documentation index at: https://praison.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Framework Adapter Protocol • AI Agent SDK

> FrameworkAdapterProtocol: Contract for YAML-driven multi-framework execution backends.

# FrameworkAdapterProtocol

> Defined in the [**protocols**](../modules/protocols) module.

<Badge color="blue">AI Agent</Badge>

Contract for YAML-driven multi-framework execution backends.

## Properties

<ResponseField name="name" type="str">
  No description available.
</ResponseField>

<ResponseField name="install_hint" type="str">
  No description available.
</ResponseField>

<ResponseField name="requires_tools_extra" type="bool">
  No description available.
</ResponseField>

<ResponseField name="is_router" type="bool">
  No description available.
</ResponseField>

## Methods

<CardGroup cols={2}>
  <Card title="is_available()" icon="function" href="../functions/FrameworkAdapterProtocol-is_available">
    Return True when this framework's optional dependencies are installed.
  </Card>

  <Card title="resolve()" icon="function" href="../functions/FrameworkAdapterProtocol-resolve">
    Pick a concrete adapter variant (e.g. autogen v0.2 vs v0.4).
  </Card>

  <Card title="setup()" icon="function" href="../functions/FrameworkAdapterProtocol-setup">
    Framework-specific pre-run hooks (observability, SDK init, etc.).
  </Card>

  <Card title="run()" icon="function" href="../functions/FrameworkAdapterProtocol-run">
    Execute the framework with shared agents.yaml configuration.
  </Card>

  <Card title="arun()" icon="function" href="../functions/FrameworkAdapterProtocol-arun">
    Async execution; default implementations may offload sync run().
  </Card>

  <Card title="cleanup()" icon="function" href="../functions/FrameworkAdapterProtocol-cleanup">
    Release resources after execution.
  </Card>

  <Card title="resolve_alias()" icon="function" href="../functions/FrameworkAdapterProtocol-resolve_alias">
    Return the concrete adapter name to dispatch to.
  </Card>
</CardGroup>

## Source

<Card title="View on GitHub" icon="github" href="https://github.com/MervinPraison/PraisonAI/blob/main/src/praisonai-agents/praisonaiagents/frameworks/protocols.py#L9">
  `praisonaiagents/frameworks/protocols.py` at line 9
</Card>