docs: 项目概览(OVERVIEW.md) + 插件开发指南(PLUGIN_DEV.md) + MCP 适配器插件

- OVERVIEW.md: 非技术用户友好的项目介绍和目标
- PLUGIN_DEV.md: 完整插件开发指南(含三种开发方式、API 参考、最佳实践)
- internal/plugins/mcp/: MCP 协议适配器插件(JSON-RPC over stdio/SSE)
  - client.go: MCP 客户端(ListTools / CallTool)
  - stdio.go: 子进程 stdin/stdout 传输
  - sse.go: HTTP POST 传输
  - plugin.go: init() 自注册 + Settings 配置读取
- README.md 更新链接
This commit is contained in:
root
2026-07-03 17:58:20 +08:00
parent 2d314b3e9c
commit 197f932932
8 changed files with 987 additions and 27 deletions

86
docs/OVERVIEW.md Normal file
View File

@ -0,0 +1,86 @@
# HomeAgent — 你的 24/7 智能管家
## 这是做什么的?
HomeAgent 是一个**持续运行的个人智能管家**。它像一个随时在线的大脑,你可以通过聊天跟它交流,让它帮你记住事情、查询知识、设置提醒、执行任务。
## 核心目标
| 目标 | 说明 |
|------|------|
| **永远在线** | 启动后持续运行,不像普通聊天软件需要每次打开 |
| **真正记住你** | 它不会每次对话都"失忆"——它会积累对你的了解,记住你的喜好、关系网和重要信息 |
| **隐私可控** | 所有数据存储在你自己的设备上(本地数据库),你也可以选择使用自己的 API 密钥 |
| **能力可扩展** | 通过"插件"添加新能力——就像手机装 App 一样 |
## 谁需要它?
- **想有个私人助理** — 帮你记待办、定时提醒、管理联系人
- **重视隐私的用户** — 数据全在本地,不经过第三方云服务
- **开发者和技术爱好者** — 可以自己编写插件来扩展功能
- **想探索 AI Agent 的人** — 一个真实可运行的 Agent 系统,不只是 API 调用
## 它能做什么?
### 🧠 记忆
- **记住你是谁** — 你的名字、喜好、重要日期
- **记住人际关系** — "张三是我同事,李四是我的朋友"
- **长期积累** — 聊得越多,它越了解你
### 📚 知识
- 你可以主动教它知识("公司的休假制度是……"
- 它会在需要时检索相关知识
### ⏰ 定时提醒
- "5分钟后提醒我喝水"
- 倒计时结束后它会主动通知你
### 🔌 可扩展(插件)
- **Web 控制台** — 在浏览器中管理和配置
- **命令行** — 通过终端快速交互
- **更多能力** — 开发者可以写插件接入任何服务
## 它是如何工作的?(简述)
```
你(通过聊天软件/终端/网页)
HomeAgent 内核 ←→ 插件(能力扩展)
本地存储(你的数据只在你这里)
```
- **内核** 是"大脑"——负责理解你说什么、调用什么能力、记住什么
- **插件** 是"手脚"——负责收发消息、设置定时器、连接外部服务等
- **所有数据存本地** — 你的对话、记忆、配置都保存在你自己的设备上
## 和普通 AI 聊天有什么区别?
| | 普通 AI 聊天 | HomeAgent |
|---|---|---|
| 记忆 | 每次对话独立,不记得你 | 长期记忆,越来越了解你 |
| 持续运行 | 关掉就没了 | 7×24 在线 |
| 主动能力 | 只能回复问题 | 能设定时器、主动提醒 |
| 可扩展 | 固定能力 | 插件系统,可无限扩展 |
| 数据隐私 | 上传到云服务 | 本地存储,完全可控 |
## 快速体验
```bash
# 启动(需要 DeepSeek API 密钥)
DEEPSEEK_API_KEY="sk-xxx" ./homed -data /tmp/ha
# 在另一个终端聊天
echo "你好,请记住我喜欢喝咖啡" | ./waiter
```
## 项目状态
HomeAgent 正在积极开发中。核心功能已可运行,插件系统和开发者 API 已就绪。
---
*想参与开发?查看 [PLUGIN_DEV.md](PLUGIN_DEV.md) 插件开发指南。*
*了解技术架构?查看 [ARCHITECTURE.md](ARCHITECTURE.md)。*