Skip to main content
Glama

Workflows: get

workflows_get
Read-only

Reads one neonloops workflow (a task that runs on a schedule or when an app event happens) in full: name, status, project, publish state, run cost cap and spend this billing period, the draft graph of steps and edges with each step's config flat in its data, the revision that workflows_edit needs, and every published version, newest first, with its id and which one is live. With checks: true it also says whether a run would accept the graph and what publishing would refuse, with warnings, and publishes nothing. An unknown or unreachable workflow is refused. For many workflows use workflows_list, and workflows_list_node_types for each step type's config shape; a rollback with workflows_publish takes a version id from here.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "workflow_id": "<workflow_id>"
    },
    "name": "workflows_get"
  }
}

Input Schema

NameRequiredDescriptionDefault
checksNoAlso run the run check (would a run accept this graph) and the publish check (what publishing would refuse, and its warnings). Slower, because the publish check reads the workflow's tables, connections and the app catalogue. Default false.
workflow_idYesThe workflow to read; workflows_list gives the ids.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedInput schema / properties / checks
      Added value: +{
      +  "description": "Also run the run check (would a run accept this graph) and the publish check (what publishing would refuse, and its warnings). Slower, because the publish check reads the workflow's tables, connections and the app catalogue. Default false.",
      +  "type": "boolean"
      +}
    • addedInput schema / properties / workflow_id / description
      Added value: +"The workflow to read; workflows_list gives the ids."
  2. First observed

TDQS

A4.6/5.0
Behavior5/5

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

Goes well beyond the readOnly/openWorld annotations: it discloses that unknown or unreachable workflows are refused, that checks:true runs validations and 'publishes nothing', and that the publish check is slower because it reads tables, connections and the app catalogue. That is real operational context an agent cannot get from the annotations.

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

Conciseness4/5

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

Front-loaded with the core verb and return contents, then closes with routing to alternatives. The enumeration of returned fields is long and dense, but nearly every clause carries decision-relevant information, so there is little genuine waste.

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

Completeness5/5

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

There is no output schema, so the description must carry the return-value burden, and it does: it describes the shape of the draft graph, the revision needed by workflows_edit, and the ordered version list with the live one identified. Nothing an agent needs to call or interpret this tool is missing.

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

Parameters3/5

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

Schema description coverage is 100%, so both parameters are already fully documented in the input schema, including that checks is slower and reads tables/connections/catalogue. The description restates the checks behavior rather than adding new semantics, so the baseline 3 applies.

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

Purpose5/5

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

Specific verb and resource ('Reads one neonloops workflow') followed by an enumeration of exactly what is returned: name, status, project, publish state, cost cap and spend, draft graph with step config, revision, and published versions newest first. This clearly separates it from workflows_list, which is the plural listing tool.

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

Usage Guidelines5/5

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

Routes the agent explicitly: 'For many workflows use workflows_list', 'workflows_list_node_types for each step type's config shape', and 'a rollback with workflows_publish takes a version id from here'. It also states when to use the checks option, so the agent knows both when to call this tool and when to call siblings.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources