MCP Reference

Install MCP and look up published tool input schemas and examples from the package MCP contract without a live Factory host.

How to install MCP

Install the you CLI, then point your MCP-capable host at you mcp serve over stdio with cwd set to your workflow project root. Reload the host so it discovers you.factory_session.* tools. Full host JSON, serve modes, and integration steps live on the MCP documentation page.
you mcp serve

MCP documentation

Tool Inventory

Scan the published MCP tools below. Filter by tool name, description, or lifecycle when those facets are present on a tool. Open a tool card for its input schema and examples, and copy its stable anchor when you need a deep link.

10 published MCP tools from the package contract.

Filter MCP tools

Apply one durable Factory Session lifecycle control such as approve, pause, resume, cancel, terminate, or retry-dispatch. Maps to POST /factory-sessions/{session_id}/{control}.

Input schema

Title
you.factory_session.control input
Type
object
Required
sessionId, operation

Apply one durable Factory Session lifecycle control such as approve, pause, resume, cancel, terminate, or retry-dispatch. Maps to POST /factory-sessions/{session_id}/{control}.

Properties
  • approvalPreviewIdstringOptional

    Approval preview identity when operation is APPROVE.

  • approvedPolicyobjectOptional

    Approved orchestrator policy when operation is APPROVE.

  • dispatchIdstringOptional

    Target dispatch identifier when operation is RETRY_DISPATCH.

  • operationstringRequired

    Lifecycle control operation for one Factory Session.

    Enum: APPROVE, PAUSE, RESUME, CANCEL, TERMINATE, RETRY_DISPATCH

  • reasonstringOptional

    Optional operator-provided reason for audit and diagnostics.

  • requestIdstringOptional

    Optional idempotency key for one lifecycle control request.

  • sessionIdstringRequired

    Stable durable Factory Session identifier.

Example (generated)

{
  "sessionId": "example-sessionId",
  "operation": "APPROVE"
}

Get one durable Factory Session inspection read model with lifecycle status, source identity, phase, progress, and result summary. Maps to GET /factory-sessions/{session_id}.

Input schema

Title
you.factory_session.get input
Type
object
Required
sessionId

Get one durable Factory Session inspection read model with lifecycle status, source identity, phase, progress, and result summary. Maps to GET /factory-sessions/{session_id}.

Properties
  • sessionIdstringRequired

    Stable durable Factory Session identifier.

Example (generated)

{
  "sessionId": "example-sessionId"
}

Retrieve one durable Factory Session result in final or partial mode with optional artifact metadata. Maps to GET /factory-sessions/{session_id}/results.

Input schema

Title
you.factory_session.get_result input
Type
object
Required
sessionId

Retrieve one durable Factory Session result in final or partial mode with optional artifact metadata. Maps to GET /factory-sessions/{session_id}/results.

Properties
  • includeArtifactsbooleanOptional

    When true, include FactoryArtifact metadata refs in the response.

  • modestringOptional

    Result retrieval mode. Defaults to final when omitted.

    Enum: final, partial

  • sessionIdstringRequired

    Stable durable Factory Session identifier.

Example (generated)

{
  "sessionId": "example-sessionId"
}

List Factory Sessions for one scope (live workspace, persisted durable execution, or all). Uses GET /factory-sessions durable listing vocabulary.

Input schema

Title
you.factory_session.list input
Type
object

List Factory Sessions for one scope (live workspace, persisted durable execution, or all). Uses GET /factory-sessions durable listing vocabulary.

Properties
  • scopestringOptional

    Session list scope. Defaults to live when omitted.

    Enum: live, persisted, all

Example (generated)

{}

List FactoryArtifact summaries for one Factory Session, including artifact id, kind, visibility, size or hash metadata, and dispatch linkage when available. Maps to GET /factory-sessions/{session_id}/artifacts.

Input schema

Title
you.factory_session.list_artifacts input
Type
object
Required
sessionId

List FactoryArtifact summaries for one Factory Session, including artifact id, kind, visibility, size or hash metadata, and dispatch linkage when available. Maps to GET /factory-sessions/{session_id}/artifacts.

Properties
  • sessionIdstringRequired

    Stable durable Factory Session identifier.

Example (generated)

{
  "sessionId": "example-sessionId"
}

List dispatch summaries for one Factory Session, including dispatch id, status, kind, phase, and provider-session correlation metadata when available. Maps to GET /factory-sessions/{session_id}/dispatches.

Input schema

Title
you.factory_session.list_dispatches input
Type
object
Required
sessionId

