fix(docs): deal conflicts

Author: floritange

.gitignore

@@ -98,7 +98,7 @@ ipython_config.py
 #   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
 #   This is especially recommended for binary packages to ensure reproducibility, and is more
 #   commonly ignored for libraries.
-#uv.lock
+uv.lock
 
 # poetry
 #   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.

README.md

@@ -39,9 +39,18 @@ uv pip install -e .
 
 ## Configuration
 
-We recommand you to create a `config.yaml` file in the root directory of your own project, `VeADK` is able to read it automatically.
+We recommand you to create a `config.yaml` file in the root directory of your own project, `VeADK` is able to read it automatically. For running a minimal agent, you just need to set the following configs in your `config.yaml` file:
+
+```yaml
+model:
+  agent:
+    provider: openai
+    name: doubao-seed-1-6-250615
+    api_base: https://ark.cn-beijing.volces.com/api/v3/
+    api_key: # <-- set your Volcengine ARK api key here
+```
 
-You can refer to the [example config file](config.yaml.example) for more details.
+You can refer to the [config instructions](https://volcengine.github.io/veadk-python/installation.html#%E9%85%8D%E7%BD%AE) for more details.
 
 ## Have a try
 
@@ -61,8 +70,8 @@ print(res)
 
 VeADK provides several useful command line tools for faster deployment and optimization, such as:
 
-- `veadk deploy`: deploy your project to Volcengine VeFaaS platform (you can use `veadk init` to init a demo project first)
-- `veadk prompt`: otpimize the system prompt of your agent by PromptPilot
+- `veadk deploy`: deploy your project to [Volcengine VeFaaS platform](https://www.volcengine.com/product/vefaas) (you can use `veadk init` to init a demo project first)
+- `veadk prompt`: otpimize the system prompt of your agent by [PromptPilot](https://promptpilot.volcengine.com)
 
 ## Contribution
 

config.yaml.example config.yaml.fullconfig.yaml.example renamed to config.yaml.full

@@ -2,12 +2,12 @@ model:
   # [required] for running agent
   agent:
     provider: openai
-    name: doubao-1-5-pro-256k-250115
+    name: doubao-seed-1-6-250615
     api_base: https://ark.cn-beijing.volces.com/api/v3/
-    api_key:
+    api_key: 
   # [optional] for llm-as-a-judge a evaluation
   judge:  
-    name: doubao-1-5-pro-256k-250115
+    name: doubao-seed-1-6-250615
     api_base: https://ark.cn-beijing.volces.com/api/v3/
     api_key: 
   # [optional] for knowledgebase
@@ -40,6 +40,8 @@ tool:
   las:
     url: #mcp sse url
     dataset_id:  #dataset name
+  mcp_router:
+    url: #mcp sse/streamable-http url
 
 
 observability:

config.yaml.simple

@@ -0,0 +1,6 @@
+model:
+  agent:
+    provider: openai
+    name: doubao-seed-1-6-250615
+    api_base: https://ark.cn-beijing.volces.com/api/v3/
+    api_key: 

docs/docs/.vuepress/config.js

@@ -13,7 +13,7 @@ export default defineUserConfig({
 
     navbar: ['/', '/introduction'],
 
-    sidebar: ['introduction', 'installation', 'get-started', 'agent', 'memory', 'knowledgebase', 'tracing', 'evaluation', 'deploy', 'cli', 'veadk-studio']
+    sidebar: ['introduction', 'installation', 'get-started', 'agent', 'memory', 'tool', 'knowledgebase', 'tracing', 'evaluation', 'deploy', 'cli', 'veadk-studio']
   }),
 
   bundler: viteBundler(),

docs/docs/.vuepress/public/images/memory-optimization.png

@@ -13,13 +13,13 @@ actions:
 
 features:
   - title: 更丰富的内置工具
-    details: Builtin工具，例如侧重头条、抖音搜索的web_search等；MCP工具，例如飞书Lark、数据湖LAS、优解PromptPilot等
+    details: Builtin工具，例如侧重头条、抖音搜索的WEB_SEARCH等；MCP工具，例如飞书Lark、数据湖LAS、优解PromptPilot等
   - title: 更灵活的功能扩展
     details: 提供Agent各类组件的基础实现，通过插件方式灵活扩展。
   - title: 更完备的观测和评估管理
     details: 运行时数据通过OpenTelemetry协议无缝衔接APMPlus、Cozeloop、TLS；运行时数据生成测试数据集文件，可直接在本地和Cozeloop中进行评估测试。
   - title: 更强大的知识和记忆管理
-    details: 知识库支持火山引擎各类现有数据库，例如关系型数据库、键值数据库、VikingDB知识库，记忆库等。
+    details: 知识库支持火山引擎各类现有数据库，例如关系型数据库、缓存数据库、VikingDB知识库、记忆库等。
   - title: 更科学的结果评测
     details: 提供不确定性Tools（例如搜索类）场景下的测评解决方案，弥补传统仅根据输入输出进行评测而导致评测结果不符合预期的问题。
   - title: 更友好的最佳实践

docs/docs/.vuepress/public/images/tracing-apmplus.png

@@ -1,23 +1,61 @@
 # 智能体
 
+智能体 Agent 是一个具备完整功能的执行单元，依托内置的大模型推理能力，其不仅可以独立完成各类任务、与用户进行智能交互、调用外部工具资源，还能实现与其他 Agent 之间的协同配合。
+
 ## 属性
 
-Agent中主要包括如下属性：
+Agent 中主要包括如下属性：
 
 | 属性 | 类型 | 说明 |
 | --- | --- | --- |
-| name | str | Agent的名称，即标识符 |
-| description | str | Agent的描述，后续会被构建为系统提示词的一部分；也被用来在A2A协议中进行Agent挑选 |
-| instruction | str | Agent中内置模型的系统提示词 |
-| tools | list | Function call中的工具列表，既可以是本地工具，也可以是MCP工具 |
-| sub_agents | list | 子Agent列表，用于多Agent之间交互 |
-| long_term_memory | Vector database | 长期记忆，后端通常为一个向量数据库（Vector database），能够检索 |
-| knowledgebase | Vector database | 知识库，后端通常为一个向量数据库（Vector database），能够检索 |
-| tracers | list | 追踪器列表，能够定义不同的追踪方式，并在Agent执行完毕后对整体Tracing信息保存至本地 |
+| name | str | Agent 的名称，即标识符 |
+| description | str | Agent 的描述，后续会被构建为系统提示词的一部分，也被用来在A2A协议中进行 Agent 挑选 |
+| instruction | str | Agent 中内置模型的系统提示词 |
+| model_name | str | Agent 中内置模型的名称，默认从环境变量中获取 |
+| model_provider | str | Agent 中内置模型的提供商，默认从环境变量中获取 |
+| model_api_base | str | Agent 中内置模型的 API Base，默认从环境变量中获取 |
+| model_api_key | str | Agent 中内置模型的 API Key，默认从环境变量中获取 |
+| tools | list | Function call 中的工具列表，既可以是本地工具，也可以是 MCP 工具 |
+| sub_agents | list | 子 Agent 列表，用于多 Agent 之间交互 |
+| knowledgebase | KnowledgeBase | 知识库，后端支持本地内存（local）和数据库（opensearch、viking、redis、mysql），通常设置为一个能够检索的向量数据库 |
+| long_term_memory | LongTermMemory | 长期记忆，后端支持本地内存（local）和数据库（opensearch、viking、redis、mysql），通常设置为一个能够检索的向量数据库 |
+| tracers | list | 追踪器列表，能够定义不同的追踪方式，并在 Agent 执行完毕后将整体 Tracing 信息保存至本地 |
+| serve_url | str | Agent 服务主机的 URL，将显示在 Agent Card 中 |
+
+您可以在[火山引擎方舟平台](https://www.volcengine.com/product/ark)选择适合您的大模型。
+
+## 运行
+
+在生产环境中，我们推荐您使用 VeADK 的`Runner`执行器来进行多租户服务与 Agent 运行，在多租场景下，`Runner`通过三个属性来确定资源空间：
+
+- `app_name`：应用名称
+- `user_id`：用户ID
+- `session_id`：某个用户某次会话的ID
+
+```python
+from veadk import Agent, Runner
+from veadk.memory.short_term_memory import ShortTermMemory
+
+# Define Runner config
+APP_NAME = "..."
+USER_ID = "..."
+SESSION_ID = "..."
+
+agent = Agent()
+
+runner = Runner(
+    agent=agent,
+    short_term_memory=ShortTermMemory(),
+    app_name=APP_NAME,
+    user_id=USER_ID
+)
+
+response = await runner.run(messages="...", session_id=SESSION_ID)
+```
 
-## A2A智能体
+## A2A 智能体
 
-当你的智能体部署到云上后，可以在本地被初始化为一个Remote Agent，也就是能够通过A2A协议来访问的智能体，初始化方法如下：
+当智能体部署到云上后，可以在本地被初始化为一个 Remote Agent，也就是能够通过 A2A 协议来访问的智能体，初始化方法如下：
 
 ```python
 remote_agent = RemoteVeAgent(
@@ -29,33 +67,50 @@ short_term_memory = ShortTermMemory()
 runner = Runner(
     agent=remote_agent,
     short_term_memory=short_term_memory
-    )
+)
 
 res = await runner.run(
     messages="...",
     session_id="sample_session"
-    )
+)
 ```
 
-## 运行
+## 多智能体
+
+使用 VeADK 可以构建多 Agent 协作， 主 Agent 通过 `sub_agents` 机制协调多个子 Agent 完成复杂任务。以下代码示例分别定义了三个 Agent：
 
-在生产环境中，我们推荐您使用`Runner`来进行多租户服务：
+- weather_reporter：负责获取指定城市的天气信息（调用了 `get_city_weather` 工具）。
+- suggester：根据天气情况给出穿衣建议。
+- planner_agent：作为“调度员”，先调用 `weather_reporter` 获取天气，再调用 `suggester` 获取建议，最后将结果整合返回给用户。
+
+该多智能体协作能更好的满足用户的需求。
 
 ```python
 from veadk import Agent, Runner
 from veadk.memory.short_term_memory import ShortTermMemory
+from veadk.tools.demo_tools import get_city_weather
 
-# Define runner config
-APP_NAME = ""
-USER_ID = ""
-SESSION_ID = ""
+session_id = "..."
+prompt = "..."
 
-agent = Agent()
+# define three agents, one for planner, two for write poem and polish
+weather_reporter = Agent(
+    name="weather_reporter",
+    description="A weather reporter agent to report the weather.",
+    tools=[get_city_weather],
+)
+suggester = Agent(
+    name="suggester",
+    description="A suggester agent that can give some clothing suggestions according to a city's weather.",
+)
 
-runner = Runner(
-    agent=agent,
-    short_term_memory=ShortTermMemory()
-    )
+planner_agent = Agent(
+    name="planner",
+    description="A planner that can generate a suggestion according to a city's weather.",
+    instruction="Invoke weather reporter agent first to get the weather, then invoke suggester agent to get the suggestion. Return the final response to user.",
+    sub_agents=[weather_reporter, suggester],
+)
 
+runner = Runner(agent=planner_agent, short_term_memory=ShortTermMemory())
 response = await runner.run(messages=prompt, session_id=session_id)
 ```