​
Agent-Readable Surfaces

Use this page to understand the public files and endpoints that make PubFi readable by agents, search systems, documentation tools, and integration clients.

​
Public Asset Inventory

​
How To Use Them

  • Use agents.md as the public machine-readable guide for Discovery, OpenAPI, capability, and gateway boundaries.
  • Use llms.txt as the concise public site index.
  • Use llms-full.txt for expanded Discovery context.
  • Use the Discovery directory Markdown mirror for agent-readable source-selection context.
  • Use Discovery capability-card JSON for source-selection capability cards, schemas, provenance, and freshness metadata. Use the Runtime OpenAPI for executable /v1/capabilities route shapes.
  • Use the Agent interface guide for agent integration guidance.
  • Use the API Reference for interactive HTTP route exploration.
  • Use OpenAPI for executable HTTP route shapes, methods, parameters, and response schemas. Use the Auth Boundary notes in these docs for account and key requirements until the public OpenAPI source publishes security metadata.
  • Use the MCP manifest, product-site discovery pointer, or MCP server card for hosted MCP discovery metadata.
  • Use the public docs site for long-form explanations and examples.

​
Public Boundary

These surfaces must not expose:
  • production seo_geo rows;
  • keyword-growth queues;
  • issue-outbox drafts;
  • raw answer-engine samples;
  • account, billing, usage, or dashboard data;
  • PubFi API keys or upstream provider keys;
  • private procurement notes;
  • internal automation prompts.

​
Change Checklist

When a public docs page, Discovery page, or example changes, maintainers should check whether:
  1. llms.txt needs a new concise link;
  2. llms-full.txt needs expanded plain-text context;
  3. the Agent interface guide needs a new agent-readable note;
  4. API Reference, OpenAPI, provider OpenAPI, agents.md, or MCP links changed;
  5. README and GitHub navigation should point to the new asset;
  6. the page avoids implying ranking, traffic, AI citation, or runtime availability success.

​
Reachability Checks

For public launch and maintenance, record only public-safe reachability status: These labels are reachability evidence. They are not ranking, traffic, or citation proof.