Install & Compatibility
Where this runs
tested against v1.0.0b260528 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
py 3.9
✕ build_error
✕ build_error
82MB installed
● package 82MB
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
serve
✓ from agent_framework.devui import serve
Main function to launch the DevUI.
Agent
✓ from agent_framework import Agent
Class for defining AI agents within the framework.
OpenAIChatClient
✓ from agent_framework.openai import OpenAIChatClient
Client for connecting agents to OpenAI-compatible chat models.
This quickstart demonstrates how to define a simple agent with a tool and then launch the DevUI to interact with it. The `serve` function starts the web UI and API server, making the agent accessible for testing and debugging in a browser. Ensure `OPENAI_API_KEY` is set as an environment variable if you intend for the agent to use an actual OpenAI client.
import os
from agent_framework import Agent
from agent_framework.openai import OpenAIChatClient
from agent_framework.devui import serve
# NOTE: Set OPENAI_API_KEY environment variable for actual API calls
# Example for a simple tool
def get_weather(location: str) -> str:
"""Get weather for a location."""
return f"Weather in {location}: 72°F and sunny"
# Create your agent
agent = Agent(
name="WeatherAgent",
client=OpenAIChatClient(api_key=os.environ.get('OPENAI_API_KEY', '')) if os.environ.get('OPENAI_API_KEY') else None, # Pass API key if available
tools=[get_weather]
)
# Launch debug UI - this opens a browser to http://localhost:8080
print("Launching DevUI... access at http://localhost:8080")
serve(entities=[agent], auto_open=True)
devui --version
Debug
Known issues
breakingThe Microsoft Agent Framework, including DevUI, is currently in a development/preview stage. APIs and features are subject to frequent changes, and building from source is sometimes recommended over pre-release packages to ensure the latest updates.fixRefer to the official GitHub repository (microsoft/agent-framework) for the latest API changes and consider installing directly from source for the most up-to-date features, or pin to a specific pre-release version.
affects: All 1.x.x pre-release versions
gotchaDevUI is explicitly stated as a 'sample app' and 'not intended for production use.' Its primary purpose is for local development, testing, and debugging of agents and workflows within the Agent Framework, rather than deployment.fixFor production environments or advanced features, it is recommended to build a custom interface and API server using the core Agent Framework SDK.
affects: All versions
gotchaWhen using DevUI's OpenAI Proxy feature or agents that interact with OpenAI-compatible clients (like `OpenAIChatClient`), an `OPENAI_API_KEY` (or a `GITHUB_TOKEN` for GitHub Models) must be configured as an environment variable on the backend for proper authentication.fixSet `OPENAI_API_KEY` (or `GITHUB_TOKEN`) as an environment variable in your development environment before launching DevUI or the agent application.
affects: All versions
gotchaA specific architectural consideration for developers is to avoid using `async with` context managers when creating agents with Model Context Protocol (MCP) tools for DevUI.fixWhen integrating MCP tools with agents intended for DevUI, ensure that `async with` is not used in their definition or interaction logic.
affects: All versions
gotchaDue to its pre-release status, installation of `agent-framework-devui` typically requires the `--pre` flag with pip (e.g., `pip install agent-framework-devui --pre`) to access the latest beta versions.fixAlways include the `--pre` flag during `pip install` to ensure the package is found and installed correctly. Omission may result in 'No matching distribution found' errors.
affects: All 1.x.x pre-release versions
Upgrade
Version history
1.0.0b260528latest on PyPI · released May 28, 2026
Audit
Dependencies
agent-frameworkrequiredCore framework for which DevUI provides a user interface.
openaioptionalRequired for interacting with OpenAI-compatible APIs and clients used by agents.