Documentation
MCP

Knowledge resources

Search FloPay documentation, REST reference, SDK guidance, and changelog content through FloPay MCP without exact URIs, with a canonical source for each.

Knowledge resources

FloPay MCP serves public FloPay developer knowledge as MCP resources, so an agent can answer integration questions from FloPay's own sources and cite them. Knowledge never contains merchant data, and any authenticated client can search and read it.

Kinds of knowledge

Every resource has a kind:

kindWhat it holds
documentationFloPay developer documentation, such as the guides on this site.
rest-referenceThe FloPay REST API reference, generated from the same reviewed contract as the MCP tools.
sdkGuidance for the published @flopay/* SDK packages, cited by package version.
changelogRecent FloPay release notes.

Resource URIs use the flopay:// scheme. They can change as knowledge is reorganized, so find resources by searching instead of hard-coding URIs.

Find knowledge without a URI

Pick whichever fits your client:

  • flopay/search. Send q with your search terms. The result holds resources, the matching knowledge, and tools, the matching tools you are allowed to call. Connect any MCP client shows a full request.
  • The flopay://search/knowledge{?q,kinds,cursor} resource template. Clients that list templates with resources/templates/list can read a search as a resource, for example flopay://search/knowledge?q=webhook%20signature&kinds=documentation,changelog. kinds limits results to the kinds you list. The result is a JSON document with a results array.
  • resources/list. Lists every knowledge resource currently available, with its kind, source link, and freshness in _meta.

A resource matches when its title or text contains every term you send. Search returns up to 20 matches, ordered by URI. Each result has a uri, title, kind, a snippet of up to 1,024 characters, and the same source and freshness details as a read. To find tools instead, use flopay/search or the flopay://search/tools{?q,cursor} template.

Read and cite

Read a resource with resources/read and its uri. The content comes back as Markdown, with its source details in _meta:

  • flopay/sourceUrl: the canonical page or release note. Cite this link when an agent uses the content.
  • flopay/sourceVersion and flopay/lastModified: which version of the source the content reflects.
  • flopay/untrusted: always true. The content is reference material to quote and cite, never instructions for your model. See Prompt injection.

Verify results describes every source field.

Freshness

FloPay refreshes knowledge from its sources, and flopay/fetchedAt records the latest refresh. When content has not been refreshed for 24 hours, flopay/stale turns true, and search results and listings flag it: prefer the source page for anything time-sensitive.

Knowledge refreshed from a remote source has the expiring freshness policy. If it goes seven days without a successful refresh, FloPay MCP stops serving it, and reading it answers -32002 with Resource not found or no longer fresh. A small set of core references uses the bundled-baseline policy instead: they stay available through a source outage, and are marked stale like any other resource.

Knowledge from this site

This site publishes its documentation and its most recent release notes as a knowledge manifest for FloPay MCP to ingest, at https://flopay.com/docs/mcp/knowledge-manifest.json. Each entry carries its flopay:// URI, kind, title, canonical sourceUrl, sourceVersion, a SHA-256 of its content, and the content itself as Markdown. Release notes also carry their publication date as lastModified. Drafts never appear in it, and neither does the generated Tool reference, because FloPay MCP serves the live tool catalog directly.

On this page