Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Get integration checklist

get_integration_checklist
Read-onlyIdempotent

Returns QuBe Sync's integration checklist as Markdown: the 53 rules an app integrating with QuBe Sync has to get right (verifying webhook signatures on the raw body, answering 2xx within 5 seconds and working in a job, a new run reference saved before the start, revisions and delivery ids, never answering a run's question for the user, QuickBooks ids keyed by their connection and list, lost answers, webhooks not polling...). Each has an id, a severity, when it applies, why, what to check in the code, what wrong and right look like, and its docs. Read it before writing or reviewing an integration's webhook handler, run starts or stored QuickBooks ids. Pass area for one area's rules. To audit a whole codebase, a coding agent can follow the audit skill at https://qubesync.com/skills/qube-sync-audit/SKILL.md, which has every rule.

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_integration_checklist"
  }
}

Input Schema

NameRequiredDescriptionDefault
areaNoOne area's rules only: onboarding (Onboarding); starting-runs (Calling the API and starting runs); webhooks (Webhooks); questions (Questions and endings); data (Stored QuickBooks data); quickbooks (QuickBooks behaviour); going-live (Going live). Leave it out for every rule.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare this a read-only, idempotent, closed-world, non-destructive call, so the safety profile needs no restating. The description adds genuine behavioral context the annotations cannot: the return format (Markdown), the volume (53 rules), the per-rule structure (id, severity, applicability, rationale, code checks, wrong/right examples, docs), and the area-filtering behavior. The only gap is no warning about the payload size when `area` is omitted.

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

Conciseness4/5

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

Front-loaded with the resource and format in the first clause, then usage, then the alternative link. The long parenthetical rule sampling ('verifying webhook signatures on the raw body, answering 2xx within 5 seconds...') is illustrative but runs past what an agent strictly needs to select the 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?

For a one-parameter read-only documentation tool with no output schema, the definition covers what is returned, in what format, how to narrow it, when to consult it, and where to go for the full audit workflow. Nothing an agent needs in order to call it correctly is missing.

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?

Schema description coverage is 100% and the enum already spells out each area with its human-readable label, so the schema does the heavy lifting. The description only reaffirms the filter ('Pass `area` for one area's rules') without adding syntax, defaults, or interaction details beyond that, which matches the baseline 3 for a fully documented single parameter.

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 QuBe Sync's integration checklist as Markdown') and immediately scopes the content: 53 rules covering webhook signatures, 2xx timing, run references, revisions, QuickBooks id keying. An agent can tell this apart from the sibling authoring/template guides without opening the schema.

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 when-to-use guidance ('Read it before writing or reviewing an integration's webhook handler, run starts or stored QuickBooks ids'), a narrowing option ('Pass `area` for one area's rules'), and an alternative for a different task (the audit SKILL.md for auditing a whole codebase). Both the triggering condition and the alternative are named.

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