@jangts/agent-core 0.1.0 → 0.1.1

package/README.md

@@ -1,5 +1,64 @@
+[English](#english) | [中文](#中文)
+
+<a id="english"></a>
+
+# @jangts/agent-core
+
+<img src="https://agent-core-docs.pages.jangts.cafe/branding/agent-core-logo.png" alt="Agent Core" width="420">
+
+A platform-independent agent runtime with a runtime API, companion Support utilities, and optional Kits. Supports ESM, CommonJS, browsers, and Node.js.
+
+[Full developer documentation](https://agent-core-docs.pages.jangts.cafe)
+
+```sh
+npm install @jangts/agent-core
+```
+
+A minimal Core call needs only a Provider and raw input. Support is optional:
+
+```ts
+import { CompatibleModelProvider, ModelRunner } from '@jangts/agent-core';
+
+const provider = new CompatibleModelProvider({ config: {
+  baseUrl: process.env.AI_BASE_URL!,
+  apiKey: process.env.AI_API_KEY!,
+  model: process.env.AI_MODEL!,
+} });
+const model = new ModelRunner({ provider });
+const text = (await model.invoke('Hello')).value;
+```
+
+This connects to a real Chat Completions-compatible model; the application supplies all three connection settings. See [Basic usage](development/docs/basic-usage.md) to override settings or add tools, context policies, and workflows.
+
+- [How it works](development/docs/mechanisms.md): collaboration, tasks, execution flow, model/tool sequences, and an application knowledge-answering example.
+- [Developer guide](development/docs/README.md): new applications, existing project integration, manual and agent-assisted development, knowledge resources, and runtime growth.
+- [API reference](development/docs/api/README.md): examples, parameters, return values, and exceptions.
+- [Complete knowledge-answering example](development/docs/api/knowledge-answering.md): reading sources, context, generation, checking, and template-based delivery.
+
+[MockGPT Kit](development/docs/api/mock.md) provides direct mock generation, Provider protocol injection, a minimal Node server, and web text sources through `@jangts/agent-core/mock`, `/mock/node`, and `/mock/web`, without a separate mock dependency import.
+
+Import Core and Support from the package root. Import Kits by module, or use the aggregate `/kits` entry point.
+
+The package manager installs streaming, mock-gpt, and other runtime dependencies automatically. See [Installation](development/docs/getting-started.md).
+
+The `agent-core-app` Skill provides resource preparation and validation tools. See [Agent-assisted development](development/docs/agent-development.md).
+
+Regular Workflow nodes assemble, select, trim, or compress context, with replaceable implementations from Support. Core retains generic trust/structure auditing, actual request measurement, budgets, and cancellation guarantees. To retain recent verbatim messages or ongoing task summaries, apply a recommended Support policy to the same configuration and override individual parameters. See [Context nodes](development/docs/api/context-processing.md).
+
+Bind fixed model definitions, Workflows, and tools ahead of time, passing only per-request state. Existing request-level Runners can join the same Engine through `bindModelRuntime` and reuse its budget and scope. Applications register `execution.observe.event` to receive execution facts; persistent logging is independently optional.
+
+`ModelRunner.sink.output` receives actual generated chunks while preserving call budgets, cancellation, and protocol validation; `invoke` still returns the complete result. Applications can use `Support.createReplyPreview` to register previewable functions and body JSON paths, then send in-progress previews with `Support.streamEvents`. Confirm the final body after business validation, or retract it on failure. Previews cannot serve as authorization, tool execution, or official history. See [Core API](development/docs/api/core.md).
+
+In this repository, `npm run test:agent-audit` builds Agent Core and MockGPT and runs logic, security, and performance regressions. Use `-- --repeat=2` for two consecutive rounds or `--no-build` to reuse existing builds. Coverage merges V8 ranges with c8/Istanbul and includes every generated ESM module, including modules not imported by existing tests. Statements, lines, functions, and branches must all reach 100%; uncovered logic fails the audit even if assertions pass. Reports are written to root `.tmp/agent-audit/`. Builds remove stale package output so moved sources cannot leave obsolete modules. Regressions use offline resources, injected ports, and loopback HTTP, without real models or public websites; they do not verify real-model comprehension or decision quality.
+
+---
+
+<a id="中文"></a>
+
 # @jangts/agent-core
 
+<img src="https://agent-core-docs.pages.jangts.cafe/branding/agent-core-logo.png" alt="Agent Core" width="420">
+
 平台无关的 Agent 运行库，提供运行 API、配套 Support 与可选 Kit。支持 ESM、CommonJS，以及浏览器／Node 环境。
 
 [完整网页开发文档](https://agent-core-docs.pages.jangts.cafe)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jangts/agent-core",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "type": "commonjs",
   "description": "Platform-independent agent runtime and configurable modules for evidence, delivery, policies and interactions",
   "homepage": "https://agent-core-docs.pages.jangts.cafe/",
@@ -251,5 +251,24 @@
   },
   "devDependencies": {
     "typescript": "~6.0.2"
-  }
+  },
+  "keywords": [
+    "ai",
+    "agent",
+    "ai-agent",
+    "ai-agents",
+    "llm",
+    "agent-framework",
+    "agent-runtime",
+    "workflow",
+    "tool-calling",
+    "function-calling",
+    "chat-completions",
+    "openai-compatible",
+    "context-management",
+    "streaming",
+    "typescript",
+    "nodejs",
+    "browser"
+  ]
 }