Skip to main content

AI Toolkit - CLI and SDK for agent debugging and workflow visualization

Project description

Agent Dev CLI

A Python CLI and SDK for agent debugging and workflow visualization with VS Code AI Toolkit integration.

Installation

pip install agent-dev-cli --pre

Note: This package is currently in beta. The --pre flag is required to install pre-release versions.

Usage

Option 1: CLI Wrapper (Recommended)

The easiest way to use Agent Dev CLI - no code changes required:

# Run your agent script with agentdev instrumentation
agentdev run my_agent.py

# Specify a custom port
agentdev run workflow.py --port 9000

# Enable verbose output
agentdev run my_agent.py --verbose

# Pass arguments to your script
agentdev run my_agent.py -- --model gpt-4 --temperature 0.7

The CLI automatically:

  • Intercepts from_agent_framework() calls
  • Injects agentdev visualization endpoints
  • Opens the workflow visualization in VS Code

Option 2: Programmatic API

If you prefer explicit control, you can integrate agentdev directly:

from agentdev import configure_agent_server
from azure.ai.agentserver.agentframework import from_agent_framework

# Create your agent
agent = build_agent(chat_client)

# Create agent server
agent_server = from_agent_framework(agent)

# Setup workflow visualization
configure_agent_server(agent_server)

# Run the server
await agent_server.run_async()

CLI Commands

agentdev run

Run a Python agent script with agentdev instrumentation.

agentdev run [OPTIONS] SCRIPT [ARGS]...

Options:
  -p, --port INTEGER    Agent server port (default: 8087)
  -v, --verbose         Enable verbose output
  --help                Show this message and exit

agentdev info

Show agentdev configuration and status information.

agentdev info

Features

  • Health Check Endpoint: Adds a /agentdev/health endpoint to your agent server
  • Workflow Visualization: Starts a visualization server on port 8090 for WorkflowAgent instances
  • Easy Integration: Simple one-function setup

Testing Your Agent Server

Once your agent server is running, you can test it using curl:

# Health check
curl http://localhost:8087/agentdev/health

# Send a request to your agent (streaming)
curl 'http://localhost:8087/agentdev/v1/responses' \
  -H 'Content-Type: application/json' \
  -d '{"model":"your-agent-model-id","input":{"role":"user","text":"Hello!"},"stream":true}'

Requirements

License

This project is licensed under the Microsoft AI Toolkit – Agent Dev CLI License Terms.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

agent_dev_cli-0.0.1b260205.tar.gz (23.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

agent_dev_cli-0.0.1b260205-py3-none-any.whl (27.8 kB view details)

Uploaded Python 3

File details

Details for the file agent_dev_cli-0.0.1b260205.tar.gz.

File metadata

  • Download URL: agent_dev_cli-0.0.1b260205.tar.gz
  • Upload date:
  • Size: 23.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.6

File hashes

Hashes for agent_dev_cli-0.0.1b260205.tar.gz
Algorithm Hash digest
SHA256 42c7f5849a0bfc7d17640a0bf0e24e2ff02600dc5f99243486a3ffee848e35a2
MD5 81ae52bf4cf46802f77013e0b2b2e968
BLAKE2b-256 c9cf77612bc737f1333a1e99e265838101ebf441526c559e81deed505a25d45a

See more details on using hashes here.

File details

Details for the file agent_dev_cli-0.0.1b260205-py3-none-any.whl.

File metadata

File hashes

Hashes for agent_dev_cli-0.0.1b260205-py3-none-any.whl
Algorithm Hash digest
SHA256 7897833e33a0802deedf51851679a52909827b25853b1c6d7e4e012efe8af233
MD5 0a5c7e96e74d7849d562a1fa19673bfa
BLAKE2b-256 6420fd894de6944f09716e59a8e31af0b748be1185268f8b434949090f857d53

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page