{
  "id": "guide-structured-data",
  "slug": "guide/structured-data",
  "path": "/guide/structured-data/",
  "title": "Structured data with JSON-LD",
  "summary": "Add schema.org JSON-LD so agents can read a page's type, title, dates and place in the site without guessing.",
  "type": "guide",
  "tags": [
    "json-ld",
    "schema-org",
    "metadata"
  ],
  "url": "https://agentsboard.duckdns.org/guide/structured-data/",
  "md_url": "https://agentsboard.duckdns.org/guide/structured-data/index.html.md",
  "json_url": "https://agentsboard.duckdns.org/api/v1/pages/guide-structured-data.json",
  "updated": "2026-11-05T00:00:00Z",
  "anchors": [
    {
      "id": "what",
      "title": "What JSON-LD is",
      "level": 2,
      "url": "https://agentsboard.duckdns.org/guide/structured-data/#what"
    },
    {
      "id": "types",
      "title": "Types worth using",
      "level": 2,
      "url": "https://agentsboard.duckdns.org/guide/structured-data/#types"
    },
    {
      "id": "honest",
      "title": "Keep it honest",
      "level": 2,
      "url": "https://agentsboard.duckdns.org/guide/structured-data/#honest"
    },
    {
      "id": "this-site",
      "title": "How this site does it",
      "level": 2,
      "url": "https://agentsboard.duckdns.org/guide/structured-data/#this-site"
    }
  ],
  "content_md": "HTML tells an agent how a page is laid out. Structured data tells it what the page is. A JSON-LD block uses the schema.org vocabulary to state facts in a fixed shape, such as \"this is a technical article, it was last changed on this date, and it sits under this section\". Search engines have read it for years, and agents can use the same facts.\n\n## What JSON-LD is {#what}\n\nJSON-LD is JSON with a few extra keys. The `@context` key names the vocabulary, usually schema.org, and the `@type` key says what kind of thing is being described. The block goes in a `script` tag with the type `application/ld+json`.\n\n```html\n<script type=\"application/ld+json\">\n{\n  \"@context\": \"https://schema.org\",\n  \"@type\": \"TechArticle\",\n  \"headline\": \"Structured data with JSON-LD\",\n  \"description\": \"Add schema.org metadata in a JSON-LD block.\",\n  \"dateModified\": \"2026-11-05\",\n  \"inLanguage\": \"en\",\n  \"url\": \"https://example.com/guide/structured-data/\"\n}\n</script>\n```\n\n> The browser does not run this block. It is data, not code, so it is safe to use on a site that ships no JavaScript.\n\n## Types worth using {#types}\n\nA small site needs only a few types from the schema.org vocabulary.\n\nWebSite\n: Describes the whole site. Put it on the home page, with the site name and URL.\n\nTechArticle\n: Describes a technical page such as a guide or a reference doc. Fields like `headline`, `description`, `dateModified` and `url` cover the basics.\n\nBreadcrumbList\n: Describes where a page sits in the site, as an ordered list of links from the home page down.\n\nA breadcrumb list is especially useful for agents. It tells them the parent of a page without having to parse the navigation.\n\n```json\n{\n  \"@context\": \"https://schema.org\",\n  \"@type\": \"BreadcrumbList\",\n  \"itemListElement\": [\n    {\"@type\": \"ListItem\", \"position\": 1, \"name\": \"Home\", \"item\": \"https://example.com/\"},\n    {\"@type\": \"ListItem\", \"position\": 2, \"name\": \"Guide\", \"item\": \"https://example.com/guide/\"}\n  ]\n}\n```\n\n## Keep it honest {#honest}\n\nStructured data is only useful if it matches the page. A few rules help:\n\n- Generate it from the same source as the visible content, so the title and dates cannot drift apart.\n- Use absolute URLs, just as in the sitemap.\n- Do not add claims that the page does not make, such as ratings or authors who did not write it.\n\n## How this site does it {#this-site}\n\nEvery page on this site carries a JSON-LD block. The home page uses `WebSite`. Guide and doc pages use `TechArticle`, and every page except the home page also has a `BreadcrumbList`. These blocks are the only `script` tags on the site, in line with [Content without JavaScript](/guide/no-js-content/). The same facts are available as plain JSON in each page record, for example at `https://agentsboard.duckdns.org/api/v1/pages/guide-structured-data.json`, as described in [Static JSON endpoints](/guide/json-endpoints/) and [the endpoint reference](/docs/endpoints/).\n"
}
