Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.equinix.dev/llms.txt

Use this file to discover all available pages before exploring further.

llms.txt is the agent equivalent of robots.txt. It points an LLM or MCP client at the surfaces a package exposes — the docs, the local mirror, the OpenAPI spec, and the read/write boundaries.
The file is plain text, served at the package root. No YAML frontmatter required, no schema validator. Convention is documented at llmstxt.org.

​
Where it lives

SurfacePath
Package root.equinix-dev/providers/<slug>/llms.txt
Live cataloghttps://equinix.dev/providers/<slug>/llms.txt
Local Explorerhttp://127.0.0.1:8787/providers/<slug>/llms.txt
The catalog also exposes a top-level equinix.dev/llms.txt that indexes the per-package files.

​
Per-package format

# Equinix Fabric Cloud Router
provider: equinix/fabric-cloud-router
version: 0.1.0
schema: equinix.dev/provider-package/v1

# Public endpoints
mcp: https://mcp.equinix.com/fabric
docs: https://equinix.dev/providers/equinix/fabric-cloud-router
upstream-terraform: https://github.com/equinix/terraform-provider-equinix
upstream-fabric-modules: https://github.com/equinix/terraform-equinix-fabric

# Local mirror
local-api: http://127.0.0.1:8787/api/search?q=equinix/fabric-cloud-router
local-openapi: http://127.0.0.1:8787/openapi.json

# Agent guidance
read-tools-allowed: yes
mutating-tools-allowed: no  # blocked_by_default_requires_human_confirmation

# Boundaries
no-secrets: this file does not contain credentials
no-pricing: see pricing.md for the structured contract

​
Top-level format

The site-wide llms.txt indexes the package set: 
# equinix.dev
description: developer platform for Equinix Fabric, Network Edge, and Metal
catalog: https://equinix.dev/providers
docs: https://equinix.dev/docs

## Provider packages
equinix/fabric-cloud-router: https://equinix.dev/providers/equinix/fabric-cloud-router
equinix/fabric-connection: https://equinix.dev/providers/equinix/fabric-connection
aws/direct-connect: https://equinix.dev/providers/aws/direct-connect
... 49 more

## Local development
local-explorer: http://127.0.0.1:8787
local-explorer-openapi: http://127.0.0.1:8787/openapi.json

​
Why this file matters

Single discovery URL

A new MCP client only needs the site root to learn the surface. No crawling, no scraping, no guessing.

Boundary declaration

The file explicitly declares what an agent can read and that mutating tools are blocked. The boundary is human-authored, not inferred.

Versioned per package

Every package’s llms.txt carries a version: line. An MCP client can short-circuit if the version is older than what it has cached.

No replacement for docs

The file points at /docs and /providers/<slug> for human-grade content. It’s a routing file, not a content file.

​
What it deliberately omits

No credentials, no API keys, no quotas. llms.txt is published alongside the package and treated as world-readable. Anything sensitive (an OAuth client ID, a tenant-scoped MCP token) belongs in the customer’s .env.local, never in this file.
# DO NOT include in llms.txt
api-key: sk-ant-...
oauth-client-id: ...
quota-remaining: 4280

​
Generating it

equinix-dev add <slug> writes the per-package llms.txt from the package’s provider.json + mcp.json. Re-run after editing either file: 
equinix-dev package regenerate-llmstxt equinix/fabric-cloud-router
The site-wide equinix.dev/llms.txt is built by the static-site generator (scripts/generate_provider_pages.py in the live catalog project) by walking all installed packages.