Plori

Official

by plori-ai

Overview Schema Source Related Servers Discussions Admin

JavaScript

Remote

Get workflow

get_workflow

Read-only

Retrieve a workflow's metadata and the steps of its execution version (active or current for draft).

Instructions

Get one workflow's metadata and step projection. The projection is the version pinned for execution (active_version), falling back to current_version for a draft that has not been activated.

Input Schema

TableJSON Schema

Name	Required	Description	Default
`workflow_id`	Yes	The workflow's UUID (from list_workflows or create_workflow).

Output Schema

TableJSON Schema

Name	Required	Description
`id`	Yes
`name`	Yes
`engine`	Yes
`status`	Yes
`user_id`	Yes
`agent_id`	Yes
`hook_key`	Yes
`cron_expr`	Yes
`created_at`	Yes
`projection`	Yes	Arbitrary JSON owned by the producing engine.
`updated_at`	Yes
`description`	Yes
`notify_pref`	Yes
`next_fire_at`	Yes
`trigger_kind`	Yes
`paused_reason`	No
`template_slug`	No
`active_version`	Yes
`current_version`	Yes
`spend_cap_month`	Yes
`agent_deleted_at`	No

Schema Changelog

Changes observed during successful MCP inspections.

Changed1 schema field changedv0.16.0Sep 19, 2026

changedOutput schema / (root)

Previous value: -nullNew value: +{
+  "properties": {
+    "active_version": {
+      "maximum": 2147483647,
+      "minimum": -2147483648,
+      "type": [
+        "null",
+        "integer"
+      ]
+    },
+    "agent_deleted_at": {
+      "type": [
+        "null",
+        "string"
+      ]
+    },
+    "agent_id": {
+      "type": [
+        "null",
+        "string"
+      ]
+    },
+    "created_at": {
+      "type": "string"
+    },
+    "cron_expr": {
+      "type": "string"
+    },
+    "current_version": {
+      "maximum": 2147483647,
+      "minimum": -2147483648,
+      "type": "integer"
+    },
+    "description": {
+      "type": "string"
+    },
+    "engine": {
+      "type": "string"
+    },
+    "hook_key": {
+      "type": [
+        "null",
+        "string"
+      ]
+    },
+    "id": {
+      "type": "string"
+    },
+    "name": {
+      "type": "string"
+    },
+    "next_fire_at": {
+      "type": [
+        "null",
+        "string"
+      ]
+    },
+    "notify_pref": {
+      "type": "string"
+    },
+    "paused_reason": {
+      "type": "string"
+    },
+    "projection": {
+      "description": "Arbitrary JSON owned by the producing engine."
+    },
+    "spend_cap_month": {
+      "type": "integer"
+    },
+    "status": {
+      "type": "string"
+    },
+    "template_slug": {
+      "type": "string"
+    },
+    "trigger_kind": {
+      "type": "string"
+    },
+    "updated_at": {
+      "type": "string"
+    },
+    "user_id": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "id",
+    "user_id",
+    "agent_id",
+    "name",
+    "description",
+    "engine",
+    "status",
+    "current_version",
+    "active_version",
+    "trigger_kind",
+    "cron_expr",
+    "next_fire_at",
+    "hook_key",
+    "spend_cap_month",
+    "notify_pref",
+    "created_at",
+    "updated_at",
+    "projection"
+  ],
+  "type": "object"
+}

Addedv0.7.0Aug 9, 2026

TDQS

A3.6/5.0

Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description adds genuinely useful behavior beyond that: which version the returned projection reflects (active_version, falling back to current_version for an unactivated draft). This is exactly the kind of non-obvious resolution logic annotations cannot express.

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?

Two tight sentences, front-loaded with the core action and followed by the one non-obvious rule. No filler, no restating of the title, nothing to trim.

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 an output schema present, the description need not document return values, and it is complete for a single-ID read. It omits edge behavior such as what happens for an unknown or deleted workflow_id, which is a minor gap rather than a blocker.

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?

There is a single parameter with 100% schema description coverage, and the schema already explains that workflow_id is a UUID sourced from list_workflows or create_workflow. The description adds nothing further about the parameter, so the baseline 3 applies.

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 (get one workflow) and clarifies exactly what is returned: metadata plus a step projection resolved from active_version. The version-fallback explanation implicitly distinguishes it from get_workflow_version and list_workflows, but no sibling is named explicitly, so it falls just short of a 5.

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

Usage Guidelines2/5

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

The description never says when to reach for this tool versus get_workflow_version, get_workflow_execution, or list_workflows, nor does it state any prerequisites (e.g., needing an ID from list_workflows). Usage is only minimally inferable from the phrase 'Get one workflow's...'.

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