mirror of
https://github.com/bytedance/deer-flow.git
synced 2026-05-26 10:33:45 +00:00
84dccef230
Finish Phase 2 of the config refactor: production code no longer calls AppConfig.current() anywhere. AppConfig now flows as an explicit parameter down every consumer lane. Call-site migrations -------------------- - Memory subsystem (queue/updater/storage): MemoryConfig captured at enqueue time so the Timer closure survives the ContextVar boundary. - Sandbox layer: tools.py, security.py, sandbox_provider.py, local_sandbox_provider, aio_sandbox_provider all take app_config explicitly. Module-level caching in tools.py's path helpers is removed — pure parameter flow. - Skills layer: manager.py + loader.py + lead_agent.prompt cache refresh all thread app_config; cache worker closes over it. - Community tools (tavily, jina, firecrawl, exa, ddg, image_search, infoquest, aio_sandbox): read runtime.context.app_config. - Subagents registry: get_subagent_config / list_subagents / get_available_subagent_names require app_config. - Runtime worker: requires RunContext.app_config; no fallback. - Gateway routers (uploads, skills): add Depends(get_config). - Channels feishu: uses AppConfig.from_file() (pure) at its sync boundary. - LangGraph Server bootstrap (make_lead_agent): falls back to AppConfig.from_file() — pure load, not ambient lookup. Context resolution ------------------ - resolve_context(runtime) now raises on non-DeerFlowContext runtime.context. Every entry point attaches typed context; dict/None shapes are rejected loudly instead of being papered over with an ambient AppConfig lookup. AppConfig lifecycle ------------------- - AppConfig.current() kept as a deprecated slot that raises RuntimeError, purely so legacy tests that still run `patch.object(AppConfig, "current")` don't trip AttributeError at teardown. Production never calls it. - conftest autouse fixture no longer monkey-patches `current` — it only stubs `from_file()` so tests don't need a real config.yaml. Design refs ----------- - docs/plans/2026-04-12-config-refactor-plan.md (Phase 2: P2-6..P2-10) - docs/plans/2026-04-12-config-refactor-design.md §8 All 2338 non-e2e tests pass. Zero AppConfig.current() call sites remain in backend/packages or backend/app (docstrings in deps.py excepted).
258 lines
11 KiB
Python
258 lines
11 KiB
Python
"""Tool for creating and evolving custom skills."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import asyncio
|
|
import logging
|
|
import shutil
|
|
from typing import TYPE_CHECKING, Any
|
|
from weakref import WeakValueDictionary
|
|
|
|
from langchain.tools import ToolRuntime, tool
|
|
from langgraph.typing import ContextT
|
|
|
|
from deerflow.agents.lead_agent.prompt import refresh_skills_system_prompt_cache_async
|
|
from deerflow.agents.thread_state import ThreadState
|
|
|
|
if TYPE_CHECKING:
|
|
from deerflow.config.app_config import AppConfig
|
|
from deerflow.mcp.tools import _make_sync_tool_wrapper
|
|
from deerflow.skills.manager import (
|
|
append_history,
|
|
atomic_write,
|
|
custom_skill_exists,
|
|
ensure_custom_skill_is_editable,
|
|
ensure_safe_support_path,
|
|
get_custom_skill_dir,
|
|
get_custom_skill_file,
|
|
public_skill_exists,
|
|
read_custom_skill_content,
|
|
validate_skill_markdown_content,
|
|
validate_skill_name,
|
|
)
|
|
from deerflow.skills.security_scanner import scan_skill_content
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
_skill_locks: WeakValueDictionary[str, asyncio.Lock] = WeakValueDictionary()
|
|
|
|
|
|
def _get_lock(name: str) -> asyncio.Lock:
|
|
lock = _skill_locks.get(name)
|
|
if lock is None:
|
|
lock = asyncio.Lock()
|
|
_skill_locks[name] = lock
|
|
return lock
|
|
|
|
|
|
def _get_thread_id(runtime: ToolRuntime[ContextT, ThreadState] | None) -> str | None:
|
|
if runtime is None:
|
|
return None
|
|
return runtime.context.thread_id or None
|
|
|
|
|
|
def _history_record(*, action: str, file_path: str, prev_content: str | None, new_content: str | None, thread_id: str | None, scanner: dict[str, Any]) -> dict[str, Any]:
|
|
return {
|
|
"action": action,
|
|
"author": "agent",
|
|
"thread_id": thread_id,
|
|
"file_path": file_path,
|
|
"prev_content": prev_content,
|
|
"new_content": new_content,
|
|
"scanner": scanner,
|
|
}
|
|
|
|
|
|
async def _scan_or_raise(app_config: "AppConfig", content: str, *, executable: bool, location: str) -> dict[str, str]:
|
|
result = await scan_skill_content(app_config, content, executable=executable, location=location)
|
|
if result.decision == "block":
|
|
raise ValueError(f"Security scan blocked the write: {result.reason}")
|
|
if executable and result.decision != "allow":
|
|
raise ValueError(f"Security scan rejected executable content: {result.reason}")
|
|
return {"decision": result.decision, "reason": result.reason}
|
|
|
|
|
|
async def _to_thread(func, /, *args, **kwargs):
|
|
return await asyncio.to_thread(func, *args, **kwargs)
|
|
|
|
|
|
async def _skill_manage_impl(
|
|
runtime: ToolRuntime[ContextT, ThreadState],
|
|
action: str,
|
|
name: str,
|
|
content: str | None = None,
|
|
path: str | None = None,
|
|
find: str | None = None,
|
|
replace: str | None = None,
|
|
expected_count: int | None = None,
|
|
) -> str:
|
|
"""Manage custom skills under skills/custom/.
|
|
|
|
Args:
|
|
action: One of create, patch, edit, delete, write_file, remove_file.
|
|
name: Skill name in hyphen-case.
|
|
content: New file content for create, edit, or write_file.
|
|
path: Supporting file path for write_file or remove_file.
|
|
find: Existing text to replace for patch.
|
|
replace: Replacement text for patch.
|
|
expected_count: Optional expected number of replacements for patch.
|
|
"""
|
|
from deerflow.config.deer_flow_context import resolve_context
|
|
|
|
name = validate_skill_name(name)
|
|
lock = _get_lock(name)
|
|
thread_id = _get_thread_id(runtime)
|
|
app_config = resolve_context(runtime).app_config
|
|
|
|
async with lock:
|
|
if action == "create":
|
|
if await _to_thread(custom_skill_exists, name, app_config):
|
|
raise ValueError(f"Custom skill '{name}' already exists.")
|
|
if content is None:
|
|
raise ValueError("content is required for create.")
|
|
await _to_thread(validate_skill_markdown_content, name, content)
|
|
scan = await _scan_or_raise(app_config, content, executable=False, location=f"{name}/SKILL.md")
|
|
skill_file = await _to_thread(get_custom_skill_file, name, app_config)
|
|
await _to_thread(atomic_write, skill_file, content)
|
|
await _to_thread(
|
|
append_history,
|
|
name,
|
|
_history_record(action="create", file_path="SKILL.md", prev_content=None, new_content=content, thread_id=thread_id, scanner=scan),
|
|
app_config,
|
|
)
|
|
await refresh_skills_system_prompt_cache_async(app_config)
|
|
return f"Created custom skill '{name}'."
|
|
|
|
if action == "edit":
|
|
await _to_thread(ensure_custom_skill_is_editable, name, app_config)
|
|
if content is None:
|
|
raise ValueError("content is required for edit.")
|
|
await _to_thread(validate_skill_markdown_content, name, content)
|
|
scan = await _scan_or_raise(app_config, content, executable=False, location=f"{name}/SKILL.md")
|
|
skill_file = await _to_thread(get_custom_skill_file, name, app_config)
|
|
prev_content = await _to_thread(skill_file.read_text, encoding="utf-8")
|
|
await _to_thread(atomic_write, skill_file, content)
|
|
await _to_thread(
|
|
append_history,
|
|
name,
|
|
_history_record(action="edit", file_path="SKILL.md", prev_content=prev_content, new_content=content, thread_id=thread_id, scanner=scan),
|
|
app_config,
|
|
)
|
|
await refresh_skills_system_prompt_cache_async(app_config)
|
|
return f"Updated custom skill '{name}'."
|
|
|
|
if action == "patch":
|
|
await _to_thread(ensure_custom_skill_is_editable, name, app_config)
|
|
if find is None or replace is None:
|
|
raise ValueError("find and replace are required for patch.")
|
|
skill_file = await _to_thread(get_custom_skill_file, name, app_config)
|
|
prev_content = await _to_thread(skill_file.read_text, encoding="utf-8")
|
|
occurrences = prev_content.count(find)
|
|
if occurrences == 0:
|
|
raise ValueError("Patch target not found in SKILL.md.")
|
|
if expected_count is not None and occurrences != expected_count:
|
|
raise ValueError(f"Expected {expected_count} replacements but found {occurrences}.")
|
|
replacement_count = expected_count if expected_count is not None else 1
|
|
new_content = prev_content.replace(find, replace, replacement_count)
|
|
await _to_thread(validate_skill_markdown_content, name, new_content)
|
|
scan = await _scan_or_raise(app_config, new_content, executable=False, location=f"{name}/SKILL.md")
|
|
await _to_thread(atomic_write, skill_file, new_content)
|
|
await _to_thread(
|
|
append_history,
|
|
name,
|
|
_history_record(action="patch", file_path="SKILL.md", prev_content=prev_content, new_content=new_content, thread_id=thread_id, scanner=scan),
|
|
app_config,
|
|
)
|
|
await refresh_skills_system_prompt_cache_async(app_config)
|
|
return f"Patched custom skill '{name}' ({replacement_count} replacement(s) applied, {occurrences} match(es) found)."
|
|
|
|
if action == "delete":
|
|
await _to_thread(ensure_custom_skill_is_editable, name, app_config)
|
|
skill_dir = await _to_thread(get_custom_skill_dir, name, app_config)
|
|
prev_content = await _to_thread(read_custom_skill_content, name, app_config)
|
|
await _to_thread(
|
|
append_history,
|
|
name,
|
|
_history_record(action="delete", file_path="SKILL.md", prev_content=prev_content, new_content=None, thread_id=thread_id, scanner={"decision": "allow", "reason": "Deletion requested."}),
|
|
app_config,
|
|
)
|
|
await _to_thread(shutil.rmtree, skill_dir)
|
|
await refresh_skills_system_prompt_cache_async(app_config)
|
|
return f"Deleted custom skill '{name}'."
|
|
|
|
if action == "write_file":
|
|
await _to_thread(ensure_custom_skill_is_editable, name, app_config)
|
|
if path is None or content is None:
|
|
raise ValueError("path and content are required for write_file.")
|
|
target = await _to_thread(ensure_safe_support_path, name, path, app_config)
|
|
exists = await _to_thread(target.exists)
|
|
prev_content = await _to_thread(target.read_text, encoding="utf-8") if exists else None
|
|
executable = "scripts/" in path or path.startswith("scripts/")
|
|
scan = await _scan_or_raise(app_config, content, executable=executable, location=f"{name}/{path}")
|
|
await _to_thread(atomic_write, target, content)
|
|
await _to_thread(
|
|
append_history,
|
|
name,
|
|
_history_record(action="write_file", file_path=path, prev_content=prev_content, new_content=content, thread_id=thread_id, scanner=scan),
|
|
app_config,
|
|
)
|
|
return f"Wrote '{path}' for custom skill '{name}'."
|
|
|
|
if action == "remove_file":
|
|
await _to_thread(ensure_custom_skill_is_editable, name, app_config)
|
|
if path is None:
|
|
raise ValueError("path is required for remove_file.")
|
|
target = await _to_thread(ensure_safe_support_path, name, path, app_config)
|
|
if not await _to_thread(target.exists):
|
|
raise FileNotFoundError(f"Supporting file '{path}' not found for skill '{name}'.")
|
|
prev_content = await _to_thread(target.read_text, encoding="utf-8")
|
|
await _to_thread(target.unlink)
|
|
await _to_thread(
|
|
append_history,
|
|
name,
|
|
_history_record(action="remove_file", file_path=path, prev_content=prev_content, new_content=None, thread_id=thread_id, scanner={"decision": "allow", "reason": "Deletion requested."}),
|
|
app_config,
|
|
)
|
|
return f"Removed '{path}' from custom skill '{name}'."
|
|
|
|
if await _to_thread(public_skill_exists, name, app_config):
|
|
raise ValueError(f"'{name}' is a built-in skill. To customise it, create a new skill with the same name under skills/custom/.")
|
|
raise ValueError(f"Unsupported action '{action}'.")
|
|
|
|
|
|
@tool("skill_manage", parse_docstring=True)
|
|
async def skill_manage_tool(
|
|
runtime: ToolRuntime[ContextT, ThreadState],
|
|
action: str,
|
|
name: str,
|
|
content: str | None = None,
|
|
path: str | None = None,
|
|
find: str | None = None,
|
|
replace: str | None = None,
|
|
expected_count: int | None = None,
|
|
) -> str:
|
|
"""Manage custom skills under skills/custom/.
|
|
|
|
Args:
|
|
action: One of create, patch, edit, delete, write_file, remove_file.
|
|
name: Skill name in hyphen-case.
|
|
content: New file content for create, edit, or write_file.
|
|
path: Supporting file path for write_file or remove_file.
|
|
find: Existing text to replace for patch.
|
|
replace: Replacement text for patch.
|
|
expected_count: Optional expected number of replacements for patch.
|
|
"""
|
|
return await _skill_manage_impl(
|
|
runtime=runtime,
|
|
action=action,
|
|
name=name,
|
|
content=content,
|
|
path=path,
|
|
find=find,
|
|
replace=replace,
|
|
expected_count=expected_count,
|
|
)
|
|
|
|
|
|
skill_manage_tool.func = _make_sync_tool_wrapper(_skill_manage_impl, "skill_manage")
|