Skip to content

Complete and publish the Hosted Agent tutorial #338

Description

@placerda

Background

The AgentOps documentation already has a strong published tutorial for Prompt Agent workflows: Tutorial: Foundry Prompt Agent (sandbox -> dev with PR gate). That tutorial gives readers a clear path through purpose, when to use the pattern, prerequisites, sandbox and dev setup, evaluation, PR-gated shipping, observation, ownership, release decisions, and acceptance evidence.

There is also an existing docs/tutorial-hosted-agent-quickstart.md file on main, so this issue is not about starting from zero. The goal is to make the Hosted Agent tutorial complete, discoverable, and consistent with the quality and structure of the published Prompt Agent tutorial.

Hosted agents are an important companion pattern for AgentOps because they represent agents reachable through endpoint URLs, such as Foundry Hosted Agent or HTTP Agent. The tutorial should help users understand when this pattern is appropriate compared with prompt agents, then walk them through a practical, end-to-end workflow.

Proposed scope

Update, complete, or publish the Hosted Agent tutorial so it covers:

  • What a hosted agent is in the AgentOps context, focusing on agents exposed through endpoint URLs.
  • When to choose a hosted agent instead of a prompt agent.
  • What the reader will build and validate during the tutorial.
  • Required prerequisites, including any Foundry, endpoint, auth, repo, or environment assumptions.
  • A clear setup path for registering or configuring the hosted agent endpoint.
  • Sandbox and dev workflow, aligned with the Prompt Agent tutorial where it makes sense.
  • Evaluation and evidence collection for the hosted agent.
  • A PR-gated path for promoting or shipping changes.
  • Observability guidance for the hosted agent path.
  • Ownership, release, or operational decision points.
  • Acceptance and evidence expectations at the end of the tutorial.

The outline does not need to copy the Prompt Agent tutorial exactly, but the reader experience should feel equally complete and production-minded.

Acceptance criteria

  • The Hosted Agent tutorial is available from the published documentation navigation or otherwise discoverable alongside the Prompt Agent tutorial.
  • The tutorial clearly explains the hosted-agent use case and contrasts it with prompt agents.
  • The tutorial works for endpoint-backed agents such as Foundry Hosted Agent or HTTP Agent, without assuming the reader is starting from a blank page.
  • The existing docs/tutorial-hosted-agent-quickstart.md content is reused, completed, or replaced thoughtfully rather than ignored.
  • The tutorial includes prerequisites, step-by-step workflow, validation/evaluation steps, observability guidance, and final acceptance/evidence guidance.
  • Terminology, tone, and structure are consistent with the published Prompt Agent tutorial.
  • Any documentation index, navigation, or publishing configuration needed to expose the tutorial is updated.

Suggested labels

  • documentation
  • tutorial
  • good first issue if the repo maintainers think the existing quickstart is close enough for a focused docs contribution

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions