Guides

Build a Workflow with Builder MCP v2

Builder MCP lets an AI agent discover Flowgear contracts, create a Workflow, run it in Debug mode, diagnose failures, and save the tested result.

Build an App with an agent v2

An AI coding agent can build both sides of a Flowgear App: the frontend in your local sample-App repository and the HTTP-bound Workflows that provide its backend.

Call a Sub-Workflow v2

Create a child Workflow with a deliberate Parameter and Return contract, publish it, then add it to the parent as a Sub-Workflow Step.

Configure Environment-scoped Permissions

Environment-scoped permissions add an Environment scope to permissions.

Connect Claude Code to Builder MCP v2

Register the Flowgear Builder MCP endpoint in Claude Code, authenticate, and verify the Builder context before making Workflow changes.

Connect Codex to Builder MCP v2

Register the Flowgear Builder MCP endpoint in Codex, complete OAuth, verify the target context, and load Builder Guidance before allowing Workflow changes.

Create a Connection

Connection creation and execution placement differ by runtime.

Create a Connection v1

Create a v1 Runtime Connection for the Node that will use it.

Create a Connection v2

Create a Connection for the Node Method that will use it.

Create a Listener Workflow v2

A listener Workflow remains active and waits for a supported Node Method to receive an external event or batch.

Create a Scheduled Workflow v2

Use a Schedule trigger to start the latest published and enabled Workflow at Site-local times.

Create an MCP Tool Workflow v2

Publish a narrow Workflow as an MCP tool by defining a typed argument schema, performing one business action, and returning structured content.

Design a Maintainable Workflow v2

Design a Workflow so that another builder can understand its purpose, contracts, side effects, and recovery path without reverse-engineering individual mappings.

Design Observable Workflows v2

Design logs and contracts so operators can identify what ran, where it failed, what was processed, and which parent or child execution contains the relevant detail.

Develop an App Locally v2

Download a configured sample, run it over local HTTPS, and test both its raw frontend and embedded Console behavior against a Test Environment.

Edit an Existing Workflow with Builder MCP v2

Edit an existing Workflow from its current source, preserve its identity, Debug the focused change, and save with optimistic concurrency protection.

Enable and Disable a Workflow v2

Workflow status controls whether each Environment can start the published Workflow.

Handle Large Data v2

Keep large data deferred for as long as the source and target contracts allow.

Handle Partial Batch Failures v2

Check each returned record when a Node reports individual write outcomes.

Infer a Schema v2

Node templates usually provide Parameter or Return schemas but in some cases, schema may not be known until the Node runs for the first time.

Manage Connection Values by Environment v2

Use one Connection identity across a Site while keeping test, staging, and production endpoints and credentials separate.

Manage Environments

Add, edit, and order Site Environments from Settings → Site settings.

Map Arrays v2

Map an Array by selecting a source collection on the target Property and declaring the shape of one target item under Properties.

Map Objects v2

Map an object on the Property that consumes or returns it.

Move or Copy Workflows

Use Move to to reorganize Workflows inside a Site.

Preview an Expression v2

Use the designer's Preview tab to inspect compile-time Expression results without invoking external systems.

Promote Multiple Workflows

Use bulk promotion when several Workflows or a folder of Workflows must move through the same Environment release path.

Publish a Workflow as an HTTP Endpoint v2

Build an HTTP Workflow around a matched receive/respond pair, publish it to the target Environment, enable it, and authorize callers with an API Key.

Publish and Assign an App v2

Build the static package, publish it under an Account, assign it to Sites, and verify its independently released Workflow backends.

Refresh Sub-Workflow Properties v2

Refresh a Sub-Workflow Step after the child Workflow's published Parameters or Returns change.

Roll Back a Workflow v2

Roll back by restoring an earlier design as a new latest revision.

Rotate an API Key

Use the primary and secondary secrets on a service-token API Key to rotate credentials without intentionally interrupting Workflow invocations.

Secure Workflow Design v2

Keep credentials out of Workflow source, restrict every callable surface, and test with the least privilege.

Test a Workflow Safely v2

Test the smallest useful behavior in the Test Environment.

Troubleshoot with the Assistant v2

Use the assistant to interpret current diagnostics and logs, propose a focused repair, and retest the affected path.

Use a Certificate Connection Property v2

A Node can define a Connection Property for either a public certificate or a certificate containing both public and private key material.

Use NuGet Packages in a Script v2

Add exact NuGet dependencies to a C# Script when its custom Method needs a library that is not part of the standard Runtime references.

Use the Workflow Assistant v2

Use the assistant inside the designer to discover exact contracts, propose a design, and help test or repair it while you retain control of Connections, Canvas changes, save, and release.