diff --git a/README.md b/README.md index ed1101a..2bd22e8 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,8 @@ Build AI agent teams that work together. One agent plans, another implements, a [![license](https://img.shields.io/github/license/JackChen-me/open-multi-agent)](./LICENSE) [![TypeScript](https://img.shields.io/badge/TypeScript-5.6-blue)](https://www.typescriptlang.org/) +**English** | [中文](./README_zh.md) + ## Why Open Multi-Agent? - **Multi-Agent Teams** — Define agents with different roles, tools, and even different models. They collaborate through a message bus and shared memory. diff --git a/README_zh.md b/README_zh.md new file mode 100644 index 0000000..116c7ff --- /dev/null +++ b/README_zh.md @@ -0,0 +1,282 @@ +# Open Multi-Agent + +构建能协同工作的 AI 智能体团队。一个智能体负责规划,一个负责实现,一个负责审查——框架自动处理任务调度、依赖关系和智能体间通信。 + +[![GitHub stars](https://img.shields.io/github/stars/JackChen-me/open-multi-agent)](https://github.com/JackChen-me/open-multi-agent/stargazers) +[![license](https://img.shields.io/github/license/JackChen-me/open-multi-agent)](./LICENSE) +[![TypeScript](https://img.shields.io/badge/TypeScript-5.6-blue)](https://www.typescriptlang.org/) + +[English](./README.md) | **中文** + +## 为什么选择 Open Multi-Agent? + +- **多智能体团队** — 定义不同角色、工具甚至不同模型的智能体。它们通过消息总线和共享内存协作。 +- **任务 DAG 调度** — 任务之间存在依赖关系。框架进行拓扑排序——有依赖的任务等待,无依赖的任务并行执行。 +- **模型无关** — Claude 和 GPT 可以在同一个团队中使用。每个智能体可以单独配置模型。你也可以为任何 LLM 编写自己的适配器。 +- **进程内执行** — 没有子进程开销。所有内容在一个 Node.js 进程中运行。可部署到 Serverless、Docker、CI/CD。 + +## 快速开始 + +```bash +npm install @jackchen_me/open-multi-agent +``` + +在环境变量中设置 `ANTHROPIC_API_KEY`(以及可选的 `OPENAI_API_KEY`)。 + +```typescript +import { OpenMultiAgent } from '@jackchen_me/open-multi-agent' + +const orchestrator = new OpenMultiAgent({ defaultModel: 'claude-sonnet-4-6' }) + +// 一个智能体,一个任务 +const result = await orchestrator.runAgent( + { + name: 'coder', + model: 'claude-sonnet-4-6', + tools: ['bash', 'file_write'], + }, + 'Write a TypeScript function that reverses a string, save it to /tmp/reverse.ts, and run it.', +) + +console.log(result.output) +``` + +## 多智能体团队 + +这才是有意思的地方。三个智能体,一个目标: + +```typescript +import { OpenMultiAgent } from '@jackchen_me/open-multi-agent' +import type { AgentConfig } from '@jackchen_me/open-multi-agent' + +const architect: AgentConfig = { + name: 'architect', + model: 'claude-sonnet-4-6', + systemPrompt: 'You design clean API contracts and file structures.', + tools: ['file_write'], +} + +const developer: AgentConfig = { + name: 'developer', + model: 'claude-sonnet-4-6', + systemPrompt: 'You implement what the architect designs.', + tools: ['bash', 'file_read', 'file_write', 'file_edit'], +} + +const reviewer: AgentConfig = { + name: 'reviewer', + model: 'claude-sonnet-4-6', + systemPrompt: 'You review code for correctness and clarity.', + tools: ['file_read', 'grep'], +} + +const orchestrator = new OpenMultiAgent({ + defaultModel: 'claude-sonnet-4-6', + onProgress: (event) => console.log(event.type, event.agent ?? event.task ?? ''), +}) + +const team = orchestrator.createTeam('api-team', { + name: 'api-team', + agents: [architect, developer, reviewer], + sharedMemory: true, +}) + +// 描述一个目标——框架将其拆解为任务并编排执行 +const result = await orchestrator.runTeam(team, 'Create a REST API for a todo list in /tmp/todo-api/') + +console.log(`成功: ${result.success}`) +console.log(`Token 用量: ${result.totalTokenUsage.output_tokens} output tokens`) +``` + +## 更多示例 + +
+任务流水线 — 显式控制任务图和分配 + +```typescript +const result = await orchestrator.runTasks(team, [ + { + title: 'Design the data model', + description: 'Write a TypeScript interface spec to /tmp/spec.md', + assignee: 'architect', + }, + { + title: 'Implement the module', + description: 'Read /tmp/spec.md and implement the module in /tmp/src/', + assignee: 'developer', + dependsOn: ['Design the data model'], // 等待设计完成后才开始 + }, + { + title: 'Write tests', + description: 'Read the implementation and write Vitest tests.', + assignee: 'developer', + dependsOn: ['Implement the module'], + }, + { + title: 'Review code', + description: 'Review /tmp/src/ and produce a structured code review.', + assignee: 'reviewer', + dependsOn: ['Implement the module'], // 可以和测试并行执行 + }, +]) +``` + +
+ +
+自定义工具 — 使用 Zod schema 定义工具 + +```typescript +import { z } from 'zod' +import { defineTool, Agent, ToolRegistry, ToolExecutor, registerBuiltInTools } from '@jackchen_me/open-multi-agent' + +const searchTool = defineTool({ + name: 'web_search', + description: 'Search the web and return the top results.', + inputSchema: z.object({ + query: z.string().describe('The search query.'), + maxResults: z.number().optional().describe('Number of results (default 5).'), + }), + execute: async ({ query, maxResults = 5 }) => { + const results = await mySearchProvider(query, maxResults) + return { data: JSON.stringify(results), isError: false } + }, +}) + +const registry = new ToolRegistry() +registerBuiltInTools(registry) +registry.register(searchTool) + +const executor = new ToolExecutor(registry) +const agent = new Agent( + { name: 'researcher', model: 'claude-sonnet-4-6', tools: ['web_search'] }, + registry, + executor, +) + +const result = await agent.run('Find the three most recent TypeScript releases.') +``` + +
+ +
+多模型团队 — 在一个工作流中混合使用 Claude 和 GPT + +```typescript +const claudeAgent: AgentConfig = { + name: 'strategist', + model: 'claude-opus-4-6', + provider: 'anthropic', + systemPrompt: 'You plan high-level approaches.', + tools: ['file_write'], +} + +const gptAgent: AgentConfig = { + name: 'implementer', + model: 'gpt-5.4', + provider: 'openai', + systemPrompt: 'You implement plans as working code.', + tools: ['bash', 'file_read', 'file_write'], +} + +const team = orchestrator.createTeam('mixed-team', { + name: 'mixed-team', + agents: [claudeAgent, gptAgent], + sharedMemory: true, +}) + +const result = await orchestrator.runTeam(team, 'Build a CLI tool that converts JSON to CSV.') +``` + +
+ +
+流式输出 + +```typescript +import { Agent, ToolRegistry, ToolExecutor, registerBuiltInTools } from '@jackchen_me/open-multi-agent' + +const registry = new ToolRegistry() +registerBuiltInTools(registry) +const executor = new ToolExecutor(registry) + +const agent = new Agent( + { name: 'writer', model: 'claude-sonnet-4-6', maxTurns: 3 }, + registry, + executor, +) + +for await (const event of agent.stream('Explain monads in two sentences.')) { + if (event.type === 'text' && typeof event.data === 'string') { + process.stdout.write(event.data) + } +} +``` + +
+ +## 架构 + +``` +┌─────────────────────────────────────────────────────────────────┐ +│ OpenMultiAgent (Orchestrator) │ +│ │ +│ createTeam() runTeam() runTasks() runAgent() getStatus() │ +└──────────────────────┬──────────────────────────────────────────┘ + │ + ┌──────────▼──────────┐ + │ Team │ + │ - AgentConfig[] │ + │ - MessageBus │ + │ - TaskQueue │ + │ - SharedMemory │ + └──────────┬──────────┘ + │ + ┌─────────────┴─────────────┐ + │ │ +┌────────▼──────────┐ ┌───────────▼───────────┐ +│ AgentPool │ │ TaskQueue │ +│ - Semaphore │ │ - dependency graph │ +│ - runParallel() │ │ - auto unblock │ +└────────┬──────────┘ │ - cascade failure │ + │ └───────────────────────┘ +┌────────▼──────────┐ +│ Agent │ +│ - run() │ ┌──────────────────────┐ +│ - prompt() │───►│ LLMAdapter │ +│ - stream() │ │ - AnthropicAdapter │ +└────────┬──────────┘ │ - OpenAIAdapter │ + │ └──────────────────────┘ +┌────────▼──────────┐ +│ AgentRunner │ ┌──────────────────────┐ +│ - conversation │───►│ ToolRegistry │ +│ loop │ │ - defineTool() │ +│ - tool dispatch │ │ - 5 built-in tools │ +└───────────────────┘ └──────────────────────┘ +``` + +## 内置工具 + +| 工具 | 说明 | +|------|------| +| `bash` | 执行 Shell 命令。返回 stdout + stderr。支持超时和工作目录设置。 | +| `file_read` | 读取指定绝对路径的文件内容。支持偏移量和行数限制以处理大文件。 | +| `file_write` | 写入或创建文件。自动创建父目录。 | +| `file_edit` | 通过精确字符串匹配编辑文件。 | +| `grep` | 使用正则表达式搜索文件内容。优先使用 ripgrep,回退到 Node.js 实现。 | + +## 参与贡献 + +欢迎提 Issue、功能需求和 PR。以下方向的贡献尤其有价值: + +- **LLM 适配器** — Ollama、llama.cpp、vLLM、Gemini。`LLMAdapter` 接口只需实现两个方法:`chat()` 和 `stream()`。 +- **示例** — 真实场景的工作流和用例。 +- **文档** — 指南、教程和 API 文档。 + +## Star 趋势 + +[![Star History Chart](https://api.star-history.com/svg?repos=JackChen-me/open-multi-agent&type=Date)](https://star-history.com/#JackChen-me/open-multi-agent&Date) + +## 许可证 + +MIT