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

AssetCanonical purposePublic URL
llms.txtconcise public site and Discovery indexhttps://pubfi.ai/llms.txt
llms-full.txtexpanded answer-engine retrieval corpushttps://pubfi.ai/llms-full.txt
Agent interface guideagent integration guidancehttps://docs.pubfi.ai/docs/reference/agent-interface
API Referenceinteractive HTTP referencehttps://api.pubfi.ai/reference
OpenAPIexecutable HTTP schemahttps://api.pubfi.ai/openapi.json
MCP manifesthosted MCP discoveryhttps://mcp.pubfi.ai/.well-known/mcp.json
Discovery pagessource-selection and provider contexthttps://pubfi.ai/discovery
public docs repositorysource provenance and contribution corpusfuture pubfi-docs repository
canonical docs sitefull long-form docsfuture docs.pubfi.ai site

How To Use Them

  • Use llms.txt as the concise public site index.
  • Use llms-full.txt for expanded Discovery context.
  • 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, auth headers, parameters, and response schemas.
  • Use the MCP manifest for hosted MCP discovery.
  • 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, 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:
CheckSafe status
llms.txt returns 200llms_index_reachable
llms-full.txt returns 200llms_full_reachable
API Reference returns 200api_reference_reachable
OpenAPI returns JSONopenapi_reachable
MCP manifest returns JSONmcp_manifest_reachable
sitemap includes canonical docs pagesitemap_member
crawler fetched pagecrawler_fetch_observed
These labels are reachability evidence. They are not ranking, traffic, or citation proof.