Spaces:
Paused
Paused
File size: 22,698 Bytes
9792ea7 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 | # -*- coding: utf-8 -*-
"""The AgentCreate tool — spawns a worker into the current team."""
from __future__ import annotations
import copy
import json
from typing import TYPE_CHECKING
from pydantic import Field
from ._team_tool_base import _TeamToolBase
from .._types import SubAgentTemplate
from ..message_bus import MessageBusKeys
from .._bus_ops import enqueue_run_trigger
from ..storage import AgentData, AgentRecord, SessionConfig, TeamMember
from ..storage._utils import _ensure_team_members
from ...message import HintBlock, TextBlock, ToolResultState
from ...permission import PermissionContext
from ...state import AgentState
from ...tool import ToolChunk, ParamsBase
if TYPE_CHECKING:
from ..message_bus import MessageBus
from ..storage import StorageBase
from ..workspace_manager import WorkspaceManagerBase
_DEFAULT_SYSTEM_PROMPT_TEMPLATE = (
"You are {member_name}, a member of team '{team_name}' led by "
"{leader_name}.\n\n"
"Team purpose: {team_description}\n\n"
"Your role: {member_description}\n\n"
"You communicate with the team leader and other members "
"through the TeamSay tool. "
"Speak on the team only when you have something "
"external to share — your private reasoning stays private."
)
DEFAULT_SUB_AGENT_TEMPLATE = SubAgentTemplate(
type="default",
description="Default worker agent with standard configuration.",
system_prompt_template=_DEFAULT_SYSTEM_PROMPT_TEMPLATE,
override_leader_mode=False,
extend_leader_permission_rules=True,
extend_leader_working_directories=True,
)
# The built-in default sub-agent template.
#
# Used when no custom templates are registered, or when the leader
# agent creates a member without specifying a ``subagent_type`` (or
# explicitly specifies ``subagent_type="default"``). Developers can
# override this by registering their own template with
# ``type="default"`` via :func:`~agentscope.app.create_app`.
#
# The default template fully follows the leader: the worker inherits
# the leader's permission mode, working directories, and rules —
# matching the intuition that a generic worker should behave like the
# leader unless the developer registers a more opinionated template.
def _merge_leader_permissions(
template: SubAgentTemplate,
leader_context: PermissionContext,
) -> PermissionContext:
"""Build the worker's permission context from the template, layered
with the leader's runtime state according to the template's three
inherit-from-leader flags.
- ``override_leader_mode``: if True, the template's
:attr:`PermissionContext.mode` wins; otherwise the worker
inherits the leader's mode.
- ``extend_leader_permission_rules``: if True, the leader's
allow/deny/ask rules are appended after the template's rules for
each tool, so the worker doesn't re-prompt for permissions the
user has already granted in the leader session. The template's
rules appear first in each list, so the engine — which returns
on the first matching rule per stage — evaluates the template's
intent before the leader's.
- ``extend_leader_working_directories``: if True, the leader's
working directories are merged in; on key (path) collisions the
template's entry wins.
The template fields are deep-copied so the returned context is
independent of both the template and the leader state.
"""
merged = template.permission_context.model_copy(deep=True)
if not template.override_leader_mode:
merged.mode = leader_context.mode
if template.extend_leader_working_directories:
for path, wd in leader_context.working_directories.items():
merged.working_directories.setdefault(
path,
wd.model_copy(deep=True),
)
if template.extend_leader_permission_rules:
for attr in ("allow_rules", "deny_rules", "ask_rules"):
merged_rules: dict = getattr(merged, attr)
for tool_name, rules in getattr(leader_context, attr).items():
merged_rules.setdefault(tool_name, []).extend(
r.model_copy(deep=True) for r in rules
)
return merged
class _AgentCreateParams(ParamsBase):
"""Parameters for :class:`AgentCreate`."""
name: str = Field(
description=(
'Short identifier for the new member, e.g. ``"researcher"`` '
'or ``"coder-1"``. Other members address it via '
"``TeamSay(to=<this name>)``, so it MUST be unique within "
"the team."
),
)
description: str = Field(
description=(
"One-sentence summary of the member's role — e.g. "
'``"Researches background information on the target topic"``. '
"Becomes part of the member's system prompt so it understands "
"its place in the team."
),
)
prompt: str = Field(
description=(
"The first task delivered to the member as a user message. "
"The member begins executing immediately upon creation, so "
"make this concrete and self-contained — do not just say "
'``"wait for instructions"`` (use TeamSay later instead). '
"Include any context, constraints, deliverables, and "
"deadlines the member needs."
),
)
class AgentCreate(_TeamToolBase):
"""Spawn a new worker member into the team you lead."""
name: str = "AgentCreate"
is_state_injected: bool = True
description: str = """Add a new member to the team you lead.
## When to Use This Tool
After ``TeamCreate``, call this for each member you want on the team. \
Each call:
- Creates a worker agent dedicated to this team.
- Delivers ``prompt`` as the worker's first user message — **the worker \
starts executing it immediately**. (So DONT use ``TeamSay`` right after \
creating one agent).
## When NOT to Use This Tool
- You're not currently leading a team. Call ``TeamCreate`` first.
- The new member would duplicate an existing member's role; reuse the \
existing member via ``TeamSay`` instead.
## Effects
- Use the ``name`` you chose as ``to=<name>`` in ``TeamSay`` to direct \
messages to this member specifically. Names must be unique within the \
team (including against the leader's name); duplicates are rejected.
- Members spawned this way live only as long as the team — they are \
deleted when ``TeamDelete`` is called.
## Important
- You are responsible for organising the team, assigning tasks, collecting \
every member's report, and producing the final answer — all members report \
directly to you. Therefore, **DO NOT** encourage members to communicate with \
each other, and **AVOID** creating "integrator"-style members; both make the \
overall communication topology unnecessarily complex.
"""
input_schema: dict = _AgentCreateParams.model_json_schema()
def __init__(
self,
storage: "StorageBase",
message_bus: "MessageBus",
workspace_manager: "WorkspaceManagerBase",
user_id: str,
session_id: str,
agent_id: str,
sub_agent_templates: dict[str, SubAgentTemplate] | None = None,
) -> None:
"""Bind request-scoped identifiers plus sub-agent templates.
Extends :meth:`_TeamToolBase.__init__` with the optional
template registry. The built-in ``"default"`` template is
always injected; extra templates unlock a ``subagent_type``
enum in the tool's input schema.
Args:
storage (`StorageBase`):
Application storage backend.
message_bus (`MessageBus`):
Application message bus.
workspace_manager (`WorkspaceManagerBase`):
Workspace manager (forwarded to base for uniform
team-tool wiring; currently unused here).
user_id (`str`):
The owner user id.
session_id (`str`):
The calling session id.
agent_id (`str`):
The calling agent id.
sub_agent_templates (`dict[str, SubAgentTemplate] | None`, \
optional):
Template registry keyed by type.
"""
super().__init__(
storage,
message_bus,
workspace_manager,
user_id,
session_id,
agent_id,
)
self._sub_agent_templates: dict[str, SubAgentTemplate] = dict(
sub_agent_templates or {},
)
if "default" not in self._sub_agent_templates:
self._sub_agent_templates["default"] = DEFAULT_SUB_AGENT_TEMPLATE
# Only expose subagent_type when the developer registered
# custom templates — a single "default" type is redundant in
# the schema and would confuse the LLM.
has_custom_templates = set(self._sub_agent_templates) != {"default"}
if has_custom_templates:
schema = copy.deepcopy(
_AgentCreateParams.model_json_schema(),
)
type_descriptions = "\n".join(
f"- ``{t.type!r}`` — {t.description}"
for t in self._sub_agent_templates.values()
)
schema["properties"]["subagent_type"] = {
"type": "string",
"enum": list(self._sub_agent_templates),
"description": (
"The type of sub-agent template to use. "
"Available types:\n\n"
f"{type_descriptions}\n\n"
"Each type has pre-configured system prompt, "
"permissions, and task context."
),
}
self.input_schema = schema
async def __call__(
self,
name: str,
description: str,
prompt: str,
subagent_type: str = "default",
_agent_state: AgentState | None = None,
) -> ToolChunk:
"""Spawn the worker agent + session directly via storage.
Reads the current session + team records from storage to
enforce two preconditions: the calling session must be in a
team, and it must be that team's leader.
The worker's configuration (system prompt, context/react
config, permission context, task context) is determined by
the :class:`SubAgentTemplate` matching ``subagent_type``. The
leader's user-confirmed permission rules and working
directories are merged into the template's permission context
so the worker does not re-prompt for permissions the user has
already granted.
Args:
name (`str`):
Short identifier for the worker, unique within the
team. Used as the ``to`` target in ``TeamSay``.
description (`str`):
One-sentence summary of the worker's role.
prompt (`str`):
First task delivered as a user message to the worker.
subagent_type (`str`, defaults to ``"default"``):
Template type to use. Must match a registered
:class:`SubAgentTemplate.type`.
_agent_state (`AgentState | None`, optional):
Live leader state injected by the toolkit.
Returns:
`ToolChunk`:
A success message containing the new member id, or an
error chunk on failure.
"""
try:
session = await self._storage.get_session(
self._user_id,
self._agent_id,
self._session_id,
)
if session is None or session.team_id is None:
return ToolChunk(
content=[
TextBlock(
text=(
"AgentCreate: this session is not in "
"any team — call TeamCreate first."
),
),
],
state=ToolResultState.ERROR,
)
team = await self._storage.get_team(
self._user_id,
session.team_id,
)
if team is None:
return ToolChunk(
content=[
TextBlock(
text=(
"AgentCreate: team "
f"{session.team_id} no longer exists."
),
),
],
state=ToolResultState.ERROR,
)
if team.session_id != self._session_id:
return ToolChunk(
content=[
TextBlock(
text=(
"AgentCreate: only the team leader "
"can add members; this session is a "
"worker."
),
),
],
state=ToolResultState.ERROR,
)
# Look up leader session for chat-model inheritance + name.
leader_session = await self._storage.get_session(
self._user_id,
"", # agent_id unused at storage level
team.session_id,
)
if leader_session is None:
return ToolChunk(
content=[
TextBlock(
text=(
f"AgentCreate: leader session "
f"{team.session_id} for team {team.id} is "
f"missing — team is in an inconsistent "
f"state."
),
),
],
state=ToolResultState.ERROR,
)
# Resolve the template.
template = self._sub_agent_templates.get(subagent_type)
if template is None:
available = list(self._sub_agent_templates)
return ToolChunk(
content=[
TextBlock(
text=(
f"AgentCreate: unknown subagent_type "
f"{subagent_type!r}; expected one of "
f"{available}."
),
),
],
state=ToolResultState.ERROR,
)
# Enforce team-scoped name uniqueness. TeamSay routes by
# ``name`` (not agent_id), so duplicates would be ambiguous
# and unaddressable. The leader's name participates too —
# workers must not collide with it.
#
# Also reject ``@`` in the name: invited members display as
# ``"<name>@<agent_id[:8]>"`` in TeamSay, and letting a
# created member sneak an ``@`` into its name would make
# the two routing forms visually collide.
if "@" in name:
return ToolChunk(
content=[
TextBlock(
text=(
f"AgentCreate: member name {name!r} cannot "
f"contain the character '@'."
),
),
],
state=ToolResultState.ERROR,
)
leader_agent_record = await self._storage.get_agent(
self._user_id,
leader_session.agent_id,
)
existing_names: set[str] = set()
if leader_agent_record is not None:
existing_names.add(leader_agent_record.data.name)
members = await _ensure_team_members(
self._storage,
self._user_id,
team,
)
for member in members:
member_record = await self._storage.get_agent(
member.owner_id,
member.agent_id,
)
if member_record is not None:
existing_names.add(member_record.data.name)
if name in existing_names:
return ToolChunk(
content=[
TextBlock(
text=(
f"AgentCreate: a team member named "
f"{name!r} already exists. Member names "
f"must be unique within the team "
f"(including the leader's name); pick "
f"another."
),
),
],
state=ToolResultState.ERROR,
)
# Resolve leader name early — needed both for the system
# prompt template and for the initial team-message hint.
leader_name = (
leader_agent_record.data.name
if leader_agent_record is not None
else leader_session.agent_id
)
# 1. Build worker AgentRecord (source="team" so it's hidden
# from the global agent list).
system_prompt = template.system_prompt_template.format(
team_name=team.data.name,
team_description=team.data.description,
member_name=name,
member_description=description,
leader_name=leader_name,
)
worker_agent = AgentRecord(
user_id=self._user_id,
source="team",
data=AgentData(
name=name,
system_prompt=system_prompt,
context_config=template.context_config.model_copy(
deep=True,
),
react_config=template.react_config.model_copy(
deep=True,
),
),
)
await self._storage.upsert_agent(self._user_id, worker_agent)
# 2. Build worker SessionRecord, inheriting leader's model
# config. The template's permission context is the base;
# on top of it we merge the leader's mode and/or rules
# and/or working directories according to the template's
# inherit-from-leader flags. See
# :func:`_merge_leader_permissions` for the policy.
leader_permission_context = (
_agent_state.permission_context
if _agent_state is not None
else leader_session.state.permission_context
)
worker_permission_context = _merge_leader_permissions(
template,
leader_permission_context,
)
worker_state = AgentState(
permission_context=worker_permission_context,
tasks_context=template.tasks_context.model_copy(
deep=True,
),
)
worker_session = await self._storage.upsert_session(
user_id=self._user_id,
agent_id=worker_agent.id,
config=SessionConfig(
workspace_id=leader_session.config.workspace_id,
name=f"team:{team.id}/{name}",
chat_model_config=(
leader_session.config.chat_model_config
),
fallback_chat_model_config=(
leader_session.config.fallback_chat_model_config
),
),
state=worker_state,
)
await self._storage.set_session_team_id(
self._user_id,
worker_session.id,
team.id,
)
# 3. Append worker to the team roster. Write both the
# legacy ``member_ids`` (for backwards-compatible
# readers) and the new ``members`` entry with
# ``role="created"`` — the two must stay in sync so
# ``ensure_team_members`` and any legacy reader agree
# on membership. ``members`` above was materialised via
# the same helper, so it includes any prior migration.
team.data.member_ids = [
*team.data.member_ids,
worker_agent.id,
]
team.data.members = [
*members,
TeamMember(
owner_id=self._user_id,
agent_id=worker_agent.id,
session_id=worker_session.id,
role="created",
),
]
await self._storage.upsert_team(self._user_id, team)
# 4. Deliver the initial task to the worker's inbox + wakeup.
hint = HintBlock(
hint=(
f'<team-message from="{leader_name}">\n'
f"{prompt}\n"
f"</team-message>"
),
source=json.dumps(
{
"label": "team_message",
"sublabel": leader_name,
},
ensure_ascii=False,
),
)
await self._message_bus.queue_push(
MessageBusKeys.inbox(worker_session.id),
hint.model_dump(mode="json"),
)
await enqueue_run_trigger(
self._message_bus,
user_id=self._user_id,
session_id=worker_session.id,
agent_id=worker_agent.id,
)
return ToolChunk(
content=[
TextBlock(
text=(
f"Member {name!r} added to team "
f"{team.data.name!r}."
),
),
],
)
except Exception as e: # pylint: disable=broad-except
return ToolChunk(
content=[TextBlock(text=f"AgentCreate failed: {e}")],
state=ToolResultState.ERROR,
)
|