This release is a pre-release and may not be stable for production use.
DevUI - A Sample App for Running Agents and Workflows
A lightweight, standalone sample app interface for running entities (agents/workflows) in the Microsoft Agent Framework supporting directory-based discovery, in-memory entity registration, and sample entity gallery.
Quick Start
# Install
pip install agent-framework-devui
You can also launch it programmatically
from agent_framework import ChatAgent
from agent_framework.openai import OpenAIChatClient
from agent_framework.devui import serve
def get_weather(location: str) -> str:
"""Get weather for a location."""
return f"Weather in {location}: 72°F and sunny"
# Create your agent
agent = ChatAgent(
name="WeatherAgent",
chat_client=OpenAIChatClient(),
tools=[get_weather]
)
# Launch debug UI - that's it!
serve(entities=[agent], auto_open=True)
# → Opens browser to http://localhost:8080
In addition, if you have agents/workflows defined in a specific directory structure (see below), you can launch DevUI from the cli to discover and run them.
# Launch web UI + API server
devui ./agents --port 8080
# → Web UI: http://localhost:8080
# → API: http://localhost:8080/v1/*
When DevUI starts with no discovered entities, it displays a sample entity gallery with curated examples from the Agent Framework repository to help you get started quickly.
Directory Structure
For your agents to be discovered by the DevUI, they must be organized in a directory structure like below. Each agent/workflow must have an __init__.py that exports the required variable (agent or workflow).
Note: .env files are optional but will be automatically loaded if present in the agent/workflow directory or parent entities directory. Use them to store API keys, configuration variables, and other environment-specific settings.
agents/
├── weather_agent/
│ ├── __init__.py # Must export: agent = ChatAgent(...)
│ ├── agent.py
│ └── .env # Optional: API keys, config vars
├── my_workflow/
│ ├── __init__.py # Must export: workflow = WorkflowBuilder()...
│ ├── workflow.py
│ └── .env # Optional: environment variables
└── .env # Optional: shared environment variables
Viewing Telemetry (Otel Traces) in DevUI
Agent Framework emits OpenTelemetry (Otel) traces for various operations. You can view these traces in DevUI by enabling tracing when starting the server.
devui ./agents --tracing framework
OpenAI-Compatible API
For convenience, you can interact with the agents/workflows using the standard OpenAI API format. Just specify the entity_id in the extra_body field. This can be an agent_id or workflow_id.
# Standard OpenAI format
curl -X POST http://localhost:8080/v1/responses \
-H "Content-Type: application/json" \
-d @- << 'EOF'
{
"model": "agent-framework",
"input": "Hello world",
"extra_body": {"entity_id": "weather_agent"}
}
CLI Options
devui [directory] [options]
Options:
--port, -p Port (default: 8080)
--host Host (default: 127.0.0.1)
--headless API only, no UI
--config YAML config file
--tracing none|framework|workflow|all
--reload Enable auto-reload
Key Endpoints
GET /v1/entities- List discovered agents/workflowsGET /v1/entities/{entity_id}/info- Get detailed entity informationPOST /v1/entities/add- Add entity from URL (for gallery samples)DELETE /v1/entities/{entity_id}- Remove remote entityPOST /v1/responses- Execute agent/workflow (streaming or sync)GET /health- Health checkPOST /v1/threads- Create thread for agent (optional)GET /v1/threads?agent_id={id}- List threads for agentGET /v1/threads/{thread_id}- Get thread infoDELETE /v1/threads/{thread_id}- Delete threadGET /v1/threads/{thread_id}/messages- Get thread messages
Implementation
- Discovery:
agent_framework_devui/_discovery.py - Execution:
agent_framework_devui/_executor.py - Message Mapping:
agent_framework_devui/_mapper.py - Session Management:
agent_framework_devui/_session.py - API Server:
agent_framework_devui/_server.py - CLI:
agent_framework_devui/_cli.py
Examples
See samples/ for working agent and workflow implementations.
License
MIT
5 maintainers
Release files for agent-framework-devui 1.0.0b251001
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| agent_framework_devui-1.0.0b251001.tar.gz | 615.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| agent_framework_devui-1.0.0b251001-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 872.5 kB
Release files / agent_framework_devui-1.0.0b251001.tar.gz
| Download URL | agent_framework_devui-1.0.0b251001.tar.gz |
|---|---|
| Size | 615.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
891368951673b5fe2f7f25174eeab032d9faed37cf06d82a5f91ee5cdd8b1c15
|
|
BLAKE2b-256 checksum How to use checksums |
51ceee2d16360cc6de9214bfb11921b52a4598fd3f3789521204d499a8907a4e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.8.22
|
Release files / agent_framework_devui-1.0.0b251001-py3-none-any.whl
| Download URL | agent_framework_devui-1.0.0b251001-py3-none-any.whl |
|---|---|
| Size | 256.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
57b39fe39c2752b3df18941c581d12c728b5e5ad5814bad66d186db932449edb
|
|
BLAKE2b-256 checksum How to use checksums |
7b43a124de5659272e967e75cdcdea407facf3e6b94becf0b1218297ed59d502
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.8.22
|
