Skip to main content
Glama

Publish a workflow as a REST API

writ_expose_workflow_api
Idempotent

Publish a saved workflow as a managed REST endpoint that runs the workflow and returns its JSON result. Repeated calls reuse the same endpoint.

Instructions

Publish a saved workflow through Writ's managed REST gateway, using the same resource as the frontend's REST endpoint switch. The returned POST URL waits for the workflow and returns its JSON result. Repeated calls reuse the existing endpoint.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
labelNoOptional name for the endpoint.
workflowNo
workflow_idNo
wait_timeoutNoDeprecated alias of timeout_seconds.
timeout_secondsNoManaged run timeout. Defaults to 120, or 300 for AI navigation workflows.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.1.0

TDQS

A3.6/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations cover safety (readOnlyHint=false, destructiveHint=false, idempotentHint=true), and the description adds real context: the returned POST URL blocks until the workflow finishes and returns its JSON result, and repeat calls are idempotent (reuse the endpoint). It does not mention auth/permission requirements, which is the remaining gap.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three tight sentences, front-loaded with the core action, then the return behavior, then the idempotency note. No filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With no output schema, the description appropriately explains the return (a POST URL that returns the workflow's JSON result) and the idempotency behavior. It is complete for invoking, though it omits permission/prerequisite context and gives no parameter guidance.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Five parameters with only 60% schema coverage; 'workflow' and 'workflow_id' have no description in either schema or description text, and the description adds nothing about how to specify which workflow, the label, or timeout behavior. It does not compensate for the coverage gap.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb+resource: publishing a saved workflow as a managed REST endpoint, and clarifies it uses the same resource as the frontend's REST switch. It is distinguishable from siblings like writ_run_workflow or writ_website_to_api, though it never names an alternative explicitly.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Usage context is implied (expose a saved workflow as an API endpoint) and it notes that repeated calls reuse the existing endpoint, but there is no explicit when-to-use/when-not guidance or comparison against alternatives such as running the workflow directly.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.