opc-agent 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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 [yyyy] [name of copyright owner]
+
+   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,179 @@
+# OPC Agent
+
+**Open Agent Framework — Build, test, and run AI Agents for business workstations.**
+
+[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![TypeScript](https://img.shields.io/badge/TypeScript-5.5-blue.svg)](https://www.typescriptlang.org/)
+
+OPC Agent is an open-source framework for building production-ready AI agents. It provides a declarative agent definition format (OAD), pluggable skills, multi-channel support, and a progressive trust model for safe deployment.
+
+## Architecture
+
+```
+┌─────────────────────────────────────────────────┐
+│                   OPC Agent                      │
+├─────────────┬──────────┬────────────────────────┤
+│   Channels  │  Skills  │       Memory           │
+│  ┌────────┐ │ ┌──────┐ │  ┌──────────────────┐  │
+│  │  Web   │ │ │ FAQ  │ │  │  Short-term       │  │
+│  │  WS    │ │ │Custom│ │  │  Long-term        │  │
+│  │  CLI   │ │ │ ...  │ │  └──────────────────┘  │
+│  └────────┘ │ └──────┘ │                        │
+├─────────────┴──────────┴────────────────────────┤
+│              Agent Runtime                       │
+│  ┌──────────┐ ┌────────┐ ┌────────────────────┐ │
+│  │ Lifecycle│ │ Router │ │   LLM Providers    │ │
+│  │ Manager  │ │        │ │ OpenAI/DeepSeek/   │ │
+│  │          │ │        │ │ Qwen via agentkits │ │
+│  └──────────┘ └────────┘ └────────────────────┘ │
+├─────────────────────────────────────────────────┤
+│              DTV Framework                       │
+│  Data (read-only) │ Trust (sandbox→listed) │ Value│
+└─────────────────────────────────────────────────┘
+```
+
+## Quick Start
+
+```bash
+# Install
+npm install -g opc-agent
+
+# Create a new agent project
+opc init my-agent --template customer-service
+
+# Enter the project
+cd my-agent
+
+# Validate the agent definition
+opc build
+
+# Test in sandbox
+opc test
+
+# Run the agent
+opc run
+```
+
+## OAD — Open Agent Definition
+
+Agents are defined using a declarative YAML format:
+
+```yaml
+apiVersion: opc/v1
+kind: Agent
+metadata:
+  name: my-agent
+  version: 1.0.0
+  description: "My first agent"
+spec:
+  provider:
+    default: deepseek
+    allowed: [openai, deepseek, qwen]
+  model: deepseek-chat
+  systemPrompt: "You are a helpful assistant."
+  skills:
+    - name: faq-lookup
+      description: "Look up FAQ answers"
+  channels:
+    - type: web
+      port: 3000
+  memory:
+    shortTerm: true
+    longTerm: false
+  dtv:
+    trust:
+      level: sandbox
+    value:
+      metrics: [response_time, satisfaction_score]
+```
+
+## Programmatic Usage
+
+```typescript
+import { BaseAgent, AgentRuntime, WebChannel } from 'opc-agent';
+
+// Option 1: Use runtime with OAD file
+const runtime = new AgentRuntime();
+await runtime.loadConfig('oad.yaml');
+await runtime.initialize();
+await runtime.start();
+
+// Option 2: Build programmatically
+const agent = new BaseAgent({
+  name: 'my-agent',
+  systemPrompt: 'You are helpful.',
+  provider: 'deepseek',
+  model: 'deepseek-chat',
+});
+
+agent.registerSkill(myCustomSkill);
+agent.bindChannel(new WebChannel(3000));
+
+await agent.init();
+await agent.start();
+```
+
+## Core Concepts
+
+| Concept | Description |
+|---------|-------------|
+| **Agent** | Autonomous AI entity with lifecycle (init → ready → running → stopped) |
+| **Skill** | Modular capability (FAQ, ticket creation, etc.) |
+| **Channel** | User interface (Web HTTP, WebSocket, CLI) |
+| **Memory** | Short-term (session) and long-term (persistent) |
+| **OAD** | Declarative YAML agent definition format |
+
+## DTV Framework
+
+**D**ata — **T**rust — **V**alue: A governance framework for agent operations.
+
+- **Data**: Read-only access to business data via MRGConfig reader
+- **Trust**: Progressive levels control capabilities
+  - `sandbox` → `verified` → `certified` → `listed`
+- **Value**: Metrics tracking for ROI (response time, satisfaction, resolution rate)
+
+## Templates
+
+| Template | Description |
+|----------|-------------|
+| `customer-service` | FAQ + human handoff, web channel |
+| More coming soon... | Sales, IT help desk, content moderation |
+
+## CLI Commands
+
+| Command | Description |
+|---------|-------------|
+| `opc init [name]` | Initialize a new agent project |
+| `opc create <name>` | Create agent from template |
+| `opc build` | Validate OAD definition |
+| `opc test` | Run in sandbox mode |
+| `opc run` | Start agent with channels |
+| `opc publish` | Package for registry (coming soon) |
+
+## Comparison
+
+| Feature | OPC Agent | LangChain | AutoGen |
+|---------|-----------|-----------|---------|
+| Declarative config | ✅ OAD YAML | ❌ | ❌ |
+| Trust levels | ✅ 4-tier | ❌ | ❌ |
+| Built-in channels | ✅ Web, WS | ❌ | ❌ |
+| Business-focused | ✅ | ❌ General | ❌ Research |
+| Value tracking | ✅ ROI metrics | ❌ | ❌ |
+| TypeScript-first | ✅ | Python | Python |
+| Lightweight | ✅ ~5 deps | ❌ Heavy | ❌ Heavy |
+
+## Contributing
+
+1. Fork the repository
+2. Create a feature branch: `git checkout -b feature/my-feature`
+3. Commit your changes: `git commit -am 'Add my feature'`
+4. Push: `git push origin feature/my-feature`
+5. Open a Pull Request
+
+## License
+
+[Apache-2.0](LICENSE)
+
+---
+
+Built by [Deepleaper](https://github.com/Deepleaper) 🚀

package/README.zh-CN.md

@@ -0,0 +1,126 @@
+# OPC Agent
+
+**开放 Agent 框架 — 构建、测试和运行面向企业工作站的 AI Agent。**
+
+[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![TypeScript](https://img.shields.io/badge/TypeScript-5.5-blue.svg)](https://www.typescriptlang.org/)
+
+OPC Agent 是一个开源框架，用于构建生产级 AI Agent。提供声明式 Agent 定义格式（OAD）、可插拔技能、多通道支持，以及渐进式信任模型确保安全部署。
+
+## 架构
+
+```
+┌─────────────────────────────────────────────────┐
+│                   OPC Agent                      │
+├─────────────┬──────────┬────────────────────────┤
+│    通道      │   技能   │        记忆            │
+│  ┌────────┐ │ ┌──────┐ │  ┌──────────────────┐  │
+│  │  Web   │ │ │ FAQ  │ │  │  短期记忆         │  │
+│  │  WS    │ │ │ 自定义│ │  │  长期记忆         │  │
+│  │  CLI   │ │ │ ...  │ │  └──────────────────┘  │
+│  └────────┘ │ └──────┘ │                        │
+├─────────────┴──────────┴────────────────────────┤
+│              Agent 运行时                        │
+│  ┌──────────┐ ┌────────┐ ┌────────────────────┐ │
+│  │ 生命周期  │ │ 路由器 │ │   LLM 提供商       │ │
+│  │ 管理器    │ │        │ │ OpenAI/DeepSeek/   │ │
+│  │          │ │        │ │ Qwen (agentkits)   │ │
+│  └──────────┘ └────────┘ └────────────────────┘ │
+├─────────────────────────────────────────────────┤
+│              DTV 框架                            │
+│  数据（只读）│ 信任（沙箱→上架）│ 价值（指标追踪）│
+└─────────────────────────────────────────────────┘
+```
+
+## 快速开始
+
+```bash
+# 安装
+npm install -g opc-agent
+
+# 创建新的 Agent 项目
+opc init my-agent --template customer-service
+
+# 进入项目目录
+cd my-agent
+
+# 验证 Agent 定义
+opc build
+
+# 沙箱测试
+opc test
+
+# 运行 Agent
+opc run
+```
+
+## OAD — 开放 Agent 定义
+
+Agent 使用声明式 YAML 格式定义：
+
+```yaml
+apiVersion: opc/v1
+kind: Agent
+metadata:
+  name: my-agent
+  version: 1.0.0
+  description: "我的第一个 Agent"
+spec:
+  provider:
+    default: deepseek
+    allowed: [openai, deepseek, qwen]
+  model: deepseek-chat
+  systemPrompt: "你是一个有用的助手。"
+  skills:
+    - name: faq-lookup
+      description: "查询常见问题"
+  channels:
+    - type: web
+      port: 3000
+  memory:
+    shortTerm: true
+    longTerm: false
+  dtv:
+    trust:
+      level: sandbox
+    value:
+      metrics: [response_time, satisfaction_score]
+```
+
+## 核心概念
+
+| 概念 | 说明 |
+|------|------|
+| **Agent** | 自治 AI 实体，具有生命周期（init → ready → running → stopped） |
+| **Skill（技能）** | 模块化能力（FAQ、工单创建等） |
+| **Channel（通道）** | 用户接口（Web HTTP、WebSocket、CLI） |
+| **Memory（记忆）** | 短期（会话内）和长期（持久化） |
+| **OAD** | 声明式 YAML Agent 定义格式 |
+
+## DTV 框架
+
+**D**ata（数据）— **T**rust（信任）— **V**alue（价值）：Agent 运营治理框架。
+
+- **数据**：通过 MRGConfig 只读访问业务数据
+- **信任**：渐进式级别控制 Agent 能力
+  - `sandbox`（沙箱）→ `verified`（已验证）→ `certified`（已认证）→ `listed`（已上架）
+- **价值**：ROI 指标追踪（响应时间、满意度、解决率）
+
+## CLI 命令
+
+| 命令 | 说明 |
+|------|------|
+| `opc init [name]` | 初始化新的 Agent 项目 |
+| `opc create <name>` | 从模板创建 Agent |
+| `opc build` | 验证 OAD 定义 |
+| `opc test` | 沙箱模式测试 |
+| `opc run` | 启动 Agent |
+| `opc publish` | 打包到注册中心（即将推出） |
+
+## 许可证
+
+[Apache-2.0](LICENSE)
+
+---
+
+由 [Deepleaper](https://github.com/Deepleaper) 构建 🚀

package/dist/channels/index.d.ts

@@ -0,0 +1,10 @@
+import type { IChannel, Message } from '../core/types';
+export type { IChannel } from '../core/types';
+export declare abstract class BaseChannel implements IChannel {
+    abstract type: string;
+    protected handler: ((message: Message) => Promise<Message>) | null;
+    onMessage(handler: (message: Message) => Promise<Message>): void;
+    abstract start(): Promise<void>;
+    abstract stop(): Promise<void>;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/channels/index.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseChannel = void 0;
+class BaseChannel {
+    handler = null;
+    onMessage(handler) {
+        this.handler = handler;
+    }
+}
+exports.BaseChannel = BaseChannel;
+//# sourceMappingURL=index.js.map

package/dist/channels/web.d.ts

@@ -0,0 +1,12 @@
+import { BaseChannel } from './index';
+export declare class WebChannel extends BaseChannel {
+    readonly type = "web";
+    private app;
+    private server;
+    private port;
+    constructor(port?: number);
+    private setupRoutes;
+    start(): Promise<void>;
+    stop(): Promise<void>;
+}
+//# sourceMappingURL=web.d.ts.map

package/dist/channels/web.js

@@ -0,0 +1,81 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebChannel = void 0;
+const express_1 = __importDefault(require("express"));
+const index_1 = require("./index");
+class WebChannel extends index_1.BaseChannel {
+    type = 'web';
+    app;
+    server = null;
+    port;
+    constructor(port = 3000) {
+        super();
+        this.port = port;
+        this.app = (0, express_1.default)();
+        this.app.use(express_1.default.json());
+        this.setupRoutes();
+    }
+    setupRoutes() {
+        this.app.get('/health', (_req, res) => {
+            res.json({ status: 'ok', timestamp: Date.now() });
+        });
+        this.app.post('/chat', async (req, res) => {
+            if (!this.handler) {
+                res.status(503).json({ error: 'Agent not ready' });
+                return;
+            }
+            const { message, sessionId } = req.body;
+            if (!message) {
+                res.status(400).json({ error: 'message is required' });
+                return;
+            }
+            const msg = {
+                id: `msg_${Date.now()}_${Math.random().toString(36).slice(2, 8)}`,
+                role: 'user',
+                content: message,
+                timestamp: Date.now(),
+                metadata: { sessionId: sessionId ?? 'default' },
+            };
+            try {
+                const response = await this.handler(msg);
+                res.json({ response: response.content, id: response.id });
+            }
+            catch (err) {
+                res.status(500).json({ error: 'Internal error' });
+            }
+        });
+        // SSE streaming endpoint
+        this.app.get('/stream', (req, res) => {
+            res.writeHead(200, {
+                'Content-Type': 'text/event-stream',
+                'Cache-Control': 'no-cache',
+                'Connection': 'keep-alive',
+            });
+            res.write('data: {"type":"connected"}\n\n');
+            const interval = setInterval(() => {
+                res.write('data: {"type":"heartbeat"}\n\n');
+            }, 30000);
+            req.on('close', () => clearInterval(interval));
+        });
+    }
+    async start() {
+        return new Promise((resolve) => {
+            this.server = this.app.listen(this.port, () => {
+                console.log(`[WebChannel] Listening on port ${this.port}`);
+                resolve();
+            });
+        });
+    }
+    async stop() {
+        return new Promise((resolve, reject) => {
+            if (!this.server)
+                return resolve();
+            this.server.close((err) => (err ? reject(err) : resolve()));
+        });
+    }
+}
+exports.WebChannel = WebChannel;
+//# sourceMappingURL=web.js.map

package/dist/cli.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=cli.d.ts.map