{
"markdown": "\n\n# PubFi Docs\n\nPublic documentation and examples for PubFi's agent-native crypto data layer.\n\n[](https://docs.pubfi.ai)\n[](https://api.pubfi.ai/reference)\n[](https://api.pubfi.ai/openapi.json)\n[](LICENSE-DOCS.md)\n[](LICENSE-CODE.md)\n[](https://github.com/helixbox/pubfi-docs)\n\n
\n\n## About\n\nThis repository is the public source of truth for PubFi's long-form docs. It is separate from the\nprivate `pubfi-mono` repository so public docs, examples, issue templates, and agent-readable\nmaterials can be indexed by GitHub, search engines, and answer engines.\n\nThe v0 docs framework is Mintlify. The intended production shape is:\n\n```text\ngithub.com/helixbox/pubfi-docs\n -> Mintlify GitHub integration\n -> docs.pubfi.ai\n -> root docs routes such as /getting-started/quickstart and /reference/api-reference\n -> linked from pubfi.ai product surfaces and legacy docs redirects\n -> canonical cross-links from README, llms.txt, Discovery, API Reference, MCP, and examples\n```\n\nSnapshot sources:\n\n- `pubfi-mono` source snapshot at `d0ee242963fc4a6477e79b2ece98ec3aece643ce`;\n- `quantro-mono` origin/main through `f5a4dec934f4a2a6e072149d694df7984391b74b`; and\n- public Runtime OpenAPI, Registry v2 catalog, MCP `tools/list`, Staging and Production x402\n challenges, and the repository-access acceptance workflows observed on 2026-07-27.\n\n## Start Here\n\n- [Docs home](index.md)\n- [Project overview](project-overview.md)\n- [Quickstart](getting-started/quickstart.md)\n- [Staging guide](getting-started/staging.md)\n- [API key and runtime](getting-started/api-key-runtime.md)\n- [Registry gateway examples](reference/provider-gateway-examples.md)\n- [MCP client setup](getting-started/mcp-client.md)\n- [MCP client guides](getting-started/mcp-clients.md)\n- [ChatGPT and Codex Plugin](getting-started/chatgpt-codex-plugin.md)\n- [Accountless x402](getting-started/x402.md)\n- [Payment and execution modes](concepts/payment-and-execution-modes.md)\n- [API Reference](reference/api-reference.md)\n- [Agent-readable surfaces](agent-readable/surfaces.md)\n- [Security and public data](reference/security-and-public-data.md)\n\n## Published Surfaces\n\n- Docs site: `https://docs.pubfi.ai`\n- Product site: `https://pubfi.ai`\n- Staging product site: `https://stg.pubfi.ai`\n- Staging API: `https://api-stg.pubfi.ai`\n- Staging MCP: `https://mcp-stg.pubfi.ai`\n- Staging MCP x402: `https://mcp-stg.pubfi.ai/x402`\n- Pricing: `https://pubfi.ai/pricing`\n- Blog: `https://pubfi.ai/blog`\n- Product pages: `https://pubfi.ai/products/{product_slug}`\n- Discovery: `https://pubfi.ai/discovery`\n- Discovery directory Markdown: `https://pubfi.ai/discovery.md`\n- Provider Profile index: `https://pubfi.ai/discovery/sources`\n- Sitemap: `https://pubfi.ai/sitemap.xml`\n- Robots policy: `https://pubfi.ai/robots.txt`\n- IndexNow verification key: `https://pubfi.ai/50e4aa84-257b-4ff4-a822-5da3d567384c.txt`\n- Login: `https://pubfi.ai/login`\n- Privacy policy: `https://pubfi.ai/privacy-policy`\n- Terms of service: `https://pubfi.ai/terms-of-service`\n- Agents guide: `https://pubfi.ai/agents.md`\n- Product LLM index: `https://pubfi.ai/llms.txt`\n- Product LLM full export: `https://pubfi.ai/llms-full.txt`\n- Discovery capability-card JSON: `https://pubfi.ai/discovery/agent-capabilities.json`\n- Interactive API reference: `https://api.pubfi.ai/reference`\n- OpenAPI schema: `https://api.pubfi.ai/openapi.json`\n- API-host MCP manifest: `https://api.pubfi.ai/.well-known/mcp.json`\n- MCP manifest: `https://mcp.pubfi.ai/.well-known/mcp.json`\n- OpenAI Apps domain ownership proof: `https://mcp.pubfi.ai/.well-known/openai-apps-challenge`\n- MCP OAuth protected resource: `https://mcp.pubfi.ai/.well-known/oauth-protected-resource`\n- MCP x402 endpoint: `https://mcp.pubfi.ai/x402`\n- MCP discovery pointer: `https://pubfi.ai/.well-known/mcp.json`\n- MCP server card: `https://pubfi.ai/.well-known/mcp/server-card.json`\n- Optional MCP registry auth proof route: `https://pubfi.ai/.well-known/mcp-registry-auth`\n\n## Repository Contents\n\n```text\npubfi-docs/\n├── AGENTS.md\n├── README.md\n├── docs.json\n├── CONTRIBUTING.md\n├── LICENSE.md\n├── LICENSE-DOCS.md\n├── LICENSE-CODE.md\n├── CHANGELOG.md\n├── llms.txt\n├── llms-full.txt\n├── favicon.svg\n├── index.md\n├── project-overview.md\n├── getting-started/\n├── concepts/\n├── agent-readable/\n├── reference/\n├── use-cases/\n├── faq.md\n├── glossary.md\n├── maintenance/\n│ └── public-docs-maintenance.md\n├── assets/\n│ └── README.md\n└── examples/\n ├── README.md\n └── agents/\n ├── capability-curl/\n ├── pubfi-route-tools-mcp/\n ├── x402-base-mainnet/\n └── x402-base-sepolia/\n```\n\nRunnable public-safe examples live under [examples/](examples/README.md):\n\n- `examples/agents/pubfi-route-tools-mcp/`: dependency-free stdio bridge and smoke for the hosted\n MCP endpoint;\n- `examples/agents/capability-curl/`: no-auth Registry v2 catalog inspection;\n- `examples/agents/x402-base-sepolia/`: no-secret inspection of the current x402 challenge.\n- `examples/agents/x402-base-mainnet/`: Production HTTP and MCP clients pinned to the historical\n 2026-07-27 Base mainnet route, asset, amount, and payee. Current catalog and challenge checks are\n required before use.\n\n## Shared Favicon\n\nThe root `favicon.svg` is copied from `pubfi-mono/apps/web/app/icon.svg` at\n`7a1b8e13943d454db5f76d03a29e1ce8f65ee616`. This source keeps the docs icon aligned with the\nPubFi product site.\n\n## Local Development Preview\n\n```sh\nnpx mint@latest dev --no-open\n```\n\nThe local preview serves the docs site at `http://localhost:3000`.\n\n## Checks\n\n```sh\nnpm ci\nnpm run check\nnpx mint@latest validate\n```\n\nThe portable check validates Mintlify navigation targets, Markdown links, docs-site route links,\ntrailing whitespace, secret patterns, unsafe SEO/GEO success phrases, and example syntax.\nFor docs output, navigation, or generated static asset changes, also run the Mint export and static\nassertions documented in `maintenance/public-docs-maintenance.md`. These checks run locally before\nthe current GitHub pull request merge. Main-branch release workflows deploy the canonical site.\n\nAuthenticated examples require a PubFi API key and must load it from a secret store. Paid x402\nclients require a buyer wallet key that must also stay in a secret store. Do not commit\ncredentials, wallet addresses, payment signatures, payment responses, raw account responses, or\nproduction readbacks.\n\n## Publishing\n\nDeploy this repository with Mintlify export to Vercel and set `docs.pubfi.ai` as the canonical docs\ndomain. Production builds emit `sitemap.xml`, `robots.txt`, and clean canonical metadata for root\ndocs routes. GitHub Pages is a fallback only; do not run a second canonical docs site unless\ncanonical and noindex rules are explicit.\n\n## Public Boundary\n\nSafe claims:\n\n- PubFi is building an agent-native crypto data layer.\n- Discovery is an open index, demand engine, and source-selection surface for crypto data APIs.\n- PubFi exposes generic route/capability tooling for agents and MCP clients. The authenticated MCP\n root accepts API keys or OAuth access tokens; accountless payment uses the separate `/x402`\n endpoint.\n- PubFi Staging uses separate web, API, and MCP roots and a Base Sepolia x402 test boundary.\n- Public Discovery and LLM exports are generated from checked-in public-safe curated data.\n\nUnsafe claims:\n\n- every Discovery source is callable through PubFi;\n- local SEO/GEO artifacts prove ranking, traffic, or AI citation success;\n- GitHub exposure alone proves search success;\n- PubFi performs supplier procurement, supplier payment, wallet custody, or live model-ranked\n routing by default.\n- Every gateway route supports x402, or an old challenge or acceptance run proves current\n Production availability without a current catalog and unsigned challenge.\n- A Base Sepolia Staging challenge proves that Production x402 is available.\n\n## Appreciation\n\nWe would like to extend our heartfelt gratitude to the following projects and contributors:\n\n- Mintlify for the docs framework used by this repository.\n- OpenAPI and Scalar for API-reference conventions and tooling patterns.\n- Model Context Protocol contributors for the agent-tool interface standard.\n- Public crypto data API providers whose documentation makes source discovery and comparison\n possible.\n\n## Additional Acknowledgements\n\n- PubFi contributors and maintainers.\n- The broader open-source documentation community for docs-as-code practices.\n\n\n\n### License\n\nDocumentation is licensed under [CC-BY-4.0](LICENSE-DOCS.md); examples, scripts, config, and\nautomation are licensed under [MIT](LICENSE-CODE.md). See [LICENSE.md](LICENSE.md).\n\n
\n",
"bytes": 9110,
"sha": "da899d69a7cd0ff2f120b094cbdbc1f85f9171ee7852b1bf169f7e2342b83dd7",
"repo_slug": "helixbox/pubfi-docs",
"fonte": "repo",
"truncated": false,
"api": "https://agentalog.com/api/listings/mcp_ai_pubfi_mcp_04c88e36/readme"
}