Skip to content

Clarify that st2 resource manages linked references, not agent state #62

Description

@schickling-assistant

Problem

st2 resource add|ls|read|remove manages durable linked-reference records stored under an agent's resources/links/ directory.

That surface is distinct from both:

  • the agent's native durable state under resources/inbox, resources/archive, and resources/context; and
  • typed Resource bindings declared in Agent Spec and projected through st2 agents --json.

Current top-level help already calls the command “linked resources,” but subcommand help and human output still shorten that to an agent's “resources.” A reader can reasonably mistake the command for an inventory of the state tree or of declared Resource bindings.

Narrow scope

Use agent vocabulary and make the linked-reference boundary explicit in help and output wording:

  • st2 resource --help says it manages linked references and is not an inventory of agent state or Agent Spec Resource bindings;
  • add, ls, read, and remove describe link records consistently; and
  • human list/read output uses wording that does not imply all durable agent material.

Non-goals

  • renaming or removing the shipped st2 resource command;
  • changing storage paths or link-record wire format;
  • adding a generic inventory API for inbox, archive, context, status, links, or other future state;
  • changing Agent Spec Resource bindings; or
  • unifying linked references, declared Resource identities, and mutable agent state.

A structured durable-state inventory is a separate consumer contract and should be proposed separately only when a concrete consumer needs it. This help-only clarification remains GitHub backlog, not active WORK or SITREP.

Metadata

Metadata

Assignees

No one assigned

    Labels

    area:resourceTyped Resource bindings and linked records · Set: manualorigin:agentFiled or primarily produced by an AI agent · Set: manualtype:docsDocumentation-only change or documentation task · Set: manual

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions