清理 main.go 模板代码并补充 README 文档

- 移除 main.go 中的 GoLand 自动生成模板代码，替换为项目实际入口 - 补充空的 README.md，添加项目说明、架构图、模块表和快速开始指南
2026-05-14 15:36:42 +08:00
parent 6dba8028d3
commit b8459ef36c
2 changed files with 118 additions and 12 deletions
@@ -0,0 +1,68 @@
+# go-tiny-claw
+
+一个轻量级的 AI Agent 引擎，基于 Go 语言实现标准的 **ReAct（Reasoning + Acting）** 循环模式。
+
+## 项目背景
+
+go-tiny-claw 受 Claude / OpenAI 的 Agent 概念启发，旨在提供一个简洁、可扩展的微型 Agent 框架核心。它定义了 Agent 与大模型交互的标准契约，让开发者可以快速搭建自己的 AI 助手应用。
+
+## 核心架构
+
+```
+┌─────────────────────────────────────────────┐
+│                AgentEngine                   │
+│  ┌──────────┐    ┌──────────┐               │
+│  │LLMProvider│    │ Registry │               │
+│  └─────┬────┘    └─────┬────┘               │
+│        │               │                    │
+│        ▼               ▼                    │
+│  大模型推理服务     本地工具执行              │
+└─────────────────────────────────────────────┘
+```
+
+### 模块说明
+
+| 包 | 说明 |
+|---|---|
+| `internal/engine` | **AgentEngine** — 核心驱动，实现 ReAct 主循环 |
+| `internal/provider` | **LLMProvider** 接口 — 与大模型通信的统一契约 |
+| `internal/schema` | 核心数据结构定义（Message、ToolCall、ToolResult） |
+| `internal/tools` | **Registry** 接口 — 工具的注册与分发执行 |
+
+### ReAct 循环流程
+
+1. 系统初始化 Context，注入用户指令
+2. 向大模型发起推理请求（含可用工具列表）
+3. 模型返回文本回复和/或工具调用请求
+4. 如果模型未请求工具调用 → 任务完成，退出循环
+5. 执行模型请求的工具，获取 Observation
+6. 将 Observation 追加到上下文，回到步骤 2
+
+## 快速开始
+
+```go
+package main
+
+import (
+    "context"
+    "go-tiny-claw/internal/engine"
+    "go-tiny-claw/internal/schema"
+)
+
+func main() {
+    provider := &mockProvider{}
+    registry := &mockRegistry{}
+    eng := engine.NewAgentEngine(provider, registry, "/path/to/workdir")
+    eng.Run(context.Background(), "你的指令")
+}
+```
+
+## 扩展
+
+- **替换 Provider**: 实现 `LLMProvider` 接口即可接入任意大模型（OpenAI、Claude、本地模型等）
+- **注册工具**: 实现 `Registry` 接口即可挂载自定义工具集（bash、文件操作、代码搜索等）
+- **自定义 Schema**: 基于 `schema` 包的数据结构可灵活扩展消息格式和工具定义
+
+## License
+
+MIT