> ## 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.

# Agent OS Protocol • Rust AI Agent SDK

> AgentOSProtocol: Protocol for Agent OS integration.

# AgentOSProtocol

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

<Badge color="orange">Rust AI Agent SDK</Badge>

Protocol for Agent OS integration.

```mermaid theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
%%{init: {'theme': 'base', 'themeVariables': { 'primaryColor': '#8B0000', 'primaryTextColor': '#fff', 'primaryBorderColor': '#710101', 'lineColor': '#189AB4', 'secondaryColor': '#189AB4', 'tertiaryColor': '#fff' }}}%%

graph LR
    input["Input Data"] --> agent["Agent: AgentOSProtocol"]
    agent --> output["Output Result"]
    style agent fill:#8B0000,color:#fff
    style input fill:#8B0000,color:#fff
    style output fill:#8B0000,color:#fff
```

## Methods

### `config`

```rust theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
fn config(&self) -> &AgentOSConfig
```

Get configuration

### `register`

```rust theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
async fn register(&self) -> Result<String>
```

Register agent with Agent OS

### `heartbeat`

```rust theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
async fn heartbeat(&self) -> Result<()>
```

Send heartbeat

### `report_metrics`

```rust theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
async fn report_metrics(&self, metrics: AgentMetrics) -> Result<()>
```

Report metrics

**Parameters:**

| Name      | Type           |
| --------- | -------------- |
| `metrics` | `AgentMetrics` |

### `get_config`

```rust theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
async fn get_config(&self) -> Result<serde_json::Value>
```

Get remote configuration

## Source

<Card title="View on GitHub" icon="github" href="https://github.com/MervinPraison/PraisonAI/blob/main/src/praisonai-rust/praisonai/src/protocols/mod.rs">
  `praisonai/src/protocols/mod.rs` at line 0
</Card>

***

## Related Documentation

<CardGroup cols={2}>
  <Card title="Rust Agent" icon="robot" href="/docs/rust/agent" />

  <Card title="Rust Overview" icon="book-open" href="/docs/rust/overview" />

  <Card title="Rust Quickstart" icon="rocket" href="/docs/rust/quickstart" />

  <Card title="Rust Installation" icon="download" href="/docs/rust/installation" />

  <Card title="Rust Autonomy" icon="wand-magic-sparkles" href="/docs/rust/autonomy" />
</CardGroup>
