Skip to content

Proposal: first-class run display names, labels, links, and external status #944

Description

@PhreeMason

Use case

Local tools can dispatch a durable AgentField run with a stable X-Run-ID, signed completion webhook, input, output, and structured notes. The stock run dashboard still requires users to decode a technical run identifier or open the input/notes to learn which external task the run represents.

A pull-request reviewer, for example, should be identifiable at a glance as PR #472 — Fix hiding posted review platforms, link directly to the pull request, and show an external lifecycle such as review complete / publish pending, published, or publication failed / retryable. That status may change after the AgentField execution itself is complete.

Proposed contract

Add optional, provider-neutral run metadata:

  • display_name: mutable human-readable run name
  • labels: searchable string labels or a bounded key/value map
  • links: bounded {label, url} entries rendered as safe clickable links
  • external_status: mutable {state, label, url?, detail?} owned by the integrating application

The asynchronous execute endpoint could accept initial metadata, and a narrow authenticated run-metadata endpoint could update mutable fields after execution. The run list and detail dashboard should render the display name, labels, links, and external status while retaining the stable run identifier as technical identity.

Safety and compatibility

  • Keep every field optional and backwards compatible
  • Apply strict size/count limits and URL scheme validation
  • Do not treat labels or links as trusted HTML
  • Keep execution status separate from integration-owned external status
  • Include metadata in the agentic run summary/query surface so non-dashboard clients can discover it without loading execution payloads
  • Avoid placing credentials or webhook secrets in these fields

Structured notes are useful for progress, but they do not replace a concise list-row identity, clickable external target, or post-execution publication state.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions