跳过内容

Agent 可视化

代理可视化允许您使用 Graphviz 生成代理及其关系的结构化图形表示。这对于理解代理、工具和交接在应用程序内的交互方式非常有用。

安装

安装可选的 viz 依赖组

pip install "openai-agents[viz]"

生成图形

您可以使用 draw_graph 函数生成代理可视化。此函数创建一个有向图,其中

  • 代理 表示为黄色矩形。
  • MCP 服务器 表示为灰色矩形。
  • 工具 表示为绿色椭圆。
  • 交接 是从一个代理到另一个代理的有向边。

示例用法

import os

from agents import Agent, function_tool
from agents.mcp.server import MCPServerStdio
from agents.extensions.visualization import draw_graph

@function_tool
def get_weather(city: str) -> str:
    return f"The weather in {city} is sunny."

spanish_agent = Agent(
    name="Spanish agent",
    instructions="You only speak Spanish.",
)

english_agent = Agent(
    name="English agent",
    instructions="You only speak English",
)

current_dir = os.path.dirname(os.path.abspath(__file__))
samples_dir = os.path.join(current_dir, "sample_files")
mcp_server = MCPServerStdio(
    name="Filesystem Server, via npx",
    params={
        "command": "npx",
        "args": ["-y", "@modelcontextprotocol/server-filesystem", samples_dir],
    },
)

triage_agent = Agent(
    name="Triage agent",
    instructions="Handoff to the appropriate agent based on the language of the request.",
    handoffs=[spanish_agent, english_agent],
    tools=[get_weather],
    mcp_servers=[mcp_server],
)

draw_graph(triage_agent)

Agent Graph

这将生成一个图形,以可视化的方式表示 triage 代理 的结构及其与子代理和工具的连接。

理解可视化

生成的图形包括

  • 一个 起始节点 (__start__),指示入口点。
  • 代理表示为填充黄色颜色的 矩形
  • 工具表示为填充绿色颜色的 椭圆
  • MCP 服务器表示为填充灰色颜色的 矩形
  • 指示交互的有向边
  • 实线箭头 用于代理到代理的交接。
  • 点线箭头 用于工具调用。
  • 虚线箭头 用于 MCP 服务器调用。
  • 一个 结束节点 (__end__),指示执行终止的位置。

注意: MCP 服务器在 agents 包的最新版本中呈现(已验证在 v0.2.8 中)。如果您在可视化中看不到 MCP 框,请升级到最新版本。

自定义图形

显示图形

默认情况下,draw_graph 沿行显示图形。要在一个单独的窗口中显示图形,请编写以下代码

draw_graph(triage_agent).view()

保存图形

默认情况下,draw_graph 沿行显示图形。要将其保存为文件,请指定文件名

draw_graph(triage_agent, filename="agent_graph")

这将在工作目录中生成 agent_graph.png