@x12i/memorix-client-api 0.0.0-stage → 0.16.0

package/openapi/openapi.json

@@ -0,0 +1,480 @@
+{
+  "openapi": "3.0.3",
+  "info": {
+    "title": "Memorix client API",
+    "version": "0.16.0",
+    "description": "Read API for smart clients. Agents come from x-memorix-agent-ids. The org comes from x-memorix-org-id, or from an Authix bearer token when MEMORIX_AUTH=authix. x-memorix-caller names the calling app. Descriptors are the effective object-type fields for those agents. GET /api/v1/memorix/{path} forwards Memorix read routes. Agent functions are under /api/v1/agent-functions. Nexum subjects and canvas are under /api/v1/nexum. Scoper 2.3.0 is hosted at /api/v1/scoper. MCP is /api/v1/mcp/nexum, /api/v1/mcp/scoper, and /api/v1/mcp/mgc. Aligned with memorix-service 3.17.0 and memorix-skills 0.6.0."
+  },
+  "paths": {
+    "/health": {
+      "get": {
+        "operationId": "health",
+        "summary": "Liveness",
+        "responses": { "200": { "description": "Process is up" } }
+      }
+    },
+    "/api/v1/catalog": {
+      "get": {
+        "operationId": "catalog",
+        "summary": "Object types, content types, and field descriptors for the agent ids",
+        "description": "Each content type has derived true or false. derived true is a processing result stored on the subject. Source content is false. Metadata derived on the content type wins; otherwise the platform result types are used. A field may include mixed and shapes. shapes name a grammar and resolvesTo (objectType, contentTypes, recordId). recordId is value, paired-<sourceProperty>, or a template containing {value}. When every value shape names one object type, refersTo is that object type. A content type may also carry presentation (label, order, tab always|whenPresent|hidden, values[] with value, label, order, origin) and origin (producer model|code|mixed, use always|conditional, record). Both are optional, display metadata only, and absent when the pack has not stamped them. An object type may include functions (id, question, page, composes, pageStory, reads, optional template and kind spine|threads). template is the story template id, the same string as data.template and as presentation.values[].value on content type story. A malformed function is dropped.",
+        "parameters": [{ "$ref": "#/components/parameters/ScopeHeaders" }],
+        "responses": { "200": { "description": "Catalog" } }
+      }
+    },
+    "/api/v1/object-types/{objectType}": {
+      "get": {
+        "operationId": "objectType",
+        "summary": "One object type and its content-type descriptors",
+        "parameters": [
+          { "$ref": "#/components/parameters/ScopeHeaders" },
+          { "$ref": "#/components/parameters/ObjectType" }
+        ],
+        "responses": { "200": { "description": "Object type" }, "404": { "description": "Unknown object type" } }
+      }
+    },
+    "/api/v1/object-types/{objectType}/content-types": {
+      "get": {
+        "operationId": "contentTypes",
+        "summary": "Content types allowed on an object type, with descriptors and the leading content type",
+        "parameters": [
+          { "$ref": "#/components/parameters/ScopeHeaders" },
+          { "$ref": "#/components/parameters/ObjectType" }
+        ],
+        "responses": { "200": { "description": "Content types" } }
+      }
+    },
+    "/api/v1/object-types/{objectType}/content-types/{contentType}": {
+      "get": {
+        "operationId": "contentType",
+        "summary": "Descriptors for one content type",
+        "parameters": [
+          { "$ref": "#/components/parameters/ScopeHeaders" },
+          { "$ref": "#/components/parameters/ObjectType" },
+          { "$ref": "#/components/parameters/ContentType" }
+        ],
+        "responses": { "200": { "description": "Content type" }, "404": { "description": "Unknown content type" } }
+      }
+    },
+    "/api/v1/object-types/{objectType}/records": {
+      "get": {
+        "operationId": "listRecords",
+        "summary": "Paginated subjects, driven by a leading content type",
+        "description": "Filter, sort, and cursor apply to the leading content type. Sibling content types are attached on each row. leadingContentType defaults to the content type marked leading in metadata, or the first content type that is not relationships. contentTypes defaults to every content type on the object type except relationships. representation is json, markdown, or both (default both). pageInfo.nextCursor is the Memorix cursor. Fields with refersTo are record ids; json and rendered markdown replace them with the records they point at.",
+        "parameters": [
+          { "$ref": "#/components/parameters/ScopeHeaders" },
+          { "$ref": "#/components/parameters/ObjectType" },
+          { "name": "leadingContentType", "in": "query", "schema": { "type": "string" } },
+          { "name": "contentTypes", "in": "query", "schema": { "type": "string" }, "description": "Comma-separated content type ids" },
+          { "name": "representation", "in": "query", "schema": { "type": "string", "enum": ["json", "markdown", "both"] } },
+          { "name": "filter", "in": "query", "schema": { "type": "string" }, "description": "JSON SafeFilter" },
+          { "name": "sort", "in": "query", "schema": { "type": "string" }, "description": "JSON sort" },
+          { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 } },
+          { "name": "cursor", "in": "query", "schema": { "type": "string" } }
+        ],
+        "responses": { "200": { "description": "Page of subjects" } }
+      }
+    },
+    "/api/v1/records/{recordId}": {
+      "get": {
+        "operationId": "getRecord",
+        "summary": "One subject with all stored content types, or a named subset",
+        "description": "recordId may contain slashes; send them as extra path segments. Omit contentTypes to load every content type registered on the subject. representation is json, markdown, or both (default both). Each instance includes descriptor.fields, descriptorCoverage (complete, partial, none), and undeclaredPaths. Markdown stored with source ai or content is returned as stored. Otherwise it is rendered from .data with source rendered. Fields with refersTo are record ids; json and rendered markdown replace them with { recordId, objectType, contentType, data }. A data.<key> field is expanded at every key of that name. Unmatched ids stay strings. Prose is not parsed back into fields.",
+        "parameters": [
+          { "$ref": "#/components/parameters/ScopeHeaders" },
+          { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string" } },
+          { "name": "contentTypes", "in": "query", "schema": { "type": "string" } },
+          { "name": "representation", "in": "query", "schema": { "type": "string", "enum": ["json", "markdown", "both"] } },
+          { "name": "objectType", "in": "query", "schema": { "type": "string" }, "description": "When set, must match the directory" }
+        ],
+        "responses": { "200": { "description": "Subject" }, "404": { "description": "Subject is not reserved" } }
+      }
+    },
+    "/api/v1/processed-subjects": {
+      "get": {
+        "operationId": "processedSubjects",
+        "summary": "Distinct subjects that have a derived content row on that same record",
+        "description": "rule.id caller-or-preserved opens every catalog content type except relationships. A subject counts when a row on that record has datasource basis caller or preserved. Declared and backfill rows do not count. The process keeps the answer for the org and agent ids. checking stays true until every included collection is read with no nextCursor. A later read returns that answer. continue=true keeps those subjects and reads empty collections again. A new rule.id drops the kept answer. count is the number of distinct subjects, not the page size. pageInfo.nextCursor is omitted on the last page. A working/ record id is not a subject. An unregistered content type is skipped.",
+        "parameters": [
+          { "$ref": "#/components/parameters/ScopeHeaders" },
+          { "name": "objectType", "in": "query", "schema": { "type": "string" }, "description": "Only subjects of this object type. Absent means every object type in the catalog." },
+          { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 } },
+          { "name": "cursor", "in": "query", "schema": { "type": "string" } },
+          { "name": "continue", "in": "query", "schema": { "type": "boolean" }, "description": "Keep the saved subjects and read collections again, including ones kept as empty." }
+        ],
+        "responses": {
+          "200": { "description": "Kept subjects. saved is true once a pass has finished. checking is true while a pass is still reading." },
+          "404": { "description": "Unknown object type" }
+        }
+      },
+      "delete": {
+        "operationId": "deleteProcessedSubjects",
+        "summary": "Drop the kept processed-subject answer for this org and these agent ids",
+        "parameters": [{ "$ref": "#/components/parameters/ScopeHeaders" }],
+        "responses": { "200": { "description": "The kept answer is gone. The next GET reads again." } }
+      }
+    },
+    "/api/v1/refs/resolve": {
+      "post": {
+        "operationId": "resolveRefs",
+        "summary": "Resolve ref strings from the shapes declared on catalog fields",
+        "description": "Body is { values: string[] }, at most 200. Each string is classified by the first shape grammar that matches the whole value. value loads that reserved record. paired-<sourceProperty> attaches to the sibling subject that publishes matchProperty, or looks up data.<matchProperty>. A template attaches to a subject in the batch that publishes sourceProperty, its plural Ids field, or displayName, title, or name. The template record is loaded when that object type is in the catalog. A lookup runs only when the batch resolved no record-id subjects, on the object types named by sibling value shapes, or across the catalog when the template shape has none. Strings that do not resolve are returned in unresolved. getRecord of a non-reserved id stays 404.",
+        "parameters": [{ "$ref": "#/components/parameters/ScopeHeaders" }],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "required": ["values"],
+                "properties": {
+                  "values": { "type": "array", "maxItems": 200, "items": { "type": "string" } }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": { "description": "subjects in first-seen order, plus unresolved strings in input order" },
+          "400": { "description": "values is not an array of strings, or it exceeds 200" }
+        }
+      }
+    },
+    "/api/v1/records/{recordId}/content-types": {
+      "get": {
+        "operationId": "recordContentTypes",
+        "summary": "Content types stored on one record, joined with descriptors",
+        "parameters": [
+          { "$ref": "#/components/parameters/ScopeHeaders" },
+          { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string" } }
+        ],
+        "responses": { "200": { "description": "Stored content types" }, "404": { "description": "Subject is not reserved" } }
+      }
+    },
+    "/api/v1/memorix/{path}": {
+      "get": {
+        "operationId": "memorixGet",
+        "summary": "Forward a Memorix GET under /api",
+        "description": "path is the remainder of the Memorix path, including extra segments (data/content, memory/sources, pipelines/runs/{runId}, analytics/indexes, metadata/effective, connectors, jobs/v1/work, hooks/v1/subscriptions, data-journey/journeys, relationships/query). Query strings are forwarded. Relationship links and restricted-store break-glass content are refused. data/content: when the content type has a discriminator in the catalog, recordId plus discriminatorValue (or a filter eq clause on the discriminator path) returns that instance in the single-record shape, read from a recordId list on that content type; no match is 404 READ_NOT_FOUND naming the stored values. Without recordId, discriminatorValue is added to filter as an eq clause. recordId plus an eq filter on data.template returns the newest revision of that template, including when the content type has no discriminator. count=true is forwarded unchanged. metadata/effective and metadata/raw are forwarded unchanged, including objectTypes[].functions.",
+        "parameters": [
+          { "$ref": "#/components/parameters/ScopeHeaders" },
+          { "name": "path", "in": "path", "required": true, "schema": { "type": "string" } }
+        ],
+        "responses": {
+          "200": { "description": "Memorix response" },
+          "403": { "description": "Path is not a fetch route" }
+        }
+      }
+    },
+    "/api/v1/data/story": {
+      "get": {
+        "operationId": "readStory",
+        "summary": "AI-first story for one subject and template",
+        "description": "variant defaults to auto. auto serves a usable story-ai row, otherwise the code story. ai and code read only that content type. A usable AI row is active, has data.input, and _metadata.aiExecution.status outside CODE_ONLY, SKIPPED, FAILED, and DEFERRED. 200 matches a content read (scope, addressing, record, currentRevision) and adds story (template, served ai|code, fallbackReason AI_MISSING|AI_UNUSABLE when auto served code, ai, code). ai.stale is true when ai.basedOnRevision is behind code.revision; a stale AI row is still served. ai or code is null when that content type is not declared. 404 STORY_NOT_FOUND includes the same story block. An unknown object type or a template that is not on story presentation.values is answered as GET data/content.",
+        "parameters": [{ "$ref": "#/components/parameters/ScopeHeaders" }],
+        "responses": {
+          "200": { "description": "Served story" },
+          "404": { "description": "STORY_NOT_FOUND, or the content read for an undeclared template" }
+        }
+      }
+    },
+    "/api/v1/data/stories": {
+      "get": {
+        "operationId": "readStories",
+        "summary": "One AI-first story per template",
+        "description": "One readStory result per value in story presentation.values, in that order. Each item is template, label, story, and record or null.",
+        "parameters": [{ "$ref": "#/components/parameters/ScopeHeaders" }],
+        "responses": { "200": { "description": "Stories for the subject" } }
+      }
+    },
+    "/api/v1/data/compose": {
+      "post": {
+        "operationId": "compose",
+        "summary": "Read compose of one subject",
+        "parameters": [{ "$ref": "#/components/parameters/ScopeHeaders" }],
+        "responses": { "200": { "description": "Composition" } }
+      }
+    },
+    "/api/v1/data/compose/data": {
+      "post": {
+        "operationId": "composeData",
+        "summary": "Read compose projected to content-type .data",
+        "parameters": [{ "$ref": "#/components/parameters/ScopeHeaders" }],
+        "responses": { "200": { "description": "Data projection" } }
+      }
+    },
+    "/api/v1/data/compose/data/list": {
+      "post": {
+        "operationId": "composeDataList",
+        "summary": "Read a page of subjects as content-type .data",
+        "parameters": [{ "$ref": "#/components/parameters/ScopeHeaders" }],
+        "responses": { "200": { "description": "Page" } }
+      }
+    },
+    "/api/v1/data/lists": {
+      "post": {
+        "operationId": "runList",
+        "summary": "Run a declared list or an abstract property page",
+        "parameters": [{ "$ref": "#/components/parameters/ScopeHeaders" }],
+        "responses": { "200": { "description": "List page" } }
+      }
+    },
+    "/api/v1/data/items": {
+      "post": {
+        "operationId": "getItem",
+        "summary": "Read one item view",
+        "parameters": [{ "$ref": "#/components/parameters/ScopeHeaders" }],
+        "responses": { "200": { "description": "Item" } }
+      }
+    },
+    "/api/v1/nexum/status": {
+      "get": {
+        "operationId": "nexumStatus",
+        "summary": "Nexum canvas health and the gateway MCP URL",
+        "parameters": [{ "$ref": "#/components/parameters/ScopeHeaders" }],
+        "responses": { "200": { "description": "Canvas status. mcpUrl points at this API." } }
+      }
+    },
+    "/api/v1/nexum/snapshots": {
+      "get": {
+        "operationId": "nexumListSnapshots",
+        "summary": "List content/snapshots subjects",
+        "description": "Same read as nexum_list_snapshots. knowledgeGraphOnly keeps data.kind=knowledge-graph. limit is 1–200, default 50.",
+        "parameters": [
+          { "$ref": "#/components/parameters/ScopeHeaders" },
+          { "name": "limit", "in": "query", "schema": { "type": "integer" } },
+          { "name": "cursor", "in": "query", "schema": { "type": "string" } },
+          { "name": "knowledgeGraphOnly", "in": "query", "schema": { "type": "boolean" } }
+        ],
+        "responses": { "200": { "description": "Snapshot page" } }
+      }
+    },
+    "/api/v1/nexum/snapshots/{recordId}": {
+      "get": {
+        "operationId": "nexumGetSnapshot",
+        "summary": "One content/snapshots subject",
+        "description": "recordId may contain slashes as extra path segments. A suffix /connected is nexumGetConnectedContent.",
+        "parameters": [
+          { "$ref": "#/components/parameters/ScopeHeaders" },
+          { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string" } }
+        ],
+        "responses": { "200": { "description": "Snapshot" }, "404": { "description": "Snapshot is not stored" } }
+      }
+    },
+    "/api/v1/nexum/entities": {
+      "get": {
+        "operationId": "nexumListEntities",
+        "summary": "List or search Nexum canvas entities",
+        "parameters": [
+          { "$ref": "#/components/parameters/ScopeHeaders" },
+          { "name": "graphId", "in": "query", "schema": { "type": "string" } },
+          { "name": "q", "in": "query", "schema": { "type": "string" } },
+          { "name": "limit", "in": "query", "schema": { "type": "string" } }
+        ],
+        "responses": {
+          "200": { "description": "Canvas entities" },
+          "502": { "description": "NEXUM_UPSTREAM_UNREACHABLE: the Memorix host cannot reach Nexum explore REST" }
+        }
+      }
+    },
+    "/api/v1/nexum/entities/{entityId}": {
+      "get": {
+        "operationId": "nexumGetEntity",
+        "summary": "One Nexum canvas entity",
+        "parameters": [
+          { "$ref": "#/components/parameters/ScopeHeaders" },
+          { "name": "entityId", "in": "path", "required": true, "schema": { "type": "string" } },
+          { "name": "graphId", "in": "query", "schema": { "type": "string" } }
+        ],
+        "responses": {
+          "200": { "description": "Canvas entity" },
+          "502": { "description": "NEXUM_UPSTREAM_UNREACHABLE: the Memorix host cannot reach Nexum explore REST" }
+        }
+      }
+    },
+    "/api/v1/nexum/query": {
+      "post": {
+        "operationId": "nexumQuery",
+        "summary": "Neighbor query on the Nexum canvas",
+        "description": "Body is { nodeId, graphId?, depth? } or { seeds, depth? }. Same read as nexum_query.",
+        "parameters": [{ "$ref": "#/components/parameters/ScopeHeaders" }],
+        "responses": {
+          "200": { "description": "Neighbors" },
+          "502": { "description": "NEXUM_UPSTREAM_UNREACHABLE: the Memorix host cannot reach Nexum explore REST" }
+        }
+      }
+    },
+    "/api/v1/mcp": {
+      "get": {
+        "operationId": "listMcp",
+        "summary": "MCP servers this API can call",
+        "description": "memorix-nexum and memorix-scoper are always listed. memorix-mgc is listed when its URL is configured or discovered from Memorix connectors.",
+        "parameters": [{ "$ref": "#/components/parameters/ScopeHeaders" }],
+        "responses": { "200": { "description": "MCP servers" } }
+      }
+    },
+    "/api/v1/mcp/nexum": {
+      "get": {
+        "operationId": "nexumMcpAdvertise",
+        "summary": "Advertise memorix-nexum",
+        "parameters": [{ "$ref": "#/components/parameters/ScopeHeaders" }],
+        "responses": { "200": { "description": "Advertise document. mcpUrl is this API." } }
+      },
+      "post": {
+        "operationId": "nexumMcpCall",
+        "summary": "JSON-RPC for memorix-nexum",
+        "description": "Methods: initialize, ping, tools/list, tools/call, notifications. Tools: nexum_list_snapshots, nexum_get_snapshot, nexum_get_connected_content, nexum_knowledge_status, nexum_list_entities, nexum_get_entity, nexum_query.",
+        "parameters": [{ "$ref": "#/components/parameters/ScopeHeaders" }],
+        "responses": { "200": { "description": "JSON-RPC result" } }
+      }
+    },
+    "/api/v1/skills": {
+      "get": {
+        "operationId": "skillsInfo",
+        "summary": "Which process answers agent functions",
+        "description": "mode is embedded or external. source is this process or skill-api. baseUrl is present only when mode is external. The choice is fixed for the process lifetime.",
+        "parameters": [{ "$ref": "#/components/parameters/ScopeHeaders" }],
+        "responses": { "200": { "description": "Skills backend" } }
+      }
+    },
+    "/api/v1/agent-functions/agents/{agentId}/functions": {
+      "get": {
+        "operationId": "listAgentFunctions",
+        "summary": "List functions for one agent",
+        "description": "agentId must be one of x-memorix-agent-ids. Each item has origin agent or database. Embedded mode reads the pack catalog. External mode proxies skill-api.",
+        "parameters": [
+          { "$ref": "#/components/parameters/ScopeHeaders" },
+          { "name": "agentId", "in": "path", "required": true, "schema": { "type": "string" } }
+        ],
+        "responses": { "200": { "description": "Function catalog" }, "403": { "description": "FORBIDDEN" } }
+      }
+    },
+    "/api/v1/agent-functions/agents/{agentId}/functions/{functionId}/run": {
+      "post": {
+        "operationId": "runAgentFunction",
+        "summary": "Run one function for a stored subject",
+        "description": "Body is objectType and recordId. Subject rows are read through @x12i/memorix-client when this process hosts the function. A storyInput result is written as content type story.",
+        "parameters": [
+          { "$ref": "#/components/parameters/ScopeHeaders" },
+          { "name": "agentId", "in": "path", "required": true, "schema": { "type": "string" } },
+          { "name": "functionId", "in": "path", "required": true, "schema": { "type": "string" } }
+        ],
+        "responses": {
+          "200": { "description": "FunctionResult with structured and text" },
+          "404": { "description": "NOT_FOUND" },
+          "502": { "description": "MEMORIX_UNREACHABLE or MEMORIX_READ_FAILED" }
+        }
+      }
+    },
+    "/api/v1/agent-functions/agents/{agentId}/functions/{functionId}": {
+      "put": {
+        "operationId": "saveAgentFunction",
+        "summary": "Save a Python function override",
+        "description": "Body is source, and optional question, page, and objectTypes. source must define generate_text. Without ASSISTANT_MONGO_URI or MONGO_URI the embedded host returns 503 PERSISTENCE.",
+        "parameters": [
+          { "$ref": "#/components/parameters/ScopeHeaders" },
+          { "name": "agentId", "in": "path", "required": true, "schema": { "type": "string" } },
+          { "name": "functionId", "in": "path", "required": true, "schema": { "type": "string" } }
+        ],
+        "responses": { "200": { "description": "Saved override" }, "503": { "description": "PERSISTENCE" } }
+      },
+      "delete": {
+        "operationId": "removeAgentFunction",
+        "summary": "Delete a saved function override",
+        "parameters": [
+          { "$ref": "#/components/parameters/ScopeHeaders" },
+          { "name": "agentId", "in": "path", "required": true, "schema": { "type": "string" } },
+          { "name": "functionId", "in": "path", "required": true, "schema": { "type": "string" } }
+        ],
+        "responses": { "200": { "description": "origin agent or removed" }, "503": { "description": "PERSISTENCE" } }
+      }
+    },
+    "/api/v1/scoper": {
+      "get": {
+        "operationId": "scoperInfo",
+        "summary": "Hosted Scoper release",
+        "description": "Reports @x12i/memorix-scoper 2.3.0, the SDK 2.1.2, whether saved functions are attached, mode embedded or external, and the aligned memorix-service 3.17.0, memorix-skills 0.6.0, memorix-client 3.16.3, and ai-dispatcher 2.4.1. Subject reads use @x12i/memorix-client.",
+        "parameters": [{ "$ref": "#/components/parameters/ScopeHeaders" }],
+        "responses": { "200": { "description": "Scoper host" } }
+      }
+    },
+    "/api/v1/scoper/scope": {
+      "post": {
+        "operationId": "scoperScope",
+        "summary": "Run a scope",
+        "description": "Body is a ScopeRequest: profileId, question, and optional focus, budgets, options, hints. Org, agents, and caller come from the call headers. The same fields in the body are ignored. Saved query and scope functions run when SCOPER_FUNCTIONS_DIR is set; otherwise the reasoner answers.",
+        "parameters": [{ "$ref": "#/components/parameters/ScopeHeaders" }],
+        "responses": {
+          "200": { "description": "Evidence bundle" },
+          "400": { "description": "INVALID_REQUEST" }
+        }
+      }
+    },
+    "/api/v1/scoper/subject-data": {
+      "post": {
+        "operationId": "scoperSubjectData",
+        "summary": "Read one subject's content through Scoper",
+        "description": "Body is recordId, objectType, and contentType. Optional alsoContentTypes, sourceContentTypes, include, properties, exclude, and useMarkdown. Scope headers select the org and agents.",
+        "parameters": [{ "$ref": "#/components/parameters/ScopeHeaders" }],
+        "responses": {
+          "200": { "description": "Subject data" },
+          "400": { "description": "INVALID_REQUEST" },
+          "404": { "description": "READ_NOT_FOUND" }
+        }
+      }
+    },
+    "/api/v1/mcp/scoper": {
+      "get": {
+        "operationId": "scoperMcpAdvertise",
+        "summary": "Advertise memorix-scoper",
+        "parameters": [{ "$ref": "#/components/parameters/ScopeHeaders" }],
+        "responses": { "200": { "description": "Advertise document. mcpUrl is this API." } }
+      },
+      "post": {
+        "operationId": "scoperMcpCall",
+        "summary": "JSON-RPC for memorix-scoper",
+        "description": "Methods: initialize, ping, tools/list, tools/call, notifications. Tools: catalog, subjects_list, subjects_query, subject_data, scope.",
+        "parameters": [{ "$ref": "#/components/parameters/ScopeHeaders" }],
+        "responses": { "200": { "description": "JSON-RPC result" } }
+      }
+    },
+    "/api/v1/mcp/mgc": {
+      "get": {
+        "operationId": "mgcMcpAdvertise",
+        "summary": "Advertise memorix-mgc",
+        "parameters": [{ "$ref": "#/components/parameters/ScopeHeaders" }],
+        "responses": { "200": { "description": "MGC advertise" }, "404": { "description": "MGC URL is not configured" } }
+      },
+      "post": {
+        "operationId": "mgcMcpCall",
+        "summary": "JSON-RPC for the MGC connector MCP",
+        "description": "Forwards to the MGC source host /mcp. Stable fetch tools include mgc_list_connectors, mgc_describe_connector, and mgc_fetch.",
+        "parameters": [{ "$ref": "#/components/parameters/ScopeHeaders" }],
+        "responses": { "200": { "description": "JSON-RPC result" }, "404": { "description": "MGC URL is not configured" } }
+      }
+    }
+  },
+  "components": {
+    "parameters": {
+      "ScopeHeaders": {
+        "name": "scope",
+        "in": "header",
+        "required": true,
+        "description": "Send x-memorix-org-id, x-memorix-agent-ids (comma-separated), and x-memorix-caller on every /api/v1 call.",
+        "schema": { "type": "string" }
+      },
+      "ObjectType": {
+        "name": "objectType",
+        "in": "path",
+        "required": true,
+        "schema": { "type": "string" }
+      },
+      "ContentType": {
+        "name": "contentType",
+        "in": "path",
+        "required": true,
+        "schema": { "type": "string" }
+      }
+    }
+  }
+}

package/package.json

@@ -1,6 +1,60 @@
-{
-  "name": "@x12i/memorix-client-api",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+{
+  "name": "@x12i/memorix-client-api",
+  "version": "0.16.0",
+  "description": "Smart-client read API over Memorix, including agent functions, Nexum, Scoper, and MCP. See HANDOVER.md.",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "openapi",
+    "HANDOVER.md"
+  ],
+  "scripts": {
+    "prebuild": "node -e \"require('node:fs').rmSync('dist',{recursive:true,force:true})\"",
+    "build": "tsc -p tsconfig.build.json",
+    "dev": "tsx src/cli.ts",
+    "start": "node dist/cli.js",
+    "test": "vitest run",
+    "typecheck": "tsc --noEmit"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "dependencies": {
+    "@x12i/ai-dispatcher": "^2.4.1",
+    "@x12i/api-live-view": "^1.4.0",
+    "@x12i/authix-sdk": "1.0.1",
+    "@x12i/core-service": "^1.0.1",
+    "@x12i/memorix-agent-assistants": "0.2.0",
+    "@x12i/memorix-client": "^3.16.3",
+    "@x12i/memorix-scoper": "^2.3.0",
+    "@x12i/memorix-scoper-functions": "^0.2.0",
+    "@x12i/memorix-scoper-pagx": "^1.1.0",
+    "@x12i/memorix-scoper-sdk": "^2.1.2",
+    "fastify": "^5.1.0",
+    "mongodb": "^7.7.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.14.0",
+    "tsx": "^4.19.0",
+    "typescript": "^5.6.0",
+    "vitest": "^2.1.0"
+  },
+  "license": "exellix-license",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/x12i/memorix-client-api.git",
+    "directory": "memorix-client-api"
+  }
+}

package/README.md

@@ -1,3 +0,0 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.