# 外部 Agent 集成指南

## 文档维护规范

0. **先改文档，再动代码** - 新功能或重大修改需先完成文档更新、并完成审阅后，再进行代码实现
1. **文档分层，链接代码** - 关键实现需标注代码文件路径；格式：`module/file.py:function_name`
2. **简洁快照，日志分离** - 只记录已确认的集成方式

---

## 概述

本指南介绍如何集成外部 Agent（运行在不同机器或使用其他 Agent 框架）。

---

## 特点

- 运行在不同机器
- 或使用其他 Agent 框架
- 通过 HTTP API 接入
- 使用 Client SDK 简化调用

---

## 集成步骤

### 1. 安装 SDK

```bash
pip install gateway-client
```

### 2. 创建客户端

```python
from gateway.client.python import GatewayClient

client = GatewayClient("http://gateway-host:8000")
```

### 3. 使用核心功能

**查询对话列表：**
```python
conversations = client.list_conversations()
```

**获取消息历史：**
```python
messages = client.get_messages(conversation_id)
```

**发送消息：**
```python
client.send_message(conversation_id, text="Hello!")
```

---

## 相关文档

- [需求规划](../requirements.md)：外部 Agent 接入需求
- [架构设计](../architecture.md)：API 层架构
- [API 文档](../api/)：HTTP API 参考
- [Python SDK 文档](../client/python.md)：SDK 详细文档