Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Validate workflow chart

validate_workflow_chart
Read-onlyIdempotent

Validates a workflow chart without saving or running it -- the same structural validation and lint as POST /api/v2/workflows/validate, minus the checks that need a specific app. Returns {valid, errors, warnings, workflows_to_create}. errors block saving/publishing and must be fixed; warnings are likely mistakes worth reviewing. Each issue has a path into the chart document (e.g. states.create.on.success.0.target) and a message. A workflow state calling a child workflow not listed in known_workflows is reported as a warning, and its key is listed in workflows_to_create: that workflow must exist and be published in the app before this chart can be published.

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": {
      "chart": "<chart>"
    },
    "name": "validate_workflow_chart"
  }
}

Input Schema

NameRequiredDescriptionDefault
chartYesThe chart document to check (the JSON object with version, key, states, ...). A JSON-encoded string of it is also accepted.
known_workflowsNoKeys of workflows that already exist in the target app and that this chart may call from `workflow` states. Calls to other keys are reported as warnings.

Output Schema

NameRequiredDescriptionDefault
validYes
errorsYes
warningsYes
workflows_to_createYesChild workflow keys this chart calls that were not in known_workflows.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.7/5.0
Behavior5/5

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

Goes well beyond the readOnly/idempotent annotations by disclosing severity semantics (errors block saving/publishing, warnings are likely mistakes), the issue shape (path + message), and the subtle known_workflows/workflows_to_create dependency for child-workflow publishing. This is exactly the kind of consequence-level detail annotations cannot carry.

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?

Front-loaded with purpose, then the return shape, then severity semantics, then the one non-obvious edge case. Five dense sentences with no filler; every clause carries decision-relevant information.

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?

For a two-parameter, nested-object validation tool with an output schema, the description supplies everything an agent needs: what is validated, what the result fields mean, what blocks publishing, and the cross-chart publishing prerequisite. Nothing material is missing.

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

Parameters4/5

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

Schema coverage is 100%, so the baseline is 3, but the description adds real meaning: known_workflows existence gating explains what happens to calls to unlisted keys and why the parameter matters. It also notes the chart may be passed as a JSON-encoded string, which the schema supports but understates.

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 ("Validates a workflow chart") plus a clear scope constraint ("without saving or running it"), and anchors it to the equivalent API endpoint. An agent knows exactly what this does and that it is a dry run, not a create/publish operation.

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?

Gives clear context for when to use it: pre-flight structural validation before saving/publishing, and explicitly bounds it by noting it lacks the checks that need a specific app. No alternative tool is named for the app-specific case, but the exclusion boundary is stated.

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