Merge pull request #9 from volcengine/feat/refine-doc

feat: refine cli/sdk developer documentation

Author: innsd

README.md

@@ -1,6 +1,65 @@
-# Agentkit Python SDK
+<div align="center">
+  <h1>
+    Agentkit Platform Python SDK and Starter Toolkit
+  </h1>
 
-Python SDK for transforming any AI agent into a production-ready application. Framework-agnostic primitives for runtime, memory, authentication, and tools with volcengine-managed infrastructure.
+  <h2>
+    Launch your local agent on Volcengine AgentKit Platform as a fully managed service.
+  </h2>
+
+  <div align="center">
+    <a href="https://github.com/volcengine/agentkit-sdk-python/graphs/commit-activity"><img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/m/volcengine/agentkit-sdk-python"/></a>
+    <a href="https://github.com/volcengine/agentkit-sdk-python/pulls"><img alt="GitHub open pull requests" src="https://img.shields.io/github/issues-pr/volcengine/agentkit-sdk-python"/></a>
+    <a href="https://github.com/volcengine/agentkit-sdk-python/blob/main/LICENSE"><img alt="License" src="https://img.shields.io/github/license/volcengine/agentkit-sdk-python"/></a>
+    <a href="https://pypi.org/project/agentkit-sdk-python"><img alt="PyPI version" src="https://img.shields.io/pypi/v/agentkit-sdk-python"/></a>
+    <a href="https://python.org"><img alt="Python versions" src="https://img.shields.io/pypi/pyversions/agentkit-sdk-python"/></a>
+  </div>
+
+  <p>
+  <a href="https://console.volcengine.com/agentkit/"> Volcengine AgentKit</a>
+    ◆ <a href="https://volcengine.github.io/agentkit-sdk-python/">Documentation</a>
+    ◆ <a href="https://github.com/volcengine/agentkit-samples/tree/main">Samples</a>
+    ◆ <a href="https://pypi.org/project/agentkit-sdk-python/">PyPI Package</a>
+    ◆ <a href="https://github.com/volcengine/agentkit-sdk-python">GitHub Repository</a>
+
+  </p>
+</div>
+
+## Overview
+
+AgentKit is a developer platform by Volcengine that supports the building, deployment, and operation of AI Agents. It lowers the entry barrier for developers and enterprises by providing essential infrastructure beyond the model—including security, built-in tools, memory, knowledge, monitoring, and evaluation. This empowers enterprises to efficiently build, deploy, and operate complex, intelligent, enterprise-grade Agents. The platform also includes a Python SDK and a Starter Toolkit to help developers build, deploy, publish, and manage Agent applications through an SDK and CLI.
+
+AgentKit includes the following modular Services that you can use together or independently:
+
+## AgentKit Runtime
+
+AgentKit Runtime is a fully managed service that provides a secure, isolated environment for running AI Agents. It supports the deployment of Agents built with any framework and language, and provides a set of APIs for interacting with the Agents.
+
+**[Runtime Quick Start](https://volcengine.github.io/agentkit-sdk-python/content/4.runtime/1.overview.html)**
+
+## AgentKit Tools
+
+AgentKit Tools is a service that provides a set of built-in tools for AI Agents. It supports the execution of common tasks, such as data retrieval, web search, and code execution, in a secure and scalable manner.
+
+**[Tools Quick Start](https://volcengine.github.io/agentkit-sdk-python/content/5.tools/1.sandbox_quickstart.html)**
+
+## AgentKit Memory
+
+AgentKit Memory is a service that provides a persistent storage solution for AI Agents. It supports the storage of Agent states, memories, and other data in a secure and scalable manner.
+
+**[Memory Quick Start](https://volcengine.github.io/agentkit-sdk-python/content/6.memory/1.memory_quickstart.html)**
+
+## AgentKit Knowledge
+
+AgentKit Knowledge is a service that provides a knowledge base solution for AI Agents. It supports the storage of Agent knowledge, facts, and other data in a secure and scalable manner.
+
+**[Knowledge Quick Start](https://volcengine.github.io/agentkit-sdk-python/content/7.knowledge/1.knowledge_quickstart.html)**
+
+## AgentKit MCP
+
+AgentKit MCP is a service that provides a set of tools for managing AI Agents. It supports the deployment, configuration, and monitoring of Agents in a secure and scalable manner.
+
+**[MCP Quick Start](https://volcengine.github.io/agentkit-sdk-python/content/8.mcp/2.mcp_quickstart.html)**
 
 ## Installation
 
@@ -25,3 +84,7 @@ pip install agentkit-sdk-python==1.0.0.dev1
 ```
 
 **Note**: Development versions may contain bugs and are not recommended for production use.
+
+## License
+
+This project is licensed under the [Apache 2.0 License](./LICENSE).

docs/.vitepress/config.js

@@ -1,8 +1,8 @@
 export default {
   title: 'AgentKit',
   description: 'Python SDK and CLI for building Agent applications on Volcengine',
-  base: '/agentkit-sdk-python/',
-
+  base: '/',
+  
   head: [
     ['link', { rel: 'icon', href: '/favicon.ico' }]
   ],
@@ -20,10 +20,10 @@ export default {
           text: '📖 概述',
           collapsed: false,
           items: [
-            { text: 'AgentKit 概述', link: '/content/1.introduction/1.overview' },
+            { text: 'AgentKit', link: '/content/1.introduction/1.overview' },
             { text: '安装指南', link: '/content/1.introduction/2.installation' },
             { text: '快速开始', link: '/content/1.introduction/3.quickstart' },
-            { text: '常见问题', link: '/content/1.introduction/4.troubleshooting' }
+            { text: 'Troubleshooting', link: '/content/1.introduction/4.troubleshooting' }
           ]
         },
         {
@@ -47,7 +47,7 @@ export default {
           text: '🚀 Runtime',
           collapsed: true,
           items: [
-            { text: 'Runtime 概览', link: '/content/4.runtime/1.overview' }
+            { text: 'Runtime 快速开始', link: '/content/4.runtime/1.runtime_quickstart.md' }
           ]
         },
         {
@@ -86,10 +86,10 @@ export default {
           text: '📖 概述',
           collapsed: true,
           items: [
-            { text: 'AgentKit 概述', link: '/content/1.introduction/1.overview' },
+            { text: 'AgentKit', link: '/content/1.introduction/1.overview' },
             { text: '安装指南', link: '/content/1.introduction/2.installation' },
             { text: '快速开始', link: '/content/1.introduction/3.quickstart' },
-            { text: '常见问题', link: '/content/1.introduction/4.troubleshooting' }
+            { text: 'Troubleshooting', link: '/content/1.introduction/4.troubleshooting' }
           ]
         },
         {
@@ -113,7 +113,7 @@ export default {
           text: '🚀 Runtime',
           collapsed: true,
           items: [
-            { text: 'Runtime 概览', link: '/content/4.runtime/1.overview' }
+            { text: 'Runtime 快速开始', link: '/content/4.runtime/1.runtime_quickstart.md' }
           ]
         },
         {
@@ -152,10 +152,10 @@ export default {
           text: '📖 概述',
           collapsed: true,
           items: [
-            { text: 'AgentKit 概述', link: '/content/1.introduction/1.overview' },
+            { text: 'AgentKit', link: '/content/1.introduction/1.overview' },
             { text: '安装指南', link: '/content/1.introduction/2.installation' },
             { text: '快速开始', link: '/content/1.introduction/3.quickstart' },
-            { text: '常见问题', link: '/content/1.introduction/4.troubleshooting' }
+            { text: 'Troubleshooting', link: '/content/1.introduction/4.troubleshooting' }
           ]
         },
         {
@@ -179,7 +179,7 @@ export default {
           text: '🚀 Runtime',
           collapsed: true,
           items: [
-            { text: 'Runtime 概览', link: '/content/4.runtime/1.overview' }
+            { text: 'Runtime 快速开始', link: '/content/4.runtime/1.runtime_quickstart.md' }
           ]
         },
         {
@@ -218,10 +218,10 @@ export default {
           text: '📖 概述',
           collapsed: true,
           items: [
-            { text: 'AgentKit 概述', link: '/content/1.introduction/1.overview' },
+            { text: 'AgentKit', link: '/content/1.introduction/1.overview' },
             { text: '安装指南', link: '/content/1.introduction/2.installation' },
             { text: '快速开始', link: '/content/1.introduction/3.quickstart' },
-            { text: '常见问题', link: '/content/1.introduction/4.troubleshooting' }
+            { text: 'Troubleshooting', link: '/content/1.introduction/4.troubleshooting' }
           ]
         },
         {
@@ -245,7 +245,7 @@ export default {
           text: '🚀 Runtime',
           collapsed: false,
           items: [
-            { text: 'Runtime 概览', link: '/content/4.runtime/1.overview' }
+            { text: 'Runtime 快速开始', link: '/content/4.runtime/1.runtime_quickstart.md' }
           ]
         },
         {
@@ -283,10 +283,10 @@ export default {
           text: '📖 概述',
           collapsed: true,
           items: [
-            { text: 'AgentKit 概述', link: '/content/1.introduction/1.overview' },
+            { text: 'AgentKit', link: '/content/1.introduction/1.overview' },
             { text: '安装指南', link: '/content/1.introduction/2.installation' },
             { text: '快速开始', link: '/content/1.introduction/3.quickstart' },
-            { text: '常见问题', link: '/content/1.introduction/4.troubleshooting' }
+            { text: 'Troubleshooting', link: '/content/1.introduction/4.troubleshooting' }
           ]
         },
         {
@@ -310,7 +310,7 @@ export default {
           text: '🚀 Runtime',
           collapsed: true,
           items: [
-            { text: 'Runtime 概览', link: '/content/4.runtime/1.overview' }
+            { text: 'Runtime 快速开始', link: '/content/4.runtime/1.runtime_quickstart.md' }
           ]
         },
         {
@@ -348,10 +348,10 @@ export default {
           text: '📖 概述',
           collapsed: true,
           items: [
-            { text: 'AgentKit 概述', link: '/content/1.introduction/1.overview' },
+            { text: 'AgentKit', link: '/content/1.introduction/1.overview' },
             { text: '安装指南', link: '/content/1.introduction/2.installation' },
             { text: '快速开始', link: '/content/1.introduction/3.quickstart' },
-            { text: '常见问题', link: '/content/1.introduction/4.troubleshooting' }
+            { text: 'Troubleshooting', link: '/content/1.introduction/4.troubleshooting' }
           ]
         },
         {
@@ -375,7 +375,7 @@ export default {
           text: '🚀 Runtime',
           collapsed: true,
           items: [
-            { text: 'Runtime 概览', link: '/content/4.runtime/1.overview' }
+            { text: 'Runtime 快速开始', link: '/content/4.runtime/1.runtime_quickstart.md' }
           ]
         },
         {
@@ -413,10 +413,10 @@ export default {
           text: '📖 概述',
           collapsed: true,
           items: [
-            { text: 'AgentKit 概述', link: '/content/1.introduction/1.overview' },
+            { text: 'AgentKit', link: '/content/1.introduction/1.overview' },
             { text: '安装指南', link: '/content/1.introduction/2.installation' },
             { text: '快速开始', link: '/content/1.introduction/3.quickstart' },
-            { text: '常见问题', link: '/content/1.introduction/4.troubleshooting' }
+            { text: 'Troubleshooting', link: '/content/1.introduction/4.troubleshooting' }
           ]
         },
         {
@@ -440,7 +440,7 @@ export default {
           text: '🚀 Runtime',
           collapsed: true,
           items: [
-            { text: 'Runtime 概览', link: '/content/4.runtime/1.overview' }
+            { text: 'Runtime 快速开始', link: '/content/4.runtime/1.runtime_quickstart.md' }
           ]
         },
         {
@@ -478,10 +478,10 @@ export default {
           text: '📖 概述',
           collapsed: true,
           items: [
-            { text: 'AgentKit 概述', link: '/content/1.introduction/1.overview' },
+            { text: 'AgentKit', link: '/content/1.introduction/1.overview' },
             { text: '安装指南', link: '/content/1.introduction/2.installation' },
             { text: '快速开始', link: '/content/1.introduction/3.quickstart' },
-            { text: '常见问题', link: '/content/1.introduction/4.troubleshooting' }
+            { text: 'Troubleshooting', link: '/content/1.introduction/4.troubleshooting' }
           ]
         },
         {
@@ -505,7 +505,7 @@ export default {
           text: '🚀 Runtime',
           collapsed: true,
           items: [
-            { text: 'Runtime 概览', link: '/content/4.runtime/1.overview' }
+            { text: 'Runtime 快速开始', link: '/content/4.runtime/1.runtime_quickstart.md' }
           ]
         },
         {
@@ -571,4 +571,4 @@ export default {
       }
     }
   }
-}
+}

docs/content/1.introduction/1.overview.md

@@ -1,39 +1,34 @@
 # AgentKit
 
-## 什么是 AgentKit？
+## 产品定位
 
-AgentKit是火山引擎为AI Agent构建、部署、运行提供支持的开发工具平台，帮助开发者和企业降低 Agent 开发门槛，为Agent 提供模型之外的安全、内置工具、记忆、知识、监控、评测等基础设施，助力企业高效构建、部署、运维复杂智能的企业级Agent。平台也包含一个Python SDK和Starter Toolkit，来帮助开发者通过SDK/CLI来构建、部署、发布和管理Agent应用。
+AgentKit 是火山引擎推出的企业级 AI Agent 开发平台，为开发者提供完整的 Agent 构建、部署和运维解决方案。平台通过标准化的开发工具链和云原生基础设施，显著降低复杂智能体应用的开发部署门槛。
 
-## AgentKit Platform
+## 核心优势
 
-AgentKit Platform 为 Agent 应用提供：
+- **声明式应用定义**：通过简洁的 YAML 文件定义智能体应用的核心组件和配置，实现“一次定义，处处运行”。
+- **模块化与可扩展**：内置丰富的 **Tool**（工具）、**Memory**（记忆）、**Knowledge**（知识库）等模块，并提供标准化的接口，方便开发者自定义和扩展。
+- **云原生部署**：与 **AgentKit Platform** 无缝集成，支持一键将应用部署到云端，并提供弹性伸缩、持续集成和高可用保障。
+- **多智能体协作（MCP）**：支持构建多个 **Agent** 协同工作的复杂系统，实现任务的分解、协作和汇总。
+- **全面的生命周期管理**：提供从项目初始化、本地调试、云端部署到线上运维的全套 `agentkit` CLI 工具链。
 
-- **Runtime 环境**：提供隔离的运行环境，支持容器化部署
-- **基础设施服务**：
-  - Memory（记忆管理）
-  - Knowledge（知识库）
-  - Identity（身份认证）
-  - Gateway（MCP 工具聚合与路由）
+## 架构理念
 
-通过 AgentKit Platform，开发者无需关心底层基础设施，可以专注于 Agent 业务逻辑的开发。
+AgentKit 的核心设计理念是将 **Agent App** 的**定义**与**执行**分离。
 
-## AgentKit SDK
+- **应用定义（Definition）**：开发者通过 `agentkit.yaml` 文件声明式地定义应用的元数据、依赖、运行时环境和所需使用的平台服务（如知识库、记忆模块等）。
+- **应用执行（Execution）**：`agentkit` CLI 和 **AgentKit Platform** 负责解析定义文件，并自动完成环境准备、代码打包、镜像构建、持续集成和云端部署等一系列繁琐工作。
 
-AgentKit SDK 是一个Python开发工具包，内置了对AgentKit Platform的所有服务的客户端，开发者可以通过SDK来调用Platform的所有服务。
+这种分离的设计使得开发者可以专注于业务逻辑的实现，而将复杂的工程化问题交给 AgentKit 来处理，敏捷构建，快速生产级落地。
 
-## AgentKit CLI
+## 适用场景
 
-AgentKit CLI 是一个命令行工具，用于简化 Agent 应用的全生命周期管理，包括初始化、配置、构建、部署和运维。
+- **智能问答机器人**：快速构建集成知识库的智能问答服务。
+- **自动化工作流**：创建能够自动执行一系列任务（如发送邮件、生成报告、调用 API）的自动化流程。
+- **复杂数据分析**：构建能够理解用户意图、查询数据库、分析数据并生成可视化报告的数据分析 **Agent**。
+- **多智能体系统**：设计和部署多个 **Agent** 协同完成复杂任务的系统，例如“研究员-分析师-报告员”模式。
 
-### 主要命令
+## 开始使用
 
-| 命令 | 功能 | 说明 |
-|------|------|------|
-| `agentkit init` | 初始化项目 | 创建 Agent 应用模板，支持多种框架 |
-| `agentkit config` | 配置项目 | 交互式配置部署和运行参数 |
-| `agentkit build` | 构建镜像 | 构建符合标准的 Docker 镜像 |
-| `agentkit deploy` | 部署应用 | 将镜像部署到 Platform Runtime |
-| `agentkit launch` | 一键部署 | build + deploy 的组合命令 |
-| `agentkit invoke` | 调用应用 | 向已部署的 Agent 发送请求 |
-| `agentkit status` | 查看状态 | 查看 Runtime 运行状态 |
-| `agentkit destroy` | 销毁资源 | 释放 Runtime 实例和相关资源 |
+- **[安装 AgentKit](./2.installation.md)**：了解如何安装 AgentKit。
+- **[快速开始](./3.quickstart.md)**：通过一个简单的示例，快速体验从开发到部署的全过程。