af5fbfabec
- Context_Engineering.md: 에이전트 컨텍스트 엔지니어링 개념 정리 문서 추가 - Context_Engineering_Research.ipynb: 연구 노트북 업데이트 - deepagents_sourcecode/: docstring과 주석을 한국어로 번역
141 lines
4.8 KiB
Python
141 lines
4.8 KiB
Python
"""에이전트에 기본 셸 도구를 노출하는 간단한 미들웨어입니다.
|
|
|
|
Simplified middleware that exposes a basic shell tool to agents.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import os
|
|
import subprocess
|
|
from typing import Any
|
|
|
|
from langchain.agents.middleware.types import AgentMiddleware, AgentState
|
|
from langchain.tools import ToolRuntime, tool
|
|
from langchain_core.messages import ToolMessage
|
|
from langchain_core.tools.base import ToolException
|
|
|
|
|
|
class ShellMiddleware(AgentMiddleware[AgentState, Any]):
|
|
"""Give basic shell access to agents via the shell.
|
|
|
|
This shell will execute on the local machine and has NO safeguards except
|
|
for the human in the loop safeguard provided by the CLI itself.
|
|
"""
|
|
|
|
def __init__(
|
|
self,
|
|
*,
|
|
workspace_root: str,
|
|
timeout: float = 120.0,
|
|
max_output_bytes: int = 100_000,
|
|
env: dict[str, str] | None = None,
|
|
) -> None:
|
|
"""Initialize an instance of `ShellMiddleware`.
|
|
|
|
Args:
|
|
workspace_root: Working directory for shell commands.
|
|
timeout: Maximum time in seconds to wait for command completion.
|
|
Defaults to 120 seconds.
|
|
max_output_bytes: Maximum number of bytes to capture from command output.
|
|
Defaults to 100,000 bytes.
|
|
env: Environment variables to pass to the subprocess. If None,
|
|
uses the current process's environment. Defaults to None.
|
|
"""
|
|
super().__init__()
|
|
self._timeout = timeout
|
|
self._max_output_bytes = max_output_bytes
|
|
self._tool_name = "shell"
|
|
self._env = env if env is not None else os.environ.copy()
|
|
self._workspace_root = workspace_root
|
|
|
|
# Build description with working directory information
|
|
description = (
|
|
f"Execute a shell command directly on the host. Commands will run in "
|
|
f"the working directory: {workspace_root}. Each command runs in a fresh shell "
|
|
f"environment with the current process's environment variables. Commands may "
|
|
f"be truncated if they exceed the configured timeout or output limits."
|
|
)
|
|
|
|
@tool(self._tool_name, description=description)
|
|
def shell_tool(
|
|
command: str,
|
|
runtime: ToolRuntime[None, AgentState],
|
|
) -> ToolMessage | str:
|
|
"""Execute a shell command.
|
|
|
|
Args:
|
|
command: The shell command to execute.
|
|
runtime: The tool runtime context.
|
|
"""
|
|
return self._run_shell_command(command, tool_call_id=runtime.tool_call_id)
|
|
|
|
self._shell_tool = shell_tool
|
|
self.tools = [self._shell_tool]
|
|
|
|
def _run_shell_command(
|
|
self,
|
|
command: str,
|
|
*,
|
|
tool_call_id: str | None,
|
|
) -> ToolMessage | str:
|
|
"""Execute a shell command and return the result.
|
|
|
|
Args:
|
|
command: The shell command to execute.
|
|
tool_call_id: The tool call ID for creating a ToolMessage.
|
|
|
|
Returns:
|
|
A ToolMessage with the command output or an error message.
|
|
"""
|
|
if not command or not isinstance(command, str):
|
|
msg = "Shell tool expects a non-empty command string."
|
|
raise ToolException(msg)
|
|
|
|
try:
|
|
result = subprocess.run( # noqa: S602
|
|
command,
|
|
check=False,
|
|
shell=True,
|
|
capture_output=True,
|
|
text=True,
|
|
timeout=self._timeout,
|
|
env=self._env,
|
|
cwd=self._workspace_root,
|
|
)
|
|
|
|
# Combine stdout and stderr
|
|
output_parts = []
|
|
if result.stdout:
|
|
output_parts.append(result.stdout)
|
|
if result.stderr:
|
|
stderr_lines = result.stderr.strip().split("\n")
|
|
output_parts.extend([f"[stderr] {line}" for line in stderr_lines])
|
|
|
|
output = "\n".join(output_parts) if output_parts else "<no output>"
|
|
|
|
# Truncate output if needed
|
|
if len(output) > self._max_output_bytes:
|
|
output = output[: self._max_output_bytes]
|
|
output += f"\n\n... Output truncated at {self._max_output_bytes} bytes."
|
|
|
|
# Add exit code info if non-zero
|
|
if result.returncode != 0:
|
|
output = f"{output.rstrip()}\n\nExit code: {result.returncode}"
|
|
status = "error"
|
|
else:
|
|
status = "success"
|
|
|
|
except subprocess.TimeoutExpired:
|
|
output = f"Error: Command timed out after {self._timeout:.1f} seconds."
|
|
status = "error"
|
|
|
|
return ToolMessage(
|
|
content=output,
|
|
tool_call_id=tool_call_id,
|
|
name=self._tool_name,
|
|
status=status,
|
|
)
|
|
|
|
|
|
__all__ = ["ShellMiddleware"]
|