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.

Approved sources

Website knowledge comes only from canonical https://flopay.com/docs/ URLs in this site's validated knowledge manifest. Resources under /docs/technical-reference/rest/ are classified as rest-reference; other guide pages are documentation, and recent release notes are changelog.

Current SDK knowledge uses flopay://sdk/<package>/<section> URIs. For every published package, FloPay verifies the package artifact and all five manifest-declared README sections: installation, usage, examples, public-api, and errors.

Historical breaking-change and deprecation notes use flopay://sdk/migrations/... URIs. They stay out of resources/list and ordinary search. Search includes them only when the query names their exact version or expresses an approved migration intent, such as migration, upgrade, deprecated, removed, or breaking.

Find knowledge without a URI

Pick whichever fits your client:

  • flopay/search. Send q with your search terms and optionally kinds. 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.

Both search surfaces use the same resource ranking and kinds filter. Search normalizes and lightly stems useful terms, ignores common question words, and can return a resource that matches some rather than all terms. Ranking weights title matches above content matches and boosts phrase matches and entries matching every useful term. URI provides a deterministic tie-breaker when scores match.

Search returns up to 20 matches. 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

The knowledge store starts empty when the MCP process starts. FloPay requests a refresh immediately after the server begins listening and every 24 hours after that. Each refresh builds one complete, validated website and SDK candidate before replacing the current snapshot. The replacement is atomic, so a client never sees a partly refreshed set.

If either source fails validation or cannot be fetched, FloPay keeps the process-local last-known-good snapshot. It is not a bundled fallback and does not survive a process restart. If the first refresh fails, the store remains empty.

Every resource has the expiring freshness policy, and flopay/fetchedAt records its successful refresh. After 24 hours without a successful refresh, flopay/stale turns true, and search results and listings flag the resource. After seven days, FloPay MCP removes it from lists and search, and reading its URI answers -32002 with Resource not found or no longer fresh. Prefer the canonical source page for anything time-sensitive.

Empty states

Before the first successful refresh, or after every resource expires, knowledge methods return explicit empty results:

  • resources/list returns resources: [].
  • flopay/search returns resources: []; matching merchant tools can still appear in its separate tools array.
  • Reading flopay://search/knowledge{?q,kinds,cursor} returns JSON with results: [].
  • resources/read for an unavailable or expired URI returns JSON-RPC error -32002 with Resource not found or no longer fresh.

Merchant tools remain available independently of the knowledge snapshot.

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