Files
microsoft--agent-framework/python/packages/devui/AGENTS.md
T
wehub-resource-sync db620d33df
CodeQL / Analyze (csharp) (push) Waiting to run
CodeQL / Analyze (python) (push) Waiting to run
dotnet-build-and-test / dotnet-test-functions (push) Has been cancelled
dotnet-build-and-test / paths-filter (push) Has been cancelled
dotnet-build-and-test / dotnet-build (Debug, windows-latest, net9.0) (push) Has been cancelled
dotnet-build-and-test / dotnet-build (Release, ubuntu-latest, net10.0) (push) Has been cancelled
dotnet-build-and-test / dotnet-build (Release, ubuntu-latest, net8.0) (push) Has been cancelled
dotnet-build-and-test / dotnet-build (Release, windows-latest, net472) (push) Has been cancelled
dotnet-build-and-test / dotnet-test (Release, integration, true, ubuntu-latest, net10.0) (push) Has been cancelled
dotnet-build-and-test / dotnet-test (Release, integration, true, windows-latest, net472) (push) Has been cancelled
dotnet-build-and-test / dotnet-foundry-hosted-it (push) Has been cancelled
dotnet-build-and-test / dotnet-build-and-test-check (push) Has been cancelled
dotnet-build-and-test / Integration Test Report (push) Has been cancelled
chore: import upstream snapshot with attribution
2026-07-13 13:39:25 +08:00

1.3 KiB

DevUI Package (agent-framework-devui)

Interactive developer UI for testing and debugging agents and workflows.

Main Classes

  • serve() - Launch the DevUI server
  • DevServer - The FastAPI-based development server
  • register_cleanup() - Register cleanup hooks for entities
  • CheckpointConversationManager - Manages conversation checkpoints

Models

  • AgentFrameworkRequest - Request model for agent invocations
  • OpenAIResponse / OpenAIError - OpenAI-compatible response models
  • DiscoveryResponse / EntityInfo - Entity discovery models

Usage

from agent_framework.devui import serve

agent = Agent(...)
serve(entities=[agent], port=8080, auto_open=True)

CLI

# Run with auto-discovery
devui ./agents

# Run with specific entities
devui --entities my_agent.py

Security Posture

DevUI is a development-only sample app, not a production hosting surface. Authentication is enabled by default. Unauthenticated mode is allowed only on localhost / 127.0.0.1; 0.0.0.0, LAN IPs, and hostnames require DEVUI_AUTH_TOKEN or --auth-token.

Import Path

from agent_framework.devui import serve, register_cleanup
# or directly:
from agent_framework_devui import serve