Docs - AgentDetail environment variable configuration

[jenna-winkler]

Description

The AgentDetail class supports environment variable configuration through the variables parameter, but this functionality is undocumented. Developers have no way of discovering this feature exists, understanding what it does, or learning how to use it properly.

Current State

The only way to discover this functionality is by reading source code from existing agents. For example, the github-issue-creator agent demonstrates usage:

detail=AgentDetail(
    interaction_mode="multi-turn",
    framework="BeeAI",
    variables=[
        EnvVar(name="GITHUB_REPOSITORY", description="The repository to create the issue in", required=True),
        EnvVar(name="GITHUB_PAT", description="The GitHub Personal Access Token to use for the API", required=True),
        EnvVar(name="DOCS_URL", description="The URL of the documentation to use for the API", required=False),
        EnvVar(name="TEMPLATE_BUG_URL", description="The URL of the bug template to use for the API", required=False),
        EnvVar(name="TEMPLATE_FEATURE_URL", description="The URL of the feature template to use for the API", required=False),
    ],
)

Requested documentation

Documentation should cover:

1. Purpose - What does declaring environment variables in AgentDetail accomplish?
2. Behavior - How does Agent Stack use this information (validation, UI display, etc.)?
3. Usage - Basic example of configuring environment variables
4. Parameters - Full specification of the EnvVar class (name, description, required fields)
5. Runtime behavior - What happens when required variables are missing?

[grahamwhiteuk]

Also make sure to check for other missing documentation. Docs should be a first-class citizen when making a release, if the docs are not complete, don't make the release. There could even be a pre-commit check and GitHub action to make sure that docs are up-to-date with the code.