ReadMe · JSON Structure

Readme Developer Hub Structure

The logical content structure of a ReadMe-managed developer hub. Branches contain the versioned content tree; everything inside lives under a branch.

Type: Properties: 0

DocumentationDeveloper HubAPI ReferencePortalAnalyticsArtificial IntelligenceMCPBi-Directional Sync

Readme Developer Hub Structure is a JSON Structure definition published by ReadMe.

Meta-schema:

JSON Structure

{
  "title": "ReadMe Developer Hub Structure",
  "description": "The logical content structure of a ReadMe-managed developer hub. Branches contain the versioned content tree; everything inside lives under a branch.",
  "structure": {
    "project": {
      "branches": [
        {
          "id": "string",
          "name": "string (e.g. v1, v2, stable)",
          "apiDefinitions": [
            { "id": "string", "title": "string", "source": "api|upload|url|rdme" }
          ],
          "guides": {
            "categories": [
              {
                "slug": "string",
                "title": "string",
                "pages": [
                  { "slug": "string", "title": "string", "parentDoc": "slug|null" }
                ]
              }
            ]
          },
          "reference": {
            "categories": [
              {
                "slug": "string",
                "title": "string",
                "pages": [
                  { "slug": "string", "title": "string", "operation": "OpenAPI op ref" }
                ]
              }
            ]
          },
          "changelog": [
            { "slug": "string", "title": "string", "type": "added|fixed|improved|deprecated|removed" }
          ],
          "customPages": [
            { "slug": "string", "title": "string", "htmlmode": "boolean" }
          ],
          "recipes": [
            { "slug": "string", "title": "string" }
          ]
        }
      ],
      "apiKeys": [
        { "id": "string", "label": "string" }
      ],
      "integrations": {
        "git": {
          "platform": "github|gitlab",
          "repository": "owner/repo",
          "biDirectional": true
        },
        "ai": {
          "agent": true,
          "linter": true,
          "docsAudit": true,
          "askAI": "optional add-on",
          "githubAIWriter": true,
          "inlineAI": true
        },
        "mcp": {
          "readmeMcpServer": "https://mcp.readme.com",
          "projectMcpServer": "auto-provisioned per project"
        }
      },
      "metrics": {
        "developerDashboard": true,
        "apiLogIngestion": "https://metrics.readme.io/v1/request"
      }
    }
  }
}

Work with this as data

Every JSON Structure here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for json structure

4 MCP tools reach this

find_json_structuresBrowse and filter every JSON Structure in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This JSON Structure

curl "https://apis.io/api/v1/json-structures/readme-developer-hub-structure"

All json structure

curl "https://apis.io/api/v1/json-structures?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.