@vectros-ai/mcp-server 0.17.0 → 0.17.1
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/CHANGELOG.md +104 -0
- package/README.md +52 -10
- package/dist/cli-http.js +170 -33
- package/dist/cli-http.js.map +1 -1
- package/dist/cli-http.mjs +170 -33
- package/dist/cli-http.mjs.map +1 -1
- package/dist/cli.js +177 -41
- package/dist/cli.js.map +1 -1
- package/dist/cli.mjs +177 -41
- package/dist/cli.mjs.map +1 -1
- package/dist/index.js +156 -26
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +156 -26
- package/dist/index.mjs.map +1 -1
- package/package.json +2 -2
package/dist/index.mjs
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
// src/server.ts
|
|
2
2
|
import { Server } from "@modelcontextprotocol/sdk/server/index.js";
|
|
3
3
|
|
|
4
|
-
//
|
|
4
|
+
// node_modules/@vectros-ai/sdk/dist/index.mjs
|
|
5
5
|
var __defProp = Object.defineProperty;
|
|
6
6
|
var __export = (target, all) => {
|
|
7
7
|
for (var name in all)
|
|
@@ -3400,6 +3400,7 @@ var AuthClient = class {
|
|
|
3400
3400
|
*
|
|
3401
3401
|
* @throws {@link Vectros.ForbiddenError}
|
|
3402
3402
|
* @throws {@link Vectros.NotFoundError}
|
|
3403
|
+
* @throws {@link Vectros.ConflictError}
|
|
3403
3404
|
* @throws {@link Vectros.TooManyRequestsError}
|
|
3404
3405
|
*
|
|
3405
3406
|
* @example
|
|
@@ -3442,6 +3443,8 @@ var AuthClient = class {
|
|
|
3442
3443
|
throw new ForbiddenError(_response.error.body, _response.rawResponse);
|
|
3443
3444
|
case 404:
|
|
3444
3445
|
throw new NotFoundError(_response.error.body, _response.rawResponse);
|
|
3446
|
+
case 409:
|
|
3447
|
+
throw new ConflictError(_response.error.body, _response.rawResponse);
|
|
3445
3448
|
case 429:
|
|
3446
3449
|
throw new TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
3447
3450
|
default:
|
|
@@ -3586,7 +3589,7 @@ var AuthClient = class {
|
|
|
3586
3589
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "PUT", "/v1/app-contexts/{contextId}");
|
|
3587
3590
|
}
|
|
3588
3591
|
/**
|
|
3589
|
-
* Permanently deletes an app context and everything in it — every record, document, folder, schema, role,
|
|
3592
|
+
* 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.
|
|
3590
3593
|
*
|
|
3591
3594
|
* @param {Vectros.DeleteAppContextRequest} request
|
|
3592
3595
|
* @param {AuthClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -4121,7 +4124,7 @@ var AuthClient = class {
|
|
|
4121
4124
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/auth/issuers/{issuerId}");
|
|
4122
4125
|
}
|
|
4123
4126
|
/**
|
|
4124
|
-
* 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.
|
|
4127
|
+
* 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 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.
|
|
4125
4128
|
*
|
|
4126
4129
|
* @param {Vectros.IssuerUpdateRequest} request
|
|
4127
4130
|
* @param {AuthClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -4188,7 +4191,7 @@ var AuthClient = class {
|
|
|
4188
4191
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "PUT", "/v1/auth/issuers/{issuerId}");
|
|
4189
4192
|
}
|
|
4190
4193
|
/**
|
|
4191
|
-
* 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.
|
|
4194
|
+
* 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.
|
|
4192
4195
|
*
|
|
4193
4196
|
* @param {Vectros.DeleteIssuerRequest} request
|
|
4194
4197
|
* @param {AuthClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -4314,7 +4317,7 @@ var AuthClient = class {
|
|
|
4314
4317
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/auth/issuers");
|
|
4315
4318
|
}
|
|
4316
4319
|
/**
|
|
4317
|
-
* 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`.
|
|
4320
|
+
* 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`. 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 for the full contract, including why it does NOT protect a shared/consumer-IdP registration with no company-domain population.
|
|
4318
4321
|
*
|
|
4319
4322
|
* @param {Vectros.IssuerRequest} request
|
|
4320
4323
|
* @param {AuthClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -5812,7 +5815,7 @@ var DocumentsClient = class {
|
|
|
5812
5815
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/documents/{id}/versions");
|
|
5813
5816
|
}
|
|
5814
5817
|
/**
|
|
5815
|
-
* 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
|
|
5818
|
+
* 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.
|
|
5816
5819
|
*
|
|
5817
5820
|
* @param {Vectros.FileUploadRequest} request
|
|
5818
5821
|
* @param {DocumentsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -7578,7 +7581,7 @@ var IdentityClient = class {
|
|
|
7578
7581
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/users/exists-by-email");
|
|
7579
7582
|
}
|
|
7580
7583
|
/**
|
|
7581
|
-
* Returns the audit trail of changes to a user, most recent first. Identity history is always recorded
|
|
7584
|
+
* 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.
|
|
7582
7585
|
*
|
|
7583
7586
|
* @param {Vectros.GetUserVersionsRequest} request
|
|
7584
7587
|
* @param {IdentityClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -8648,7 +8651,7 @@ var RecordsClient = class {
|
|
|
8648
8651
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v1/records/lookup");
|
|
8649
8652
|
}
|
|
8650
8653
|
/**
|
|
8651
|
-
* 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.
|
|
8654
|
+
* 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.
|
|
8652
8655
|
*
|
|
8653
8656
|
* @param {Vectros.GetRecordTombstoneRequest} request
|
|
8654
8657
|
* @param {RecordsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -9055,7 +9058,7 @@ var SchemasClient = class {
|
|
|
9055
9058
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "PUT", "/v1/schemas/{id}");
|
|
9056
9059
|
}
|
|
9057
9060
|
/**
|
|
9058
|
-
* 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.
|
|
9061
|
+
* 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.
|
|
9059
9062
|
*
|
|
9060
9063
|
* @param {Vectros.DeleteSchemaRequest} request
|
|
9061
9064
|
* @param {SchemasClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -9190,7 +9193,7 @@ var ScriptsClient = class {
|
|
|
9190
9193
|
*
|
|
9191
9194
|
* **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`).
|
|
9192
9195
|
*
|
|
9193
|
-
* **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
|
|
9196
|
+
* **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()`.
|
|
9194
9197
|
*
|
|
9195
9198
|
* **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.
|
|
9196
9199
|
*
|
|
@@ -9285,11 +9288,14 @@ var ScriptsClient = class {
|
|
|
9285
9288
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v1/scripts/execute");
|
|
9286
9289
|
}
|
|
9287
9290
|
/**
|
|
9288
|
-
* 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.
|
|
9291
|
+
* 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.
|
|
9289
9292
|
*
|
|
9290
9293
|
* @param {Vectros.ListScriptsRequest} request
|
|
9291
9294
|
* @param {ScriptsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
9292
9295
|
*
|
|
9296
|
+
* @throws {@link Vectros.BadRequestError}
|
|
9297
|
+
* @throws {@link Vectros.NotFoundError}
|
|
9298
|
+
*
|
|
9293
9299
|
* @example
|
|
9294
9300
|
* await client.scripts.listScripts({
|
|
9295
9301
|
* name: "notify-assignee",
|
|
@@ -9300,11 +9306,13 @@ var ScriptsClient = class {
|
|
|
9300
9306
|
return HttpResponsePromise.fromPromise(this.__listScripts(request, requestOptions));
|
|
9301
9307
|
}
|
|
9302
9308
|
async __listScripts(request = {}, requestOptions) {
|
|
9303
|
-
const { name, startFrom, limit } = request;
|
|
9309
|
+
const { name, startFrom, limit, includeSource, latest } = request;
|
|
9304
9310
|
const _queryParams = {
|
|
9305
9311
|
name,
|
|
9306
9312
|
startFrom,
|
|
9307
|
-
limit
|
|
9313
|
+
limit,
|
|
9314
|
+
includeSource,
|
|
9315
|
+
latest
|
|
9308
9316
|
};
|
|
9309
9317
|
const _authRequest = await this._options.authProvider.getAuthRequest();
|
|
9310
9318
|
const _headers = mergeHeaders(
|
|
@@ -9330,16 +9338,23 @@ var ScriptsClient = class {
|
|
|
9330
9338
|
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
9331
9339
|
}
|
|
9332
9340
|
if (_response.error.reason === "status-code") {
|
|
9333
|
-
|
|
9334
|
-
|
|
9335
|
-
|
|
9336
|
-
|
|
9337
|
-
|
|
9341
|
+
switch (_response.error.statusCode) {
|
|
9342
|
+
case 400:
|
|
9343
|
+
throw new BadRequestError(_response.error.body, _response.rawResponse);
|
|
9344
|
+
case 404:
|
|
9345
|
+
throw new NotFoundError(_response.error.body, _response.rawResponse);
|
|
9346
|
+
default:
|
|
9347
|
+
throw new VectrosError({
|
|
9348
|
+
statusCode: _response.error.statusCode,
|
|
9349
|
+
body: _response.error.body,
|
|
9350
|
+
rawResponse: _response.rawResponse
|
|
9351
|
+
});
|
|
9352
|
+
}
|
|
9338
9353
|
}
|
|
9339
9354
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/scripts");
|
|
9340
9355
|
}
|
|
9341
9356
|
/**
|
|
9342
|
-
* 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.
|
|
9357
|
+
* 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.
|
|
9343
9358
|
*
|
|
9344
9359
|
* @param {Vectros.ScriptRequest} request
|
|
9345
9360
|
* @param {ScriptsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -9526,12 +9541,13 @@ var ScriptsClient = class {
|
|
|
9526
9541
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "PUT", "/v1/scripts/{id}");
|
|
9527
9542
|
}
|
|
9528
9543
|
/**
|
|
9529
|
-
* 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.
|
|
9544
|
+
* 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.
|
|
9530
9545
|
*
|
|
9531
9546
|
* @param {Vectros.DeleteScriptRequest} request
|
|
9532
9547
|
* @param {ScriptsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
9533
9548
|
*
|
|
9534
9549
|
* @throws {@link Vectros.NotFoundError}
|
|
9550
|
+
* @throws {@link Vectros.ConflictError}
|
|
9535
9551
|
* @throws {@link Vectros.TooManyRequestsError}
|
|
9536
9552
|
*
|
|
9537
9553
|
* @example
|
|
@@ -9571,6 +9587,8 @@ var ScriptsClient = class {
|
|
|
9571
9587
|
switch (_response.error.statusCode) {
|
|
9572
9588
|
case 404:
|
|
9573
9589
|
throw new NotFoundError(_response.error.body, _response.rawResponse);
|
|
9590
|
+
case 409:
|
|
9591
|
+
throw new ConflictError(_response.error.body, _response.rawResponse);
|
|
9574
9592
|
case 429:
|
|
9575
9593
|
throw new TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
9576
9594
|
default:
|
|
@@ -10163,8 +10181,8 @@ function warnOnSuboptimalKey(key, log) {
|
|
|
10163
10181
|
|
|
10164
10182
|
// src/build-info.ts
|
|
10165
10183
|
var BUILD_INFO = {
|
|
10166
|
-
mcpServer: true ? "0.17.
|
|
10167
|
-
sdk: true ? "0.
|
|
10184
|
+
mcpServer: true ? "0.17.1" : "dev",
|
|
10185
|
+
sdk: true ? "0.44.0" : "dev"
|
|
10168
10186
|
};
|
|
10169
10187
|
|
|
10170
10188
|
// src/log.ts
|
|
@@ -10500,6 +10518,8 @@ var hybridSearch = ({ client, log }) => ({
|
|
|
10500
10518
|
title: "Hybrid search",
|
|
10501
10519
|
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).',
|
|
10502
10520
|
inputSchema,
|
|
10521
|
+
// A pure read — never creates, modifies, or deletes anything server-side.
|
|
10522
|
+
annotations: { readOnlyHint: true, destructiveHint: false, idempotentHint: true },
|
|
10503
10523
|
handler: async (args) => {
|
|
10504
10524
|
const limit = args.limit ?? MCP_DEFAULT_LIMIT;
|
|
10505
10525
|
const mode = args.mode ?? "HYBRID";
|
|
@@ -10648,6 +10668,8 @@ var recordQuery = ({ client, log }) => ({
|
|
|
10648
10668
|
title: "Record query (list or lookup)",
|
|
10649
10669
|
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.",
|
|
10650
10670
|
inputSchema: inputSchema2,
|
|
10671
|
+
// A pure read — never creates, modifies, or deletes anything server-side.
|
|
10672
|
+
annotations: { readOnlyHint: true, destructiveHint: false, idempotentHint: true },
|
|
10651
10673
|
handler: async (args) => {
|
|
10652
10674
|
const limit = args.limit ?? MCP_DEFAULT_LIMIT2;
|
|
10653
10675
|
const type = args.type;
|
|
@@ -10893,6 +10915,8 @@ var recordGet = ({ client, log }) => ({
|
|
|
10893
10915
|
title: "Get a record by id or externalId",
|
|
10894
10916
|
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.",
|
|
10895
10917
|
inputSchema: inputSchema3,
|
|
10918
|
+
// A pure read — never creates, modifies, or deletes anything server-side.
|
|
10919
|
+
annotations: { readOnlyHint: true, destructiveHint: false, idempotentHint: true },
|
|
10896
10920
|
handler: async (args) => {
|
|
10897
10921
|
const id = args.id;
|
|
10898
10922
|
const externalId = args.externalId;
|
|
@@ -10938,6 +10962,8 @@ var recordBatchGet = ({ client, log }) => ({
|
|
|
10938
10962
|
title: "Get multiple records by id in one call",
|
|
10939
10963
|
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.",
|
|
10940
10964
|
inputSchema: inputSchema4,
|
|
10965
|
+
// A pure read — never creates, modifies, or deletes anything server-side.
|
|
10966
|
+
annotations: { readOnlyHint: true, destructiveHint: false, idempotentHint: true },
|
|
10941
10967
|
handler: async (args) => {
|
|
10942
10968
|
const ids = args.ids;
|
|
10943
10969
|
try {
|
|
@@ -10996,6 +11022,13 @@ var recordCreate = ({ client, log }) => ({
|
|
|
10996
11022
|
title: "Create a record",
|
|
10997
11023
|
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).",
|
|
10998
11024
|
inputSchema: inputSchema5,
|
|
11025
|
+
// Creates, never modifies or deletes an existing record. Idempotent ONLY when the caller
|
|
11026
|
+
// supplies `externalId` (optional, per the doc comment above) — re-creating with the same
|
|
11027
|
+
// one returns the existing record rather than duplicating it. `externalId` is not required,
|
|
11028
|
+
// so annotated for the less-safe default (omit it, and a retry creates a second record),
|
|
11029
|
+
// not the safer opt-in — same standard applied to record_batch_write, which has the
|
|
11030
|
+
// identical optional-externalId shape.
|
|
11031
|
+
annotations: { readOnlyHint: false, destructiveHint: false, idempotentHint: false },
|
|
10999
11032
|
handler: async (args) => {
|
|
11000
11033
|
const type = args.type;
|
|
11001
11034
|
try {
|
|
@@ -11061,6 +11094,15 @@ var recordBatchWrite = ({ client, log }) => ({
|
|
|
11061
11094
|
title: "Create or upsert multiple records in one call",
|
|
11062
11095
|
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).',
|
|
11063
11096
|
inputSchema: inputSchema6,
|
|
11097
|
+
// Creates by default, and can overwrite existing records as a FULL replacement when
|
|
11098
|
+
// `upsert:true` is passed (destructive to whatever fields the old version carried and
|
|
11099
|
+
// this call omits). Idempotent ONLY when every item supplies `externalId` (optional,
|
|
11100
|
+
// per its own field doc above) — re-submitting then converges, with or without
|
|
11101
|
+
// `upsert:true`. `externalId` is not required, so annotated for the less-safe default:
|
|
11102
|
+
// an item with no `externalId` at all has no dedup key, and a resubmit creates a second
|
|
11103
|
+
// record for it regardless of `upsert`. Same standard applied to record_create/
|
|
11104
|
+
// document_ingest's identical optional-externalId shape.
|
|
11105
|
+
annotations: { readOnlyHint: false, destructiveHint: true, idempotentHint: false },
|
|
11064
11106
|
handler: async (args) => {
|
|
11065
11107
|
const items = args.items;
|
|
11066
11108
|
const atomicity = args.atomicity;
|
|
@@ -11124,6 +11166,10 @@ var recordUpdate = ({ client, log }) => ({
|
|
|
11124
11166
|
title: "Update a record by id or externalId",
|
|
11125
11167
|
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.",
|
|
11126
11168
|
inputSchema: inputSchema7,
|
|
11169
|
+
// A JSON Merge Patch — overwrites the fields it names, so it can destroy a prior field
|
|
11170
|
+
// value the caller did not mean to lose. Re-applying the same patch converges to the
|
|
11171
|
+
// same state, so it is idempotent.
|
|
11172
|
+
annotations: { readOnlyHint: false, destructiveHint: true, idempotentHint: true },
|
|
11127
11173
|
handler: async (args) => {
|
|
11128
11174
|
const id = args.id;
|
|
11129
11175
|
const externalId = args.externalId;
|
|
@@ -11158,6 +11204,10 @@ var recordDelete = ({ client, log }) => ({
|
|
|
11158
11204
|
title: "Delete a record",
|
|
11159
11205
|
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.",
|
|
11160
11206
|
inputSchema: inputSchema8,
|
|
11207
|
+
// Deletes (leaves a tombstone server-side, but the record is gone from every normal
|
|
11208
|
+
// read path). Idempotent in the standard REST sense: the end state ("this id no longer
|
|
11209
|
+
// resolves") is the same whether this is the first delete or a repeat of one.
|
|
11210
|
+
annotations: { readOnlyHint: false, destructiveHint: true, idempotentHint: true },
|
|
11161
11211
|
handler: async (args) => {
|
|
11162
11212
|
const id = args.id;
|
|
11163
11213
|
try {
|
|
@@ -11220,6 +11270,15 @@ var ragAsk = ({ client, log }) => ({
|
|
|
11220
11270
|
title: "RAG ask (corpus-wide)",
|
|
11221
11271
|
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.",
|
|
11222
11272
|
inputSchema: inputSchema9,
|
|
11273
|
+
// NOT a pure read: this call reserves an atomic hold against the caller's prepaid inference
|
|
11274
|
+
// balance before generation starts, then debits it on completion — a real financial side
|
|
11275
|
+
// effect that can trigger a configured auto-recharge against the tenant's card.
|
|
11276
|
+
// `readOnlyHint:true` would let a host
|
|
11277
|
+
// skip a confirmation prompt on a call with real, unbounded-under-retry spend; ordinary reads
|
|
11278
|
+
// that merely meter usage stay `readOnlyHint:true` (hybrid_search has no inference-cost leg),
|
|
11279
|
+
// but a call that can debit a balance and possibly charge a card is a different class. Not
|
|
11280
|
+
// idempotent either: every repeat charges again, and generation is non-deterministic.
|
|
11281
|
+
annotations: { readOnlyHint: false, destructiveHint: false, idempotentHint: false },
|
|
11223
11282
|
handler: async (args, extra) => {
|
|
11224
11283
|
const rawSearch = args.search ?? {};
|
|
11225
11284
|
if (rawSearch.scope !== void 0 && rawSearch.scopeFilters !== void 0) {
|
|
@@ -11319,6 +11378,15 @@ var documentAsk = ({ client, log }) => ({
|
|
|
11319
11378
|
title: "Document ask (single-document)",
|
|
11320
11379
|
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.",
|
|
11321
11380
|
inputSchema: inputSchema10,
|
|
11381
|
+
// NOT a pure read: this call reserves an atomic hold against the caller's prepaid inference
|
|
11382
|
+
// balance before generation starts, then debits it on completion — a real financial side
|
|
11383
|
+
// effect that can trigger a configured auto-recharge against the tenant's card.
|
|
11384
|
+
// `readOnlyHint:true` would let a host
|
|
11385
|
+
// skip a confirmation prompt on a call with real, unbounded-under-retry spend; ordinary reads
|
|
11386
|
+
// that merely meter usage stay `readOnlyHint:true` (hybrid_search has no inference-cost leg),
|
|
11387
|
+
// but a call that can debit a balance and possibly charge a card is a different class. Not
|
|
11388
|
+
// idempotent either: every repeat charges again, and generation is non-deterministic.
|
|
11389
|
+
annotations: { readOnlyHint: false, destructiveHint: false, idempotentHint: false },
|
|
11322
11390
|
handler: async (args, extra) => {
|
|
11323
11391
|
try {
|
|
11324
11392
|
const stream = await client.inference.documentAsk({
|
|
@@ -11397,6 +11465,8 @@ var listSchemas = ({ client, log }) => ({
|
|
|
11397
11465
|
title: "List record schemas",
|
|
11398
11466
|
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.',
|
|
11399
11467
|
inputSchema: inputSchema11,
|
|
11468
|
+
// A pure read — never creates, modifies, or deletes anything server-side.
|
|
11469
|
+
annotations: { readOnlyHint: true, destructiveHint: false, idempotentHint: true },
|
|
11400
11470
|
handler: async (args) => {
|
|
11401
11471
|
const userId = args.userId;
|
|
11402
11472
|
const scope = args.scope;
|
|
@@ -11451,6 +11521,8 @@ var documentGet = ({ client, log }) => ({
|
|
|
11451
11521
|
title: "Get document metadata (and optionally text)",
|
|
11452
11522
|
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.",
|
|
11453
11523
|
inputSchema: inputSchema12,
|
|
11524
|
+
// A pure read — never creates, modifies, or deletes anything server-side.
|
|
11525
|
+
annotations: { readOnlyHint: true, destructiveHint: false, idempotentHint: true },
|
|
11454
11526
|
handler: async (args) => {
|
|
11455
11527
|
const documentId = args.documentId;
|
|
11456
11528
|
const externalId = args.externalId;
|
|
@@ -11545,6 +11617,8 @@ var documentQuery = ({ client, log }) => ({
|
|
|
11545
11617
|
title: "Document query (list or lookup)",
|
|
11546
11618
|
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.",
|
|
11547
11619
|
inputSchema: inputSchema13,
|
|
11620
|
+
// A pure read — never creates, modifies, or deletes anything server-side.
|
|
11621
|
+
annotations: { readOnlyHint: true, destructiveHint: false, idempotentHint: true },
|
|
11548
11622
|
handler: async (args) => {
|
|
11549
11623
|
const limit = args.limit ?? MCP_DEFAULT_LIMIT3;
|
|
11550
11624
|
const field = args.field;
|
|
@@ -11655,6 +11729,10 @@ var documentUpdate = ({ client, log }) => ({
|
|
|
11655
11729
|
title: "Update a document",
|
|
11656
11730
|
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.',
|
|
11657
11731
|
inputSchema: inputSchema14,
|
|
11732
|
+
// A JSON Merge Patch — overwrites the fields it names, so it can destroy a prior field
|
|
11733
|
+
// value the caller did not mean to lose. Re-applying the same patch converges to the
|
|
11734
|
+
// same state, so it is idempotent.
|
|
11735
|
+
annotations: { readOnlyHint: false, destructiveHint: true, idempotentHint: true },
|
|
11658
11736
|
handler: async (args) => {
|
|
11659
11737
|
const documentId = args.documentId;
|
|
11660
11738
|
const externalId = args.externalId;
|
|
@@ -11703,6 +11781,9 @@ var documentDelete = ({ client, log }) => ({
|
|
|
11703
11781
|
title: "Delete a document",
|
|
11704
11782
|
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).',
|
|
11705
11783
|
inputSchema: inputSchema15,
|
|
11784
|
+
// Deletes. Idempotent in the standard REST sense: the end state ("this id no longer
|
|
11785
|
+
// resolves") is the same whether this is the first delete or a repeat of one.
|
|
11786
|
+
annotations: { readOnlyHint: false, destructiveHint: true, idempotentHint: true },
|
|
11706
11787
|
handler: async (args) => {
|
|
11707
11788
|
const documentId = args.documentId;
|
|
11708
11789
|
try {
|
|
@@ -11740,6 +11821,8 @@ var folderQuery = ({ client, log }) => ({
|
|
|
11740
11821
|
title: "Folder query (list or get)",
|
|
11741
11822
|
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.",
|
|
11742
11823
|
inputSchema: inputSchema16,
|
|
11824
|
+
// A pure read — never creates, modifies, or deletes anything server-side.
|
|
11825
|
+
annotations: { readOnlyHint: true, destructiveHint: false, idempotentHint: true },
|
|
11743
11826
|
handler: async (args) => {
|
|
11744
11827
|
const id = args.id;
|
|
11745
11828
|
try {
|
|
@@ -11774,7 +11857,9 @@ var inputSchema17 = {
|
|
|
11774
11857
|
name: z17.string().min(1, "name is required").describe("Folder display name."),
|
|
11775
11858
|
description: z17.string().optional().describe("Optional description of the folder's purpose."),
|
|
11776
11859
|
parentId: z17.string().optional().describe("Parent folder id \u2014 places the folder under this parent. Omit for the context default root. Create-only."),
|
|
11777
|
-
slug: z17.string().optional().describe(
|
|
11860
|
+
slug: z17.string().optional().describe(
|
|
11861
|
+
"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."
|
|
11862
|
+
),
|
|
11778
11863
|
userId: z17.string().optional().describe("Owning user (Vectros UUID)."),
|
|
11779
11864
|
scopes: z17.array(z17.string()).optional().describe(
|
|
11780
11865
|
'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.'
|
|
@@ -11783,8 +11868,18 @@ var inputSchema17 = {
|
|
|
11783
11868
|
var folderCreate = ({ client, log }) => ({
|
|
11784
11869
|
name: "folder_create",
|
|
11785
11870
|
title: "Create a folder",
|
|
11786
|
-
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).",
|
|
11871
|
+
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).",
|
|
11787
11872
|
inputSchema: inputSchema17,
|
|
11873
|
+
// Idempotent ONLY when the caller supplies `slug` explicitly (see the doc comment above): an
|
|
11874
|
+
// omitted slug is derived through a collision-probing suffix loop that returns only a
|
|
11875
|
+
// freshly-proved-free value, so the idempotency check running after that derivation can never
|
|
11876
|
+
// match on the default path. `slug` is optional, so this is annotated for the less-safe default —
|
|
11877
|
+
// the same standard applied to record_create/document_ingest/record_batch_write's identical
|
|
11878
|
+
// optional-dedupe-key shape. (A prior version of this annotation claimed unconditional
|
|
11879
|
+
// idempotency, reasoning that the derived slug made this tool "genuinely structurally different"
|
|
11880
|
+
// from the optional-externalId tools — that reasoning was wrong: the derivation is unconditional,
|
|
11881
|
+
// but it is unconditionally NON-colliding by construction, which is the opposite property.)
|
|
11882
|
+
annotations: { readOnlyHint: false, destructiveHint: false, idempotentHint: false },
|
|
11788
11883
|
handler: async (args) => {
|
|
11789
11884
|
try {
|
|
11790
11885
|
const folder = await client.folders.createFolder({
|
|
@@ -11826,6 +11921,10 @@ var folderUpdate = ({ client, log }) => ({
|
|
|
11826
11921
|
title: "Update a folder",
|
|
11827
11922
|
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.",
|
|
11828
11923
|
inputSchema: inputSchema18,
|
|
11924
|
+
// A JSON Merge Patch — overwrites the fields it names, so it can destroy a prior field
|
|
11925
|
+
// value the caller did not mean to lose. Re-applying the same patch converges to the
|
|
11926
|
+
// same state, so it is idempotent.
|
|
11927
|
+
annotations: { readOnlyHint: false, destructiveHint: true, idempotentHint: true },
|
|
11829
11928
|
handler: async (args) => {
|
|
11830
11929
|
const id = args.id;
|
|
11831
11930
|
const name = args.name;
|
|
@@ -11861,6 +11960,9 @@ var folderDelete = ({ client, log }) => ({
|
|
|
11861
11960
|
title: "Delete a folder",
|
|
11862
11961
|
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.',
|
|
11863
11962
|
inputSchema: inputSchema19,
|
|
11963
|
+
// Deletes. Idempotent in the standard REST sense: the end state ("this id no longer
|
|
11964
|
+
// resolves") is the same whether this is the first delete or a repeat of one.
|
|
11965
|
+
annotations: { readOnlyHint: false, destructiveHint: true, idempotentHint: true },
|
|
11864
11966
|
handler: async (args) => {
|
|
11865
11967
|
const id = args.id;
|
|
11866
11968
|
try {
|
|
@@ -11884,6 +11986,8 @@ var currentIdentity = ({ log, apiKey, environment }) => ({
|
|
|
11884
11986
|
title: "Current identity (tenant + principal scope)",
|
|
11885
11987
|
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.",
|
|
11886
11988
|
inputSchema: inputSchema20,
|
|
11989
|
+
// A pure read (/v1/ping) — never creates, modifies, or deletes anything server-side.
|
|
11990
|
+
annotations: { readOnlyHint: true, destructiveHint: false, idempotentHint: true },
|
|
11887
11991
|
handler: async () => {
|
|
11888
11992
|
try {
|
|
11889
11993
|
const identity = await resolveIdentity({ log, apiKey, environment });
|
|
@@ -12013,6 +12117,16 @@ var documentIngest = ({ client, log, transport, ingestRoot }) => ({
|
|
|
12013
12117
|
title: "Ingest a new document (text body or file upload)",
|
|
12014
12118
|
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`.",
|
|
12015
12119
|
inputSchema: inputSchema21,
|
|
12120
|
+
// Creates by default, idempotent ONLY when the caller supplies `externalId` (optional,
|
|
12121
|
+
// per the doc comment above) — re-ingest then returns the existing document rather than
|
|
12122
|
+
// duplicating it. `externalId` is not required, so annotated for the less-safe default
|
|
12123
|
+
// (omit it, and every call creates a new document), same standard applied to
|
|
12124
|
+
// record_create/record_batch_write's identical optional-externalId shape. `upsert:true`
|
|
12125
|
+
// is a further, real, named capability of this tool that OVERWRITES an existing
|
|
12126
|
+
// document's content and re-indexes it — that path is destructive to the prior body, so
|
|
12127
|
+
// this is flagged destructive rather than claiming create-only safety a caller can
|
|
12128
|
+
// invoke past.
|
|
12129
|
+
annotations: { readOnlyHint: false, destructiveHint: true, idempotentHint: false },
|
|
12016
12130
|
handler: async (args) => {
|
|
12017
12131
|
const title = args.title;
|
|
12018
12132
|
const text = args.text;
|
|
@@ -12123,7 +12237,7 @@ var documentIngest = ({ client, log, transport, ingestRoot }) => ({
|
|
|
12123
12237
|
}
|
|
12124
12238
|
const putRes = await fetch(uploadUrl, {
|
|
12125
12239
|
method: "PUT",
|
|
12126
|
-
headers: { "Content-Type": fileType },
|
|
12240
|
+
headers: { "Content-Type": fileType, ...presignedUploadHeaders(upload) },
|
|
12127
12241
|
body: bytes
|
|
12128
12242
|
});
|
|
12129
12243
|
if (!putRes.ok) {
|
|
@@ -12162,6 +12276,13 @@ var documentIngest = ({ client, log, transport, ingestRoot }) => ({
|
|
|
12162
12276
|
}
|
|
12163
12277
|
});
|
|
12164
12278
|
var document_ingest_default = documentIngest;
|
|
12279
|
+
function presignedUploadHeaders(response) {
|
|
12280
|
+
if (typeof response !== "object" || response === null) return {};
|
|
12281
|
+
const { requiredHeaderName, requiredHeaderValue } = response;
|
|
12282
|
+
if (typeof requiredHeaderName !== "string" || requiredHeaderName === "") return {};
|
|
12283
|
+
if (typeof requiredHeaderValue !== "string") return {};
|
|
12284
|
+
return { [requiredHeaderName]: requiredHeaderValue };
|
|
12285
|
+
}
|
|
12165
12286
|
|
|
12166
12287
|
// src/tools/lookup_principal.ts
|
|
12167
12288
|
import { z as z21 } from "zod";
|
|
@@ -12195,6 +12316,8 @@ var lookupPrincipal = ({ client, log }) => ({
|
|
|
12195
12316
|
title: "Look up a user identity or a namespaced identity entity",
|
|
12196
12317
|
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.",
|
|
12197
12318
|
inputSchema: inputSchema22,
|
|
12319
|
+
// A pure read — never creates, modifies, or deletes anything server-side.
|
|
12320
|
+
annotations: { readOnlyHint: true, destructiveHint: false, idempotentHint: true },
|
|
12198
12321
|
handler: async (args) => {
|
|
12199
12322
|
const kind = args.kind;
|
|
12200
12323
|
const isUser = kind === "user";
|
|
@@ -12279,6 +12402,8 @@ var versionHistory = ({ client, log }) => ({
|
|
|
12279
12402
|
title: "Version history (record or document)",
|
|
12280
12403
|
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.",
|
|
12281
12404
|
inputSchema: inputSchema23,
|
|
12405
|
+
// A pure read — never creates, modifies, or deletes anything server-side.
|
|
12406
|
+
annotations: { readOnlyHint: true, destructiveHint: false, idempotentHint: true },
|
|
12282
12407
|
handler: async (args) => {
|
|
12283
12408
|
const resourceType = args.resourceType;
|
|
12284
12409
|
const id = args.id;
|
|
@@ -12556,7 +12681,12 @@ var VectrosMCPServer = class {
|
|
|
12556
12681
|
// MCP client (a well-behaved client rejects an unknown key before the call).
|
|
12557
12682
|
// The server enforces it too (z.object(...).strict() below) so a raw JSON-RPC
|
|
12558
12683
|
// call that skips client validation is still rejected — belt and suspenders.
|
|
12559
|
-
inputSchema: { ...zodShapeToJsonSchema(t.inputSchema), additionalProperties: false }
|
|
12684
|
+
inputSchema: { ...zodShapeToJsonSchema(t.inputSchema), additionalProperties: false },
|
|
12685
|
+
// Forwarded from the tool's own definition, not hand-copied here: adding an
|
|
12686
|
+
// annotation to a tool factory does nothing for a client unless it also reaches
|
|
12687
|
+
// this emitted list — the actual `tools/list` response a host reads, not the
|
|
12688
|
+
// source that builds it.
|
|
12689
|
+
...t.annotations ? { annotations: t.annotations } : {}
|
|
12560
12690
|
}))
|
|
12561
12691
|
})
|
|
12562
12692
|
);
|