Skip to main content
Glama

woo_helper_invoices_test_connection

Verifies an invoice provider connection by running read-only GET requests for company, tax type, and small-business status; use it to confirm credentials and configuration before invoicing.

Instructions

Test the invoice provider connection (read-only GETs: company, tax type, small-business status).

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "site": "<site>"
    },
    "name": "woo_helper_invoices_test_connection"
  }
}

Input Schema

NameRequiredDescriptionDefault
siteYesSite id (see list_sites)
providerNoDefault: the configured provider

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv3.14.0

TDQS

A3.5/5.0
Behavior3/5

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

With no annotations supplied, the description carries the full burden, and it does contribute one important fact: the operation performs read-only GETs, so it is non-mutating. It does not say what happens on failure (raise vs. return an error status), whether the check is cached, or what shape the result takes.

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 front-loaded sentence with no filler; the parenthetical efficiently lists the checks performed, and every clause earns its place.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple two-parameter connection probe with no output schema, the description covers intent and side-effect profile, but leaves the agent guessing about the return value and failure behavior, which matter when the whole point of the call is to detect a broken configuration.

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%, so both 'site' and 'provider' are already documented, including the enum and the default-to-configured-provider behavior. The description adds nothing further about parameter meaning, which is acceptable at full coverage but earns only the baseline.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb (test) and resource (invoice provider connection) and even enumerates what the check exercises: company, tax type, small-business status. That is enough to distinguish it from data-fetching siblings like get_invoices or put_invoices, though it never names an alternative explicitly.

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?

Usage is only implied by the tool's nature: verify the invoice provider before relying on it. There is no explicit statement of when to call it (e.g., before first invoice, after changing provider credentials) and no mention of the sibling status/connection tools that might overlap.

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