Skip to content

[Bug] Workflow agent quickstart — code snippet out of sync with source, resources/skills breaks FileSource #803

Closed

Description

@Ryan-Nightwish

linked issues: #766

Search before asking

  • I searched in the issues and found nothing similar.

Description

Found during workflow agent quickstart doc verification.

Collection of issues for
docs/content/docs/get-started/quickstart/workflow_agent.md and the
associated example code:

  1. Python process_input code snippet differs from source (doc line 131-136 vs review_analysis_agent.py line 91) — the doc shows:

    input_event = InputEvent.from_event(event)
    input: ProductReview = input_event.input

    but the actual source uses:

    input = ProductReview.model_validate(InputEvent.from_event(event).input)

    The doc version omits the model_validate() call, which is semantically different.

  2. Python env-setup comment wrongly mentions ProductSuggestionAgent (doc line 51-52) — the "Prepare Agents Execution Environment" snippet's comment says the connection is "used by the ReviewAnalysisAgent and ProductSuggestionAgent", but the section is introducing the general environment setup and the actual single-agent source comment only mentions ReviewAnalysisAgent.

  3. Python examples fail at runtime — resources/ directory contains non-JSON files (product bug) —workflow_single_agent_example.py uses FileSource to read the entire resources/ directory. However, resources/skills/math-calculator/SKILL.md (bundled for the Skills Agent quickstart) also lives there. FileSource recurses into the subdirectory and tries to parse SKILL.md as JSON, producing:

    ValidationError: 1 validation error for ProductReview
      Invalid JSON: invalid number at line 1 column 2
      [type=json_invalid, input_value='---', input_type=str]
    

    This issue seems to be solved by: #782

How to reproduce

Version and environment

Flink Agents 0.3.0 (main).

Are you willing to submit a PR?

  • I'm willing to submit a PR!

Activity

  1. added
    bug[Issue Type] Something isn't working as expected.
    priority/majorDefault priority of the PR or issue.
    on Jun 8, 2026
  2. Ryan-Nightwish commented on Jun 8, 2026

    @Ryan-Nightwish
    ContributorAuthor

    Correction on item 2: the ProductSuggestionAgent comment is actually correct — the quickstart covers both the single-agent and multi-agent examples, and WorkflowMultipleAgentExample does use ProductSuggestionAgent. The change was reverted in the PR. Only item 1 remains valid.

  3. added
    tech debt[Issue Type] User-unaware issues, such as code refactor and infrastructure maintenance.
    priority/blockerIndicates the PR or issue that should block the release until it gets resolved.
    fixVersion/0.3.0The feature or bug should be implemented/fixed in the 0.3.0 version.
    and removed
    bug[Issue Type] Something isn't working as expected.
    priority/majorDefault priority of the PR or issue.
    on Jun 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

fixVersion/0.3.0The feature or bug should be implemented/fixed in the 0.3.0 version.priority/blockerIndicates the PR or issue that should block the release until it gets resolved.tech debt[Issue Type] User-unaware issues, such as code refactor and infrastructure maintenance.

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions