Fetch vendor records from QuickBooks Online with configurable page size and starting position to handle large vendor lists.
List Vendor records in QuickBooks Online with pagination.
| Name | Required | Description | Default |
|---|---|---|---|
| maxResults | No | Maximum number of results to return (default: 100, max: 1000) | |
| startPosition | No | Starting position for pagination (1-based, default: 1) |
Changes observed during successful MCP inspections.
v1.4.4Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided. Description implies read-only (list with pagination), but does not explicitly state no side effects, auth requirements, or rate limits. Adequate but minimal.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Single sentence, to the point. Could improve front-loading (e.g., 'List all vendor records...') but very concise overall.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given simplicity of tool (list with pagination), description is complete enough. Schema covers params; no output schema needed. Mentions QBO and pagination.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so parameters are already well-described in schema. Description adds 'with pagination' context but no extra meaning beyond schema defaults and constraints.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states it lists vendor records with pagination. It distinguishes from siblings like qbo_vendors_get (single record) and qbo_vendors_search (likely filtered), though not explicit.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No explicit when-to-use vs alternatives. Implies usage for paginated listing, but does not guide when to choose over qbo_vendors_search or other list tools.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.