Skip to content

Document the Generate text step for agents and contributors #51

Open

Description

@Silthus

Parent

Spec: #22 — Generate text, an LLM action node for workflows.

What to build

An agent authoring a workflow through MCP has no way to discover the coupling between the node's output fields and its output variables. Get it wrong and the node runs, spends the customer's AI credits, and throws the result away. Nothing fails, so nothing tells anyone.

Five in-repo files. None of them under the shared docs tree — workflows has no page there, and the public docs page is a follow-up in the other repo.

  1. The workflow graph schema reference. Document the array form of the output-variable mapping, then add a worked Generate text example carrying the three facts an agent cannot infer: output-field keys must name variables that already exist; every field needs a matching output-variable entry whose result path points at that field, and a node without them generates, bills, and discards; and pointing a result path at the raw text is how the whole generation reaches a variable. Also state that runs spend AI credits and that the node's default error handling is abort.
  2. The workflow-building skill. One clause: this step spends AI credits whenever async functions are not mocked.
  3. The lifecycle and debugging reference. Correct the standing claim that the catalog never lists fixed-template steps.
  4. The workflows MCP tool definitions. Add the credit clause to the test-run tool description, and regenerate the two generated MCP schema files.
  5. The workflows contributing guide. A queue-routing subsection covering the new async parameter type — the schema union, the dispatch branch, the inline branch for test invocations, and reschedule-on-pending. Six lines on the per-template renderer as the cheap route for a bespoke panel. Fix the one stale path.

The spec asks for this in the same pull request as the feature, on the reasoning that a skill one release behind is a published document telling agents a paid operation is free. Splitting it out is only safe because the flag is off at merge, so the constraint moves rather than disappearing: this must land before the flag is enabled for any organization. That is why it gates the rollout ticket.

Acceptance criteria

  • The graph schema reference carries a Generate text worked example, and an agent following it cannot build a node that generates, bills, and discards.
  • The three non-discoverable facts are all stated: field keys name existing variables, each field needs its matching output-variable entry, and the raw generation is reachable by result path.
  • The graph schema reference states that runs spend AI credits and that the default error handling is abort.
  • The workflow-building skill states that the step spends AI credits when async functions are not mocked.
  • The lifecycle and debugging reference no longer claims the catalog never lists fixed-template steps.
  • The MCP test-run tool description carries the credit clause, and both generated MCP schema files are regenerated to match.
  • The contributing guide documents the new queue parameter type across all four of its touch points, plus the per-template renderer route, and the stale path is fixed.
  • No customer data, internal thread contents, or unreleased roadmap detail appears in any of the five files.

Blocked by

Metadata

Metadata

Assignees

No one assigned

    Labels

    ready-for-agentFully specified, ready for an AFK agent

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions