Skip to main content
Glama
chrischall

Housecall Pro MCP

by chrischall
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

housecallpro_get_invoice

Read-only

Retrieve a Housecall Pro invoice by pasting the contractor's link to view total, subtotal, tax, balance due, and online payment status.

Instructions

Read an invoice a Housecall Pro contractor sent you: amount, subtotal, tax, what is still owed, and whether it can be paid online. The default compact view returns money both as integer cents (*_cents) and dollars (*_usd). Note this document carries no line items — the portal shows a summary only.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
linkNoThe Housecall Pro link your contractor sent you — paste it directly (pro.housecallpro.com/mobile_estimate/… or /mobile_invoice/…, or a client.housecallpro.com/estimates/… or /invoices/… URL), or the retrieval token from the end of it. Alternatively the label of a link configured in HOUSECALLPRO_LINKS. Omit only when exactly one link is configured.
viewNoResponse shape: "compact" (default) drops fields the response already carries elsewhere; "raw" returns the upstream payload unprojected. "compact" is the summary: totals, balance due, payability and the company, with every money field as both `*_cents` and `*_usd`, plus the `tax_cents`/`tax_usd` and `is_paid` this server derives. "raw" is the upstream document — it carries neither, and its money is integer CENTS with no dollar sibling.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.4.0
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  2. Changed2 schema fields changedv0.3.0
    • removedInput schema / properties / raw
      Removed value: -{
-  "description": "Return the full upstream document instead of the summary.",
-  "type": "boolean"
-}
    • addedInput schema / properties / view
      Added value: +{
+  "description": "Response shape: \"compact\" (default) drops fields the response already carries elsewhere; \"raw\" returns the upstream payload unprojected. \"compact\" is the summary: totals, balance due, payability and the company, with every money field as both `*_cents` and `*_usd`, plus the `tax_cents`/`tax_usd` and `is_paid` this server derives. \"raw\" is the upstream document — it carries neither, and its money is integer CENTS with no dollar sibling.",
+  "enum": [
+    "compact",
+    "raw"
+  ],
+  "type": "string"
+}
  3. First observedv0.2.0

TDQS

A4.3/5.0
Behavior4/5

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

Beyond the readOnlyHint annotation, the description discloses that the document has no line items and that the portal shows a summary only. It also explains the compact/raw view difference, which is useful behavioral context for a read-only operation.

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?

The description is compact and front-loaded: purpose first, then key output conventions, then an important caveat. Every sentence earns its place and there is no filler.

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 read-only tool with two well-documented parameters, the description plus schema cover input, output shape, and caveats. The lack of an output schema is compensated by the description's clear statement of what the tool returns.

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 coverage is 100%, so the link and view parameters are already fully described in the input schema. The description reinforces the view behavior and defaults but adds little semantic value beyond what the schema provides.

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?

The description states a specific verb and resource: 'Read an invoice a Housecall Pro contractor sent you' and enumerates the returned data (amount, subtotal, tax, amount still owed, payability). The resource is unambiguous against sibling tools like get_estimate because it explicitly targets invoices.

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?

The description gives clear usage context: use it when you need the summary of an invoice sent by a Housecall Pro contractor. It does not explicitly discuss exclusions or alternatives, but the distinction from estimate-focused siblings is evident.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools