Skip to main content
Glama

Get workflow

get_workflow
Read-onlyIdempotent

Retrieve a Bannerbear workflow by UID to inspect its configuration, steps, and status for design automation tasks.

Instructions

GET /v5/workflows/{uid}. Current Bannerbear V5 operation; provider scopes, locks and credits apply. Read operation.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
uidYes
accountNoExact private workspace profile label; no fallback to another profile key.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

TDQS

C2.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, openWorldHint and destructiveHint, so the safety profile is covered. The description adds 'provider scopes, locks and credits apply,' which hints at auth/scope requirements and possible credit consumption beyond the annotations, but it names these categories generically without saying which scope is needed or what 'locks' means, and 'Read operation' duplicates the readOnly annotation.

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

Conciseness3/5

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

It is short and front-loads the endpoint, which is good. But 'Current Bannerbear V5 operation' and 'Read operation' are filler clauses that consume space without adding actionable information.

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

Completeness2/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 should explain what a workflow record looks like or at least what the call returns, and it should fill the gap on the undocumented 'uid' parameter. It does neither, leaving an agent without knowledge of the response shape or parameter meaning.

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?

Schema coverage is only 50%: 'account' is documented in the schema but 'uid' has no description at all. The description contributes nothing beyond the path template implying {uid} is the workflow identifier; format, constraints, and the meaning of 'account' (workspace profile) are left to the schema or unexplained.

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

Purpose3/5

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

The endpoint string 'GET /v5/workflows/{uid}' does encode a specific verb and resource, so the agent can infer this fetches one workflow by UID. However it never states that in plain language and gives no differentiation from close siblings like list_workflows or get_workflow_run, both of which could be confused with a single-record fetch.

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?

There is no when-to-use guidance, no prerequisites, and no named alternative. 'Read operation' only restates the obvious; nothing tells the agent when to pick this over list_workflows or get_workflow_run.

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