Skip to main content
Glama

Qb Query

qb_query
Read-onlyIdempotent

Execute a QuickBooks SQL-like query (QBO query language) against any entity type — Customer, Invoice, Account, etc. Example: "SELECT * FROM Customer MAXRESULTS 10". Returns raw QuickBooks API response with matching records.

Input Schema

NameRequiredDescriptionDefault
queryYesQuickBooks SQL-like query string (e.g., "SELECT * FROM Customer MAXRESULTS 10")

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "oneOf": [
      +    {
      +      "properties": {
      +        "error": {
      +          "description": "Error code if connection not configured",
      +          "type": "string"
      +        },
      +        "message": {
      +          "description": "Error message with setup instructions",
      +          "type": "string"
      +        }
      +      },
      +      "required": [
      +        "error",
      +        "message"
      +      ],
      +      "type": "object"
      +    },
      +    {
      +      "properties": {
      +        "QueryResponse": {
      +          "description": "Array of query results matching the QuickBooks query",
      +          "items": {
      +            "type": "object"
      +          },
      +          "type": "array"
      +        }
      +      },
      +      "type": "object"
      +    }
      +  ],
      +  "type": "object"
      +}
  2. Changed1 schema field changed
    • addedInput schema / examples
      Added value: +[
      +  {
      +    "query": "SELECT * FROM Customer MAXRESULTS 10"
      +  },
      +  {
      +    "query": "SELECT * FROM Invoice WHERE DocNumber = '1001' AND TxnDate >= '2024-01-01'"
      +  }
      +]
  3. First observed

TDQS

A4.1/5.0
Behavior3/5

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

Annotations already state readOnlyHint, idempotentHint, destructiveHint. Description adds that it returns raw API response and uses QBO query language, but doesn't elaborate on potential limits, pagination, or error behavior. Adequate but minimal added value.

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?

Single sentence with essential information front-loaded. Example included inline. No redundant words.

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?

Given the simple one-parameter tool, rich annotations, and presence of output schema (not shown but signaled), the description sufficiently covers purpose, usage, and behavior. No gaps identified.

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 covers 100% of the single parameter with a description. Description adds value by providing examples of valid queries and explaining the query syntax, which goes beyond the schema's description.

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?

Clearly states the tool executes a QuickBooks SQL-like query against any entity type, with an example. Distinguishes from sibling tools like qb_get_customer and qb_list_accounts which are opinionated retrieval tools.

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

Usage Guidelines3/5

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

Implies general use for querying any entity, but doesn't explicitly contrast with specific getter/list tools or provide guidance on when not to use it. Could mention that for single records the dedicated getter tools may be more appropriate.

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.