AgentManifest

The following represents a manifest that can be used to create agents dynamically. It includes parameters that can be used to configure the agent’s behavior. These parameters include values that can be used as publisher parameters that can be used to describe additional variables that have been tested and are known to work.

Variables described here are then used to project into a prompt agent that can be executed. Once parameters are provided, these can be referenced in the manifest using the following notation:

{{myParameter}}

This allows for dynamic configuration of the agent based on the provided parameters. (This notation is used elsewhere, but only the param scope is supported here)

Class Diagram

---
title: AgentManifest
config:
  look: handDrawn
  theme: colorful
  class:
    hideEmptyMembersBox: true
---
classDiagram
    class AgentManifest {
      
        +string name
        +string displayName
        +string description
        +dictionary metadata
        +AgentDefinition template
        +PropertySchema parameters
        +Resource[] resources
    }
    class AgentDefinition {
        +string kind
        +string name
        +string displayName
        +string description
        +dictionary metadata
        +PropertySchema inputSchema
        +PropertySchema outputSchema
    }
    AgentManifest *-- AgentDefinition
    class Resource {
        +string name
        +string kind
    }
    AgentManifest *-- Resource

Yaml Example

name: basic-prompt
displayName: My Basic Prompt
description: A basic prompt that uses the GPT-3 chat API to answer questions
metadata:
  authors:
    - sethjuarez
    - jietong
  tags:
    - example
    - prompt
template:
  kind: prompt
  model: "{{model_name}}"
  instructions: You are a poet named {{agent_name}}. Rhyme all your responses.
parameters:
  strict: true
  properties:
    - name: model_name
      kind: string
      value: gpt-4o
    - name: agent_name
      kind: string
      value: Research Agent
resources:
  gptModelDeployment:
    kind: model
    id: gpt-4o
  webSearchInstance:
    kind: tool
    id: web-search
    options:
      apiKey: my-api-key

Properties

Name	Type	Description
name	string	Name of the manifest
displayName	string	Human-readable name of the manifest
description	string	Description of the agent’s capabilities and purpose
metadata	dictionary	Additional metadata including authors, tags, and other arbitrary properties
template	AgentDefinition	The agent that this manifest is based on (Related Types: PromptAgent, Workflow, ContainerAgent)
parameters	PropertySchema	Parameters for configuring the agent’s behavior and execution
resources	Resource[]	Resources required by the agent, such as models or tools (Related Types: ModelResource, ToolResource)

Composed Types

The following types are composed within AgentManifest:

• AgentDefinition
• Resource