Skip to content

Latest commit

 

History

31 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Dev Tools for the Foundry Agent Service

The Microsoft Foundry Agent Service provides some good tools in the playground for tracing and debugging -- oddly though if you want to just see the raw JSON content of Agents/Conversations/Responses, there's no easy way to do that. These Dev Tools help close that gap -- providing a UI and a CLI for viewing stored data in Agent Service.

NOTE: This repo is a beta / work in progress, it's subject to change, and Issues and PRs welcome!

Requirements


UI - Foundry Agent Service Explorer

A minimal browser front-end now lives under ui/. It reuses the same authentication + HTTP helpers as the CLI and allows you to easily browse Agents, Conversations and Responses.

Only compatible with Agents v2 in Foundry (new) -

Steps:

  1. Make sure you have already run npm install inside cli/ so @azure/identity is available, and authenticate with az login (or provide AZURE_CLIENT_ID, etc.).

  2. Set your project endpoint in the shell (export AZA_PROJECT=https://myendpoint/projects/12345/v1).

  3. Build and Start the UI server:

    cd ui
    npm install
    npm run build
    npm start
  4. Open http://localhost:4173 in a browser, paste the same project endpoint (or leave the field blank to rely on AZA_PROJECT [TBD]).


CLI - aza - Foundry Agent Service CLI

A lightweight CLI for Microsoft Foundry Agent Service. Read-only. Now updated to Support for Foundry Agent Service v2 as well as v1 (Classic)

Installation

Install deps:

cd cli && npm install

Authentication

Foundry Agent Service requires an authenticated user or service principal to access. AZA uses DefaultAzureCredential which adapts to a whichever creds are available.

This is easiest done by using Azure CLI.

Run az login or provide env vars (AZURE_CLIENT_ID, etc.). Scope used: https://ai.azure.com/.default.

Usage

To run:

./bin/aza <args>

(Optionally add cli/bin to PATH.)

Usage (v2):
	aza agents list [--limit N --order asc|desc --after ID --before ID]
	aza agents show <agentName>
	aza resp[onses] list [--limit N --order asc|desc --after ID --before ID]
	aza resp[onses] show <responseId>
	aza conv[ersations] list [--limit N --order asc|desc --after ID --before ID]
	aza conv[ersations] show <conversationId>

Usage (v1):
	aza agents list [--limit N --order asc|desc --after ID --before ID] -v1
	aza agents show <agentId> -v1
	aza threads list
	aza threads show <threadId>
	aza threads runs list <threadId>
	aza threads runs show <threadId> <runId>
	aza runs list <threadId>
	aza runs show <threadId> <runId>

Usage (common for v1 and v2):
	aza files list [--limit N --order asc|desc --after ID --before ID]
	aza files show <fileId>
	aza vs list
	aza vs show <vectorStoreId>
	aza vs files list <vectorStoreId>
	aza vs files show <vectorStoreId> <fileId>

Flags:

  • -p, --project or env AZA_PROJECT = base endpoint including project id
  • --api-version (default v1 / env AZA_API_VERSION)
  • --json pretty JSON (_at timestamps converted)
  • --raw raw body
  • --debug verbose HTTP
  • --help show built-in usage

Examples:

AZA_PROJECT=https://myendpoint/projects/12345/v1 aza agents list
aza -p https://myendpoint/projects/12345/v1 files list --json
aza responses list --limit 20
aza vs files list vst_123456789
aza vs files show vst_123456789 file_abcdef

Agents command maps to REST assistants endpoint (naming aligned to docs).

About

A UI and CLI for viewing objects in the Microsoft Foundry Agent Service

Resources

Stars

9 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages