@tencent-ai/agent-sdk 0.0.33 → 0.1.0

package/README.md

@@ -1,12 +1,75 @@
-# Genie - Agent SDK
+# CodeBuddy Agent SDK
 
-负责与 Agent 交互，提供 Agent SDK 接口。
+SDK for building AI agents with CodeBuddy Code's capabilities. Programmatically interact with AI to build autonomous agents that can understand codebases, edit files, and execute workflows.
 
-## 使用
+## Installation
 
-需要注意的是：
+```bash
+npm install @tencent-ai/agent-sdk
+```
 
-- **所有的组件注册都必须在获取组件（容器中的任何一个组件）之前完成，否则注册无效。**
-- **此模块的所有功能都依赖于配置模块 `Product`， 因此在使用时，必须先通过 `registerProductProvider` 去提供配置，才可以正常使用。**
+## Quick Start
 
-[示例](https://cnb.cool/carmeloren/agent-sdk-sample)
+```typescript
+import { query } from '@tencent-ai/agent-sdk';
+
+const response = query({
+  prompt: 'What files are in this directory?',
+  options: {
+    permissionMode: 'bypassPermissions',
+  },
+});
+
+for await (const message of response) {
+  if (message.type === 'assistant') {
+    for (const block of message.message.content) {
+      if (block.type === 'text') {
+        console.log(block.text);
+      }
+    }
+  }
+}
+```
+
+## API Reference
+
+### `query(options)`
+
+Create a query to interact with the agent.
+
+```typescript
+const q = query({
+  prompt: string,           // The prompt to send
+  options: {
+    model?: string,         // Model to use
+    permissionMode?: 'default' | 'acceptEdits' | 'bypassPermissions',
+    maxTurns?: number,      // Maximum conversation turns
+    cwd?: string,           // Working directory
+    hooks?: HookCallback[], // Event hooks
+    agents?: Record<string, AgentDefinition>, // Custom agents
+  },
+});
+
+// Iterate over messages
+for await (const message of q) {
+  // Handle message
+}
+
+```
+
+### Message Types
+
+- `system` - Session initialization info
+- `assistant` - Agent responses (text, tool calls)
+- `result` - Query completion status
+
+## Related Links
+
+- [CodeBuddy Code CLI](https://www.npmjs.com/package/@tencent-ai/codebuddy-code)
+- [Documentation](https://cnb.cool/codebuddy/codebuddy-code/-/blob/main/docs)
+- [Issues](https://cnb.cool/codebuddy/codebuddy-code/-/issues)
+
+## Feedback
+
+- Submit issues at [Issues](https://cnb.cool/codebuddy/codebuddy-code/-/issues)
+- Contact: codebuddy@tencent.com