Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Get workflow template

get_workflow_template
Read-onlyIdempotent

Returns one shipped workflow chart template by key (see list_workflow_templates), with the child workflows it calls, every question it can ask (each prompt.id, with its options) and every way it can end, and the API calls that install and run it. Its whole usage contract, with example webhooks and answers, is GET /api/v2/workflow-templates/{key}/usage.md (or /usage for JSON), readable before anything is installed. Unmodified, install it with POST /api/v2/workflow-templates/{key}/install (body {"publish": true}), which installs its child workflows too ("replace": true re-installs over the ones the app already has); adapted (check with validate_workflow_chart), install it with PUT /api/v2/workflows/{key} (publish: true), each child first. Then run it with POST /api/v2/connections/{connection_id}/workflow-runs with an input matching the chart's declared inputs, on a realtime or simulated connection: a standard one answers 422 with errors.code realtime_required and nothing stored, so the same call starts the run once the connection is upgraded. An installed workflow is a copy: when the template changes later, GET /api/v2/workflows/{key} says so in template.status (update_available), and installing it again with "replace": true takes the new version.

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": {
      "key": "<key>"
    },
    "name": "get_workflow_template"
  }
}

Input Schema

NameRequiredDescriptionDefault
keyYesThe template key.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive, and the description adds real value beyond them: it discloses that an installed workflow is a copy, that template.status surfaces update_available later, and that running on a non-realtime connection returns 422 realtime_required with nothing stored. Much of this describes sibling endpoints (install, run) rather than this tool's own behavior, which keeps it from a 5.

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 front-loaded correctly, leading with what the tool returns, but the second half is one long semicolon-chained block covering install, run, 422 handling, and version drift — content that belongs to the install/run/authoring tools. Dense and information-rich, yet oversized for a single-parameter read tool.

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?

With no output schema, the description carries the burden of describing the return value, and it does so precisely: child workflows, prompts with options, termination paths, and install/run calls. For a one-parameter read tool, an agent has everything needed to call it and interpret the result.

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 `key` parameter with 100% schema description coverage, so the schema already carries the semantics and the baseline of 3 applies. The description adds only the qualifier that the key identifies a shipped template and implicitly that list_workflow_templates is where keys come from — useful but marginal.

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?

States a specific verb and resource ("Returns one shipped workflow chart template by key") and then enumerates exactly what comes back: child workflows, every prompt.id with options, every ending, and the install/run API calls. It explicitly names the sibling list_workflow_templates as the enumeration counterpart, so an agent can distinguish the two without opening a schema.

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

Usage Guidelines4/5

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

Provides strong lifecycle context: read the usage.md contract before installing, use validate_workflow_chart to check an adapted chart, install unmodified via POST .../install or adapted via PUT .../workflows/{key}. What's missing is an explicit when-not-to-use or a statement of the alternative for simply listing templates beyond the parenthetical reference to list_workflow_templates.

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