docs(agent-team-profile): adopt package README standard

This commit is contained in:
fengsy
2026-08-26 00:53:57 +08:00
parent d97868b943
commit a28f543ae4
3 changed files with 150 additions and 12 deletions
@@ -2,5 +2,5 @@
# side as of the last confirmed-consistent state. Both languages carry equal authority;
# after editing either side, bring the other along and re-record with:
# pnpm run verify-translation-pairing --write packages/experimental/agent-team-profile/README.md
README.md: dd53b3da34a9f06299621d5f09e3b456c6aae583
README.zh.md: 2d10af9e682c8c32f29c47290b3696c4fa550e9f
README.md: 7b0e2172b88287998f346d32010eb73ef3619eae
README.zh.md: b7323ebed66fe8dfc9c47749223d252a76e13363
@@ -1,12 +1,33 @@
---
description: "Private Agent Teams profile layer over dsh-base, for source-checkout users who want Team-scoped coordination tools while retaining one-shot delegation."
kind: "package-bundle"
---
# @deepseek-ai/dsh-experimental-agent-team-profile
English | [中文](README.zh.md)
Private profile bundle that enables [Agent Teams](../agent-team/README.md) over `@deepseek-ai/dsh-base`. Its patch inserts the Team domain and scoped tools, disables the overlapping global continuable-child controls, and keeps the ordinary fresh and fork delegation tools as one-shot operations. Install this package explicitly into a source-checkout profile; it is excluded from official releases.
## Summary
## Profile installation
`dsh-experimental-agent-team-profile` is a private profile layer that enables [Agent Teams](../agent-team/README.md) over `@deepseek-ai/dsh-base`. Its patch inserts the Team domain and Team-scoped tools, disables the overlapping global continuable-child controls, and keeps the ordinary fresh and fork delegation tools as one-shot operations. Add it explicitly to an initialized source-checkout profile; official releases exclude this package.
From this repository checkout, add the package to an initialized profile:
## Table of Contents
- [Use this package](#use-this-package)
- [Understand the implementation](#understand-the-implementation)
- [Further Exploration](#further-exploration)
- [Model Experience](#model-experience)
- [Known Limitations and Deferred Work](#known-limitations-and-deferred-work)
- [Dev Note](#dev-note)
-----
<a id="use-this-package"></a>
## Use this package
### Install into a profile
From this repository checkout, add the package to an initialized profile, then run a task that asks the Lead to delegate work:
```sh
pnpm dsh plugin --profile headless add ./packages/experimental/agent-team-profile
@@ -15,6 +36,41 @@ pnpm dsh --profile headless "Use Agent Teams to split this task between two team
The profile must already contain `@deepseek-ai/dsh-base`, whose Subagent services and provider rows this layer consumes. Removing the package with `dsh plugin --profile <name> remove @deepseek-ai/dsh-experimental-agent-team-profile` removes the bundle from the profile's ordered layer list.
### What you get
The layer adds the Agent Teams domain and its scoped creation, roster, messaging, interruption, waiting, and task-board tools. It disables the global continuable-child control rows whose tool names overlap with Team controls, while leaving `subagent` and `subagent_fork` available as one-shot delegation tools.
-----
<a id="understand-the-implementation"></a>
## Understand the implementation
<details>
<summary>Implementation internals — click to expand</summary>
The package's runtime content is [`cordis.patch.yml`](cordis.patch.yml). Applied after `dsh-base`, the patch disables `tool-subagent-control`, `tool-subagent-list-agents`, and `tool-subagent-report`; sets the fresh and fork Subagent rows to `one-shot`; and inserts the Team service and tool rows with explicit providers and limits.
| File | Role |
|---|---|
| [`cordis.patch.yml`](cordis.patch.yml) | Ordered patch over `dsh-base` |
| [`src/index.ts`](src/index.ts) | Empty module entry; the patch is the runtime content |
| [`src/invariant.ts`](src/invariant.ts) | Empty invariant companion for the static bundle |
</details>
-----
<a id="further-exploration"></a>
## Further Exploration
- [Experimental packages](../README.md) — incubation status and release exclusion.
- [Agent Teams service](../agent-team/README.md) — durable roster, messaging, and task-board behavior.
- [Agent Teams tools](../tool-agent-team/README.md) — the Team-scoped model tool surface.
- [Base bundle](../../bundle/base/README.md) — the profile layer this patch extends.
-----
<a id="model-experience"></a>
## Model Experience
### Team policy and tools
@@ -33,5 +89,18 @@ The bundle's composition is prefix-stable while its patch, Team identity, and co
## Known Limitations and Deferred Work
<a id="known-limitations-and-deferred-work"></a>
- **Source-checkout only** — this private package is not present in official npm, CLI, Web, or Python release payloads.
- **Shared checkout** — every teammate observes the same working directory; this bundle adds no worktree isolation or filesystem locking.
- **Base profile required** — the patch depends on row ids and Subagent providers supplied by `dsh-base`; it is not a standalone profile.
<a id="dev-note"></a>
### Dev Note
<details>
<summary>Working context for maintainers — click to expand</summary>
None.
</details>
@@ -1,12 +1,33 @@
---
description: "叠加在 dsh-base 上的私有 Agent Teams profile 层,供源码 checkout 用户使用 Team-scoped 协作工具,同时保留一次性 delegation。"
kind: "package-bundle"
---
# @deepseek-ai/dsh-experimental-agent-team-profile
[English](README.md) | 中文
`@deepseek-ai/dsh-base` 之上启用 [Agent Teams](../agent-team/README.zh.md) 的私有 profile bundle。它的 patch 会插入 Team domain 与 scoped 工具、禁用名称重叠的全局 continuable-child control,并保留普通的一次性 freshfork delegation 工具。必须从源码 checkout 将本包显式安装到 profile;正式发布会排除本包。
## 概述
## Profile 安装
`dsh-experimental-agent-team-profile` 是在 `@deepseek-ai/dsh-base` 之上启用 [Agent Teams](../agent-team/README.zh.md) 的私有 profile 层。它的 patch 会插入 Team domain 与 Team-scoped 工具、禁用名称重叠的全局 continuable-child control,并保留普通的一次性 fresh 与 fork delegation 工具。必须将本包显式添加到已初始化的源码 checkout profile;正式发布会排除本包。
在本仓库 checkout 中,将本包添加到已初始化的 profile:
## 目录
- [使用本包](#use-this-package)
- [理解实现](#understand-the-implementation)
- [进一步探索](#further-exploration)
- [模型体验](#model-experience)
- [已知限制与延期工作](#known-limitations-and-deferred-work)
- [开发备注](#dev-note)
-----
<a id="use-this-package"></a>
## 使用本包
### 安装到 profile
在本仓库 checkout 中,将本包添加到已初始化的 profile,然后运行一个要求 Lead 委派工作的任务:
```sh
pnpm dsh plugin --profile headless add ./packages/experimental/agent-team-profile
@@ -15,7 +36,42 @@ pnpm dsh --profile headless "Use Agent Teams to split this task between two team
profile 必须已经包含 `@deepseek-ai/dsh-base`,本层会使用其中的 Subagent service 与 provider 配置行。执行 `dsh plugin --profile <name> remove @deepseek-ai/dsh-experimental-agent-team-profile` 移除本包时,bundle 也会从 profile 的有序层列表中移除。
## Model Experience
### 获得的功能
本层会添加 Agent Teams domain,以及 Team-scoped 创建、roster、消息、interrupt、等待与任务板工具。它会禁用工具名与 Team control 重叠的全局 continuable-child control 行,同时保留 `subagent``subagent_fork` 作为一次性 delegation 工具。
-----
<a id="understand-the-implementation"></a>
## 理解实现
<details>
<summary>实现细节——点击展开</summary>
本包的运行时内容是 [`cordis.patch.yml`](cordis.patch.yml)。在 `dsh-base` 之后应用时,patch 会禁用 `tool-subagent-control``tool-subagent-list-agents``tool-subagent-report`,把 fresh 与 fork Subagent 行设置为 `one-shot`,并以显式 provider 和限制插入 Team service 与工具行。
| 文件 | 职责 |
|---|---|
| [`cordis.patch.yml`](cordis.patch.yml) | 叠加在 `dsh-base` 之上的有序 patch |
| [`src/index.ts`](src/index.ts) | 空模块入口;patch 是运行时内容 |
| [`src/invariant.ts`](src/invariant.ts) | 静态 bundle 的空不变式伴生插件 |
</details>
-----
<a id="further-exploration"></a>
## 进一步探索
- [实验性包](../README.zh.md)——孵化状态与发布排除规则。
- [Agent Teams service](../agent-team/README.zh.md)——持久 roster、消息与任务板行为。
- [Agent Teams 工具](../tool-agent-team/README.zh.md)——Team-scoped 模型工具表层。
- [Base bundle](../../bundle/base/README.zh.md)——本 patch 扩展的 profile 层。
-----
<a id="model-experience"></a>
## 模型体验
### Team 策略与工具
@@ -31,7 +87,20 @@ Team 策略与 schema 由 [`@deepseek-ai/dsh-experimental-tool-agent-team`](../t
只要 bundle patch、Team identity 与配置的工具 schema 不变,本 bundle 的 composition 就保持前缀稳定。
## Known Limitations and Deferred Work
## 已知限制与延期工作
- **仅限源码 checkout**:正式 npm、CLI、Web 与 Python 发布产物都不包含这个私有包。
- **共享 checkout**:所有 teammate 都观察同一个工作目录;本 bundle 不提供 worktree 隔离或文件系统锁。
<a id="known-limitations-and-deferred-work"></a>
- **仅限源码 checkout**——正式 npm、CLI、Web 与 Python 发布产物都不包含这个私有包。
- **共享 checkout**——所有 teammate 都观察同一个工作目录;本 bundle 不提供 worktree 隔离或文件系统锁。
- **需要 base profile**——本 patch 依赖 `dsh-base` 提供的配置行 id 与 Subagent provider;它不是独立 profile。
<a id="dev-note"></a>
### 开发备注
<details>
<summary>维护者的工作上下文——点击展开</summary>
无。
</details>