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.

A provider package is not a marketing card. It is a structured bundle the CLI installs into .equinix-dev/providers/<slug>/ and that agents consume directly.

​
The six files

provider.json

Name, slug, category, logo, install command, upgrade command, environment keys.

terraform.json

Official provider, module mappings, version constraints, example HCL.

mcp.json

Remote server URL, read tools, mutating tools, mutation policy.

readiness.json

Five gates: local manifest, money guard, Terraform mapping, developer app, account assets.

pricing.md

Directional pricing records — LLM-readable contract for estimate vs quote-required surfaces.

llms.txt

Agent service discovery for the package surface.

​
provider.json

The human and agent metadata. Schema version equinix.dev/provider-package/v1. 
{
  "schema": "equinix.dev/provider-package/v1",
  "name": "Equinix Fabric Cloud Router",
  "slug": "equinix/fabric-cloud-router",
  "category": "Equinix",
  "logo": "provider-logos/equinix-mark.svg",
  "description": "Fabric Cloud Router lifecycle, routing policy, and diagnostics.",
  "sources": ["terraform", "mcp"],
  "env": [
    "EQUINIX_FABRIC_CLOUD_ROUTER_PROJECT_ID",
    "EQUINIX_FABRIC_CLOUD_ROUTER_TOKEN"
  ],
  "install": "equinix-dev add equinix/fabric-cloud-router",
  "upgrade": "equinix-dev upgrade equinix/fabric-cloud-router"
}

​
terraform.json

The Terraform mapping. Status is one of official_resource, official_module, partner_provider, quote_only, concept, or no_terraform_surface. 
{
  "status": "official_resource",
  "provider": "equinix/equinix",
  "version_constraint": "~> 4.15",
  "resources": ["equinix_fabric_cloud_router"],
  "modules": ["terraform-equinix-fabric/cloud-router-connection"],
  "example": "resource \"equinix_fabric_cloud_router\" \"this\" { name = var.name }",
  "module_version": "v0.28.1"
}
For Equinix-owned capabilities, terraform.json should prefer the official provider and modules at equinix/terraform-provider-equinix and equinix/terraform-equinix-fabric. Direct resource composition is acceptable when no module fits.

​
mcp.json

The agent surface for the package. Read tools run freely; mutating tools require human confirmation. 
{
  "endpoint": "https://mcp.equinix.com/fabric",
  "read_tools": [
    "search_router",
    "get_router_package",
    "search_routes"
  ],
  "mutating_tools": [
    "create_router",
    "update_router",
    "create_router_commands"
  ],
  "mutation_policy": "blocked_by_default_requires_human_confirmation"
}

​
readiness.json

The five gates the agent encounters in Preflight. 
[
  {
    "id": "local_manifest",
    "label": "Local package manifest",
    "status": "pass",
    "detail": "Package is installed without any external API call."
  },
  {
    "id": "money_guard",
    "label": "Spend guard",
    "status": "pass",
    "detail": "All actions are dry-run, staged, or local-file writes."
  },
  {
    "id": "terraform_mapping",
    "label": "Terraform mapping",
    "status": "pass",
    "detail": "Package has a Terraform profile or review artifact mapping."
  },
  {
    "id": "developer_app",
    "label": "Equinix developer app",
    "status": "blocked",
    "detail": "Real mutations require an approved Equinix Developer Settings app."
  },
  {
    "id": "account_assets",
    "label": "Account assets",
    "status": "blocked",
    "detail": "Ports, virtual devices, service tokens, and quote surfaces are not assumed."
  }
]

​
pricing.md

A Markdown file with structured records. The agent reads it before proposing any cost-bearing topology. 
record_type: price
product: fabric_cloud_router
metro: Ashburn
package: BASIC
mrc_usd: 900
availability: available_for_estimate
agent_instruction: use_for_directional_estimate_only
See the pricing.md spec for every record type, agent instruction, and the patch shape used when the agent finds a missing record.

​
llms.txt

A discovery file pointing agents at the package’s surface. Always /llms.txt at the package root. 
# 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

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

​
Why six files?

Each file exists because of a specific failure mode in earlier developer-platform shapes:
  • provider.json is the install / upgrade contract. Without it, the agent re-discovers package shape on every run.
  • terraform.json is the bridge to Terraform truth. Without it, an agent might fabricate HCL.
  • mcp.json is the read/write boundary. Without it, an agent might call mutating tools without an approval gate.
  • readiness.json makes preflight machine-checkable. Without it, gates are tribal.
  • pricing.md keeps cost honest. Without it, an agent might guess at MRC.
  • llms.txt lets agents discover the surface from a single URL.