List dispatch summaries for one Factory Session, including dispatch id, status, kind, phase, and provider-session correlation metadata when available. Maps to GET /factory-sessions/{session_id}/dispatches.

Properties
  • phasestringOptional

    Exact canonical phase identifier.

  • sessionIdstringRequired

    Stable durable Factory Session identifier.

  • statusstringOptional

    Canonical Dispatch lifecycle status.

Example (generated)

{
  "sessionId": "example-sessionId"
}

Read ordered Factory Session event facts for reconnect and inspection without exposing internal Petri-net terminology as the primary public vocabulary. Maps to GET /factory-sessions/{session_id}/events.

Input schema

Title
you.factory_session.read_events input
Type
object
Required
sessionId

Read ordered Factory Session event facts for reconnect and inspection without exposing internal Petri-net terminology as the primary public vocabulary. Maps to GET /factory-sessions/{session_id}/events.

Properties
  • afterEventIdstringOptional

    Reconnect cursor: return events after this FactoryEvent identifier.

  • afterSequenceintegerOptional

    Reconnect cursor: return events after this sessionSequence value.

  • sessionIdstringRequired

    Stable durable Factory Session identifier.

Example (generated)

{
  "sessionId": "example-sessionId"
}

Start one async Factory Session and return an accepted or running summary for polling. Maps to POST /factory-sessions/async.

Input schema

Title
you.factory_session.start_async input
Type
object
Required
requestId, source

Start one async Factory Session and return an accepted or running summary for polling. Maps to POST /factory-sessions/async.

Properties
  • argsobjectOptional

    Structured Factory Session invocation arguments validated by the resolved source.

  • orchestratorobjectOptional

    Optional orchestrator override when the resolved source does not fully determine orchestration.

  • requestIdstringRequired

    Caller-supplied idempotency key for durable Factory Session start.

  • requestedPolicyobjectOptional

    Caller-requested orchestrator policy before approval, if required.

  • sourceobjectRequired
  • waitobjectOptional

Example (generated)

{
  "requestId": "example-requestId",
  "source": {}
}

Start one sync Factory Session and wait for terminal completion or timeout. Maps to POST /factory-sessions/sync.

Input schema

Title
you.factory_session.start_sync input
Type
object
Required
requestId, source

Start one sync Factory Session and wait for terminal completion or timeout. Maps to POST /factory-sessions/sync.

Properties
  • argsobjectOptional

    Structured Factory Session invocation arguments validated by the resolved source.

  • orchestratorobjectOptional

    Optional orchestrator override when the resolved source does not fully determine orchestration.

  • requestIdstringRequired

    Caller-supplied idempotency key for durable Factory Session start.

  • requestedPolicyobjectOptional

    Caller-requested orchestrator policy before approval, if required.

  • sourceobjectRequired
  • waitobjectOptional

Example (generated)

{
  "requestId": "example-requestId",
  "source": {}
}

Validate JavaScript orchestrator factory source through the canonical Factory preview contract (POST /factories/preview) before starting a Factory Session.

Input schema

Title
you.factory_session.validate_source input
Type
object
Required
sourceKind

Validate JavaScript orchestrator factory source through the canonical Factory preview contract (POST /factories/preview) before starting a Factory Session.

Properties
  • allowFactoryLookupbooleanOptional

    When true, explicit factory lookup is attempted after ordered workflow lookup.

  • argsSchemaobjectOptional

    Optional JSON Schema object describing Factory Session invocation arguments.

  • artifactRootstringOptional

    Optional absolute artifact root requested with the factory source.

  • defaultPolicyobjectOptional

    Optional factory default policy layer merged into the effective policy preview.

  • inlineSourcestringOptional

    Inline orchestrator source text for INLINE_WORKFLOW or FACTORY_INLINE requests.

  • metadataobjectOptional

    Optional JavaScript orchestrator metadata to validate with the source.

  • projectRootstringOptional

    Project root used for ordered JavaScript orchestrator source lookup.

  • requestedPolicyobjectOptional

    Optional request policy overrides merged into the effective policy preview.

  • sourceKindstringRequired

    JavaScript orchestrator factory source request kind for Factory preview (POST /factories/preview).

    Enum: FACTORY_ID, FACTORY_INLINE, WORKFLOW_FILE, WORKFLOW_NAME, INLINE_WORKFLOW

  • sourceValuestringOptional

    Requested workflow name, file ref, factory id, or inline label.

Example (generated)

{
  "sourceKind": "FACTORY_ID"
}