Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Get workflow authoring guide

get_workflow_authoring_guide
Read-onlyIdempotent

Returns the QuBeSync workflow authoring guide: the rules for writing a workflow chart (a JSON statechart that runs qbXML requests against QuickBooks Desktop), the chart JSON Schema, and a canonical example. Load this before writing or editing a chart, then check your chart with validate_workflow_chart.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "get_workflow_authoring_guide"
  }
}

Input Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.7/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, and openWorldHint=false, so the safety profile is covered. The description adds value by disclosing the response contents (rules, schema, example), which is the main behavioral question for a doc-fetch tool. It stops short of noting size or caching characteristics, but nothing essential is missing.

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?

A single dense sentence that front-loads what is returned, then appends the call-to-action. Every clause carries information: purpose, payload contents, prerequisite timing, and the follow-up validation step.

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 parameters and no output schema, the description carries the burden of explaining what comes back, and it does so by naming the three returned artifacts. Combined with the sequencing guidance, an agent has everything needed to call this correctly and use the result.

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?

There are zero input parameters, so there is no parameter semantics to explain and the baseline is 4. The description correctly implies a parameterless, unconditional fetch rather than suggesting any filtering options.

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 the QuBeSync workflow authoring guide) and enumerates the concrete payload: chart-writing rules, the chart JSON Schema, and a canonical example. It also defines the domain object (a JSON statechart issuing qbXML requests against QuickBooks Desktop), which separates it from sibling tools like validate_workflow_chart and the template getters.

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?

Gives explicit sequencing guidance: load this before writing or editing a chart, then check the result with validate_workflow_chart. It names the sibling alternative and the condition that selects it, so an agent knows exactly where this tool sits in the workflow.

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