PubFi MCP

by helixbox

208 downloads
Not rated
GitHub Website

About

Public docs, examples, and agent-readable integration guides for PubFi's agent-native crypto data layer.

Details

Author
helixbox
Downloads
208
Categories
Knowledge Base

- Agent-native crypto data layer with hosted MCP endpoint
- Open Discovery index for crypto data API source selection
- Generic route and capability tooling for agents and MCP clients
- Public MCP manifest and server card at well-known endpoints
- LLM-friendly surfaces including llms.txt and agent-readable docs

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

  1. Download and install Highlight from highlightai.com/download
  2. Navigate to the plugins tab and select "Add Custom Plugin"
  3. Configure the plugin with the settings below
    Plugin Name PubFi MCP
    Command (node, npx, python, etc.)

    Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.

  4. Enable "Start Automatically" if you want the plugin to start when Highlight launches

From the repository

Set up your MCP client by following the MCP client setup guide. For a quick smoke test, run the dependency-free stdio bridge in examples/agents/pubfi-route-tools-mcp/. Live examples require a PubFi API key loaded from environment variables.

pubfi.capabilities.list

Enumerate the complete installed Registry v2 catalog as deterministic compact pages. The server does not rank, infer intent, or choose a capability.

pubfi.capabilities.get

Return the full typed request, response, metering, and readiness contract for one exact capability id from the installed Registry generation.

pubfi.route.execute

Execute one exact GET or POST path through the same Registry v2 matcher, credential authority, and typed executor as the HTTP gateway. Append :free to a published free route and use the authenticated account lane for rate- and total-limited execution without Credit charging. Otherwise use the authenticated account lane with metering, or call the explicit accountless x402 MCP endpoint with payment metadata.

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "pubfi mcp": {
            "pubfi": {
                "type": "streamable-http",
                "url": "https://mcp.pubfi.ai",
                "headers": {
                    "Authorization": "Bearer <PUBFI_API_KEY>"
                }
            }
        }
    }
}

McpServers

{
    "pubfi": {
        "type": "streamable-http",
        "url": "https://mcp.pubfi.ai",
        "headers": {
            "Authorization": "Bearer <PUBFI_API_KEY>"
        }
    }
}

PubFi Docs

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

Docs
API Reference
OpenAPI
Docs Check
Docs License
Code License
GitHub last commit

</div>

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 origin/main through commit
68f202a1b538faf588979a598a30404534e23d4a.

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
- Pricing: https://pubfi.ai/pricing
- Blog: https://pubfi.ai/blog
- Product pages: https://pubfi.ai/products/{product_slug}
- Discovery: https://pubfi.ai/discovery
- Discovery directory Markdown: https://pubfi.ai/discovery.md
- Provider Profile index: https://pubfi.ai/discovery/sources
- Sitemap: https://pubfi.ai/sitemap.xml
- Robots policy: https://pubfi.ai/robots.txt
- IndexNow verification key: https://pubfi.ai/50e4aa84-257b-4ff4-a822-5da3d567384c.txt
- Login: https://pubfi.ai/login
- Privacy policy: https://pubfi.ai/privacy-policy
- Terms of service: https://pubfi.ai/terms-of-service
- 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
- Discovery capability-card JSON: https://pubfi.ai/discovery/agent-capabilities.json
- Interactive API reference: https://api.pubfi.ai/reference
- OpenAPI schema: https://api.pubfi.ai/openapi.json
- API-host MCP manifest: https://api.pubfi.ai/.well-known/mcp.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.

<div align="right">

License

<sup>Documentation is licensed under CC-BY-4.0; examples, scripts, config, and
automation are licensed under MIT. See LICENSE.md.</sup>

</div>

No reviews yet — be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.