@norbix.ai/mcp 0.2.1 → 0.4.0

package/README.md

@@ -165,8 +165,8 @@ NORBIX_HUB_URL=https://hub.norbix.ai norbix-mcp --http --port 3010
 `norbix_get_integrations`, `norbix_get_integration`, `norbix_save_integration`,
 `norbix_test_integration`, `norbix_get_marketplace_integrations`,
 `norbix_save_marketplace_integration`, `norbix_get_database_schemas`,
-`norbix_find_documents`, `norbix_insert_document`, `norbix_update_document`,
-`norbix_get_taxonomy_terms`, `norbix_get_roles`, `norbix_get_policies`,
+`norbix_find_documents`, `norbix_find_one_document`, `norbix_insert_document`,
+`norbix_update_document`, `norbix_get_taxonomy_terms`, `norbix_get_roles`, `norbix_get_policies`,
 `norbix_get_logs`, `norbix_list_service_api_keys`.
 
 Typical flow the model follows for anything not curated:
@@ -192,7 +192,7 @@ The scheduler module switch (`enableScheduler` / `disableScheduler`) is `PUT`.
 
 ## Database tools
 
-Five shortcuts cover the everyday database work. Everything else in the
+Six shortcuts cover the everyday database work. Everything else in the
 Database module (95 endpoints: schemas and drafts, records, taxonomies and
 terms, triggers, aggregates, database integrations) is reached with the
 generic trio.
@@ -200,13 +200,14 @@ generic trio.
 | Tool | SDK method | Route | Input |
 | --- | --- | --- | --- |
 | `norbix_get_database_schemas` | `hub.database.getDatabaseSchemas` | `GET /{version}/database/schemas` | `body` (paging) |
-| `norbix_find_documents` | `api.database.find` | `GET /{version}/database/collections/{collectionName}` | `body`: `collectionName`, `filter` (JSON string), `sortBy`, `pageSize`, … |
+| `norbix_find_documents` | `api.database.find` | `GET /{version}/database/collections/{collectionName}` | `collectionName`, `filter?`, `sortBy?`, `sortOrder?`, `pageSize?`, `startingAfter?`, `endingBefore?`, `expandReferences?`, `databaseIntegrationId?`, `body?` (any other `FindRequest` field) |
+| `norbix_find_one_document` | `api.database.findOne` | `GET /{version}/database/collections/{collectionName}/{id}` | `collectionName`, `id`, `expandReferences?`, `databaseIntegrationId?` |
 | `norbix_insert_document` | `api.database.insertOne` | `POST /{version}/database/collections/{collectionName}` | `collectionName`, `document`, `databaseIntegrationId?` |
-| `norbix_update_document` | `api.database.updateOne` | `PUT /{version}/database/collections/{collectionName}/{id}` | `collectionName`, `id`, `update`, `databaseIntegrationId?` |
+| `norbix_update_document` | `api.database.updateOne` | `PUT /{version}/database/collections/{collectionName}/{id}` | `collectionName`, `id`, `update`, `arrayFilters?`, `databaseIntegrationId?` |
 | `norbix_get_taxonomy_terms` | `api.database.findTerms` | `GET /{version}/database/taxonomies/{taxonomyName}/terms` | `taxonomyName`, `filter?`, `pageSize?`, `sortDescending?`, `databaseIntegrationId?` |
 
 The Api record endpoints expect the document, the update and the filter as a
