# AgentProtocol

**Package:** `flyte.ai.agents.protocol`

Minimal protocol that any agent must satisfy to work with
:class:`AgentChatAppEnvironment`.

```python
protocol AgentProtocol()
```
## Methods

| Method | Description |
|-|-|
| [`run()`](#run) | Process *message* (with prior *memory*) and return an :class:`AgentResult`. |
| [`tool_descriptions()`](#tool_descriptions) | Return JSON-friendly metadata for every registered tool. |

### run()

```python
def run(
    message: str,
    memory: list[dict[str, Any]] | 'MemoryStore' | None,
) -> AgentResult
```
Process *message* (with prior *memory*) and return an :class:`AgentResult`.

``memory`` may be a ``list[dict]`` of prior messages (e.g. a chat
``history``) or a :class:`MemoryStore` for durable, cross-run state.

Synchronous entry point. In async contexts, use ``run.aio(...)``.

| Parameter | Type | Description |
|-|-|-|
| `message` | `str` | |
| `memory` | `list[dict[str, Any]] \| 'MemoryStore' \| None` | |

### tool_descriptions()

```python
def tool_descriptions()
```
Return JSON-friendly metadata for every registered tool.

Each dict should contain at least ``name``, ``signature``, and
``description`` keys.

---
**Source**: https://github.com/unionai/unionai-docs/blob/main/content/api-reference/flyte-sdk/packages/flyte.ai.agents.protocol/agentprotocol.md
**HTML**: https://www.union.ai/docs/v2/union/api-reference/flyte-sdk/packages/flyte.ai.agents.protocol/agentprotocol/