Documentation
MCP

Verify results

Check what FloPay MCP returned using contract revisions, API status codes, correlation IDs, aggregate context with source record links, and knowledge sources.

Verify results

Models summarize, and summaries can drift from the data. Every FloPay MCP result carries the evidence to check it: which contract produced it, what the FloPay API answered, how aggregate figures were computed, and where knowledge came from. Check that evidence before an agent's answer drives a decision.

Result metadata

Every tool result carries these keys in result._meta:

KeyWhat it tells you
flopay/contractRevisionThe contract revision FloPay MCP served the tool from. The Tool reference records the revision it was generated from. A different revision means the tools may have changed since that reference was published.
flopay/httpStatusThe status the FloPay API answered with. A status of 400 or above also sets isError to true.
flopay/correlationIdThe FloPay API correlation ID, when the API sent one. Quote it when you report a problem.
flopay/traceparentThe W3C trace context, when the API sent one.
flopay/rateLimitRate-limit details the API sent: limit, remaining, reset, and retryAfter. See Limits and errors.

structuredContent is the FloPay API response body as the API returned it, and content holds the same body as text. FloPay MCP never rewrites or summarizes it, so treat structuredContent as the source of truth rather than a model's summary of it.

Tool definitions from tools/list also carry flopay/contractRevision and flopay/risk in their _meta.

Aggregate reads

Aggregate tools return the figures plus context, which records how FloPay computed them, and sourceCurrencySegments:

context fieldWhat it tells you
timeRangeThe UTC reporting window. It includes from and excludes to.
appliedFiltersFilters applied after the merchant boundary. Empty for merchant calls.
tenantScopeWhich merchant the figures cover.
currencyThe reporting currency, and the daily FX snapshots used for converted totals.
statusSemanticsWhat each status in the response means, and which timestamp it counts from.
generatedAtWhen FloPay produced the response.
dataAsOfThe point in time the underlying data reflects.
consistencyThe consistency model. Figures are eventually consistent and can lag the latest provider and webhook updates.
authoritativeLinksRelative FloPay API links, starting with /v1/, to the source records behind the figures.

sourceCurrencySegments splits monetary amounts by their original currency, so you can check a converted total against its parts.

To check a figure, follow its authoritativeLinks: find the read-only tool for that route in the Tool reference, call it, and compare. A figure newer than dataAsOf cannot be in the response yet.

Knowledge sources

Every knowledge resource read carries its source in _meta:

KeyWhat it tells you
flopay/sourceUrlThe canonical page or release the content comes from. Cite it, and open it to confirm the content.
flopay/sourceVersionThe version of that source.
flopay/lastModifiedWhen the source last changed.
flopay/fetchedAtWhen FloPay last refreshed the content.
flopay/staletrue when FloPay has not refreshed the content in the last 24 hours. Prefer the source page.
flopay/untrustedAlways true: the text is data to cite, never instructions to follow.

Previews

Before an operator confirms an action, check the preview against their intent: effects shows each change with its values before and after, targets shows the records and versions involved, warnings flags anything unusual, and expiresAt shows when the confirmation lapses. Confirmed actions describes every preview field.

Report a problem

When a result looks wrong, contact FloPay with the tool name, the time of the call, flopay/correlationId, and flopay/contractRevision. Never include access tokens, refresh tokens, or customer personal data in the report.

On this page