-JSON **string**. The three newer shortcuts accept an object or a string and
+JSON **string**. The typed shortcuts accept an object or a string and
 send the string, so this works in one call:
 
 ```json
@@ -225,6 +226,31 @@ A `$` operator in it (`$set`, `$inc`, …) is refused with
 filter `{}` is refused (`CM-ERRORS-DATABASE-037`) unless the body also has
 `allRecords: true`.
 
+**References.** A `user`, `role`, `taxonomy` (term), `collection` or `file`
+field stores ids. Pass `expandReferences: true` to `norbix_find_documents` or
+`norbix_find_one_document` and each such field comes back as
+`{ "id": "…", "display": … }` (an array of them when the field is multiple):
+
+```json
+{ "name": "norbix_find_one_document", "arguments": {
+  "collectionName": "posts", "id": "…", "expandReferences": true } }
+```
+
+```json
+{ "author": { "id": "usr_…", "display": "Jane Doe" },
+  "tags":   [ { "id": "6650…", "display": { "title": { "en": "News" }, "slug": "news" } },
+              { "id": "6651…", "display": null } ] }
+```
+
+`display` is the target's `displayField` (a user property, a role name, a
+term's title and slug, a record's chosen field). It is `null` when the target
+is gone **or** when your API key may not read the target — the two cases look
+the same on purpose. Default is off: the stored ids only.
+
+**Arrays inside a document.** `norbix_update_document` takes `arrayFilters`
+for positional paths: `update: { "items.$[i].qty": 2 }` with
+`arrayFilters: [ { "i.sku": "A1" } ]`.
+
 For anything else, search the `database` group:
 
 - `norbix_search_endpoints({ query: "taxonomy term", group: "database" })`
@@ -275,6 +301,12 @@ is written as `feat(...)` with a `Breaking: <what>` line in the body (a
 is the source of truth for the version; release notes are on the GitHub
 Releases page.
 
+The commit analyzer reads only the **start** of each subject, so a step
+number goes at the end (`feat(database): expand references — step 2`),
+never in front of the type: `[2] feat(database): …` is read as "no
+release". Pull request 10 (the schema-content contract) shipped that way
+and needed this follow-up commit to publish 0.3.0.
+
 ## Security notes
 
 - The server can do exactly what the API key can do — nothing more. Scope the

package/dist/manifest/dtos.api.json

@@ -7,6 +7,10 @@
   "base": null,
   "fields": []
  },
+ "IGet": {
+  "base": null,
+  "fields": []
+ },
  "IHasSessionId": {
   "base": null,
   "fields": [
@@ -410,6 +414,36 @@
    }
   ]
  },
+ "EchoAgentSnippetDto": {
+  "base": null,
+  "fields": [
+   {
+    "name": "client",
+    "type": "string",
+    "optional": false
+   },
+   {
+    "name": "kind",
+    "type": "string",
+    "optional": false
+   },
+   {
+    "name": "recommended",
+    "type": "boolean",
+    "optional": false
+   },
+   {
+    "name": "auth",
+    "type": "string",
+    "optional": false
+   },
+   {
+    "name": "config",
+    "type": "string",
+    "optional": false
+   }
+  ]
+ },
  "EchoAgentDto": {
   "base": null,
   "fields": [
@@ -437,6 +471,46 @@
     "name": "toolsUrl",
     "type": "string",
     "optional": false
+   },
+   {
+    "name": "cliPackage",
+    "type": "string",
+    "optional": false
+   },
+   {
+    "name": "cliInstallCommand",
+    "type": "string",
+    "optional": false
+   },
+   {
+    "name": "deviceAuthorizationUrl",
+    "type": "string",
+    "optional": false
+   },
+   {
+    "name": "deviceTokenUrl",
+    "type": "string",
+    "optional": false
+   },
+   {
+    "name": "snippets",
+    "type": "EchoAgentSnippetDto[] = []",
+    "optional": false
+   }
+  ]
+ },
+ "EchoHostingPlatformDto": {
+  "base": null,
+  "fields": [
+   {
+    "name": "provider",
+    "type": "string",
+    "optional": false
+   },
+   {
+    "name": "isAws",
+    "type": "boolean",
+    "optional": false
    }
   ]
  },
@@ -1183,6 +1257,11 @@
     "type": "{ [index: string]: string }",
     "optional": true
    },
+   {
+    "name": "slug",
+    "type": "string",
+    "optional": true
+   },
    {
     "name": "description",
     "type": "string",
@@ -1283,6 +1362,11 @@
     "type": "{ [index: string]: string }",
     "optional": true
    },
+   {
+    "name": "slug",
+    "type": "string",
+    "optional": true
+   },
    {
     "name": "description",
     "type": "string",
@@ -1571,7 +1655,7 @@
    {
     "name": "id",
     "type": "string",
-    "optional": false
+    "optional": true
    },
    {
     "name": "originalFileName",
@@ -1791,6 +1875,16 @@
     "name": "translateOptions",
     "type": "IReadOnlyDictionary<string, string>",
     "optional": true
+   },
+   {
+    "name": "default",
+    "type": "string",
+    "optional": true
+   },
+   {
+    "name": "unique",
+    "type": "boolean",
+    "optional": true
    }
   ]
  },
@@ -1811,6 +1905,31 @@
     "name": "multipleOf",
     "type": "number",
     "optional": true
+   },
+   {
+    "name": "default",
+    "type": "number",
+    "optional": true
+   },
+   {
+    "name": "unique",
+    "type": "boolean",
+    "optional": true
+   }
+  ]
+ },
+ "CurrencyDefaultDto": {
+  "base": null,
+  "fields": [
+   {
+    "name": "value",
+    "type": "number",
+    "optional": false
+   },
+   {
+    "name": "currency",
+    "type": "string",
+    "optional": false
    }
   ]
  },
@@ -1821,12 +1940,38 @@
     "name": "allowedCurrencies",
     "type": "IReadOnlyList<string>",
     "optional": true
+   },
+   {
+    "name": "multipleOf",
+    "type": "number",
+    "optional": true
+   },
+   {
+    "name": "minimum",
+    "type": "number",
+    "optional": true
+   },
+   {
+    "name": "maximum",
+    "type": "number",
+    "optional": true
+   },
+   {
+    "name": "default",
+    "type": "CurrencyDefaultDto",
+    "optional": true
    }
   ]
  },
  "BooleanFieldDto": {
   "base": "JsonSchemaFieldDto",
-  "fields": []
+  "fields": [
+   {
+    "name": "default",
+    "type": "boolean",
+    "optional": true
+   }
+  ]
  },
  "DateFieldDto": {
   "base": "JsonSchemaFieldDto",
@@ -1840,6 +1985,11 @@
     "name": "maximum",
     "type": "number",
     "optional": true
+   },
+   {
+    "name": "default",
+    "type": "number",
+    "optional": true
    }
   ]
  },
@@ -1855,6 +2005,16 @@
     "name": "maximum",
     "type": "number",
     "optional": true
+   },
+   {
+    "name": "default",
+    "type": "number",
+    "optional": true
+   },
+   {
+    "name": "unique",
+    "type": "boolean",
+    "optional": true
    }
   ]
  },
@@ -1870,7 +2030,23 @@
  },
  "TagsFieldDto": {
   "base": "JsonSchemaFieldDto",
-  "fields": []
+  "fields": [
+   {
+    "name": "minItems",
+    "type": "number",
+    "optional": true
+   },
+   {
+    "name": "maxItems",
+    "type": "number",
+    "optional": true
+   },
+   {
+    "name": "default",
+    "type": "IReadOnlyList<string>",
+    "optional": true
+   }
+  ]
  },
  "FileFieldDto": {
   "base": "JsonSchemaFieldDto",
@@ -1879,6 +2055,26 @@
     "name": "storages",
     "type": "IReadOnlyList<string>",
     "optional": true
+   },
+   {
+    "name": "minItems",
+    "type": "number",
+    "optional": true
+   },
+   {
+    "name": "maxItems",
+    "type": "number",
+    "optional": true
+   },
+   {
+    "name": "allowedFileType",
+    "type": "string",
+    "optional": true
+   },
+   {
+    "name": "maxSizeMb",
+    "type": "number",
+    "optional": true
    }
   ]
  },
@@ -1894,6 +2090,11 @@
     "name": "multiple",
     "type": "boolean",
     "optional": false
+   },
+   {
+    "name": "displayField",
+    "type": "string",
+    "optional": true
    }
   ]
  },
@@ -1924,6 +2125,11 @@
     "name": "multiple",
     "type": "boolean",
     "optional": false
+   },
+   {
+    "name": "displayField",
+    "type": "string",
+    "optional": true
    }
   ]
  },
@@ -1934,6 +2140,11 @@
     "name": "multiple",
     "type": "boolean",
     "optional": false
+   },
+   {
+    "name": "displayField",
+    "type": "string",
+    "optional": true
    }
   ]
  },
@@ -1949,6 +2160,61 @@
     "name": "multiple",
     "type": "boolean",
     "optional": false
+   },
+   {
+    "name": "default",
+    "type": "IReadOnlyList<string>",
+    "optional": true
+   }
+  ]
+ },
+ "ObjectFieldDto": {
+  "base": "JsonSchemaFieldDto",
+  "fields": [
+   {
+    "name": "properties",
+    "type": "IReadOnlyList<JsonSchemaFieldDto>",
+    "optional": false
+   },
+   {
+    "name": "required",
+    "type": "IReadOnlyList<string>",
+    "optional": true
+   }
+  ]
+ },
+ "ArrayFieldDto": {
+  "base": "JsonSchemaFieldDto",
+  "fields": [
+   {
+    "name": "items",
+    "type": "JsonSchemaFieldDto",
+    "optional": false
+   },
+   {
+    "name": "minItems",
+    "type": "number",
+    "optional": true
+   },
+   {
+    "name": "maxItems",
+    "type": "number",
+    "optional": true
+   },
+   {
+    "name": "uniqueItems",
+    "type": "boolean",
+    "optional": true
+   }
+  ]
+ },
+ "JsonFieldDto": {
+  "base": "JsonSchemaFieldDto",
+  "fields": [
+   {
+    "name": "maxBytes",
+    "type": "number",
+    "optional": true
    }
   ]
  },
@@ -2069,6 +2335,11 @@
     "name": "agent",
     "type": "EchoAgentDto",
     "optional": true
+   },
+   {
+    "name": "hostingPlatform",
+    "type": "EchoHostingPlatformDto",
+    "optional": true
    }
   ]
  },
@@ -2535,6 +2806,26 @@
    }
   ]
  },
+ "GetFileByIdResponse": {
+  "base": "ResponseBase",
+  "fields": [
+   {
+    "name": "file",
+    "type": "FileResourceRefDto",
+    "optional": true
+   },
+   {
+    "name": "isPublic",
+    "type": "boolean",
+    "optional": true
+   },
+   {
+    "name": "publicUrl",
+    "type": "string",
+    "optional": true
+   }
+  ]
+ },
  "GetFileInfoResponse": {
   "base": "ResponseBase",
   "fields": [
@@ -3986,6 +4277,11 @@
     "name": "sortOrder",
     "type": "number",
     "optional": true
+   },
+   {
+    "name": "expandReferences",
+    "type": "boolean",
+    "optional": false
    }
   ]
  },
@@ -4006,6 +4302,11 @@
     "name": "databaseIntegrationId",
     "type": "string",
     "optional": true
+   },
+   {
+    "name": "expandReferences",
+    "type": "boolean",
+    "optional": false
    }
   ]
  },
@@ -4036,6 +4337,11 @@
     "name": "pagingArgs",
     "type": "PagingArgs",
     "optional": true
+   },
+   {
+    "name": "expandReferences",
+    "type": "boolean",
+    "optional": false
    }
   ]
  },
@@ -4131,6 +4437,11 @@
     "name": "update",
     "type": "string",
     "optional": false
+   },
+   {
+    "name": "arrayFilters",
+    "type": "string",
+    "optional": true
    }
   ]
  },
@@ -4156,6 +4467,11 @@
     "name": "update",
     "type": "string",
     "optional": false
+   },
+   {
+    "name": "arrayFilters",
+    "type": "string",
+    "optional": true
    }
   ]
  },
@@ -4274,6 +4590,21 @@
    }
   ]
  },
+ "GetFileByIdRequest": {
+  "base": "CodeMashRequestBase",
+  "fields": [
+   {
+    "name": "filesIntegrationId",
+    "type": "string",
+    "optional": false
+   },
+   {
+    "name": "id",
+    "type": "string",
+    "optional": false
+   }
+  ]
+ },
  "GetFileInfoRequest": {
   "base": "CodeMashRequestBase",
   "fields": [
@@ -4374,6 +4705,21 @@
    }
   ]
  },
+ "UseFileRequest": {
+  "base": "CodeMashRequestBase",
+  "fields": [
+   {
+    "name": "filesIntegrationId",
+    "type": "string",
+    "optional": false
+   },
+   {
+    "name": "path",
+    "type": "string",
+    "optional": false
+   }
+  ]
+ },
  "Authenticate": {
   "base": null,
   "fields": [