cookbook-descriptions.json

{
  "exposed": {
    "queries": {
      "title": "GQ query best practices",
      "description": "Read before authoring queries (via `read` or `change`). Covers .gq grammar, query name dispatch, parameter declaration, the PascalCase→lowerCamelCase edge casing trap, search functions requiring trailing `limit`, and the T12 non-nullable lint rule."
    },
    "data": {
      "title": "Data ingest patterns",
      "description": "Read before calling `ingest`. Covers mode selection (merge/append/overwrite), the branch→ingest→verify→merge loop for large/risky writes, embedding-staleness gotcha (mode:merge does not recompute embeddings), and change-vs-ingest decision matrix."
    },
    "schema": {
      "title": "Schema authoring and evolution",
      "description": "Read before calling `schema_apply`. Covers .pg grammar, decorators (@key, @unique, @embed, @rename_from), inline-only enums, the add-optional→backfill→tighten sequence for non-nullable additions, and why apply is main-only and rejects open feature branches."
    },
    "remote-ops": {
      "title": "Remote-operation safety",
      "description": "Read after any 504 or unexpected error. Covers the verify-after-write ritual (commits_list head before/after), retry-safety table by node kind (pointer types dedupe via @key; append-only types duplicate on retry), and the `sync_branch()` server-internal error vs. a tool."
    },
    "search": {
      "title": "Vector and full-text search",
      "description": "Read before using nearest/bm25/rrf. Covers the scope-first-rank-second pattern, the hardcoded embedding model (gemini-embedding-2-preview, Vector(3072)), and trailing-`limit` requirement."
    }
  },
  "skipped": {
    "aliases": "CLI-only — omnigraph.yaml + --alias mechanics, not actionable through the HTTP API the MCP wraps.",
    "commands": "CLI-only — the omnigraph binary's command surface, not the HTTP API.",
    "server-policy": "Server-deployment concerns (Cedar policy, auth tokens), out of scope for an MCP client."
  }
}