@vectros-ai/mcp-server 0.17.0 → 0.17.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/cli.js CHANGED
@@ -3425,6 +3425,7 @@ var AuthClient = class {
3425
3425
  *
3426
3426
  * @throws {@link Vectros.ForbiddenError}
3427
3427
  * @throws {@link Vectros.NotFoundError}
3428
+ * @throws {@link Vectros.ConflictError}
3428
3429
  * @throws {@link Vectros.TooManyRequestsError}
3429
3430
  *
3430
3431
  * @example
@@ -3467,6 +3468,8 @@ var AuthClient = class {
3467
3468
  throw new ForbiddenError(_response.error.body, _response.rawResponse);
3468
3469
  case 404:
3469
3470
  throw new NotFoundError(_response.error.body, _response.rawResponse);
3471
+ case 409:
3472
+ throw new ConflictError(_response.error.body, _response.rawResponse);
3470
3473
  case 429:
3471
3474
  throw new TooManyRequestsError(_response.error.body, _response.rawResponse);
3472
3475
  default:
@@ -3543,7 +3546,7 @@ var AuthClient = class {
3543
3546
  return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/app-contexts/{contextId}");
3544
3547
  }
3545
3548
  /**
3546
- * Updates the name, description, and/or companyName of an app context. This is a partial update: any field you omit (or send as null) keeps its existing value. The `contextId` is immutable and is taken from the URL path, so any `contextId` in the request body is ignored. Requires the `app-contexts:u` scope.
3549
+ * Updates an app context. This is a partial update: any field you omit (or send as null) keeps its existing value. The `contextId` is immutable and is taken from the URL path, so any `contextId` in the request body is ignored. Patchable fields: `name`, `description`, `companyName`; the per-principal metering trio (`meteringAxis`, `principalBurstLimit`, `principalUsageCap` — only takes effect for a partner with the corresponding account-level feature enabled); `readAccessLogDefault` (the PHI read-access-logging context default); and `identityProjectionClaims` (requires the platform provisioning capability on top of the ordinary scope below — see its own field description). Requires the `app-contexts:u` scope.
3547
3550
  *
3548
3551
  * @param {Vectros.UpdateAppContextRequest} request
3549
3552
  * @param {AuthClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -3611,7 +3614,7 @@ var AuthClient = class {
3611
3614
  return handleNonStatusCodeError(_response.error, _response.rawResponse, "PUT", "/v1/app-contexts/{contextId}");
3612
3615
  }
3613
3616
  /**
3614
- * Permanently deletes an app context and everything in it — every record, document, folder, schema, role, and access profile belonging to the context. This is irreversible. The deletion runs asynchronously: the call returns 202 immediately and the context's data drains in the background. Poll the context's `status` field to observe when the teardown completes (`purging` while draining, then `deleted`). To guard against accidental deletion, you must echo the contextId back in the `confirm` query parameter (`?confirm={contextId}`). The reserved `default` and `vectros-admin` contexts cannot be deleted. This operation requires a root API key (one beginning with `sk_`): no scoped credential, not even one with full wildcard (`*`) scope, can trigger this teardown.
3617
+ * Permanently deletes an app context and everything in it — every record, document, folder, schema, role, access profile, and trusted-issuer registration belonging to the context. This is irreversible. The deletion runs asynchronously: the call returns 202 immediately and the context's data drains in the background. Poll the context's `status` field to observe when the teardown completes (`purging` while draining, then `deleted`). To guard against accidental deletion, you must echo the contextId back in the `confirm` query parameter (`?confirm={contextId}`). The reserved `default` and `vectros-admin` contexts cannot be deleted. This operation requires a root API key (one beginning with `sk_`): no scoped credential, not even one with full wildcard (`*`) scope, can trigger this teardown.
3615
3618
  *
3616
3619
  * @param {Vectros.DeleteAppContextRequest} request
3617
3620
  * @param {AuthClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -4146,7 +4149,7 @@ var AuthClient = class {
4146
4149
  return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/auth/issuers/{issuerId}");
4147
4150
  }
4148
4151
  /**
4149
- * Updates the mutable fields of a registered issuer: `subClaim`, `emailClaim`, `status` (`active`/`suspended` — a suspended issuer's tokens are rejected identically to an unregistered issuer at exchange time), and `selfSignupPolicies`. Fields omitted from the body are left unchanged (partial update). `issuer`, `jwksUri`, `audience`, and `contextId` are trust-anchor / routing-pin fields and are immutable via this route — supplying a value that differs from the current registration is rejected with 400; supplying the current value back is a no-op. Rotating a trust anchor requires deleting and re-registering the issuer, which is itself refused while any user is bound through it. Requires a root API key or the bootstrap's provisioning capability, gated identically to every other operation on this surface. A credential confined to one app context may only update an issuer registered in that context; naming one registered in another context returns 404, identically to a nonexistent issuerId. A root API key may update any issuer.
4152
+ * Updates the mutable fields of a registered issuer: `subClaim`, `emailClaim`, `userinfoUri`, `capturedClaims`, `restrictedToDomain` (a new non-blank value must already be a VERIFIED domain for your account; an empty string clears it back to domain-less; see `IssuerUpdateRequest.restrictedToDomain` for the full semantics), `status` (`active`/`suspended` — a registration awaiting verification (`pending_verification`) accepts no status change until it is verified; a suspended issuer's tokens are rejected identically to an unregistered issuer at exchange time), and `selfSignupPolicies`. Fields omitted from the body are left unchanged (partial update). `issuer`, `jwksUri`, `audience`, and `contextId` are trust-anchor / routing-pin fields and are immutable via this route — supplying a value that differs from the current registration is rejected with 400; supplying the current value back is a no-op. Rotating a trust anchor requires deleting and re-registering the issuer, which is itself refused while any user is bound through it. **`subClaim` is identity-determining, not merely cosmetic**: it names which verified JWT claim is read as the federated user's identifier, so changing it on an issuer that already has bound users would silently re-identify (or, under self-signup, orphan) every one of them — changing it is therefore refused once any user has bound through this issuer, the same guard `DELETE` already applies, and is only free before the first real login. Requires a root API key or the bootstrap's provisioning capability, gated identically to every other operation on this surface. A credential confined to one app context may only update an issuer registered in that context; naming one registered in another context returns 404, identically to a nonexistent issuerId. A root API key may update any issuer.
4150
4153
  *
4151
4154
  * @param {Vectros.IssuerUpdateRequest} request
4152
4155
  * @param {AuthClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -4213,7 +4216,7 @@ var AuthClient = class {
4213
4216
  return handleNonStatusCodeError(_response.error, _response.rawResponse, "PUT", "/v1/auth/issuers/{issuerId}");
4214
4217
  }
4215
4218
  /**
4216
- * Deregisters a trusted third-party IdP issuer. Requires a root API key or the bootstrap's provisioning capability. A credential confined to one app context may only deregister an issuer registered in that context; naming one registered in another context returns 404, identically to a nonexistent issuerId. A root API key may deregister any issuer. Refused if any user account was ever created or matched via this issuer (by a prior self-signup or accepted invite, through `POST /v1/auth/token/exchange`) — that access cannot be silently orphaned. Deactivate the affected users first if you intend to cut off their access, or register a replacement issuer before removing this one. An issuer that has never been used for an exchange (no bound users yet) can always be deregistered.
4219
+ * Deregisters a trusted third-party IdP issuer. Requires a root API key or the bootstrap's provisioning capability. A credential confined to one app context may only deregister an issuer registered in that context; naming one registered in another context returns 404, identically to a nonexistent issuerId. A root API key may deregister any issuer. Refused if any user account was ever created or matched via this issuer (by a prior self-signup or accepted invite, through `POST /v1/auth/token/exchange`) — that access cannot be silently orphaned. This is unconditional on the affected users' `status`: suspending them first does not lift the refusal. **A bound registration cannot be replaced, self-service, within its own app context**: registering a replacement issuer under a different issuerId in the SAME context also fails, because the context's one-active-issuer claim is released only when THIS registration is deleted. Two real options: suspend this issuer (stops new exchanges immediately) and register a replacement under a DIFFERENT app context — note that targets a different context, so this context's existing users/roles/access profiles are not carried over; or contact your platform operator, who can force-release this registration so a replacement may be registered in the SAME context under a new issuerId. **The operator path is not a lighter-weight alternative to the first — it PERMANENTLY RETIRES this issuerId and leaves every bound user unable to ever exchange through it again; it does not preserve continuity for them any better than registering under a different context does.** An issuer that has never been used for an exchange (no bound users yet) can always be deregistered.
4217
4220
  *
4218
4221
  * @param {Vectros.DeleteIssuerRequest} request
4219
4222
  * @param {AuthClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -4339,7 +4342,7 @@ var AuthClient = class {
4339
4342
  return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/auth/issuers");
4340
4343
  }
4341
4344
  /**
4342
- * Registers a trusted third-party IdP issuer that BYO-IdP token exchange (`POST /v1/auth/token/exchange`) may accept a `subject_token` from. Requires a root API key or the CLI bootstrap's provisioning capability — never an ordinary partner-grantable scope. A credential authorized only via the provisioning capability may register only against the app context it is bound to; naming a different one returns 403. A root API key is unaffected and may register against any of its contexts. Idempotent by `issuerId` within your tenant; the `(issuer, audience)` pair must not already be registered by a different issuerId/tenant. If `issuerId` collides with a registration owned by a different app context than the one you're confined to, the request fails with 400 rather than returning that context's configuration. An app context may have at most one active issuer — deregister the existing one first if you need to replace it. One issuer MAY serve several contexts today, each via its own registration row with a distinct `audience`.
4345
+ * Registers a trusted third-party IdP issuer that BYO-IdP token exchange (`POST /v1/auth/token/exchange`) may accept a `subject_token` from. Requires a root API key or the CLI bootstrap's provisioning capability — never an ordinary partner-grantable scope. A credential authorized only via the provisioning capability may register only against the app context it is bound to; naming a different one returns 403. A root API key is unaffected and may register against any of its contexts. A registration without `restrictedToDomain` is created `pending_verification` with a one-time challenge (`verificationClaim`, `verificationNonce`, `verificationExpiresAt`) and accepts no token until you prove you control the issuer with `POST /v1/auth/issuers/{issuerId}/verify`; it claims no `(issuer, audience)` pair until then, so registering never reveals whether another tenant holds one. A registration scoped to an already-verified domain with `restrictedToDomain` is `active` at once. Idempotent by `issuerId` within your tenant. If `issuerId` collides with a registration owned by a different app context than the one you're confined to, the request fails with 400 rather than returning that context's configuration. An app context may have at most one active issuer — deregister the existing one first if you need to replace it. One issuer MAY serve several contexts today, each via its own registration row with a distinct `audience`. Optionally name `restrictedToDomain` to scope this registration's (issuer, audience) uniqueness to a specific VERIFIED domain rather than the bare pair — see that field's own description. A domain-scoped registration proves control of the DOMAIN, not of the issuer itself: it routes only tokens carrying that domain's `hd` claim.
4343
4346
  *
4344
4347
  * @param {Vectros.IssuerRequest} request
4345
4348
  * @param {AuthClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -4405,6 +4408,82 @@ var AuthClient = class {
4405
4408
  }
4406
4409
  return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v1/auth/issuers");
4407
4410
  }
4411
+ /**
4412
+ * Proves you administer the IdP application a `pending_verification` registration names, activating it. A registration created without `restrictedToDomain` accepts no tokens until this succeeds. Configure your IdP, with an admin-controlled rule (an Auth0 Action, an Okta inline hook, an Entra claims-mapping policy, a Keycloak protocol mapper), to add the registration's `verificationClaim` to the tokens it issues, set to its `verificationNonce`; sign in once; and send that token here. The `jwksUri` you registered must be exactly the `jwks_uri` your issuer's OpenID Connect discovery document (`<issuer>/.well-known/openid-configuration`) publishes, and the token must verify against that key set — an issuer that publishes no discovery document cannot be verified this way. The token is checked and discarded; it is never stored. The `(issuer, audience)` pair is claimed at this moment, so a pair another registration already holds is refused with 400. A challenge expires 7 days after registration; an expired registration cannot be verified — delete it and register again. Requires a root API key or the bootstrap's provisioning capability, gated identically to every other operation on this surface. A credential confined to one app context may only verify an issuer registered in that context; naming one registered in another context returns 404, identically to a nonexistent issuerId.
4413
+ *
4414
+ * @param {Vectros.IssuerVerifyRequest} request
4415
+ * @param {AuthClient.RequestOptions} requestOptions - Request-specific configuration.
4416
+ *
4417
+ * @throws {@link Vectros.BadRequestError}
4418
+ * @throws {@link Vectros.ForbiddenError}
4419
+ * @throws {@link Vectros.NotFoundError}
4420
+ * @throws {@link Vectros.ConflictError}
4421
+ * @throws {@link Vectros.TooManyRequestsError}
4422
+ *
4423
+ * @example
4424
+ * await client.auth.verifyIssuer({
4425
+ * issuerId: "auth0-prod",
4426
+ * token: "token"
4427
+ * })
4428
+ */
4429
+ verifyIssuer(request, requestOptions) {
4430
+ return HttpResponsePromise.fromPromise(this.__verifyIssuer(request, requestOptions));
4431
+ }
4432
+ async __verifyIssuer(request, requestOptions) {
4433
+ const { issuerId, ..._body } = request;
4434
+ const _authRequest = await this._options.authProvider.getAuthRequest();
4435
+ const _headers = mergeHeaders(
4436
+ _authRequest.headers,
4437
+ this._options?.headers,
4438
+ requestOptions?.headers
4439
+ );
4440
+ const _response = await fetcher({
4441
+ url: url_exports.join(
4442
+ await Supplier.get(this._options.baseUrl) ?? await Supplier.get(this._options.environment),
4443
+ `v1/auth/issuers/${url_exports.encodePathParam(issuerId)}/verify`
4444
+ ),
4445
+ method: "POST",
4446
+ headers: _headers,
4447
+ contentType: "application/json",
4448
+ queryString: url_exports.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
4449
+ requestType: "json",
4450
+ body: _body,
4451
+ timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1e3,
4452
+ maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
4453
+ abortSignal: requestOptions?.abortSignal,
4454
+ fetchFn: this._options?.fetch,
4455
+ logging: this._options.logging
4456
+ });
4457
+ if (_response.ok) {
4458
+ return { data: _response.body, rawResponse: _response.rawResponse };
4459
+ }
4460
+ if (_response.error.reason === "status-code") {
4461
+ switch (_response.error.statusCode) {
4462
+ case 400:
4463
+ throw new BadRequestError(_response.error.body, _response.rawResponse);
4464
+ case 403:
4465
+ throw new ForbiddenError(_response.error.body, _response.rawResponse);
4466
+ case 404:
4467
+ throw new NotFoundError(_response.error.body, _response.rawResponse);
4468
+ case 409:
4469
+ throw new ConflictError(_response.error.body, _response.rawResponse);
4470
+ case 429:
4471
+ throw new TooManyRequestsError(_response.error.body, _response.rawResponse);
4472
+ default:
4473
+ throw new VectrosError({
4474
+ statusCode: _response.error.statusCode,
4475
+ body: _response.error.body,
4476
+ rawResponse: _response.rawResponse
4477
+ });
4478
+ }
4479
+ }
4480
+ return handleNonStatusCodeError(
4481
+ _response.error,
4482
+ _response.rawResponse,
4483
+ "POST",
4484
+ "/v1/auth/issuers/{issuerId}/verify"
4485
+ );
4486
+ }
4408
4487
  /**
4409
4488
  * Returns the identity bound to your credential — your account, principal type, key id, and scope details — so you can confirm who you are authenticated as and that the credential is valid. MCP clients use this to render "signed in as ..." in a chat UI without a separate identity endpoint.
4410
4489
  *
@@ -5837,7 +5916,7 @@ var DocumentsClient = class {
5837
5916
  return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/documents/{id}/versions");
5838
5917
  }
5839
5918
  /**
5840
- * Starts a file-based document by returning a short-lived presigned S3 PUT URL. Upload the file bytes directly to `uploadUrl`; the document is then automatically queued for text extraction and asynchronous indexing. Supplying an `externalId` makes this idempotent — re-initiating an upload with the same `externalId` re-issues a fresh presigned URL to the SAME existing document/object (so a re-upload inherently replaces the file body) rather than creating a duplicate. The response's `created` field (and the HTTP status — 201 when a new document was minted, 200 when an existing one was matched) tells the two apart. With `?upsert=true`, the submitted `payload`/`title` are also applied to the matched document (file-body divergence cannot be diffed at upload-init — the bytes have not arrived yet — so the re-upload itself replaces the body). Creating a NEW document requires the `documents:c` scope. Re-uploading over an EXISTING document overwrites (and re-indexes) its body, so it is an update: it requires the `documents:u` scope (as does `?upsert=true` for the metadata).
5919
+ * Starts a file-based document by returning a short-lived presigned S3 PUT URL. Upload the file bytes directly to `uploadUrl`; the document is then automatically queued for text extraction and asynchronous indexing. Supplying an `externalId` makes this idempotent — re-initiating an upload with the same `externalId` re-issues a fresh presigned URL for the SAME existing document, targeting a newly-staged object rather than the document's current one — your PUT lands there first, and the document only adopts it once the upload is validated (so a re-upload inherently replaces the file body) rather than creating a duplicate. The response's `created` field (and the HTTP status — 201 when a new document was minted, 200 when an existing one was matched) tells the two apart. With `?upsert=true`, the submitted `payload`/`title` are also applied to the matched document (file-body divergence cannot be diffed at upload-init — the bytes have not arrived yet — so the re-upload itself replaces the body). Creating a NEW document requires the `documents:c` scope. Re-uploading over an EXISTING document overwrites (and re-indexes) its body, so it is an update: it requires the `documents:u` scope (as does `?upsert=true` for the metadata). **Your PUT to `uploadUrl` MUST include the header named in the response's `requiredHeaderName`, set to `requiredHeaderValue` exactly.** It is a signed part of the presigned request — the PUT never reaches this service either way, so neither failure uses this API's JSON error shape. Omitting it, or sending a different value, invalidates the request's signature and S3 rejects it with a 403 `SignatureDoesNotMatch`. Sending it correctly makes the URL single-use: `requiredHeaderName` is always `If-None-Match` and `requiredHeaderValue` is always `*` — a create, a recovery upload for a document whose earlier file is missing, and a re-upload ALL target a freshly-minted, never-written key, so the same S3 conditional-write precondition applies uniformly (S3's own documented conditional-write behavior): a replay after the object already exists (from your own completed PUT, or anyone else's) fails with `412 Precondition Failed`; a replay after the object was deleted and never re-created finds an absent key again and can succeed — single-use is a property of the object's existence, not a one-time token. **Either precondition can also fail with `409 Conflict` if your PUT genuinely races a concurrent delete on the same object.** Whichever of `412` or `409` you receive, the remedy is the same: call this endpoint again for a fresh URL rather than retrying the same PUT — a fresh call always targets a new key, so it is never subject to whatever raced the previous one.
5841
5920
  *
5842
5921
  * @param {Vectros.FileUploadRequest} request
5843
5922
  * @param {DocumentsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -7603,7 +7682,7 @@ var IdentityClient = class {
7603
7682
  return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/users/exists-by-email");
7604
7683
  }
7605
7684
  /**
7606
- * Returns the audit trail of changes to a user, most recent first. Identity history is always recorded and always available. Sensitive field values are redacted in every historical version. Returns a page in the `{data, nextCursor}` envelope. Requires the `users:r` scope.
7685
+ * Returns the audit trail of changes to a user, most recent first, including after the user has been deleted. Identity history is always recorded. Post-delete, this is readable by an account-level (root) API key only — a context-confined credential 404s after the delete, the same response it would get for a nonexistent id. Sensitive field values are redacted in every historical version. Returns a page in the `{data, nextCursor}` envelope. Requires the `users:r` scope.
7607
7686
  *
7608
7687
  * @param {Vectros.GetUserVersionsRequest} request
7609
7688
  * @param {IdentityClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -8673,7 +8752,7 @@ var RecordsClient = class {
8673
8752
  return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v1/records/lookup");
8674
8753
  }
8675
8754
  /**
8676
- * Returns the tombstone left behind when a record was hard-deleted, confirming the deletion and recording when it happened. Look it up using the deleted record's original ID. Requires the `records:r:<type>` scope.
8755
+ * Returns the tombstone left behind when a record was hard-deleted, confirming the deletion and recording when it happened. Look it up using the deleted record's original ID. Requires the `records:r:<type>` scope, granted without a `data_scope` restriction: the owner of a deleted record cannot be checked, so a credential confined to an ownership compartment (e.g. `data_scope: {scope:org: [org_A]}`) cannot read tombstones, including for records it owned.
8677
8756
  *
8678
8757
  * @param {Vectros.GetRecordTombstoneRequest} request
8679
8758
  * @param {RecordsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -9080,7 +9159,7 @@ var SchemasClient = class {
9080
9159
  return handleNonStatusCodeError(_response.error, _response.rawResponse, "PUT", "/v1/schemas/{id}");
9081
9160
  }
9082
9161
  /**
9083
- * Permanently deletes a record schema. The request is refused with 409 if records of this type still exist — delete those records first, since every record must reference a live schema. A lineage base (a schema other schemas declare `basedOn`) also cannot be deleted while any such variant still exists — delete the variant schema(s) first. It is likewise refused while any trigger rule fires off this schema — delete those trigger rules first. Requires the `schemas:d` scope.
9162
+ * Permanently deletes a record schema. The request is refused with 409 if records of this type still exist — delete those records first, since every record must reference a live schema. The same applies to documents bound to this schema (for a schema declaring the `document` surface) — delete those documents first. A lineage base (a schema other schemas declare `basedOn`) also cannot be deleted while any such variant still exists — delete the variant schema(s) first. It is likewise refused while any trigger rule fires off this schema — delete those trigger rules first. Requires the `schemas:d` scope.
9084
9163
  *
9085
9164
  * @param {Vectros.DeleteSchemaRequest} request
9086
9165
  * @param {SchemasClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -9215,7 +9294,7 @@ var ScriptsClient = class {
9215
9294
  *
9216
9295
  * **Budget.** Seconds of useful work: the script has 15 s of wall clock (never more than 16) and a bounded number of statements and host calls; a runaway script is stopped early with `RESOURCE_LIMIT_EXCEEDED`. The transaction is bounded by the number of underlying storage rows it writes — 100 rows after merging — rather than by the number of entities: creating a folder costs 3 rows; creating a plain text document or a record costs 1 row plus one per range-indexed lookup field plus one per `reference` field. So "create a folder and file N documents" holds up to 97 plain documents, 48 with one range field or one reference, 32 with both; if a script exceeds the limit the error says so (`WRITE_BUFFER_CAP_EXCEEDED`, with `total` and `limit`) and nothing is committed. This request takes the write-path limits (burst, credit ceiling, principal quota) once, before the script runs — there is no free-read allowance here, so an account over its credit ceiling is refused even for a read-only script. Reads the script performs are metered as reads, writes as writes, and execution time beyond what those operations include is charged as script execution time (see `GET /v1/usage`).
9217
9296
  *
9218
- * **Reads inside the script.** A `get` sees the script's own staged writes. A list, query or lookup never shows a row the script has deleted, shows a row it re-saved with the updated content, and does not yet show a row it created — you hold that row's id from `create()`.
9297
+ * **Reads inside the script.** A `get` sees the script's own staged writes. A list, query or lookup never shows a row the script has deleted, shows a row it re-saved with the updated content, and does not show a row it created — you hold that row's id from `create()`.
9219
9298
  *
9220
9299
  * **Retries.** Send an optional `Idempotency-Key` header (1–128 characters of letters, digits, `.`, `_`, `:` or `-`) to make a retry safe: a request repeated under the same key within 24 hours receives the same response as the first attempt without executing again — when that first attempt SUCCEEDED (a duplicate still in flight is refused with `409 IDEMPOTENCY_IN_PROGRESS`; the same key on a different request is refused with `422 IDEMPOTENCY_KEY_REUSED`). A first attempt that FAILED with any other status is not remembered: the same key is free to try again, so a retry after a `400` or a `429` executes. If an execution's outcome cannot be determined — the script did not finish inside the budget while its writes may have committed — the response is `500 EXECUTION_OUTCOME_UNKNOWN` carrying `execution.id`, and a keyed retry receives that same answer: inspect what the script would have written, then use a NEW key for a new attempt. When a key is present the serialised `result` is capped at 16 KB instead of 256 KB. Without a key, a lost response cannot be distinguished from a failed one; re-read before retrying.
9221
9300
  *
@@ -9310,11 +9389,14 @@ var ScriptsClient = class {
9310
9389
  return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v1/scripts/execute");
9311
9390
  }
9312
9391
  /**
9313
- * Returns a paginated list of your scripts. Pass `name` to list every version of one script name (oldest first); omit it for a flat list across every name in your account (newest first). Results are returned as a `{data, nextCursor}` envelope — pass `nextCursor` as `startFrom` to fetch the next page. Requires the `scripts:r` scope.
9392
+ * Returns a paginated list of your scripts. Pass `name` to list every version of one script name (oldest first); omit it for a flat list across every name in your account (newest first). Results are returned as a `{data, nextCursor}` envelope — pass `nextCursor` as `startFrom` to fetch the next page. Requires the `scripts:r` scope. **Each row's `source` is omitted by default** (`sourceOmitted: true`) — scripts are immutable per version, so a name's version history can otherwise carry every version's complete source in one response. Pass `?includeSource=true` to get it back inline, or fetch one version's full source with a by-id GET. **`?name=<n>&latest=true`** answers "what is the current version of this name" in one bounded call — a single `ScriptResponse` object (not a page), instead of draining every page of the name's version history to find the newest yourself.
9314
9393
  *
9315
9394
  * @param {Vectros.ListScriptsRequest} request
9316
9395
  * @param {ScriptsClient.RequestOptions} requestOptions - Request-specific configuration.
9317
9396
  *
9397
+ * @throws {@link Vectros.BadRequestError}
9398
+ * @throws {@link Vectros.NotFoundError}
9399
+ *
9318
9400
  * @example
9319
9401
  * await client.scripts.listScripts({
9320
9402
  * name: "notify-assignee",
@@ -9325,11 +9407,13 @@ var ScriptsClient = class {
9325
9407
  return HttpResponsePromise.fromPromise(this.__listScripts(request, requestOptions));
9326
9408
  }
9327
9409
  async __listScripts(request = {}, requestOptions) {
9328
- const { name, startFrom, limit } = request;
9410
+ const { name, startFrom, limit, includeSource, latest } = request;
9329
9411
  const _queryParams = {
9330
9412
  name,
9331
9413
  startFrom,
9332
- limit
9414
+ limit,
9415
+ includeSource,
9416
+ latest
9333
9417
  };
9334
9418
  const _authRequest = await this._options.authProvider.getAuthRequest();
9335
9419
  const _headers = mergeHeaders(
@@ -9355,16 +9439,23 @@ var ScriptsClient = class {
9355
9439
  return { data: _response.body, rawResponse: _response.rawResponse };
9356
9440
  }
9357
9441
  if (_response.error.reason === "status-code") {
9358
- throw new VectrosError({
9359
- statusCode: _response.error.statusCode,
9360
- body: _response.error.body,
9361
- rawResponse: _response.rawResponse
9362
- });
9442
+ switch (_response.error.statusCode) {
9443
+ case 400:
9444
+ throw new BadRequestError(_response.error.body, _response.rawResponse);
9445
+ case 404:
9446
+ throw new NotFoundError(_response.error.body, _response.rawResponse);
9447
+ default:
9448
+ throw new VectrosError({
9449
+ statusCode: _response.error.statusCode,
9450
+ body: _response.error.body,
9451
+ rawResponse: _response.rawResponse
9452
+ });
9453
+ }
9363
9454
  }
9364
9455
  return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/scripts");
9365
9456
  }
9366
9457
  /**
9367
- * Stores a new version of a script object. Every POST creates a genuinely new version — this is NOT idempotent-by-name: pushing `name` again always creates a new row with `scriptVersion` auto-incremented (the first version pushed for a name is 1). `source` is stored as-is: nothing parses or validates it at push time. A version runs when a trigger rule references it (`POST /v1/triggers`) or when `POST /v1/scripts/execute` names it. Requires the `scripts:c` scope.
9458
+ * Stores a new version of a script object. Every POST creates a genuinely new version — this is NOT idempotent-by-name: pushing `name` again always creates a new row with `scriptVersion` auto-incremented (the first version pushed for a name is 1). `source` is stored as-is: nothing parses or validates it at push time. A version runs when a trigger rule references it (`POST /v1/triggers`) or when `POST /v1/scripts/execute` names it. `provisionedBy` MAY BE SET ON ABSENT, NEVER CHANGED, evaluated against the CURRENT LATEST version of this `name` at push time: if the latest version has no marker recorded, this push may set any value; if the latest version already has one, an omitted value inherits it forward and a DIFFERENT value is refused — a live comparison against whichever version is newest at push time, not a value fixed for the name's whole history. Pushing onto an EXISTING name with no `provisionedBy` recorded on its current latest version additionally requires that you were the caller who pushed that latest version — a name carrying a `provisionedBy` marker is exempt from this check (proving you can supply or inherit the matching marker is itself the ownership proof there). Requires the `scripts:c` scope.
9368
9459
  *
9369
9460
  * @param {Vectros.ScriptRequest} request
9370
9461
  * @param {ScriptsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -9551,12 +9642,13 @@ var ScriptsClient = class {
9551
9642
  return handleNonStatusCodeError(_response.error, _response.rawResponse, "PUT", "/v1/scripts/{id}");
9552
9643
  }
9553
9644
  /**
9554
- * Permanently deletes one script version by ID. Deleting one version does not affect any other version of the same name. Requires the `scripts:d` scope.
9645
+ * Permanently deletes one script version by ID. Deleting one version does not affect any other version of the same name. Requires the `scripts:d` scope. Refused with 409 if a live trigger rule still references this version — either directly (a pinned `scriptRef`), or via `"latest"` when this IS the newest version of its name. Delete or re-point those rules first.
9555
9646
  *
9556
9647
  * @param {Vectros.DeleteScriptRequest} request
9557
9648
  * @param {ScriptsClient.RequestOptions} requestOptions - Request-specific configuration.
9558
9649
  *
9559
9650
  * @throws {@link Vectros.NotFoundError}
9651
+ * @throws {@link Vectros.ConflictError}
9560
9652
  * @throws {@link Vectros.TooManyRequestsError}
9561
9653
  *
9562
9654
  * @example
@@ -9596,6 +9688,8 @@ var ScriptsClient = class {
9596
9688
  switch (_response.error.statusCode) {
9597
9689
  case 404:
9598
9690
  throw new NotFoundError(_response.error.body, _response.rawResponse);
9691
+ case 409:
9692
+ throw new ConflictError(_response.error.body, _response.rawResponse);
9599
9693
  case 429:
9600
9694
  throw new TooManyRequestsError(_response.error.body, _response.rawResponse);
9601
9695
  default:
@@ -10183,8 +10277,8 @@ function warnOnSuboptimalKey(key, log) {
10183
10277
 
10184
10278
  // src/build-info.ts
10185
10279
  var BUILD_INFO = {
10186
- mcpServer: true ? "0.17.0" : "dev",
10187
- sdk: true ? "0.43.0" : "dev"
10280
+ mcpServer: true ? "0.17.2" : "dev",
10281
+ sdk: true ? "0.45.0" : "dev"
10188
10282
  };
10189
10283
  function formatBuildInfo() {
10190
10284
  return `vectros-mcp-server ${BUILD_INFO.mcpServer} (sdk ${BUILD_INFO.sdk})`;
@@ -10523,6 +10617,8 @@ var hybridSearch = ({ client, log }) => ({
10523
10617
  title: "Hybrid search",
10524
10618
  description: 'Search your tenant\'s indexed content (documents + structured records) using hybrid BM25 + dense ranking. Returns up to `limit` results (default 3, max 50 \u2014 raise it in one call when you can accept the larger result) with citations and surrounding context for grounding follow-up reasoning. Narrow with contentTypes/typeName/filters, ownership (userId, and scope for ONE ownership dimension or scopeFilters for several at once \u2014 e.g. one client within one org), folder scope, a created date window, keyword precision (textMode OR/AND/PHRASE), relevance floors (minSimilarity/minTextRelevance), uniqueDocuments, and requireComplete (fail closed on a degraded backend). Tenant-isolated; the caller\'s scoped key fully constrains which content is visible. ARCHIVED (soft-retracted) documents AND records are excluded from results \u2014 fetch them by id via document_get/record_get, or restore them by setting status back to ACTIVE. One exception to know: an item archived before the platform enforced this can still be returned here until it is next written to, and nothing sweeps for those \u2014 if an archived item does come back as a hit, re-send status ARCHIVED on it (document_update / record_update) to re-assert the retraction. A hit\'s `createdAt` is when the item entered the search INDEX, which is the moment it was created in the common case but is later for anything re-indexed since \u2014 so do not report it to a user as the creation time; fetch the item with document_get/record_get and read its own createdAt for that. (The createdAfter/createdBefore filters are a separate thing and do filter on true creation time.) To stay within the agent context window each hit returns its matched chunkText + a short snippet by default; set includeContext:true for the broader surrounding passage. If the whole result would be too large it is truncated to the top hits (truncated:true). totalResults is the full matching pool and hasMore:true means results remain past this page \u2014 raise limit or advance offset to fetch them. textLegEmpty:true flags that the keyword (BM25) leg matched nothing (all textScores 0) \u2014 typically the default PHRASE mode finding no contiguous match for a long natural-language query. Loosen the keyword leg: shorten the query to its key terms, or set textMode "AND" (all terms, higher precision) or "OR" (any term, broad recall).',
10525
10619
  inputSchema,
10620
+ // A pure read — never creates, modifies, or deletes anything server-side.
10621
+ annotations: { readOnlyHint: true, destructiveHint: false, idempotentHint: true },
10526
10622
  handler: async (args) => {
10527
10623
  const limit = args.limit ?? MCP_DEFAULT_LIMIT;
10528
10624
  const mode = args.mode ?? "HYBRID";
@@ -10671,6 +10767,8 @@ var recordQuery = ({ client, log }) => ({
10671
10767
  title: "Record query (list or lookup)",
10672
10768
  description: "Query structured records of a given type. Two modes:\n \u2022 Lookup on a lookup-indexed field: pass `field` plus exactly one of `value` (exact), `values` (exact, composite \u2014 one value per field; a single-element array is the same as `value`), `from`+`to` (range), or `prefix`. `values` with more than one entry, or a comma-joined `field`, ONLY works for a lookup the schema itself declared over several fields together \u2014 check list_schemas' lookupFields for a fieldNames entry, then pass those field names comma-joined as `field`; `from`/`to`/`prefix` are not valid there. Works on sensitive fields too. Optionally narrow an exact match to a window with `sortFrom`/`sortTo`.\n \u2022 List: omit `field`, then choose ONE of `type` (every record of a type), `folderId` (every record filed in a folder, any type \u2014 combine with `type` for one type within one folder), or `recent` (the account-wide recently-updated feed across every type, newest first \u2014 the only way to read records without naming a type, and standalone: no other filter applies to it). `userId`/`scope` further narrow the type and folder modes.\nReturns a `{ data, nextCursor }` page: `data` holds up to `limit` records (default 3, max 100 \u2014 raise it in one call when you can accept the payload), and a non-null `nextCursor` means more remain \u2014 pass it back as `startFrom` to page. A composite lookup given fewer than its full field count returns records grouped by the unspecified fields, ordered within each group. Mode is auto-detected from the arguments present.",
10673
10769
  inputSchema: inputSchema2,
10770
+ // A pure read — never creates, modifies, or deletes anything server-side.
10771
+ annotations: { readOnlyHint: true, destructiveHint: false, idempotentHint: true },
10674
10772
  handler: async (args) => {
10675
10773
  const limit = args.limit ?? MCP_DEFAULT_LIMIT2;
10676
10774
  const type = args.type;
@@ -10916,6 +11014,8 @@ var recordGet = ({ client, log }) => ({
10916
11014
  title: "Get a record by id or externalId",
10917
11015
  description: "Fetch a single structured record, including the full payload. Select it EITHER by its Vectros `id` (e.g. from record_query / hybrid_search) OR by your own `externalId` + `type` \u2014 the same key you passed to record_create, resolved for you (no manual record_query lookup needed). Very large payloads are truncated to protect the agent context window. The response carries the record's processing `indexStatus`; when it is FAILED an `indexFailure.code` explains whether the content is still searchable (e.g. VECTOR_LIMIT_EXCEEDED keeps keyword search vs INDEXING_FAILED = not findable at all) \u2014 branch on the `code`, not the message.",
10918
11016
  inputSchema: inputSchema3,
11017
+ // A pure read — never creates, modifies, or deletes anything server-side.
11018
+ annotations: { readOnlyHint: true, destructiveHint: false, idempotentHint: true },
10919
11019
  handler: async (args) => {
10920
11020
  const id = args.id;
10921
11021
  const externalId = args.externalId;
@@ -10961,6 +11061,8 @@ var recordBatchGet = ({ client, log }) => ({
10961
11061
  title: "Get multiple records by id in one call",
10962
11062
  description: "Fetch several structured records by id in a single call (1-100 ids), each with its full payload \u2014 the same hydration record_get gives a single id. Use this instead of N record_get calls when you already hold several ids (e.g. a page of record_query/hybrid_search results). Any id you can't access is silently omitted from `data`; the response also returns `missingIds` \u2014 every requested id not present in `data` \u2014 so you can tell a partial result from a complete one. As with record_get, an oversized payload is truncated into a labelled `payloadPreview` rather than shipped whole.",
10963
11063
  inputSchema: inputSchema4,
11064
+ // A pure read — never creates, modifies, or deletes anything server-side.
11065
+ annotations: { readOnlyHint: true, destructiveHint: false, idempotentHint: true },
10964
11066
  handler: async (args) => {
10965
11067
  const ids = args.ids;
10966
11068
  try {
@@ -11019,6 +11121,13 @@ var recordCreate = ({ client, log }) => ({
11019
11121
  title: "Create a record",
11020
11122
  description: "Create a structured record of a given type. Provide `type` and `fields` (the payload, validated against the type schema \u2014 call list_schemas first to learn required fields and enums). Idempotent by `externalId`. Requires the key to allow records:c (and records:r to receive the existing record on a collision).",
11021
11123
  inputSchema: inputSchema5,
11124
+ // Creates, never modifies or deletes an existing record. Idempotent ONLY when the caller
11125
+ // supplies `externalId` (optional, per the doc comment above) — re-creating with the same
11126
+ // one returns the existing record rather than duplicating it. `externalId` is not required,
11127
+ // so annotated for the less-safe default (omit it, and a retry creates a second record),
11128
+ // not the safer opt-in — same standard applied to record_batch_write, which has the
11129
+ // identical optional-externalId shape.
11130
+ annotations: { readOnlyHint: false, destructiveHint: false, idempotentHint: false },
11022
11131
  handler: async (args) => {
11023
11132
  const type = args.type;
11024
11133
  try {
@@ -11084,6 +11193,15 @@ var recordBatchWrite = ({ client, log }) => ({
11084
11193
  title: "Create or upsert multiple records in one call",
11085
11194
  description: 'Write up to 50 structured records in a single call \u2014 use this instead of N record_create calls when you hold several records (e.g. filing a parsed table, or seeding a set of tasks). Items may mix types; each one is schema-validated, externalId-idempotent and scope-checked individually against its own type (records:c:<type> per item), so a batch cannot write a type you could not write one at a time. `atomicity` chooses the commit shape: "best_effort" (default) writes each item independently; "all_or_nothing" commits every item in one transaction, writing nothing at all if any item fails \u2014 prefer it when a half-written set would be worse than none. IMPORTANT: this call reports success whenever the batch was PROCESSED, including when every item failed \u2014 so always read the per-item `results` and the `succeeded`/`failed` counts rather than treating a non-error result as "all written". This differs from record_create, where a failure is an error result. Results are NOT guaranteed to arrive in the order you submitted: match each one to its item by its `index` (zero-based, the position in your `items` array). A result carries the written record\'s `id` (null on failure) and, when it failed, an `error` with a machine-readable `code` and a human-readable `message` \u2014 read it before resubmitting. It does NOT carry the record itself; fetch that with record_get/record_batch_get. A per-item `status` is created (new record written), updated (an existing record matched \u2014 overwritten only if you passed upsert:true, otherwise returned unchanged, so this is not by itself evidence of a write), conflict (uniqueness or version), invalid (validation \u2014 read `error.message` for which field), forbidden (your credential lacks the scope or ownership that item needed \u2014 fix the credential, not the item), or not_committed (this item was fine but an all_or_nothing batch was aborted by a different item, so resubmitting with that one fixed writes this one unchanged).',
11086
11195
  inputSchema: inputSchema6,
11196
+ // Creates by default, and can overwrite existing records as a FULL replacement when
11197
+ // `upsert:true` is passed (destructive to whatever fields the old version carried and
11198
+ // this call omits). Idempotent ONLY when every item supplies `externalId` (optional,
11199
+ // per its own field doc above) — re-submitting then converges, with or without
11200
+ // `upsert:true`. `externalId` is not required, so annotated for the less-safe default:
11201
+ // an item with no `externalId` at all has no dedup key, and a resubmit creates a second
11202
+ // record for it regardless of `upsert`. Same standard applied to record_create/
11203
+ // document_ingest's identical optional-externalId shape.
11204
+ annotations: { readOnlyHint: false, destructiveHint: true, idempotentHint: false },
11087
11205
  handler: async (args) => {
11088
11206
  const items = args.items;
11089
11207
  const atomicity = args.atomicity;
@@ -11147,6 +11265,10 @@ var recordUpdate = ({ client, log }) => ({
11147
11265
  title: "Update a record by id or externalId",
11148
11266
  description: "Update a record \u2014 select it by its Vectros `id` OR by your own `externalId` + `type` (the same key you passed to record_create, resolved for you). The provided `fields` are DEEP-MERGED into the existing payload (unspecified fields are preserved; a field set to `null` is deleted). Pass `expectedVersion` (the version you last read) for safe concurrent edits \u2014 a stale update is refused (409). Use `status` to archive without deleting. Requires the key to allow records:u.",
11149
11267
  inputSchema: inputSchema7,
11268
+ // A JSON Merge Patch — overwrites the fields it names, so it can destroy a prior field
11269
+ // value the caller did not mean to lose. Re-applying the same patch converges to the
11270
+ // same state, so it is idempotent.
11271
+ annotations: { readOnlyHint: false, destructiveHint: true, idempotentHint: true },
11150
11272
  handler: async (args) => {
11151
11273
  const id = args.id;
11152
11274
  const externalId = args.externalId;
@@ -11181,6 +11303,10 @@ var recordDelete = ({ client, log }) => ({
11181
11303
  title: "Delete a record",
11182
11304
  description: "Permanently delete a record by id (leaves a tombstone). Requires the key to allow records:d \u2014 a key without it gets a permission error. To archive without deleting, use record_update to set status instead.",
11183
11305
  inputSchema: inputSchema8,
11306
+ // Deletes (leaves a tombstone server-side, but the record is gone from every normal
11307
+ // read path). Idempotent in the standard REST sense: the end state ("this id no longer
11308
+ // resolves") is the same whether this is the first delete or a repeat of one.
11309
+ annotations: { readOnlyHint: false, destructiveHint: true, idempotentHint: true },
11184
11310
  handler: async (args) => {
11185
11311
  const id = args.id;
11186
11312
  try {
@@ -11243,6 +11369,15 @@ var ragAsk = ({ client, log }) => ({
11243
11369
  title: "RAG ask (corpus-wide)",
11244
11370
  description: "Ask a question grounded against your tenant's indexed content. Vectros performs a hybrid search, injects the top-K passages into the prompt, and streams a model answer back. Scope retrieval with `search` (ownership \u2014 `scope` for one ownership dimension or `scopeFilters` for several at once, e.g. one client within one org \u2014 folder, type, metadata filters, date window) to ground on a subset \u2014 e.g. one patient or one folder \u2014 and steer generation with `instructions` / `temperature`. The full answer is returned as a single response; progress notifications keep the call alive during the 30-45s generation window. Inference runs in-perimeter against AWS Bedrock \u2014 PHI never leaves the BAA boundary.",
11245
11371
  inputSchema: inputSchema9,
11372
+ // NOT a pure read: this call reserves an atomic hold against the caller's prepaid inference
11373
+ // balance before generation starts, then debits it on completion — a real financial side
11374
+ // effect that can trigger a configured auto-recharge against the tenant's card.
11375
+ // `readOnlyHint:true` would let a host
11376
+ // skip a confirmation prompt on a call with real, unbounded-under-retry spend; ordinary reads
11377
+ // that merely meter usage stay `readOnlyHint:true` (hybrid_search has no inference-cost leg),
11378
+ // but a call that can debit a balance and possibly charge a card is a different class. Not
11379
+ // idempotent either: every repeat charges again, and generation is non-deterministic.
11380
+ annotations: { readOnlyHint: false, destructiveHint: false, idempotentHint: false },
11246
11381
  handler: async (args, extra) => {
11247
11382
  const rawSearch = args.search ?? {};
11248
11383
  if (rawSearch.scope !== void 0 && rawSearch.scopeFilters !== void 0) {
@@ -11342,6 +11477,15 @@ var documentAsk = ({ client, log }) => ({
11342
11477
  title: "Document ask (single-document)",
11343
11478
  description: "Ask a question against a single indexed document. Returns a grounded answer with the document context that informed it. For documents exceeding the input-token cap, the API returns a structured 413 with `estimatedTokens` and `limitTokens`. Inference runs in-perimeter against AWS Bedrock \u2014 PHI never leaves the BAA boundary.",
11344
11479
  inputSchema: inputSchema10,
11480
+ // NOT a pure read: this call reserves an atomic hold against the caller's prepaid inference
11481
+ // balance before generation starts, then debits it on completion — a real financial side
11482
+ // effect that can trigger a configured auto-recharge against the tenant's card.
11483
+ // `readOnlyHint:true` would let a host
11484
+ // skip a confirmation prompt on a call with real, unbounded-under-retry spend; ordinary reads
11485
+ // that merely meter usage stay `readOnlyHint:true` (hybrid_search has no inference-cost leg),
11486
+ // but a call that can debit a balance and possibly charge a card is a different class. Not
11487
+ // idempotent either: every repeat charges again, and generation is non-deterministic.
11488
+ annotations: { readOnlyHint: false, destructiveHint: false, idempotentHint: false },
11345
11489
  handler: async (args, extra) => {
11346
11490
  try {
11347
11491
  const stream = await client.inference.documentAsk({
@@ -11420,6 +11564,8 @@ var listSchemas = ({ client, log }) => ({
11420
11564
  title: "List record schemas",
11421
11565
  description: 'List the structured-record schema catalog for your tenant. Each schema describes a record type (e.g. "patient", "clinical_note") \u2014 its fields, lookup-indexed fields, and capabilities. Use this to discover what record types exist before calling `record_query`. Filter with `surface` (record/document/user/entity \u2014 e.g. only document types), `recordType` (resolve one schema by its type name), or `userId`/`scope`; default returns everything the credential can see.',
11422
11566
  inputSchema: inputSchema11,
11567
+ // A pure read — never creates, modifies, or deletes anything server-side.
11568
+ annotations: { readOnlyHint: true, destructiveHint: false, idempotentHint: true },
11423
11569
  handler: async (args) => {
11424
11570
  const userId = args.userId;
11425
11571
  const scope = args.scope;
@@ -11474,6 +11620,8 @@ var documentGet = ({ client, log }) => ({
11474
11620
  title: "Get document metadata (and optionally text)",
11475
11621
  description: "Fetch metadata for a single document \u2014 select it by its Vectros `documentId` OR by your own `externalId` + `type` (resolved for you). Pass `includeText: true` to also fetch the text body (capped at ~8K tokens; `truncated: true` flag if cut). Text is available for every text-ingested document and for file-ingested documents unless they were uploaded with `storeText: false` (extracted text discarded after indexing) \u2014 then `textAvailable: false` is set; the original file is still retrievable via `includeDownloadUrl`. Pass `includeDownloadUrl: true` to also get a short-lived presigned `downloadUrl` for the original file (file-backed documents only). Returns the full document metadata, including its lifecycle `status` (ACTIVE, or ARCHIVED when soft-retracted from search \u2014 restorable via document_update) and its processing `indexStatus`. When `indexStatus` is FAILED the response also carries `indexFailure` with a machine-readable `code` telling you whether the content is still findable \u2014 e.g. TEXT_INDEX_FAILED / VECTOR_LIMIT_EXCEEDED (one leg still serves it) vs INDEXING_FAILED (not findable by search at all). Branch on `code`, not on the message.",
11476
11622
  inputSchema: inputSchema12,
11623
+ // A pure read — never creates, modifies, or deletes anything server-side.
11624
+ annotations: { readOnlyHint: true, destructiveHint: false, idempotentHint: true },
11477
11625
  handler: async (args) => {
11478
11626
  const documentId = args.documentId;
11479
11627
  const externalId = args.externalId;
@@ -11568,6 +11716,8 @@ var documentQuery = ({ client, log }) => ({
11568
11716
  title: "Document query (list or lookup)",
11569
11717
  description: "Query document metadata. Two modes:\n \u2022 Lookup on a lookup-indexed field: pass `type` and `field` plus exactly one of `value` (exact), `from`+`to` (range), or `prefix`. Works on sensitive fields (equality only there); range/prefix need a range-enabled field.\n \u2022 List: omit `field`; optionally filter by `folderId`/`userId`/`scope` (`namespace:value`).\nReturns a `{ data, nextCursor }` page: `data` holds up to `limit` documents (default 3, max 100 \u2014 raise it in one call when you can accept the payload), and a non-null `nextCursor` means more remain \u2014 pass it back as `startFrom` to page. Mode is auto-detected. Use document_get for the full text/download URL of one document.",
11570
11718
  inputSchema: inputSchema13,
11719
+ // A pure read — never creates, modifies, or deletes anything server-side.
11720
+ annotations: { readOnlyHint: true, destructiveHint: false, idempotentHint: true },
11571
11721
  handler: async (args) => {
11572
11722
  const limit = args.limit ?? MCP_DEFAULT_LIMIT3;
11573
11723
  const field = args.field;
@@ -11678,6 +11828,10 @@ var documentUpdate = ({ client, log }) => ({
11678
11828
  title: "Update a document",
11679
11829
  description: 'Update a document \u2014 select it by its Vectros `documentId` OR by your own `externalId` + `type` (resolved for you). `fields` are DEEP-MERGED into the existing typed payload (unspecified fields preserved; a field set to `null` is deleted); title/folderId/status/ownership are updated when provided and preserved otherwise. Supply `text` to re-ingest and re-index the document body in place (text documents only). Set `status: "ARCHIVED"` to soft-retract a document (pulled from search, kept and recoverable) and `status: "ACTIVE"` to restore it. Pass `expectedVersion` (the version you last read) for safe concurrent edits \u2014 a stale update is refused (409). Requires the key to allow documents:u.',
11680
11830
  inputSchema: inputSchema14,
11831
+ // A JSON Merge Patch — overwrites the fields it names, so it can destroy a prior field
11832
+ // value the caller did not mean to lose. Re-applying the same patch converges to the
11833
+ // same state, so it is idempotent.
11834
+ annotations: { readOnlyHint: false, destructiveHint: true, idempotentHint: true },
11681
11835
  handler: async (args) => {
11682
11836
  const documentId = args.documentId;
11683
11837
  const externalId = args.externalId;
@@ -11726,6 +11880,9 @@ var documentDelete = ({ client, log }) => ({
11726
11880
  title: "Delete a document",
11727
11881
  description: 'Permanently delete a document by id (removes it and its indexed content). Requires the key to allow documents:d \u2014 a key without it gets a permission error. To archive without deleting, use document_update to set status: "ARCHIVED" instead (recoverable, and needs no delete authority).',
11728
11882
  inputSchema: inputSchema15,
11883
+ // Deletes. Idempotent in the standard REST sense: the end state ("this id no longer
11884
+ // resolves") is the same whether this is the first delete or a repeat of one.
11885
+ annotations: { readOnlyHint: false, destructiveHint: true, idempotentHint: true },
11729
11886
  handler: async (args) => {
11730
11887
  const documentId = args.documentId;
11731
11888
  try {
@@ -11763,6 +11920,8 @@ var folderQuery = ({ client, log }) => ({
11763
11920
  title: "Folder query (list or get)",
11764
11921
  description: "Read folders. Two modes:\n \u2022 Get: pass `id` \u2192 returns the single folder.\n \u2022 List: omit `id`; pass `parentId` for a folder's direct children (tree navigation) or omit for a flat tenant list. Optionally filter by `userId` or `scope` (`namespace:value`).\nList mode returns `{ data, nextCursor }` (default 10, max 100 per page \u2014 raise it in one call when you can accept the larger page); a non-null `nextCursor` means more remain \u2014 pass it back as `startFrom` to page through all folders. Get mode returns the single folder object.",
11765
11922
  inputSchema: inputSchema16,
11923
+ // A pure read — never creates, modifies, or deletes anything server-side.
11924
+ annotations: { readOnlyHint: true, destructiveHint: false, idempotentHint: true },
11766
11925
  handler: async (args) => {
11767
11926
  const id = args.id;
11768
11927
  try {
@@ -11797,7 +11956,9 @@ var inputSchema17 = {
11797
11956
  name: import_zod17.z.string().min(1, "name is required").describe("Folder display name."),
11798
11957
  description: import_zod17.z.string().optional().describe("Optional description of the folder's purpose."),
11799
11958
  parentId: import_zod17.z.string().optional().describe("Parent folder id \u2014 places the folder under this parent. Omit for the context default root. Create-only."),
11800
- slug: import_zod17.z.string().optional().describe("Optional stable slug (sibling-unique; idempotency key). Lowercase letters/digits/hyphens. Derived from name when omitted."),
11959
+ slug: import_zod17.z.string().optional().describe(
11960
+ "Optional stable slug (sibling-unique; idempotency key). Lowercase letters/digits/hyphens. SUPPLY THIS to make a retry safe \u2014 if omitted, a derived slug is only ever a freshly-proved-free one, so a redelivered call creates a new sibling folder every time rather than matching the first."
11961
+ ),
11801
11962
  userId: import_zod17.z.string().optional().describe("Owning user (Vectros UUID)."),
11802
11963
  scopes: import_zod17.z.array(import_zod17.z.string()).optional().describe(
11803
11964
  'Scope ownership as `namespace:value` entries, at most 2 (e.g. ["org:<uuid>", "group:eng-team"]). `org` and `client` are reserved namespace names, registered like any other; others are namespaces you registered yourself. This is the folder\'s COMPLETE scope declaration and values must come from the credential\'s own identity. An empty array `[]` creates a PRIVATE folder owned by the calling user alone. Omit to stamp the credential\'s full identity \u2014 the default.'
@@ -11806,8 +11967,18 @@ var inputSchema17 = {
11806
11967
  var folderCreate = ({ client, log }) => ({
11807
11968
  name: "folder_create",
11808
11969
  title: "Create a folder",
11809
- description: "Create a folder to organize documents and records. Pass `parentId` to nest it (create-only \u2014 folders cannot be moved later). Idempotent by `slug` within the parent. Requires the key to allow folders:c (and folders:r to receive the existing folder on a collision).",
11970
+ description: "Create a folder to organize documents and records. Pass `parentId` to nest it (create-only \u2014 folders cannot be moved later). Idempotent by `slug` within the parent ONLY when you pass `slug` explicitly \u2014 omitting it derives a fresh, always-free slug on every call, so a retry creates a new sibling folder rather than matching the first. Requires the key to allow folders:c (and folders:r to receive the existing folder on a collision).",
11810
11971
  inputSchema: inputSchema17,
11972
+ // Idempotent ONLY when the caller supplies `slug` explicitly (see the doc comment above): an
11973
+ // omitted slug is derived through a collision-probing suffix loop that returns only a
11974
+ // freshly-proved-free value, so the idempotency check running after that derivation can never
11975
+ // match on the default path. `slug` is optional, so this is annotated for the less-safe default —
11976
+ // the same standard applied to record_create/document_ingest/record_batch_write's identical
11977
+ // optional-dedupe-key shape. (A prior version of this annotation claimed unconditional
11978
+ // idempotency, reasoning that the derived slug made this tool "genuinely structurally different"
11979
+ // from the optional-externalId tools — that reasoning was wrong: the derivation is unconditional,
11980
+ // but it is unconditionally NON-colliding by construction, which is the opposite property.)
11981
+ annotations: { readOnlyHint: false, destructiveHint: false, idempotentHint: false },
11811
11982
  handler: async (args) => {
11812
11983
  try {
11813
11984
  const folder = await client.folders.createFolder({
@@ -11849,6 +12020,10 @@ var folderUpdate = ({ client, log }) => ({
11849
12020
  title: "Update a folder",
11850
12021
  description: "Update a folder's name / description / ownership by id (RFC-7386 merge \u2014 omitted fields preserved). Pass `expectedVersion` (the version you last read) for safe concurrent edits \u2014 a stale update is refused (409). Folders cannot be moved (re-parenting is not supported by the API). Requires the key to allow folders:u.",
11851
12022
  inputSchema: inputSchema18,
12023
+ // A JSON Merge Patch — overwrites the fields it names, so it can destroy a prior field
12024
+ // value the caller did not mean to lose. Re-applying the same patch converges to the
12025
+ // same state, so it is idempotent.
12026
+ annotations: { readOnlyHint: false, destructiveHint: true, idempotentHint: true },
11852
12027
  handler: async (args) => {
11853
12028
  const id = args.id;
11854
12029
  const name = args.name;
@@ -11884,6 +12059,9 @@ var folderDelete = ({ client, log }) => ({
11884
12059
  title: "Delete a folder",
11885
12060
  description: 'Permanently delete a folder by id. The folder must be EMPTY first \u2014 it must contain no documents, no records, and no sub-folders \u2014 and a non-empty folder is refused, which is the most common way this call fails. Use record_query with this folderId, and document_query, to see what is in it. Clearing it differs by content type: a document can be moved out (document_update with a different folderId) or deleted. A RECORD can also be re-filed into another folder \u2014 the API supports it \u2014 but THIS SERVER does not expose that yet: record_update has no folderId argument, so from here your only option is record_delete (needs records:d). Do NOT read that as "the record cannot be moved" and delete partner data on that basis: if the record should be kept, move it with the Vectros API/SDK directly rather than deleting it here. A sub-folder cannot be re-parented at all, so nested folders have to be emptied and deleted innermost-first. Note the emptiness check counts everything in the folder, INCLUDING items your credential cannot read \u2014 so a refusal you cannot account for from what you can list is expected behaviour, not a bug, and retrying will not clear it. Requires the key to allow folders:d \u2014 a key without it gets a permission error. Protected folders (e.g. a context root) cannot be deleted at all, however empty.',
11886
12061
  inputSchema: inputSchema19,
12062
+ // Deletes. Idempotent in the standard REST sense: the end state ("this id no longer
12063
+ // resolves") is the same whether this is the first delete or a repeat of one.
12064
+ annotations: { readOnlyHint: false, destructiveHint: true, idempotentHint: true },
11887
12065
  handler: async (args) => {
11888
12066
  const id = args.id;
11889
12067
  try {
@@ -11907,6 +12085,8 @@ var currentIdentity = ({ log, apiKey, environment }) => ({
11907
12085
  title: "Current identity (tenant + principal scope)",
11908
12086
  description: "Describe the credential the MCP server is operating under. Returns tenantId, environment (staging|production), principalType (root_key|scoped_key|token), principalKeyId, principalLabel, and (for scoped credentials) allowedActions plus dataScope \u2014 the credential's verb+ownership reach as { userId, scopes[] }, where each scope is a `namespace:value` string (e.g. \"org:<uuid>\"). Note: this does not yet include granted_capabilities (member-lifecycle / forensic-read / context-directory-read / delegate-mint, as of API 0.40.0, joined by delegate-principal-stamp in 0.42.0) \u2014 a separate reach dimension a scope clause can carry that /v1/ping does not report yet, so allowedActions+dataScope may understate a credential's true reach. Also reports mcpServerVersion (this server's own package version) and sdkVersion (the bundled @vectros-ai/sdk version) so a caller can tell what build it's talking to. Use this when the user asks 'what can you do here?', 'what tenant am I in?', or 'what version is this?'. Calls GET /v1/ping under the hood.",
11909
12087
  inputSchema: inputSchema20,
12088
+ // A pure read (/v1/ping) — never creates, modifies, or deletes anything server-side.
12089
+ annotations: { readOnlyHint: true, destructiveHint: false, idempotentHint: true },
11910
12090
  handler: async () => {
11911
12091
  try {
11912
12092
  const identity = await resolveIdentity({ log, apiKey, environment });
@@ -12036,6 +12216,16 @@ var documentIngest = ({ client, log, transport, ingestRoot }) => ({
12036
12216
  title: "Ingest a new document (text body or file upload)",
12037
12217
  description: "Create a new document in your Vectros tenant. Two modes:\n \u2022 Text mode: pass `text` (string body). Single-call. Use for crawled content, notes, generated text.\n \u2022 File mode: pass `filePath` (local path on the MCP server's host machine). STDIO-TRANSPORT ONLY \u2014 rejected on HTTP transport. MCP server reads the bytes, requests a presigned upload URL, and PUTs them. Returns when the upload is accepted (indexStatus: PENDING_INDEX); poll with `document_get` until indexStatus is INDEXED.\nEither `text` or `filePath` must be present; both is an error. Idempotent by `externalId` (re-ingest returns the existing document, not a duplicate \u2014 requires documents:r in addition to documents:c, since being handed the existing document is a read of it). To UPDATE an existing document instead \u2014 re-index an edited body \u2014 pass `upsert:true` with the same `externalId` (and the same `schemaId`); this is the re-sync primitive for keeping a knowledge base current. Pass `schemaId` + `payload` for a typed, lookup-queryable document (records parity). indexMode defaults to HYBRID for untyped documents (omit to inherit a bound schema's default). storeText is a FILE-MODE knob (default true): false discards the uploaded file's extracted text after indexing (search + file download keep working; text retrieval and document_ask do not). Text-mode bodies are always retained, so storeText is not accepted with `text`.",
12038
12218
  inputSchema: inputSchema21,
12219
+ // Creates by default, idempotent ONLY when the caller supplies `externalId` (optional,
12220
+ // per the doc comment above) — re-ingest then returns the existing document rather than
12221
+ // duplicating it. `externalId` is not required, so annotated for the less-safe default
12222
+ // (omit it, and every call creates a new document), same standard applied to
12223
+ // record_create/record_batch_write's identical optional-externalId shape. `upsert:true`
12224
+ // is a further, real, named capability of this tool that OVERWRITES an existing
12225
+ // document's content and re-indexes it — that path is destructive to the prior body, so
12226
+ // this is flagged destructive rather than claiming create-only safety a caller can
12227
+ // invoke past.
12228
+ annotations: { readOnlyHint: false, destructiveHint: true, idempotentHint: false },
12039
12229
  handler: async (args) => {
12040
12230
  const title = args.title;
12041
12231
  const text = args.text;
@@ -12146,7 +12336,7 @@ var documentIngest = ({ client, log, transport, ingestRoot }) => ({
12146
12336
  }
12147
12337
  const putRes = await fetch(uploadUrl, {
12148
12338
  method: "PUT",
12149
- headers: { "Content-Type": fileType },
12339
+ headers: { "Content-Type": fileType, ...presignedUploadHeaders(upload) },
12150
12340
  body: bytes
12151
12341
  });
12152
12342
  if (!putRes.ok) {
@@ -12185,6 +12375,13 @@ var documentIngest = ({ client, log, transport, ingestRoot }) => ({
12185
12375
  }
12186
12376
  });
12187
12377
  var document_ingest_default = documentIngest;
12378
+ function presignedUploadHeaders(response) {
12379
+ if (typeof response !== "object" || response === null) return {};
12380
+ const { requiredHeaderName, requiredHeaderValue } = response;
12381
+ if (typeof requiredHeaderName !== "string" || requiredHeaderName === "") return {};
12382
+ if (typeof requiredHeaderValue !== "string") return {};
12383
+ return { [requiredHeaderName]: requiredHeaderValue };
12384
+ }
12188
12385
 
12189
12386
  // src/tools/lookup_principal.ts
12190
12387
  var import_zod21 = require("zod");
@@ -12218,6 +12415,8 @@ var lookupPrincipal = ({ client, log }) => ({
12218
12415
  title: "Look up a user identity or a namespaced identity entity",
12219
12416
  description: "Resolve a user, or an identity entity in a namespace (org/client/one you registered). Two modes:\n \u2022 Resolve by your own id: pass `externalId` \u2192 the matching principal incl. its Vectros UUID (the id the ownership filters on record_query / hybrid_search / rag_ask expect).\n \u2022 Lookup by a schema field: pass `type` and `field` plus exactly one of `value` (exact), `from`+`to` (range), or `prefix`. Sensitive-field-safe. (If both `externalId` and a `field` lookup are given, `externalId` wins.) For an entity kind, `contextId` names a specific app context when the namespace is context-owned rather than tenant-wide; a context-confined credential's own context is used automatically without it. Returns a `{ data, nextCursor }` page (default 10, max 100 \u2014 raise it in one call when you can accept the payload); a non-null `nextCursor` means more remain \u2014 pass it back as `startFrom`. Read-only \u2014 does not create or modify identities.",
12220
12417
  inputSchema: inputSchema22,
12418
+ // A pure read — never creates, modifies, or deletes anything server-side.
12419
+ annotations: { readOnlyHint: true, destructiveHint: false, idempotentHint: true },
12221
12420
  handler: async (args) => {
12222
12421
  const kind = args.kind;
12223
12422
  const isUser = kind === "user";
@@ -12302,6 +12501,8 @@ var versionHistory = ({ client, log }) => ({
12302
12501
  title: "Version history (record or document)",
12303
12502
  description: "Read the audit/version trail (CREATE/UPDATE/DELETE, with actor, timestamp, and diff) for a single record or document. Pass `resourceType` (record|document) and `id`. Returns `{ data, nextCursor }`; pass `nextCursor` back as `startFrom` to page through older entries. Entities without audit history (untyped) return an empty trail. Read-only.",
12304
12503
  inputSchema: inputSchema23,
12504
+ // A pure read — never creates, modifies, or deletes anything server-side.
12505
+ annotations: { readOnlyHint: true, destructiveHint: false, idempotentHint: true },
12305
12506
  handler: async (args) => {
12306
12507
  const resourceType = args.resourceType;
12307
12508
  const id = args.id;
@@ -12579,7 +12780,12 @@ var VectrosMCPServer = class {
12579
12780
  // MCP client (a well-behaved client rejects an unknown key before the call).
12580
12781
  // The server enforces it too (z.object(...).strict() below) so a raw JSON-RPC
12581
12782
  // call that skips client validation is still rejected — belt and suspenders.
12582
- inputSchema: { ...zodShapeToJsonSchema(t.inputSchema), additionalProperties: false }
12783
+ inputSchema: { ...zodShapeToJsonSchema(t.inputSchema), additionalProperties: false },
12784
+ // Forwarded from the tool's own definition, not hand-copied here: adding an
12785
+ // annotation to a tool factory does nothing for a client unless it also reaches
12786
+ // this emitted list — the actual `tools/list` response a host reads, not the
12787
+ // source that builds it.
12788
+ ...t.annotations ? { annotations: t.annotations } : {}
12583
12789
  }))
12584
12790
  })
12585
12791
  );
@@ -12863,7 +13069,8 @@ async function main() {
12863
13069
  if (process.argv.includes("--version") || process.argv.includes("-v")) {
12864
13070
  process.stdout.write(`${formatBuildInfo()}
12865
13071
  `);
12866
- process.exit(0);
13072
+ process.exitCode = 0;
13073
+ return;
12867
13074
  }
12868
13075
  const log = createLogger2();
12869
13076
  const resolved = await resolveApiKey();
@@ -12872,7 +13079,8 @@ async function main() {
12872
13079
  if (notice) log[notice.level]({ alias: notice.alias }, notice.message);
12873
13080
  if (!apiKey) {
12874
13081
  log.fatal({ reason: resolved.reason }, noKeyMessage(resolved));
12875
- process.exit(1);
13082
+ process.exitCode = 1;
13083
+ return;
12876
13084
  }
12877
13085
  const apiBaseUrl = process.env.VECTROS_API_BASE_URL;
12878
13086
  if (apiBaseUrl !== void 0) {
@@ -12884,7 +13092,8 @@ async function main() {
12884
13092
  } else {
12885
13093
  log.fatal({ err: String(err) }, "invalid VECTROS_API_BASE_URL");
12886
13094
  }
12887
- process.exit(1);
13095
+ process.exitCode = 1;
13096
+ return;
12888
13097
  }
12889
13098
  }
12890
13099
  let tools;
@@ -12892,7 +13101,8 @@ async function main() {
12892
13101
  tools = parseToolsEnv(process.env.VECTROS_MCP_TOOLS);
12893
13102
  } catch (err) {
12894
13103
  log.fatal({ err: String(err) }, "invalid VECTROS_MCP_TOOLS");
12895
- process.exit(1);
13104
+ process.exitCode = 1;
13105
+ return;
12896
13106
  }
12897
13107
  const skipFlag = (process.env.VECTROS_MCP_SKIP_PING_VALIDATION ?? "").toLowerCase();
12898
13108
  const validateOnStart = !(skipFlag === "1" || skipFlag === "true");
@@ -12911,9 +13121,21 @@ async function main() {
12911
13121
  } else {
12912
13122
  log.fatal({ err: String(err) }, "startup failed");
12913
13123
  }
12914
- process.exit(1);
13124
+ process.exitCode = 1;
13125
+ return;
12915
13126
  }
12916
13127
  const transport = createStdioTransport();
13128
+ try {
13129
+ await server.connect(transport);
13130
+ log.info(
13131
+ { version: BUILD_INFO.mcpServer, sdk: BUILD_INFO.sdk },
13132
+ "vectros-mcp-server listening on stdio"
13133
+ );
13134
+ } catch (err) {
13135
+ log.fatal({ err: String(err) }, "failed to connect transport");
13136
+ process.exitCode = 2;
13137
+ return;
13138
+ }
12917
13139
  const shutdown = async (signal) => {
12918
13140
  log.info({ signal }, "shutdown requested");
12919
13141
  try {
@@ -12925,16 +13147,6 @@ async function main() {
12925
13147
  };
12926
13148
  process.on("SIGINT", () => void shutdown("SIGINT"));
12927
13149
  process.on("SIGTERM", () => void shutdown("SIGTERM"));
12928
- try {
12929
- await server.connect(transport);
12930
- log.info(
12931
- { version: BUILD_INFO.mcpServer, sdk: BUILD_INFO.sdk },
12932
- "vectros-mcp-server listening on stdio"
12933
- );
12934
- } catch (err) {
12935
- log.fatal({ err: String(err) }, "failed to connect transport");
12936
- process.exit(2);
12937
- }
12938
13150
  }
12939
13151
  main().catch((err) => {
12940
13152
  process.stderr.write(`fatal: ${err instanceof Error ? err.stack : String(err)}