mirror of
https://gitcode.com/JianFeeeee/HomeAgent.git
synced 2026-09-21 09:28:14 +00:00
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:
46
README.md
46
README.md
@ -2,36 +2,28 @@
|
||||
|
||||
24/7 智能管家。**核心零 IO**,一切外界交互来自插件。
|
||||
|
||||
## 架构概览
|
||||
📖 [项目概览(非技术)](docs/OVERVIEW.md) ·
|
||||
🔧 [插件开发指南](docs/PLUGIN_DEV.md) ·
|
||||
🏗️ [技术架构](docs/ARCHITECTURE.md) ·
|
||||
📋 [实施计划](PLAN.md)
|
||||
|
||||
```
|
||||
homed (内核) — 零 IO,纯管理
|
||||
├── LLM 源管理 (Lua 适配器协议转换)
|
||||
├── Agent 编排 (主 agent + interceptLoop + 子 agent)
|
||||
├── 三层记忆 (Context → Document → Graph)
|
||||
├── 知识库 (独立 TF-IDF)
|
||||
├── IO 通道管理 (Queue / Interrupt / Output)
|
||||
├── 阶段管道 (StageHost: 7 阶段并行)
|
||||
└── 事件总线 (EventBus)
|
||||
│
|
||||
▼ PluginSDK (Go API: 工具/阶段/事件/记忆/知识/LLM/配置)
|
||||
│
|
||||
plugins (init() 自注册 + .so 动态加载)
|
||||
├── WebUI (HTTP 服务)
|
||||
├── CLI (Unix socket)
|
||||
├── OpenClaw 兼容 (SKILL.md → SDK 工具)
|
||||
├── Timer (timer_set 工具 + 中断反馈)
|
||||
└── 第三方 .so 插件 (plugins/<name>/plugin.so)
|
||||
```
|
||||
|
||||
核心文档: [PLAN.md](PLAN.md) · [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md)
|
||||
|
||||
## 构建
|
||||
## 快速体验
|
||||
|
||||
```bash
|
||||
# 构建
|
||||
make build
|
||||
./build/homed -data /tmp/homeagent
|
||||
./build/waiter -say "你好"
|
||||
|
||||
# 启动内核(需要 DeepSeek API 密钥)
|
||||
DEEPSEEK_API_KEY="sk-xxx" ./build/homed -data /tmp/ha
|
||||
|
||||
# 在另一个终端聊天
|
||||
echo "你好" | ./build/waiter -socket /tmp/ha/cli.sock
|
||||
```
|
||||
|
||||
依赖: Go 1.19+, CGo (go-sqlite3), Linux (Unix socket + overlayfs)
|
||||
## 架构一句话
|
||||
|
||||
```
|
||||
homed(内核零 IO)← PluginSDK → 插件(所有 IO 能力)
|
||||
```
|
||||
|
||||
依赖:Go 1.19+, CGo (go-sqlite3), Linux。
|
||||
|
||||
Reference in New Issue
Block a user