Agent metadata

[matoushavlena]

As of today, BeeAI supports the following metadata for agents:

class UiType(StrEnum):
    chat = "chat"
    hands_off = "hands-off"
    custom = "custom"


class CliExample(BaseModel, extra="allow"):
    command: str
    name: Optional[str] = None
    description: Optional[str] = None
    output: Optional[str] = None
    processingSteps: Optional[list[str]] = None


class UiDefinition(BaseModel, extra="allow"):
    type: UiType
    userGreeting: str | None = None


class Examples(BaseModel, extra="allow"):
    cli: Optional[list[CliExample]] = None


class Metadata(BaseModel, extra="allow"):
    title: Optional[str] = None
    fullDescription: Optional[str] = None
    framework: Optional[str] = None
    license: Optional[str] = None
    languages: Optional[list[str]] = None
    githubUrl: Optional[str] = None
    examples: Optional[Examples] = None
    avgRunTimeSeconds: Optional[float] = None
    avgRunTokens: Optional[float] = None
    tags: Optional[list[str]] = None
    ui: Optional[UiDefinition] = None
    provider: Optional[str] = None

To ensure our metadata is comprehensive and valuable for diverse use cases, I'd like to open a discussion on the following:

• Are there important metadata attributes currently missing?
• Should we standardize certain optional fields to improve consistency across agents?
• Can we enhance or clarify existing attributes to improve usability?

[matoushavlena]

The first consideration is enabling an agent to specify a default model or LLM provider, potentially including multiple models (some agents combine simpler and more powerful models to balance cost and performance, or require embedding models). Additionally, certain agents depend on model-specific capabilities or have been intentionally designed and tested with a limited set of models in mind.

[matoushavlena]

Building on various discussions and feedback, the latest version if Agent metadata can be found here: https://docs.beeai.dev/acp/spec/agents-get. Closing this discussion for now.