{
  "schemaVersion": "1",
  "name": "Agent Fieldnotes",
  "version": "1.0.0",
  "revision": "22ce5d34dbcb5a78",
  "canonicalOrigin": "https://robust-reef-dmr6.here.now",
  "description": "Public, read-only working knowledge for building software with agents. HTML, Markdown and JSON share the same canonical documents.",
  "access": {
    "authentication": "none",
    "permission": "read",
    "effects": "Network reads only. Copy controls write to the local clipboard only after explicit action.",
    "limits": "No hosted inference, remote execution, write API, login, or MCP server. Search is local over the downloadable index. Source links may have separate access requirements."
  },
  "entrypoints": {
    "html": "/",
    "agentGuide": "/agents/",
    "developerGuide": "/developers/",
    "versioning": "/versioning/",
    "agentInstructions": "/AGENTS.md?raw=1",
    "index": "/api/v1/index.json",
    "searchIndex": "/api/v1/search.json",
    "coverage": "/api/v1/coverage.json",
    "markdown": "/llms.txt",
    "fullMarkdown": "/llms-full.txt",
    "schema": "/api/v1/schema.json",
    "openapi": "/openapi.json",
    "cli": "/agent-cli.mjs"
  },
  "operations": [
    {
      "name": "discover",
      "method": "GET",
      "path": "/agent.json",
      "output": "Versioned capabilities, effects, limits and entrypoints."
    },
    {
      "name": "list",
      "method": "GET",
      "path": "/api/v1/index.json",
      "output": "All document metadata, categories and stable identities; filter locally or use the bounded CLI."
    },
    {
      "name": "read",
      "method": "GET",
      "path": "/api/v1/documents/{id}.json",
      "input": {
        "id": "Exact ID from index; do not infer from titles."
      },
      "output": "Metadata, headings, references, full Markdown, corpus revision."
    },
    {
      "name": "markdown",
      "method": "GET",
      "path": "/markdown/{id}.md?raw=1",
      "input": {
        "id": "Exact ID from index."
      },
      "output": "Full reference with source links."
    },
    {
      "name": "search",
      "method": "GET",
      "path": "/api/v1/search.json",
      "output": "Download and filter full text locally; CLI query supports bounded pagination. This is not a server query endpoint."
    },
    {
      "name": "export",
      "method": "GET",
      "path": "/downloads/knowledge-base.json",
      "output": "Complete corpus as structured JSON; raw Markdown also at /downloads/knowledge-base.md?raw=1."
    },
    {
      "name": "coverage",
      "method": "GET",
      "path": "/api/v1/coverage.json",
      "output": "Source-unit coverage and explicit exclusions."
    }
  ],
  "browser": {
    "global": "window.WorkshopAgent",
    "operations": [
      "discover()",
      "inspect()",
      "query({q, category})",
      "reset()",
      "copy({id, format: 'markdown' | 'url'})"
    ],
    "semantics": "Stable document IDs, semantic links, labeled search, visible focus, live status. Inspect returns actual current UI state, not persisted server state."
  },
  "consistency": {
    "policy": "Compare revision across index, document and search responses. Refetch on mismatch. CLI --revision rejects stale targets.",
    "writes": "No content writes. Reads are idempotent; retry network failures with bounded backoff. Clipboard writes report completion/error."
  },
  "httpDelivery": {
    "availability": "canonical-origin-only",
    "methods": [
      "GET",
      "HEAD"
    ],
    "negotiation": "Canonical HTML pages also accept text/markdown; responses vary by Accept and Accept-Encoding.",
    "errorSchema": "/openapi.json#/components/schemas/Problem",
    "maximumResponseBytes": 4194304,
    "upstreamDeadlineMs": 20000
  },
  "diagnostics": {
    "errors": "HTTP API failures use typed problem JSON and X-Request-ID; CLI emits requestId, code, message and nonzero exit status; browser reports search/copy errors in-page.",
    "retention": "No application analytics or request recording. Search state lives in the URL; hosting services receive ordinary requests, including URLs on navigation or reload, under their own logging policies."
  },
  "ownership": {
    "content": "content/{collection}/manifest.json and its Markdown documents",
    "rendering": "src/ui.mjs",
    "navigation": "src/site.js",
    "generation": "scripts/build.mjs",
    "retrieval": "scripts/agent-cli.mjs",
    "httpDelivery": "gateway/api/gateway.mjs",
    "apiContract": "scripts/agent-docs.mjs"
  }
}
