PubFi Docs

Public documentation and examples for PubFi's agent-native crypto data layer.

About

This repository is the public source of truth for PubFi's long-form docs. It is separate from the private pubfi-mono repository so public docs, examples, issue templates, and agent-readable materials can be indexed by GitHub, search engines, and answer engines.

The v0 docs framework is Mintlify. The intended production shape is:

github.com/helixbox/pubfi-docs
  -> Mintlify GitHub integration
  -> docs.pubfi.ai
  -> root docs routes such as /getting-started/quickstart and /reference/api-reference
  -> linked from pubfi.ai product surfaces and legacy docs redirects
  -> canonical cross-links from README, llms.txt, Discovery, API Reference, MCP, and examples

Snapshot source: pubfi-mono commit d1a0fee2e525f0fa1e100c655ef62042d15fcdcf.

Start Here

• Docs home
• Project overview
• Quickstart
• API Reference
• MCP client setup
• Agent-readable surfaces
• Security and public data

Published Surfaces

• Docs site: https://docs.pubfi.ai
• Product site: https://pubfi.ai
• Discovery: https://pubfi.ai/discovery
• Discovery directory Markdown: https://pubfi.ai/discovery.md
• Provider Profile index: https://pubfi.ai/discovery/sources
• Agents guide: https://pubfi.ai/agents.md
• Product LLM index: https://pubfi.ai/llms.txt
• Product LLM full export: https://pubfi.ai/llms-full.txt
• Capability discovery JSON: https://pubfi.ai/discovery/agent-capabilities.json
• Interactive API reference: https://api.pubfi.ai/reference
• OpenAPI schema: https://api.pubfi.ai/openapi.json
• DeGov OpenAPI: https://pubfi.ai/openapi/degov-openapi.json
• Subscan OpenAPI: https://pubfi.ai/openapi/subscan-openapi.json
• MCP manifest: https://mcp.pubfi.ai/.well-known/mcp.json
• MCP discovery pointer: https://pubfi.ai/.well-known/mcp.json
• MCP server card: https://pubfi.ai/.well-known/mcp/server-card.json
• Optional MCP registry auth proof route: https://pubfi.ai/.well-known/mcp-registry-auth

Repository Contents

pubfi-docs/
├── AGENTS.md
├── README.md
├── docs.json
├── CONTRIBUTING.md
├── LICENSE.md
├── LICENSE-DOCS.md
├── LICENSE-CODE.md
├── CHANGELOG.md
├── llms.txt
├── llms-full.txt
├── index.md
├── project-overview.md
├── getting-started/
├── concepts/
├── agent-readable/
├── reference/
├── use-cases/
├── faq.md
├── glossary.md
├── maintenance/
│   └── public-docs-maintenance.md
├── assets/
│   └── README.md
└── examples/
    ├── README.md
    └── agents/
        ├── capability-curl/
        ├── pubfi-route-tools-mcp/
        └── subscan-gateway/

Runnable public-safe examples live under examples/:

• examples/agents/pubfi-route-tools-mcp/: dependency-free stdio bridge and smoke for the hosted MCP endpoint;
• examples/agents/capability-curl/: minimal HTTPS call to the capability runtime;
• examples/agents/subscan-gateway/: lower-level provider gateway inspection path using Subscan as one concrete provider example.

Local Preview

npx mint@latest dev --no-open

The local preview serves the docs site at http://localhost:3000.

Checks

npm run check
npx mint@latest validate

The portable check validates Mintlify navigation targets, Markdown links, docs-site route links, trailing whitespace, secret patterns, unsafe SEO/GEO success phrases, and example syntax.

Live examples require a PubFi API key and must load it from local environment variables or a secret store. Do not commit credentials, wallet addresses, raw account responses, or production readbacks.

Publishing

Deploy this repository with Mintlify export to Vercel and set docs.pubfi.ai as the canonical docs domain. Production builds emit sitemap.xml, robots.txt, and clean canonical metadata for root docs routes. GitHub Pages is a fallback only; do not run a second canonical docs site unless canonical and noindex rules are explicit.

Public Boundary

Safe claims:

• PubFi is building an agent-native crypto data layer.
• Discovery is an open index, demand engine, and source-selection surface for crypto data APIs.
• PubFi exposes generic route/capability tooling for agents and MCP clients.
• Public Discovery and LLM exports are generated from checked-in public-safe curated data.

Unsafe claims:

• every Discovery source is callable through PubFi;
• local SEO/GEO artifacts prove ranking, traffic, or AI citation success;
• GitHub exposure alone proves search success;
• PubFi executes supplier procurement, wallet payments, x402 settlement, or live model-ranked routing by default.

Appreciation

We would like to extend our heartfelt gratitude to the following projects and contributors:

• Mintlify for the docs framework used by this repository.
• OpenAPI and Scalar for API-reference conventions and tooling patterns.
• Model Context Protocol contributors for the agent-tool interface standard.
• Public crypto data API providers whose documentation makes source discovery and comparison possible.

Additional Acknowledgements

• PubFi contributors and maintainers.
• The broader open-source documentation community for docs-as-code practices.

License

^{Documentation is licensed under CC-BY-4.0; examples, scripts, config, and automation are licensed under MIT. See LICENSE.md.}