@framers/agentos 0.1.0

package/LICENSE

@@ -0,0 +1,98 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
+
+2. Grant of Copyright License.
+
+Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License.
+
+Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution.
+
+You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
+
+   (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
+
+You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
+
+5. Submission of Contributions.
+
+Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
+
+6. Trademarks.
+
+This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty.
+
+Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability.
+
+In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability.
+
+While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+   Copyright (c) 2025 Framers
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+

package/README.md

@@ -0,0 +1,576 @@
+<div align="center">
+
+<a href="https://agentos.sh">
+  <img src="https://raw.githubusercontent.com/framersai/agentos/master/assets/agentos-primary-transparent-2x.png" alt="AgentOS" height="80" />
+</a>
+
+# AgentOS
+
+**Modular orchestration runtime for adaptive AI agents**
+
+[![npm version](https://img.shields.io/npm/v/@framers/agentos?style=flat-square&logo=npm&color=cb3837)](https://www.npmjs.com/package/@framers/agentos)
+[![CI](https://img.shields.io/github/actions/workflow/status/framersai/agentos/ci.yml?style=flat-square&logo=github&label=CI)](https://github.com/framersai/agentos/actions)
+[![codecov](https://codecov.io/gh/framersai/agentos/graph/badge.svg)](https://codecov.io/gh/framersai/agentos)
+[![TypeScript](https://img.shields.io/badge/TypeScript-5.4+-3178c6?style=flat-square&logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
+[![License](https://img.shields.io/badge/License-Apache_2.0-blue?style=flat-square)](https://opensource.org/licenses/Apache-2.0)
+
+[Website](https://agentos.sh) · [Documentation](https://agentos.sh/docs) · [npm](https://www.npmjs.com/package/@framers/agentos) · [GitHub](https://github.com/framersai/agentos)
+
+</div>
+
+---
+
+## Table of Contents
+
+- [Overview](#overview)
+- [Features](#features)
+- [Installation](#installation)
+- [Quick Start](#quick-start)
+- [Architecture](#architecture)
+- [Documentation](#documentation)
+- [Examples](#examples)
+- [Roadmap](#roadmap)
+- [Contributing](#contributing)
+- [License](#license)
+
+---
+
+## Overview
+
+AgentOS is a TypeScript-first orchestration runtime for building **adaptive, emergent AI agents**. Unlike traditional agent frameworks that treat agents as stateless functions, AgentOS introduces **Generalized Mind Instances (GMIs)** — context-aware entities that learn, evolve, and maintain coherent personalities across interactions.
+
+```bash
+npm install @framers/agentos
+```
+
+---
+
+## Features
+
+<table>
+<tr>
+<td width="50%">
+
+### ◆ Adaptive Intelligence
+- **GMI Architecture** — Persistent agent identities with working memory
+- **Dynamic Personas** — Contextual personality adaptation
+- **Multi-model Support** — OpenAI, Anthropic, local models
+
+</td>
+<td width="50%">
+
+### ◆ Streaming-First Runtime
+- **Token-level streaming** — Real-time response delivery
+- **Async generators** — Native TypeScript patterns
+- **WebSocket & SSE** — Multiple transport protocols
+
+</td>
+</tr>
+<tr>
+<td width="50%">
+
+### ◆ Tool Orchestration
+- **Permission management** — Fine-grained access control
+- **Dynamic registration** — Runtime tool discovery
+- **Guardrails** — Safety constraints and validation
+
+</td>
+<td width="50%">
+
+### ◆ RAG & Memory
+- **Vector storage** — Semantic memory retrieval
+- **SQL adapters** — SQLite, PostgreSQL support
+- **Context optimization** — Automatic window management
+
+</td>
+</tr>
+<tr>
+<td width="50%">
+
+### ◆ Multi-Agent Coordination
+- **Agency system** — Agent hierarchies and teams
+- **Message bus** — Inter-agent communication
+- **Handoffs** — Context transfer between agents
+
+</td>
+<td width="50%">
+
+### ◆ Human-in-the-Loop
+- **Approval workflows** — High-risk action gates
+- **Clarification requests** — Ambiguity resolution
+- **Escalation handling** — Human takeover paths
+
+</td>
+</tr>
+</table>
+
+---
+
+## Installation
+
+```bash
+# npm
+npm install @framers/agentos
+
+# pnpm
+pnpm add @framers/agentos
+
+# yarn
+yarn add @framers/agentos
+```
+
+**Requirements:** Node.js 18+ · TypeScript 5.0+
+
+---
+
+## Quick Start
+
+```typescript
+import { AgentOS } from '@framers/agentos';
+
+// Initialize
+const agent = new AgentOS();
+await agent.initialize({
+  llmProvider: {
+    provider: 'openai',
+    apiKey: process.env.OPENAI_API_KEY,
+    model: 'gpt-4o'
+  }
+});
+
+// Process requests with streaming
+for await (const chunk of agent.processRequest({
+  message: 'Help me analyze this data',
+  context: { userId: 'user-123' }
+})) {
+  if (chunk.type === 'content') {
+    process.stdout.write(chunk.content);
+  }
+}
+```
+
+### With Tools
+
+```typescript
+import { AgentOS } from '@framers/agentos';
+
+const agent = new AgentOS();
+await agent.initialize({
+  llmProvider: {
+    provider: 'openai',
+    apiKey: process.env.OPENAI_API_KEY,
+    model: 'gpt-4o'
+  },
+  tools: [{
+    name: 'get_weather',
+    description: 'Get current weather for a city',
+  parameters: {
+    type: 'object',
+    properties: {
+        city: { type: 'string' }
+    },
+      required: ['city']
+  },
+    execute: async ({ city }) => {
+      const res = await fetch(`https://api.weather.com/${city}`);
+      return res.json();
+    }
+  }]
+});
+
+// Tools are called automatically when the model decides to use them
+for await (const chunk of agent.processRequest({ message: 'Weather in Tokyo?' })) {
+  if (chunk.type === 'tool_call') console.log('Calling:', chunk.tool);
+  if (chunk.type === 'content') process.stdout.write(chunk.content);
+  }
+```
+
+### Multiple Providers
+
+```typescript
+// OpenRouter for multi-model access
+await agent.initialize({
+  llmProvider: {
+    provider: 'openrouter',
+    apiKey: process.env.OPENROUTER_API_KEY,
+    model: 'anthropic/claude-3.5-sonnet'
+  }
+});
+
+// Local Ollama
+await agent.initialize({
+  llmProvider: {
+    provider: 'ollama',
+    baseUrl: 'http://localhost:11434',
+    model: 'llama3'
+  }
+});
+```
+
+### With RAG Memory
+
+```typescript
+import { AgentOS } from '@framers/agentos';
+
+const agent = new AgentOS();
+await agent.initialize({
+  llmProvider: {
+    provider: 'openai',
+    apiKey: process.env.OPENAI_API_KEY,
+    model: 'gpt-4o'
+  },
+  memory: {
+    vectorStore: 'memory', // or 'sqlite', 'postgres'
+    embeddingModel: 'text-embedding-3-small'
+  }
+});
+
+// Ingest documents
+await agent.memory.ingest([
+  { content: 'AgentOS supports streaming responses...', metadata: { source: 'docs' } },
+  { content: 'GMIs maintain context across sessions...', metadata: { source: 'docs' } }
+]);
+
+// Queries automatically retrieve relevant context
+for await (const chunk of agent.processRequest({ 
+  message: 'How does streaming work?' 
+})) {
+  process.stdout.write(chunk.content);
+}
+```
+
+---
+
+## Architecture
+
+```
+┌─────────────────────────────────────────────────────────────────┐
+│                         AgentOS Runtime                          │
+├─────────────────────────────────────────────────────────────────┤
+│  ┌─────────────┐  ┌─────────────┐  ┌─────────────┐              │
+│  │   Request   │  │   Prompt    │  │  Streaming  │              │
+│  │   Router    │→ │   Engine    │→ │   Manager   │              │
+│  └─────────────┘  └─────────────┘  └─────────────┘              │
+│         ↓                ↓                ↓                      │
+│  ┌─────────────────────────────────────────────────────────┐    │
+│  │                    GMI Manager                           │    │
+│  │  ┌─────────┐  ┌─────────┐  ┌─────────┐  ┌─────────┐    │    │
+│  │  │ Working │  │ Context │  │ Persona │  │Learning │    │    │
+│  │  │ Memory  │  │ Manager │  │ Overlay │  │ Module  │    │    │
+│  │  └─────────┘  └─────────┘  └─────────┘  └─────────┘    │    │
+│  └─────────────────────────────────────────────────────────┘    │
+│         ↓                ↓                ↓                      │
+│  ┌─────────────┐  ┌─────────────┐  ┌─────────────┐              │
+│  │    Tool     │  │    RAG      │  │  Planning   │              │
+│  │Orchestrator │  │   Memory    │  │   Engine    │              │
+│  └─────────────┘  └─────────────┘  └─────────────┘              │
+│         ↓                ↓                ↓                      │
+│  ┌─────────────────────────────────────────────────────────┐    │
+│  │              LLM Provider Manager                        │    │
+│  │     OpenAI  │  Anthropic  │  Azure  │  Local Models     │    │
+│  └─────────────────────────────────────────────────────────┘    │
+└─────────────────────────────────────────────────────────────────┘
+```
+
+---
+
+## Documentation
+
+| Guide | Description |
+|-------|-------------|
+| [Architecture](./docs/ARCHITECTURE.md) | System design and component overview |
+| [Planning Engine](./docs/PLANNING_ENGINE.md) | Multi-step task planning and execution |
+| [Human-in-the-Loop](./docs/HUMAN_IN_THE_LOOP.md) | Approval workflows and oversight |
+| [Agent Communication](./docs/AGENT_COMMUNICATION.md) | Inter-agent messaging patterns |
+| [RAG Configuration](./docs/RAG_MEMORY_CONFIGURATION.md) | Memory and retrieval setup |
+| [Structured Output](./docs/STRUCTURED_OUTPUT.md) | JSON schema validation |
+| [Evaluation Framework](./docs/EVALUATION_FRAMEWORK.md) | Testing and quality assurance |
+| [API Reference](./docs/api/index.html) | TypeDoc-generated API docs |
+
+---
+
+## Examples
+
+### Structured Data Extraction
+
+```typescript
+import { AgentOS, StructuredOutputManager } from '@framers/agentos';
+
+const agent = new AgentOS();
+await agent.initialize({
+  llmProvider: { provider: 'openai', apiKey: process.env.OPENAI_API_KEY, model: 'gpt-4o' }
+});
+
+// Extract typed data from unstructured text
+const structured = new StructuredOutputManager({ llmProviderManager: agent.llmProviderManager });
+const contact = await structured.generate({
+  prompt: 'Extract: "Meeting with Sarah Chen (sarah@startup.io) on Jan 15 re: Series A"',
+  schema: {
+    type: 'object',
+    properties: {
+      name: { type: 'string' },
+      email: { type: 'string', format: 'email' },
+      date: { type: 'string' },
+      topic: { type: 'string' }
+    },
+    required: ['name', 'email']
+  },
+  schemaName: 'ContactInfo'
+});
+// → { name: 'Sarah Chen', email: 'sarah@startup.io', date: 'Jan 15', topic: 'Series A' }
+```
+
+### Human-in-the-Loop Approvals
+
+```typescript
+import { HumanInteractionManager } from '@framers/agentos';
+
+const hitl = new HumanInteractionManager({ defaultTimeoutMs: 300000 });
+
+// Gate high-risk operations with human approval
+const decision = await hitl.requestApproval({
+  action: {
+    type: 'database_mutation',
+    description: 'Archive 50K inactive accounts older than 2 years',
+    severity: 'high',
+    metadata: { affectedRows: 50000, table: 'users' }
+  },
+  alternatives: [
+    { action: 'soft_delete', description: 'Mark as inactive instead of archiving' },
+    { action: 'export_first', description: 'Export to CSV before archiving' }
+  ]
+});
+
+if (decision.approved) {
+  await executeArchive();
+} else if (decision.selectedAlternative) {
+  await executeAlternative(decision.selectedAlternative);
+}
+```
+
+### Autonomous Task Planning
+
+```typescript
+import { AgentOS, PlanningEngine } from '@framers/agentos';
+
+const agent = new AgentOS();
+await agent.initialize({
+  llmProvider: { provider: 'openai', apiKey: process.env.OPENAI_API_KEY, model: 'gpt-4o' }
+});
+
+const planner = new PlanningEngine({ llmProvider: agent.llmProviderManager, strategy: 'react' });
+
+// Decompose complex goals into executable steps with ReAct reasoning
+const plan = await planner.generatePlan({
+  goal: 'Migrate authentication from sessions to JWT',
+  constraints: ['Zero downtime', 'Backwards compatible for 30 days', 'Audit logging required'],
+  context: { currentStack: 'Express + Redis sessions', userCount: '50K' }
+});
+
+for await (const step of planner.executePlan(plan.id)) {
+  console.log(`[${step.status}] ${step.action}`);
+  if (step.requiresHumanApproval) {
+    const approved = await promptUser(step.description);
+    if (!approved) break;
+  }
+}
+```
+
+### Multi-Agent Collaboration
+
+```typescript
+import { AgentOS, AgencyRegistry, AgentCommunicationBus } from '@framers/agentos';
+
+// Create specialized agents
+const researcher = new AgentOS();
+await researcher.initialize({ llmProvider: llmConfig, persona: 'Research analyst' });
+
+const writer = new AgentOS();
+await writer.initialize({ llmProvider: llmConfig, persona: 'Technical writer' });
+
+// Register in agency with shared communication
+const agency = new AgencyRegistry();
+const bus = new AgentCommunicationBus();
+agency.register('researcher', researcher, { bus });
+agency.register('writer', writer, { bus });
+
+// Agents coordinate via message passing
+bus.on('research:complete', async ({ findings }) => {
+  await writer.processRequest({
+    message: `Write documentation based on: ${JSON.stringify(findings)}`
+  });
+});
+
+await researcher.processRequest({ message: 'Analyze the authentication module' });
+```
+
+### Non-Streaming Response
+
+```typescript
+import { AgentOS } from '@framers/agentos';
+
+const agent = new AgentOS();
+await agent.initialize({
+  llmProvider: { provider: 'openai', apiKey: process.env.OPENAI_API_KEY, model: 'gpt-4o' }
+});
+
+// Collect full response without streaming
+const chunks = [];
+for await (const chunk of agent.processRequest({ message: 'Explain OAuth 2.0 briefly' })) {
+  if (chunk.type === 'content') {
+    chunks.push(chunk.content);
+  }
+}
+const fullResponse = chunks.join('');
+```
+
+### Mood-Adaptive Responses
+
+```typescript
+import { AgentOS, GMIMood } from '@framers/agentos';
+
+const agent = new AgentOS();
+await agent.initialize({
+  llmProvider: { provider: 'openai', apiKey: process.env.OPENAI_API_KEY, model: 'gpt-4o' },
+  persona: {
+    name: 'Support Agent',
+    moodAdaptation: {
+      enabled: true,
+      defaultMood: GMIMood.EMPATHETIC,
+      allowedMoods: [GMIMood.EMPATHETIC, GMIMood.FOCUSED, GMIMood.ANALYTICAL],
+      sensitivityFactor: 0.7,
+      // Mood-specific prompt modifiers
+      moodPrompts: {
+        [GMIMood.EMPATHETIC]: 'Prioritize understanding and emotional support.',
+        [GMIMood.FRUSTRATED]: 'Acknowledge difficulty, offer step-by-step guidance.',
+        [GMIMood.ANALYTICAL]: 'Provide detailed technical explanations with examples.'
+      }
+    }
+  }
+});
+
+// Agent automatically adapts tone based on conversation context
+for await (const chunk of agent.processRequest({
+  message: 'This is so frustrating, nothing works!'
+})) {
+  // Response adapts with empathetic tone, mood shifts to EMPATHETIC
+}
+```
+
+### Contextual Prompt Adaptation
+
+```typescript
+import { AgentOS } from '@framers/agentos';
+
+const agent = new AgentOS();
+await agent.initialize({
+  llmProvider: llmConfig,
+  persona: {
+    name: 'Adaptive Tutor',
+    // Dynamic prompt elements injected based on runtime context
+    contextualPromptElements: [
+      {
+        id: 'beginner-guidance',
+        type: 'SYSTEM_INSTRUCTION_ADDON',
+        content: 'Explain concepts simply, avoid jargon, use analogies.',
+        criteria: { userSkillLevel: ['novice', 'beginner'] },
+        priority: 10
+      },
+      {
+        id: 'expert-mode',
+        type: 'SYSTEM_INSTRUCTION_ADDON',
+        content: 'Assume deep technical knowledge, be concise, skip basics.',
+        criteria: { userSkillLevel: ['expert', 'advanced'] },
+        priority: 10
+      },
+      {
+        id: 'debugging-context',
+        type: 'FEW_SHOT_EXAMPLE',
+        content: { role: 'assistant', content: 'Let\'s trace through step by step...' },
+        criteria: { taskHint: ['debugging', 'troubleshooting'] }
+      }
+    ],
+    // Meta-prompts for self-reflection and planning
+    metaPrompts: [
+      {
+        id: 'mid-conversation-check',
+        trigger: 'every_n_turns',
+        triggerConfig: { n: 5 },
+        prompt: 'Assess: Is the user making progress? Should I adjust my approach?'
+      }
+    ]
+  }
+});
+
+// Prompts automatically adapt based on user context and task
+await agent.updateUserContext({ skillLevel: 'expert' });
+for await (const chunk of agent.processRequest({ message: 'Explain monads' })) {
+  // Uses expert-mode prompt element, skips beginner explanations
+}
+```
+
+---
+
+## Roadmap
+
+| Version | Status | Features |
+|---------|--------|----------|
+| 0.1 | ✓ | Core runtime, GMI, streaming, tools, RAG |
+| 0.2 | → | Knowledge graphs, marketplace, visual planning |
+| 0.3 | ○ | Distributed agents, edge deployment |
+| 1.0 | ○ | Production hardening, enterprise features |
+
+See [CHANGELOG.md](./CHANGELOG.md) for release history.
+
+---
+
+## Contributing
+
+We welcome contributions. See our [Contributing Guide](https://github.com/framersai/agentos/blob/master/CONTRIBUTING.md) for details.
+
+```bash
+# Clone and setup
+git clone https://github.com/framersai/agentos.git
+cd agentos
+pnpm install
+
+# Development
+pnpm run build    # Build the package
+pnpm run test     # Run tests
+pnpm run docs     # Generate documentation
+```
+
+### Commit Convention
+
+We use [Conventional Commits](https://www.conventionalcommits.org/):
+
+```
+feat:  New features → minor version bump
+fix:   Bug fixes → patch version bump
+docs:  Documentation only
+BREAKING CHANGE: → major version bump
+```
+
+---
+
+## License
+
+[Apache 2.0](./LICENSE) © [Framers](https://frame.dev)
+
+---
+
+<div align="center">
+
+<a href="https://agentos.sh">
+  <img src="https://raw.githubusercontent.com/framersai/agentos/master/assets/agentos-primary-transparent-2x.png" alt="AgentOS" height="40" />
+</a>
+&nbsp;&nbsp;&nbsp;
+<a href="https://frame.dev">
+  <img src="https://raw.githubusercontent.com/framersai/agentos/master/assets/logos/frame-logo.svg" alt="Frame.dev" height="40" />
+</a>
+
+**Built by [Frame.dev](https://frame.dev)** · [@framersai](https://github.com/framersai)
+
+[Website](https://agentos.sh) · [Documentation](https://agentos.sh/docs) · [Twitter](https://twitter.com/framersai)
+
+</div>