@vectros-ai/mcp-server 0.17.1 → 0.18.0
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 +37 -0
- package/README.md +37 -20
- package/dist/cli-http.js +275 -168
- package/dist/cli-http.js.map +1 -1
- package/dist/cli-http.mjs +275 -168
- package/dist/cli-http.mjs.map +1 -1
- package/dist/cli.js +275 -168
- package/dist/cli.js.map +1 -1
- package/dist/cli.mjs +275 -168
- package/dist/cli.mjs.map +1 -1
- package/dist/index.js +275 -168
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +275 -168
- package/dist/index.mjs.map +1 -1
- package/package.json +3 -3
package/dist/cli-http.mjs
CHANGED
|
@@ -23,6 +23,7 @@ __export(api_exports, {
|
|
|
23
23
|
ContentTooLargeError: () => ContentTooLargeError,
|
|
24
24
|
DocumentContextEvent: () => DocumentContextEvent,
|
|
25
25
|
DocumentLookupRequest: () => DocumentLookupRequest,
|
|
26
|
+
DocumentPatchRequest: () => DocumentPatchRequest,
|
|
26
27
|
DocumentRequest: () => DocumentRequest,
|
|
27
28
|
DocumentResponse: () => DocumentResponse,
|
|
28
29
|
DoneEvent: () => DoneEvent,
|
|
@@ -366,6 +367,13 @@ var DocumentLookupRequest;
|
|
|
366
367
|
Desc: "desc"
|
|
367
368
|
};
|
|
368
369
|
})(DocumentLookupRequest || (DocumentLookupRequest = {}));
|
|
370
|
+
var DocumentPatchRequest;
|
|
371
|
+
((DocumentPatchRequest2) => {
|
|
372
|
+
DocumentPatchRequest2.Status = {
|
|
373
|
+
Active: "ACTIVE",
|
|
374
|
+
Archived: "ARCHIVED"
|
|
375
|
+
};
|
|
376
|
+
})(DocumentPatchRequest || (DocumentPatchRequest = {}));
|
|
369
377
|
var FileUploadRequest;
|
|
370
378
|
((FileUploadRequest2) => {
|
|
371
379
|
FileUploadRequest2.IndexMode = {
|
|
@@ -378,6 +386,7 @@ var FileUploadRequest;
|
|
|
378
386
|
var documents_exports = {};
|
|
379
387
|
__export(documents_exports, {
|
|
380
388
|
DocumentLookupRequest: () => DocumentLookupRequest,
|
|
389
|
+
DocumentPatchRequest: () => DocumentPatchRequest,
|
|
381
390
|
FileUploadRequest: () => FileUploadRequest,
|
|
382
391
|
LookupDocumentsRequestOrder: () => LookupDocumentsRequestOrder
|
|
383
392
|
});
|
|
@@ -3042,6 +3051,7 @@ var AuthClient = class {
|
|
|
3042
3051
|
* @param {AuthClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
3043
3052
|
*
|
|
3044
3053
|
* @throws {@link Vectros.BadRequestError}
|
|
3054
|
+
* @throws {@link Vectros.PaymentRequiredError}
|
|
3045
3055
|
* @throws {@link Vectros.ForbiddenError}
|
|
3046
3056
|
* @throws {@link Vectros.TooManyRequestsError}
|
|
3047
3057
|
*
|
|
@@ -3091,6 +3101,8 @@ var AuthClient = class {
|
|
|
3091
3101
|
switch (_response.error.statusCode) {
|
|
3092
3102
|
case 400:
|
|
3093
3103
|
throw new BadRequestError(_response.error.body, _response.rawResponse);
|
|
3104
|
+
case 402:
|
|
3105
|
+
throw new PaymentRequiredError(_response.error.body, _response.rawResponse);
|
|
3094
3106
|
case 403:
|
|
3095
3107
|
throw new ForbiddenError(_response.error.body, _response.rawResponse);
|
|
3096
3108
|
case 429:
|
|
@@ -3523,7 +3535,7 @@ var AuthClient = class {
|
|
|
3523
3535
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/app-contexts/{contextId}");
|
|
3524
3536
|
}
|
|
3525
3537
|
/**
|
|
3526
|
-
* Updates
|
|
3538
|
+
* 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.
|
|
3527
3539
|
*
|
|
3528
3540
|
* @param {Vectros.UpdateAppContextRequest} request
|
|
3529
3541
|
* @param {AuthClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -4126,7 +4138,7 @@ var AuthClient = class {
|
|
|
4126
4138
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/auth/issuers/{issuerId}");
|
|
4127
4139
|
}
|
|
4128
4140
|
/**
|
|
4129
|
-
* 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.
|
|
4141
|
+
* 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.
|
|
4130
4142
|
*
|
|
4131
4143
|
* @param {Vectros.IssuerUpdateRequest} request
|
|
4132
4144
|
* @param {AuthClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -4319,7 +4331,7 @@ var AuthClient = class {
|
|
|
4319
4331
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/auth/issuers");
|
|
4320
4332
|
}
|
|
4321
4333
|
/**
|
|
4322
|
-
* 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.
|
|
4334
|
+
* 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.
|
|
4323
4335
|
*
|
|
4324
4336
|
* @param {Vectros.IssuerRequest} request
|
|
4325
4337
|
* @param {AuthClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -4385,6 +4397,82 @@ var AuthClient = class {
|
|
|
4385
4397
|
}
|
|
4386
4398
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v1/auth/issuers");
|
|
4387
4399
|
}
|
|
4400
|
+
/**
|
|
4401
|
+
* 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.
|
|
4402
|
+
*
|
|
4403
|
+
* @param {Vectros.IssuerVerifyRequest} request
|
|
4404
|
+
* @param {AuthClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
4405
|
+
*
|
|
4406
|
+
* @throws {@link Vectros.BadRequestError}
|
|
4407
|
+
* @throws {@link Vectros.ForbiddenError}
|
|
4408
|
+
* @throws {@link Vectros.NotFoundError}
|
|
4409
|
+
* @throws {@link Vectros.ConflictError}
|
|
4410
|
+
* @throws {@link Vectros.TooManyRequestsError}
|
|
4411
|
+
*
|
|
4412
|
+
* @example
|
|
4413
|
+
* await client.auth.verifyIssuer({
|
|
4414
|
+
* issuerId: "auth0-prod",
|
|
4415
|
+
* token: "token"
|
|
4416
|
+
* })
|
|
4417
|
+
*/
|
|
4418
|
+
verifyIssuer(request, requestOptions) {
|
|
4419
|
+
return HttpResponsePromise.fromPromise(this.__verifyIssuer(request, requestOptions));
|
|
4420
|
+
}
|
|
4421
|
+
async __verifyIssuer(request, requestOptions) {
|
|
4422
|
+
const { issuerId, ..._body } = request;
|
|
4423
|
+
const _authRequest = await this._options.authProvider.getAuthRequest();
|
|
4424
|
+
const _headers = mergeHeaders(
|
|
4425
|
+
_authRequest.headers,
|
|
4426
|
+
this._options?.headers,
|
|
4427
|
+
requestOptions?.headers
|
|
4428
|
+
);
|
|
4429
|
+
const _response = await fetcher({
|
|
4430
|
+
url: url_exports.join(
|
|
4431
|
+
await Supplier.get(this._options.baseUrl) ?? await Supplier.get(this._options.environment),
|
|
4432
|
+
`v1/auth/issuers/${url_exports.encodePathParam(issuerId)}/verify`
|
|
4433
|
+
),
|
|
4434
|
+
method: "POST",
|
|
4435
|
+
headers: _headers,
|
|
4436
|
+
contentType: "application/json",
|
|
4437
|
+
queryString: url_exports.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
|
|
4438
|
+
requestType: "json",
|
|
4439
|
+
body: _body,
|
|
4440
|
+
timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1e3,
|
|
4441
|
+
maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
|
|
4442
|
+
abortSignal: requestOptions?.abortSignal,
|
|
4443
|
+
fetchFn: this._options?.fetch,
|
|
4444
|
+
logging: this._options.logging
|
|
4445
|
+
});
|
|
4446
|
+
if (_response.ok) {
|
|
4447
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
4448
|
+
}
|
|
4449
|
+
if (_response.error.reason === "status-code") {
|
|
4450
|
+
switch (_response.error.statusCode) {
|
|
4451
|
+
case 400:
|
|
4452
|
+
throw new BadRequestError(_response.error.body, _response.rawResponse);
|
|
4453
|
+
case 403:
|
|
4454
|
+
throw new ForbiddenError(_response.error.body, _response.rawResponse);
|
|
4455
|
+
case 404:
|
|
4456
|
+
throw new NotFoundError(_response.error.body, _response.rawResponse);
|
|
4457
|
+
case 409:
|
|
4458
|
+
throw new ConflictError(_response.error.body, _response.rawResponse);
|
|
4459
|
+
case 429:
|
|
4460
|
+
throw new TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
4461
|
+
default:
|
|
4462
|
+
throw new VectrosError({
|
|
4463
|
+
statusCode: _response.error.statusCode,
|
|
4464
|
+
body: _response.error.body,
|
|
4465
|
+
rawResponse: _response.rawResponse
|
|
4466
|
+
});
|
|
4467
|
+
}
|
|
4468
|
+
}
|
|
4469
|
+
return handleNonStatusCodeError(
|
|
4470
|
+
_response.error,
|
|
4471
|
+
_response.rawResponse,
|
|
4472
|
+
"POST",
|
|
4473
|
+
"/v1/auth/issuers/{issuerId}/verify"
|
|
4474
|
+
);
|
|
4475
|
+
}
|
|
4388
4476
|
/**
|
|
4389
4477
|
* 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.
|
|
4390
4478
|
*
|
|
@@ -4860,7 +4948,7 @@ var ComplianceClient = class {
|
|
|
4860
4948
|
this._options = normalizeClientOptionsWithAuth(options);
|
|
4861
4949
|
}
|
|
4862
4950
|
/**
|
|
4863
|
-
* Submits a right-to-erasure request for a single end-subject (a user, or an identity entity in any namespace). Erasure removes exactly the data the subject solely owns across the declared contexts, plus
|
|
4951
|
+
* Submits a right-to-erasure request for a single end-subject (a user, or an identity entity in any namespace). Erasure removes exactly the data the subject solely owns across the declared contexts, plus its identity and lookup rows when all contexts are covered. It never touches another account's data and never cascades into another subject's data. The request is asynchronous: it returns 202 with a `requestId`; poll `GET /v1/erasure-requests/{id}` until the job completes to obtain the completion certificate. Requires a root API key — a scoped credential is rejected with 403.
|
|
4864
4952
|
*
|
|
4865
4953
|
* @param {Vectros.ErasureRequest} request
|
|
4866
4954
|
* @param {ComplianceClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -4923,7 +5011,7 @@ var ComplianceClient = class {
|
|
|
4923
5011
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v1/erasure-requests");
|
|
4924
5012
|
}
|
|
4925
5013
|
/**
|
|
4926
|
-
* Polls an erasure request by id. While the job is still running this returns its status only; once it completes, the response also includes the verifiable completion certificate (which contexts were swept, per-context deletion counts, and reports of dangling references and shared rows
|
|
5014
|
+
* Polls an erasure request by id. While the job is still running this returns its status only; once it completes, the response also includes the verifiable completion certificate (which contexts were swept, per-context deletion counts, whether the identity was kept, and reports of dangling references and shared rows left intact). Requires a root API key.
|
|
4927
5015
|
*
|
|
4928
5016
|
* @param {Vectros.GetErasureRequestRequest} request
|
|
4929
5017
|
* @param {ComplianceClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -5166,7 +5254,7 @@ var DocumentsClient = class {
|
|
|
5166
5254
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/documents");
|
|
5167
5255
|
}
|
|
5168
5256
|
/**
|
|
5169
|
-
* Creates a document from a raw text string and queues it for asynchronous indexing so it becomes searchable. Optionally supply an `externalId` to make the create idempotent — if a document with the same `externalId` already exists in your context, that existing document is returned unchanged instead of a duplicate being created. The response's `created` field (and the HTTP status — 201 when created, 200 when an existing document was returned) tells the two apart. To overwrite an existing document's content instead of returning it unchanged, set `?upsert=true` (this also requires the `documents:u` scope). Requires the `documents:c` scope to create. Being returned the existing document on a collision is a read of that document's data and additionally requires the `documents:r` scope — a credential holding `documents:c` alone receives a `400` ("already exists") on collision instead of the document.
|
|
5257
|
+
* Creates a document from a raw text string and queues it for asynchronous indexing so it becomes searchable. Optionally supply an `externalId` to make the create idempotent — if a document with the same `externalId` already exists in your context, that existing document is returned unchanged instead of a duplicate being created. The response's `created` field (and the HTTP status — 201 when created, 200 when an existing document was returned) tells the two apart. To overwrite an existing document's content instead of returning it unchanged, set `?upsert=true` (this also requires the `documents:u` scope). Requires the `documents:c` scope to create. Being returned the existing document on a collision is a read of that document's data and additionally requires the `documents:r` scope — a credential holding `documents:c` alone receives a `400` ("already exists") on collision instead of the document. Supplying `externalId` WITHOUT `schemaId` is refused (`400`) unless you also pass `confirmUntyped=true` — externalId uniqueness is scoped per schema, so omitting `schemaId` by mistake would otherwise silently create a separate untyped document instead of targeting the typed one you likely meant.
|
|
5170
5258
|
*
|
|
5171
5259
|
* @param {Vectros.IngestDocumentRequest} request
|
|
5172
5260
|
* @param {DocumentsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -5186,10 +5274,11 @@ var DocumentsClient = class {
|
|
|
5186
5274
|
return HttpResponsePromise.fromPromise(this.__ingestDocument(request, requestOptions));
|
|
5187
5275
|
}
|
|
5188
5276
|
async __ingestDocument(request, requestOptions) {
|
|
5189
|
-
const { upsert, allowClear, body: _body } = request;
|
|
5277
|
+
const { upsert, allowClear, confirmUntyped, body: _body } = request;
|
|
5190
5278
|
const _queryParams = {
|
|
5191
5279
|
upsert,
|
|
5192
|
-
allowClear
|
|
5280
|
+
allowClear,
|
|
5281
|
+
confirmUntyped
|
|
5193
5282
|
};
|
|
5194
5283
|
const _authRequest = await this._options.authProvider.getAuthRequest();
|
|
5195
5284
|
const _headers = mergeHeaders(
|
|
@@ -5424,7 +5513,7 @@ var DocumentsClient = class {
|
|
|
5424
5513
|
/**
|
|
5425
5514
|
* Partially updates a document using an RFC 7386 JSON Merge Patch. The `payload` object is deep-merged: keys you send overwrite existing values (recursing into nested objects), a key set to `null` is deleted, and keys you omit are preserved — unlike PUT, which replaces the whole payload. Top-level fields (`title`, `folderId`, `schemaId`, ownership) are set when present and left unchanged when omitted; sending a top-level field as `null` is rejected. Supplying `text` re-ingests the document body (same as PUT). `indexMode`, `externalId`, and `storeText` (text retention is fixed at ingest) are immutable and rejected if present. The merged result is validated against the bound schema. Pass `expectedVersion` for optimistic concurrency (409 on conflict). Requires the `documents:u` scope.
|
|
5426
5515
|
*
|
|
5427
|
-
* @param {Vectros.
|
|
5516
|
+
* @param {Vectros.DocumentPatchRequest} request
|
|
5428
5517
|
* @param {DocumentsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
5429
5518
|
*
|
|
5430
5519
|
* @throws {@link Vectros.BadRequestError}
|
|
@@ -5435,17 +5524,14 @@ var DocumentsClient = class {
|
|
|
5435
5524
|
*
|
|
5436
5525
|
* @example
|
|
5437
5526
|
* await client.documents.patchDocument({
|
|
5438
|
-
* id: "id"
|
|
5439
|
-
* body: {
|
|
5440
|
-
* title: "Patient Intake Form \u2014 Jane Doe"
|
|
5441
|
-
* }
|
|
5527
|
+
* id: "id"
|
|
5442
5528
|
* })
|
|
5443
5529
|
*/
|
|
5444
5530
|
patchDocument(request, requestOptions) {
|
|
5445
5531
|
return HttpResponsePromise.fromPromise(this.__patchDocument(request, requestOptions));
|
|
5446
5532
|
}
|
|
5447
5533
|
async __patchDocument(request, requestOptions) {
|
|
5448
|
-
const { id,
|
|
5534
|
+
const { id, ..._body } = request;
|
|
5449
5535
|
const _authRequest = await this._options.authProvider.getAuthRequest();
|
|
5450
5536
|
const _headers = mergeHeaders(
|
|
5451
5537
|
_authRequest.headers,
|
|
@@ -5817,7 +5903,7 @@ var DocumentsClient = class {
|
|
|
5817
5903
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/documents/{id}/versions");
|
|
5818
5904
|
}
|
|
5819
5905
|
/**
|
|
5820
|
-
* 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.
|
|
5906
|
+
* 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. Supplying `externalId` WITHOUT `schemaId` is refused (`400`) unless you also pass `confirmUntyped=true` — externalId uniqueness is scoped per schema, so omitting `schemaId` by mistake would otherwise silently create a separate untyped document instead of targeting the typed one you likely meant.
|
|
5821
5907
|
*
|
|
5822
5908
|
* @param {Vectros.FileUploadRequest} request
|
|
5823
5909
|
* @param {DocumentsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -5836,9 +5922,10 @@ var DocumentsClient = class {
|
|
|
5836
5922
|
return HttpResponsePromise.fromPromise(this.__uploadDocument(request, requestOptions));
|
|
5837
5923
|
}
|
|
5838
5924
|
async __uploadDocument(request, requestOptions) {
|
|
5839
|
-
const { upsert, ..._body } = request;
|
|
5925
|
+
const { upsert, confirmUntyped, ..._body } = request;
|
|
5840
5926
|
const _queryParams = {
|
|
5841
|
-
upsert
|
|
5927
|
+
upsert,
|
|
5928
|
+
confirmUntyped
|
|
5842
5929
|
};
|
|
5843
5930
|
const _authRequest = await this._options.authProvider.getAuthRequest();
|
|
5844
5931
|
const _headers = mergeHeaders(
|
|
@@ -10139,7 +10226,7 @@ import {
|
|
|
10139
10226
|
ListToolsRequestSchema,
|
|
10140
10227
|
ReadResourceRequestSchema
|
|
10141
10228
|
} from "@modelcontextprotocol/sdk/types.js";
|
|
10142
|
-
import { z as
|
|
10229
|
+
import { z as z25 } from "zod";
|
|
10143
10230
|
|
|
10144
10231
|
// src/auth.ts
|
|
10145
10232
|
var KEY_RE = /^(sk|ssk|st)_(live|test)_/;
|
|
@@ -10183,8 +10270,8 @@ function warnOnSuboptimalKey(key, log) {
|
|
|
10183
10270
|
|
|
10184
10271
|
// src/build-info.ts
|
|
10185
10272
|
var BUILD_INFO = {
|
|
10186
|
-
mcpServer: true ? "0.
|
|
10187
|
-
sdk: true ? "0.
|
|
10273
|
+
mcpServer: true ? "0.18.0" : "dev",
|
|
10274
|
+
sdk: true ? "0.46.0" : "dev"
|
|
10188
10275
|
};
|
|
10189
10276
|
|
|
10190
10277
|
// src/log.ts
|
|
@@ -10476,7 +10563,7 @@ var inputSchema = {
|
|
|
10476
10563
|
"Keyword-match precision for the BM25 leg (TEXT/HYBRID modes). OR = any term (broad recall), AND = all terms (higher precision), PHRASE = contiguous phrase. Default: PHRASE (slop 3) in HYBRID, OR in TEXT. (The advanced raw-query COMPLEX mode is intentionally not exposed here.)"
|
|
10477
10564
|
),
|
|
10478
10565
|
limit: z.number().int().min(1).max(MCP_MAX_LIMIT).optional().describe(
|
|
10479
|
-
`Max hits per page. Defaults to a low ${MCP_DEFAULT_LIMIT} to protect the agent context window; raise up to ${MCP_MAX_LIMIT} (
|
|
10566
|
+
`Max hits per page. Defaults to a low ${MCP_DEFAULT_LIMIT} to protect the agent context window; raise up to ${MCP_MAX_LIMIT} (this tool's ceiling) in one call when you can accept the larger result, or page with \`offset\` instead.`
|
|
10480
10567
|
),
|
|
10481
10568
|
offset: z.number().int().min(0).max(200).optional().describe("Skip the first N hits \u2014 for pagination (0\u2013200)."),
|
|
10482
10569
|
folderId: z.string().optional().describe("Scope to content in this EXACT folder (Vectros folder id)."),
|
|
@@ -11225,52 +11312,61 @@ var recordDelete = ({ client, log }) => ({
|
|
|
11225
11312
|
var record_delete_default = recordDelete;
|
|
11226
11313
|
|
|
11227
11314
|
// src/tools/rag_ask.ts
|
|
11315
|
+
import { z as z10 } from "zod";
|
|
11316
|
+
|
|
11317
|
+
// src/tools/provider-alias.ts
|
|
11228
11318
|
import { z as z9 } from "zod";
|
|
11319
|
+
var providerAliasInput = z9.string().min(1, "providerAlias must be non-empty when supplied").optional().describe(
|
|
11320
|
+
"Route THIS call through your own model provider instead of the platform-hosted default, by the alias of a provider config your account has activated. It works only after your account has set up that provider and signed the platform's risk-acceptance waiver; without both, the platform refuses the call with a 403, which is returned to you as written. A call served by your own provider leaves the platform-hosted Bedrock path, and Vectros's AWS BAA boundary. Omit it (the default) to use the platform-hosted path. When set, `model` names the model on your provider's own id space, and falls back to that provider config's default model when omitted."
|
|
11321
|
+
);
|
|
11322
|
+
|
|
11323
|
+
// src/tools/rag_ask.ts
|
|
11229
11324
|
var SEARCH_MCP_DEFAULT_LIMIT = 5;
|
|
11230
11325
|
var SEARCH_MCP_MAX_LIMIT = 50;
|
|
11231
11326
|
var inputSchema9 = {
|
|
11232
|
-
query:
|
|
11233
|
-
instructions:
|
|
11327
|
+
query: z10.string().min(1, "query must be non-empty").describe("Question to ground against retrieved content."),
|
|
11328
|
+
instructions: z10.string().optional().describe(
|
|
11234
11329
|
'System prompt that overrides the default for the generation step \u2014 e.g. "answer only from the provided context, cite sources, be concise". Default: a generic answer-from-context instruction.'
|
|
11235
11330
|
),
|
|
11236
|
-
model:
|
|
11237
|
-
"Inference model alias (e.g. claude-haiku-4-5, claude-sonnet-5, claude-opus-
|
|
11331
|
+
model: z10.string().optional().describe(
|
|
11332
|
+
"Inference model alias (e.g. claude-haiku-4-5, claude-sonnet-5, claude-opus-5-5). Default = tier-appropriate Haiku. See GET /v1/models for the catalog the calling key can reach. When `providerAlias` is set, this instead names the model on that provider's own id space."
|
|
11238
11333
|
),
|
|
11239
|
-
|
|
11240
|
-
|
|
11241
|
-
|
|
11242
|
-
|
|
11334
|
+
providerAlias: providerAliasInput,
|
|
11335
|
+
search: z10.object({
|
|
11336
|
+
mode: z10.enum(["HYBRID", "TEXT", "SEMANTIC"]).optional().describe("Retrieval mode. Default HYBRID."),
|
|
11337
|
+
limit: z10.number().int().min(1).max(SEARCH_MCP_MAX_LIMIT).optional().describe(
|
|
11338
|
+
`Passages to retrieve before generating (the grounding-corpus size). Default ${SEARCH_MCP_DEFAULT_LIMIT}; raise up to ${SEARCH_MCP_MAX_LIMIT} (this tool's ceiling) for a broader corpus when the extra grounding is worth the larger prompt.`
|
|
11243
11339
|
),
|
|
11244
11340
|
// Retrieval scoping — parity with hybrid_search so an agent can ground the
|
|
11245
11341
|
// answer on a specific owner / folder / type / metadata subset, not just the
|
|
11246
11342
|
// whole-tenant corpus.
|
|
11247
|
-
userId:
|
|
11248
|
-
scope:
|
|
11343
|
+
userId: z10.string().optional().describe("Restrict retrieval to content owned by this user (Vectros UUID)."),
|
|
11344
|
+
scope: z10.string().optional().describe(
|
|
11249
11345
|
'Restrict retrieval to content carrying this scope value, in `namespace:value` form (e.g. "org:<uuid>", "client:<uuid>", "group:eng-team"). `org` and `client` are reserved namespace names, registered like any other; others are namespaces you registered yourself. Mutually exclusive with `scopeFilters` \u2014 use this for ONE dimension.'
|
|
11250
11346
|
),
|
|
11251
|
-
scopeFilters:
|
|
11347
|
+
scopeFilters: z10.array(z10.string()).min(1, "scopeFilters must name at least one dimension when supplied").optional().describe(
|
|
11252
11348
|
'Restrict retrieval to content matching ALL of these scope values \u2014 one per namespace \u2014 for a credential whose access spans more than one ownership dimension. e.g. ["org:<uuid>", "client:<uuid>"] grounds the answer on one specific client WITHIN one specific org, which `scope` alone cannot express. Naming the same namespace twice is rejected. Mutually exclusive with `scope`.'
|
|
11253
11349
|
),
|
|
11254
|
-
folderId:
|
|
11255
|
-
rootFolderId:
|
|
11256
|
-
typeName:
|
|
11257
|
-
contentTypes:
|
|
11258
|
-
filters:
|
|
11350
|
+
folderId: z10.string().optional().describe("Restrict retrieval to this exact folder."),
|
|
11351
|
+
rootFolderId: z10.string().optional().describe("Restrict retrieval to this folder and all its descendants."),
|
|
11352
|
+
typeName: z10.string().optional().describe("Restrict record retrieval to this schema type."),
|
|
11353
|
+
contentTypes: z10.array(z10.enum(["documents", "records"])).optional().describe('Narrow retrieval to content types. ["documents"] or ["records"]; omit for both.'),
|
|
11354
|
+
filters: z10.record(z10.unknown()).optional().describe(
|
|
11259
11355
|
'Field-level metadata filters (AND-combined). Value = scalar (equality), array (OR-set), or operator map ($eq/$ne/$gt/$gte/$lt/$lte, $in/$nin). e.g. {"status":"open"}.'
|
|
11260
11356
|
),
|
|
11261
|
-
createdAfter:
|
|
11357
|
+
createdAfter: z10.string().optional().describe(
|
|
11262
11358
|
"Restrict retrieval to content CREATED at/after this ISO 8601 UTC timestamp \u2014 the item's own creation time, which does not move when it is re-indexed. An item matched on its FIRST index may be checked against its index time instead, a bounded clock-skew allowance."
|
|
11263
11359
|
),
|
|
11264
|
-
createdBefore:
|
|
11265
|
-
requireComplete:
|
|
11360
|
+
createdBefore: z10.string().optional().describe("Same creation-time basis as createdAfter, bounding at/before this ISO 8601 UTC value."),
|
|
11361
|
+
requireComplete: z10.boolean().optional().describe("Fail closed (503) on a degraded search backend instead of grounding on partial results. Default false.")
|
|
11266
11362
|
}).optional().describe("Retrieval params + scoping. Default mode HYBRID, limit " + SEARCH_MCP_DEFAULT_LIMIT + "."),
|
|
11267
|
-
maxTokens:
|
|
11268
|
-
temperature:
|
|
11363
|
+
maxTokens: z10.number().int().min(1).optional().describe("Max output tokens."),
|
|
11364
|
+
temperature: z10.number().min(0).max(1).optional().describe("Sampling temperature (0.0\u20131.0). Default 0.3 \u2014 lower favors deterministic, retrieval-grounded answers.")
|
|
11269
11365
|
};
|
|
11270
11366
|
var ragAsk = ({ client, log }) => ({
|
|
11271
11367
|
name: "rag_ask",
|
|
11272
11368
|
title: "RAG ask (corpus-wide)",
|
|
11273
|
-
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.
|
|
11369
|
+
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. Calls without `providerAlias` are served by platform-hosted AWS Bedrock. A call that sets `providerAlias` goes to your own model provider, outside Vectros's AWS BAA boundary.",
|
|
11274
11370
|
inputSchema: inputSchema9,
|
|
11275
11371
|
// NOT a pure read: this call reserves an atomic hold against the caller's prepaid inference
|
|
11276
11372
|
// balance before generation starts, then debits it on completion — a real financial side
|
|
@@ -11312,6 +11408,7 @@ var ragAsk = ({ client, log }) => ({
|
|
|
11312
11408
|
query: args.query,
|
|
11313
11409
|
instructions: args.instructions,
|
|
11314
11410
|
model: args.model,
|
|
11411
|
+
providerAlias: args.providerAlias,
|
|
11315
11412
|
search,
|
|
11316
11413
|
maxTokens: args.maxTokens,
|
|
11317
11414
|
temperature: args.temperature
|
|
@@ -11366,19 +11463,20 @@ var ragAsk = ({ client, log }) => ({
|
|
|
11366
11463
|
var rag_ask_default = ragAsk;
|
|
11367
11464
|
|
|
11368
11465
|
// src/tools/document_ask.ts
|
|
11369
|
-
import { z as
|
|
11466
|
+
import { z as z11 } from "zod";
|
|
11370
11467
|
var inputSchema10 = {
|
|
11371
|
-
documentId:
|
|
11372
|
-
prompt:
|
|
11373
|
-
model:
|
|
11374
|
-
"Inference model alias. Default = tier-appropriate Haiku. See GET /v1/models for the catalog the calling key can reach."
|
|
11468
|
+
documentId: z11.string().min(1, "documentId is required").describe("ID of the document to ask against."),
|
|
11469
|
+
prompt: z11.string().min(1, "prompt is required").describe("Question to ask about the document."),
|
|
11470
|
+
model: z11.string().optional().describe(
|
|
11471
|
+
"Inference model alias. Default = tier-appropriate Haiku. See GET /v1/models for the catalog the calling key can reach. When `providerAlias` is set, this instead names the model on that provider's own id space."
|
|
11375
11472
|
),
|
|
11376
|
-
|
|
11473
|
+
providerAlias: providerAliasInput,
|
|
11474
|
+
maxTokens: z11.number().int().min(1).optional().describe("Max output tokens.")
|
|
11377
11475
|
};
|
|
11378
11476
|
var documentAsk = ({ client, log }) => ({
|
|
11379
11477
|
name: "document_ask",
|
|
11380
11478
|
title: "Document ask (single-document)",
|
|
11381
|
-
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`.
|
|
11479
|
+
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`. Calls without `providerAlias` are served by platform-hosted AWS Bedrock. A call that sets `providerAlias` goes to your own model provider, outside Vectros's AWS BAA boundary.",
|
|
11382
11480
|
inputSchema: inputSchema10,
|
|
11383
11481
|
// NOT a pure read: this call reserves an atomic hold against the caller's prepaid inference
|
|
11384
11482
|
// balance before generation starts, then debits it on completion — a real financial side
|
|
@@ -11395,6 +11493,7 @@ var documentAsk = ({ client, log }) => ({
|
|
|
11395
11493
|
id: args.documentId,
|
|
11396
11494
|
prompt: args.prompt,
|
|
11397
11495
|
model: args.model,
|
|
11496
|
+
providerAlias: args.providerAlias,
|
|
11398
11497
|
maxTokens: args.maxTokens
|
|
11399
11498
|
});
|
|
11400
11499
|
const progressToken = extra._meta?.progressToken;
|
|
@@ -11447,18 +11546,18 @@ var documentAsk = ({ client, log }) => ({
|
|
|
11447
11546
|
var document_ask_default = documentAsk;
|
|
11448
11547
|
|
|
11449
11548
|
// src/tools/list_schemas.ts
|
|
11450
|
-
import { z as
|
|
11549
|
+
import { z as z12 } from "zod";
|
|
11451
11550
|
var inputSchema11 = {
|
|
11452
|
-
userId:
|
|
11551
|
+
userId: z12.string().optional().describe(
|
|
11453
11552
|
"Filter to schemas visible to a specific user. Optional; default returns all schemas the credential can see."
|
|
11454
11553
|
),
|
|
11455
|
-
scope:
|
|
11554
|
+
scope: z12.string().optional().describe(
|
|
11456
11555
|
'Filter to schemas carrying this scope value, in `namespace:value` form (e.g. "org:<uuid>", "group:eng-team"). `org` and `client` are reserved namespace names, registered like any other. Optional; default returns all schemas the credential can see.'
|
|
11457
11556
|
),
|
|
11458
|
-
surface:
|
|
11557
|
+
surface: z12.enum(["record", "document", "user", "entity"]).optional().describe(
|
|
11459
11558
|
"Filter to schemas bindable to this surface \u2014 e.g. `document` to list only document types, or `record` for record types. Identity entities in any namespace (org/client/one you registered) bind under the single `entity` surface; `user` and `entity` are account-wide. Optional."
|
|
11460
11559
|
),
|
|
11461
|
-
recordType:
|
|
11560
|
+
recordType: z12.string().optional().describe(
|
|
11462
11561
|
'Resolve the single schema for this record type (its natural handle, e.g. "patient") instead of listing \u2014 returns a one-element result, or empty if none. Combine with `surface=user|entity` for an identity schema. Takes precedence over userId. Optional.'
|
|
11463
11562
|
)
|
|
11464
11563
|
};
|
|
@@ -11494,19 +11593,19 @@ var listSchemas = ({ client, log }) => ({
|
|
|
11494
11593
|
var list_schemas_default = listSchemas;
|
|
11495
11594
|
|
|
11496
11595
|
// src/tools/document_get.ts
|
|
11497
|
-
import { z as
|
|
11596
|
+
import { z as z13 } from "zod";
|
|
11498
11597
|
var MAX_TEXT_CHARS = 32e3;
|
|
11499
11598
|
var inputSchema12 = {
|
|
11500
|
-
documentId:
|
|
11501
|
-
externalId:
|
|
11599
|
+
documentId: z13.string().optional().describe("The document ID returned by document_ingest or hybrid_search. Provide this OR externalId+type."),
|
|
11600
|
+
externalId: z13.string().optional().describe(
|
|
11502
11601
|
"Your caller-owned externalId \u2014 an alternative selector to `documentId` (requires `type`). Fetches the document you ingested under that externalId without a manual lookup first."
|
|
11503
11602
|
),
|
|
11504
|
-
type:
|
|
11505
|
-
includeText:
|
|
11603
|
+
type: z13.string().optional().describe("Document type \u2014 REQUIRED when selecting by `externalId` (externalId is unique within a type)."),
|
|
11604
|
+
includeText: z13.boolean().optional().describe(
|
|
11506
11605
|
"If true, fetch and include the document text (capped at ~8K tokens, truncated: true flag if cut). Default false \u2014 metadata only. For larger documents, prefer `document_ask` over dumping text into context."
|
|
11507
11606
|
),
|
|
11508
|
-
includeDownloadUrl:
|
|
11509
|
-
"If true, also return a short-lived presigned `downloadUrl` for the original file (file-backed documents only \u2014 the way to retrieve the raw bytes of a document ingested via file mode). Default false. Unavailable for text-only documents \u2014 `downloadAvailable: false` is set instead."
|
|
11607
|
+
includeDownloadUrl: z13.boolean().optional().describe(
|
|
11608
|
+
"If true, also return a short-lived presigned `downloadUrl` for the original file (file-backed documents only \u2014 the way to retrieve the raw bytes of a document ingested via file mode). Default false. Unavailable for text-only documents \u2014 `downloadAvailable: false` is set instead. `downloadExpires` is an upper bound, not a guarantee: if the file behind this document is replaced (a document_ingest upsert) after this URL is minted, the URL can stop working before that time. Request a fresh one after any re-ingest rather than reusing one you already hold."
|
|
11510
11609
|
)
|
|
11511
11610
|
};
|
|
11512
11611
|
function truncateText(text) {
|
|
@@ -11589,28 +11688,28 @@ var documentGet = ({ client, log }) => ({
|
|
|
11589
11688
|
var document_get_default = documentGet;
|
|
11590
11689
|
|
|
11591
11690
|
// src/tools/document_query.ts
|
|
11592
|
-
import { z as
|
|
11691
|
+
import { z as z14 } from "zod";
|
|
11593
11692
|
var MCP_DEFAULT_LIMIT3 = 3;
|
|
11594
11693
|
var MCP_MAX_LIMIT3 = 100;
|
|
11595
11694
|
var inputSchema13 = {
|
|
11596
11695
|
// Lookup-mode args — provide `field` plus EXACTLY ONE of: value | from+to | prefix.
|
|
11597
|
-
field:
|
|
11598
|
-
value:
|
|
11599
|
-
from:
|
|
11600
|
-
to:
|
|
11601
|
-
prefix:
|
|
11602
|
-
order:
|
|
11696
|
+
field: z14.string().optional().describe("Lookup mode: name of the lookup-indexed field to query by."),
|
|
11697
|
+
value: z14.string().optional().describe("Lookup mode (equality): exact-match value for `field`. Works on sensitive fields too."),
|
|
11698
|
+
from: z14.string().optional().describe("Lookup mode (range): inclusive lower bound; requires `to`. Range-enabled, non-sensitive fields only."),
|
|
11699
|
+
to: z14.string().optional().describe("Lookup mode (range): inclusive upper bound; requires `from`."),
|
|
11700
|
+
prefix: z14.string().optional().describe("Lookup mode (prefix): match values starting with this. Range-enabled string fields only."),
|
|
11701
|
+
order: z14.enum(["asc", "desc"]).optional().describe(
|
|
11603
11702
|
"Lookup mode: sort direction by the looked-up field. `asc` (default) or `desc` \u2014 use `desc` with a range/prefix lookup to get the most-recent / highest values first (e.g. latest-N). Ignored in list mode."
|
|
11604
11703
|
),
|
|
11605
|
-
type:
|
|
11704
|
+
type: z14.string().optional().describe("Lookup mode: the document type (the bound schema's type). Required with `field`."),
|
|
11606
11705
|
// List-mode args:
|
|
11607
|
-
folderId:
|
|
11608
|
-
userId:
|
|
11609
|
-
scope:
|
|
11706
|
+
folderId: z14.string().optional().describe("List mode: only documents in this folder (Vectros folder id)."),
|
|
11707
|
+
userId: z14.string().optional().describe("List mode: scope to documents owned by this user."),
|
|
11708
|
+
scope: z14.string().optional().describe(
|
|
11610
11709
|
'List mode: filter to documents carrying this scope value, in `namespace:value` form (e.g. "org:<uuid>", "client:<uuid>", "group:eng-team"). `org` and `client` are reserved namespace names, registered like any other; others are namespaces you registered yourself.'
|
|
11611
11710
|
),
|
|
11612
|
-
startFrom:
|
|
11613
|
-
limit:
|
|
11711
|
+
startFrom: z14.string().optional().describe("Pagination cursor \u2014 pass the `nextCursor` from the previous page to fetch the next. Works in both list and lookup mode."),
|
|
11712
|
+
limit: z14.number().int().min(1).max(MCP_MAX_LIMIT3).optional().describe(
|
|
11614
11713
|
`Max documents per page. Defaults to a low ${MCP_DEFAULT_LIMIT3} to protect the agent context window; raise up to ${MCP_MAX_LIMIT3} (the documents API max) in one call when you can accept the larger payload, or page with \`startFrom\` instead.`
|
|
11615
11714
|
)
|
|
11616
11715
|
};
|
|
@@ -11700,29 +11799,29 @@ var documentQuery = ({ client, log }) => ({
|
|
|
11700
11799
|
var document_query_default = documentQuery;
|
|
11701
11800
|
|
|
11702
11801
|
// src/tools/document_update.ts
|
|
11703
|
-
import { z as
|
|
11802
|
+
import { z as z15 } from "zod";
|
|
11704
11803
|
var inputSchema14 = {
|
|
11705
|
-
documentId:
|
|
11706
|
-
externalId:
|
|
11804
|
+
documentId: z15.string().optional().describe("The Vectros document id to update. Provide this OR externalId+type."),
|
|
11805
|
+
externalId: z15.string().optional().describe(
|
|
11707
11806
|
"Your caller-owned externalId \u2014 an alternative selector to `documentId` (requires `type`). Updates the document you ingested under that externalId without a manual lookup first."
|
|
11708
11807
|
),
|
|
11709
|
-
type:
|
|
11710
|
-
title:
|
|
11711
|
-
fields:
|
|
11808
|
+
type: z15.string().optional().describe("Document type \u2014 REQUIRED when selecting by `externalId` (externalId is unique within a type)."),
|
|
11809
|
+
title: z15.string().optional().describe("New title. Omit to keep the current title."),
|
|
11810
|
+
fields: z15.record(z15.string(), z15.unknown()).optional().describe(
|
|
11712
11811
|
"Typed-payload field\u2192value changes DEEP-MERGED into the existing payload (a field set to `null` is deleted; unspecified fields preserved). Omit to leave the payload unchanged."
|
|
11713
11812
|
),
|
|
11714
|
-
text:
|
|
11813
|
+
text: z15.string().optional().describe(
|
|
11715
11814
|
"New raw text body. Supplying it re-ingests the document body and re-queues it for indexing, so the search index reflects the edit (text-ingested documents only \u2014 not file-backed ones). Omit to leave the stored text unchanged. This is the in-place alternative to re-ingesting with upsert:true."
|
|
11716
11815
|
),
|
|
11717
|
-
folderId:
|
|
11718
|
-
status:
|
|
11816
|
+
folderId: z15.string().optional().describe("Move the document into this folder (cannot be cleared once set)."),
|
|
11817
|
+
status: z15.enum(["ACTIVE", "ARCHIVED"]).optional().describe(
|
|
11719
11818
|
"Lifecycle status. `ARCHIVED` soft-retracts the document \u2014 it is pulled from search and recall but kept and recoverable; set it back to `ACTIVE` to re-index and restore it. The way to retire superseded content when the credential has no delete authority. Omit to leave unchanged."
|
|
11720
11819
|
),
|
|
11721
|
-
userId:
|
|
11722
|
-
scopes:
|
|
11820
|
+
userId: z15.string().optional().describe("Reassign the owning user (Vectros UUID)."),
|
|
11821
|
+
scopes: z15.array(z15.string()).optional().describe(
|
|
11723
11822
|
'Reassign scope ownership as `namespace:value` entries, at most 2 (e.g. ["org:<uuid>", "group:eng-team"]) \u2014 the COMPLETE new parent set. `org`/`client` are reserved namespace names, registered like any other. Omit to leave ownership unchanged; `[]` clears it (private to the owning user).'
|
|
11724
11823
|
),
|
|
11725
|
-
expectedVersion:
|
|
11824
|
+
expectedVersion: z15.number().int().optional().describe(
|
|
11726
11825
|
"Optimistic concurrency: the version you last read. If the document changed since, the update is refused as a conflict (re-read and retry). Omit for last-write-wins."
|
|
11727
11826
|
)
|
|
11728
11827
|
};
|
|
@@ -11750,18 +11849,18 @@ var documentUpdate = ({ client, log }) => ({
|
|
|
11750
11849
|
try {
|
|
11751
11850
|
const resolved = await resolveDocumentIdByExternalId(client, { id: documentId, externalId, type });
|
|
11752
11851
|
if ("error" in resolved) return toolError("document_update", new Error(resolved.error));
|
|
11753
|
-
const
|
|
11754
|
-
if (title !== void 0)
|
|
11755
|
-
if (fields !== void 0)
|
|
11756
|
-
if (text !== void 0)
|
|
11757
|
-
if (folderId !== void 0)
|
|
11758
|
-
if (status !== void 0)
|
|
11759
|
-
if (userId !== void 0)
|
|
11760
|
-
if (scopes !== void 0)
|
|
11761
|
-
if (expectedVersion !== void 0)
|
|
11852
|
+
const patch = {};
|
|
11853
|
+
if (title !== void 0) patch.title = title;
|
|
11854
|
+
if (fields !== void 0) patch.payload = fields;
|
|
11855
|
+
if (text !== void 0) patch.text = text;
|
|
11856
|
+
if (folderId !== void 0) patch.folderId = folderId;
|
|
11857
|
+
if (status !== void 0) patch.status = status;
|
|
11858
|
+
if (userId !== void 0) patch.userId = userId;
|
|
11859
|
+
if (scopes !== void 0) patch.scopes = scopes;
|
|
11860
|
+
if (expectedVersion !== void 0) patch.expectedVersion = expectedVersion;
|
|
11762
11861
|
const updated = await client.documents.patchDocument({
|
|
11763
11862
|
id: resolved.id,
|
|
11764
|
-
|
|
11863
|
+
...patch
|
|
11765
11864
|
});
|
|
11766
11865
|
log.debug({ tool: "document_update", documentId: resolved.id, externalId }, "document_update ok");
|
|
11767
11866
|
return { content: [{ type: "text", text: JSON.stringify(updated, null, 2) }] };
|
|
@@ -11774,9 +11873,9 @@ var documentUpdate = ({ client, log }) => ({
|
|
|
11774
11873
|
var document_update_default = documentUpdate;
|
|
11775
11874
|
|
|
11776
11875
|
// src/tools/document_delete.ts
|
|
11777
|
-
import { z as
|
|
11876
|
+
import { z as z16 } from "zod";
|
|
11778
11877
|
var inputSchema15 = {
|
|
11779
|
-
documentId:
|
|
11878
|
+
documentId: z16.string().min(1, "documentId is required").describe("The Vectros document id to delete.")
|
|
11780
11879
|
};
|
|
11781
11880
|
var documentDelete = ({ client, log }) => ({
|
|
11782
11881
|
name: "document_delete",
|
|
@@ -11803,18 +11902,18 @@ var documentDelete = ({ client, log }) => ({
|
|
|
11803
11902
|
var document_delete_default = documentDelete;
|
|
11804
11903
|
|
|
11805
11904
|
// src/tools/folder_query.ts
|
|
11806
|
-
import { z as
|
|
11905
|
+
import { z as z17 } from "zod";
|
|
11807
11906
|
var MCP_DEFAULT_LIMIT4 = 10;
|
|
11808
11907
|
var MCP_MAX_LIMIT4 = 100;
|
|
11809
11908
|
var inputSchema16 = {
|
|
11810
|
-
id:
|
|
11811
|
-
parentId:
|
|
11812
|
-
userId:
|
|
11813
|
-
scope:
|
|
11909
|
+
id: z17.string().optional().describe("Get mode: fetch this single folder by id."),
|
|
11910
|
+
parentId: z17.string().optional().describe("List mode: direct children of this folder (tree navigation). Omit for a flat tenant list."),
|
|
11911
|
+
userId: z17.string().optional().describe("List mode: scope to folders owned by this user."),
|
|
11912
|
+
scope: z17.string().optional().describe(
|
|
11814
11913
|
'List mode: filter to folders carrying this scope value, in `namespace:value` form (e.g. "org:<uuid>", "client:<uuid>", "group:eng-team"). `org` and `client` are reserved namespace names, registered like any other; others are namespaces you registered yourself.'
|
|
11815
11914
|
),
|
|
11816
|
-
startFrom:
|
|
11817
|
-
limit:
|
|
11915
|
+
startFrom: z17.string().optional().describe("List mode: pagination cursor \u2014 pass the `nextCursor` from the previous page to fetch the next."),
|
|
11916
|
+
limit: z17.number().int().min(1).max(MCP_MAX_LIMIT4).optional().describe(
|
|
11818
11917
|
`List mode: max folders per page. Default 10; raise up to ${MCP_MAX_LIMIT4} (the folders API max) in one call when you can accept the larger page, or page with \`startFrom\`.`
|
|
11819
11918
|
)
|
|
11820
11919
|
};
|
|
@@ -11854,16 +11953,16 @@ var folderQuery = ({ client, log }) => ({
|
|
|
11854
11953
|
var folder_query_default = folderQuery;
|
|
11855
11954
|
|
|
11856
11955
|
// src/tools/folder_create.ts
|
|
11857
|
-
import { z as
|
|
11956
|
+
import { z as z18 } from "zod";
|
|
11858
11957
|
var inputSchema17 = {
|
|
11859
|
-
name:
|
|
11860
|
-
description:
|
|
11861
|
-
parentId:
|
|
11862
|
-
slug:
|
|
11958
|
+
name: z18.string().min(1, "name is required").describe("Folder display name."),
|
|
11959
|
+
description: z18.string().optional().describe("Optional description of the folder's purpose."),
|
|
11960
|
+
parentId: z18.string().optional().describe("Parent folder id \u2014 places the folder under this parent. Omit for the context default root. Create-only."),
|
|
11961
|
+
slug: z18.string().optional().describe(
|
|
11863
11962
|
"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."
|
|
11864
11963
|
),
|
|
11865
|
-
userId:
|
|
11866
|
-
scopes:
|
|
11964
|
+
userId: z18.string().optional().describe("Owning user (Vectros UUID)."),
|
|
11965
|
+
scopes: z18.array(z18.string()).optional().describe(
|
|
11867
11966
|
'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.'
|
|
11868
11967
|
)
|
|
11869
11968
|
};
|
|
@@ -11905,16 +12004,16 @@ var folderCreate = ({ client, log }) => ({
|
|
|
11905
12004
|
var folder_create_default = folderCreate;
|
|
11906
12005
|
|
|
11907
12006
|
// src/tools/folder_update.ts
|
|
11908
|
-
import { z as
|
|
12007
|
+
import { z as z19 } from "zod";
|
|
11909
12008
|
var inputSchema18 = {
|
|
11910
|
-
id:
|
|
11911
|
-
name:
|
|
11912
|
-
description:
|
|
11913
|
-
userId:
|
|
11914
|
-
scopes:
|
|
12009
|
+
id: z19.string().min(1, "id is required").describe("The Vectros folder id to update."),
|
|
12010
|
+
name: z19.string().optional().describe("New folder name. Omit to keep the current name."),
|
|
12011
|
+
description: z19.string().optional().describe("New description. Omit to leave unchanged."),
|
|
12012
|
+
userId: z19.string().optional().describe("Reassign the owning user (Vectros UUID)."),
|
|
12013
|
+
scopes: z19.array(z19.string()).optional().describe(
|
|
11915
12014
|
'Reassign scope ownership as `namespace:value` entries, at most 2 (e.g. ["org:<uuid>", "group:eng-team"]) \u2014 the COMPLETE new parent set. `org`/`client` are reserved namespace names, registered like any other. Omit to leave ownership unchanged; `[]` clears it (private to the owning user).'
|
|
11916
12015
|
),
|
|
11917
|
-
expectedVersion:
|
|
12016
|
+
expectedVersion: z19.number().int().optional().describe(
|
|
11918
12017
|
"Optimistic concurrency: the version you last read. If the folder changed since, the update is refused as a conflict (re-read and retry). Omit for last-write-wins."
|
|
11919
12018
|
)
|
|
11920
12019
|
};
|
|
@@ -11953,9 +12052,9 @@ var folderUpdate = ({ client, log }) => ({
|
|
|
11953
12052
|
var folder_update_default = folderUpdate;
|
|
11954
12053
|
|
|
11955
12054
|
// src/tools/folder_delete.ts
|
|
11956
|
-
import { z as
|
|
12055
|
+
import { z as z20 } from "zod";
|
|
11957
12056
|
var inputSchema19 = {
|
|
11958
|
-
id:
|
|
12057
|
+
id: z20.string().min(1, "id is required").describe("The Vectros folder id to delete.")
|
|
11959
12058
|
};
|
|
11960
12059
|
var folderDelete = ({ client, log }) => ({
|
|
11961
12060
|
name: "folder_delete",
|
|
@@ -12005,7 +12104,7 @@ var currentIdentity = ({ log, apiKey, environment }) => ({
|
|
|
12005
12104
|
var current_identity_default = currentIdentity;
|
|
12006
12105
|
|
|
12007
12106
|
// src/tools/document_ingest.ts
|
|
12008
|
-
import { z as
|
|
12107
|
+
import { z as z21 } from "zod";
|
|
12009
12108
|
import { readFile, realpath } from "fs/promises";
|
|
12010
12109
|
import { basename, extname, resolve, relative, isAbsolute } from "path";
|
|
12011
12110
|
var IngestPathError = class extends Error {
|
|
@@ -12081,43 +12180,46 @@ function inferMimeType(filePath) {
|
|
|
12081
12180
|
return EXT_TO_MIME[ext] ?? "application/octet-stream";
|
|
12082
12181
|
}
|
|
12083
12182
|
var inputSchema21 = {
|
|
12084
|
-
title:
|
|
12085
|
-
indexMode:
|
|
12183
|
+
title: z21.string().min(1, "title is required").describe("Human-readable document title \u2014 appears in search results and the UI."),
|
|
12184
|
+
indexMode: z21.enum(["HYBRID", "SEMANTIC", "TEXT", "NONE"]).optional().describe(
|
|
12086
12185
|
"Index strategy. HYBRID (BM25 + dense, default; best for general retrieval), SEMANTIC (dense only; concept-driven queries), TEXT (BM25 only; exact-match / keyword), NONE (store-only / archival \u2014 retrievable by id and structured-field lookup but never in search results). Omit to inherit the bound schema's default."
|
|
12087
12186
|
),
|
|
12088
|
-
externalId:
|
|
12089
|
-
'Stable caller-supplied id. Immutable; unique per type within your context. Re-ingesting with the same externalId returns the existing document (idempotent) instead of creating a duplicate \u2014 use it to make ingests safely retryable and as the key other records reference. Mirrors record_create. Receiving the existing document back is a read of it and needs documents:r in addition to documents:c; a create-only key gets an "already exists" error instead of the document.'
|
|
12187
|
+
externalId: z21.string().optional().describe(
|
|
12188
|
+
'Stable caller-supplied id. Immutable; unique per type within your context. Re-ingesting with the same externalId returns the existing document (idempotent) instead of creating a duplicate \u2014 use it to make ingests safely retryable and as the key other records reference. Mirrors record_create. Receiving the existing document back is a read of it and needs documents:r in addition to documents:c; a create-only key gets an "already exists" error instead of the document. Pass `schemaId` with it: an externalId with no `schemaId` is refused (400) unless `confirmUntyped` is true.'
|
|
12189
|
+
),
|
|
12190
|
+
upsert: z21.boolean().optional().describe(
|
|
12191
|
+
"When true, re-ingesting an existing externalId OVERWRITES that document and re-indexes the new body (text mode) / re-uploads and re-indexes the new file (file mode), instead of returning the existing one unchanged. This is the curation/re-sync primitive: edit a source, re-ingest with upsert:true, and the search index reflects the new content. Requires the documents:u scope. IMPORTANT: pass the SAME schemaId (and type) you used originally \u2014 externalId is unique WITHIN a type. Omitting schemaId is refused (400) unless `confirmUntyped` is true, and with it the call targets the UNTYPED namespace, so it mints or updates an untyped document and never touches the typed one. The response `created` flag confirms which happened (created:true = a new document was minted)."
|
|
12090
12192
|
),
|
|
12091
|
-
|
|
12092
|
-
"
|
|
12193
|
+
schemaId: z21.string().optional().describe(
|
|
12194
|
+
"Bind this document to a record schema. When set, `payload` is validated against the schema and its lookup fields become directly queryable via document_query (records parity). Resolve a schema id from its type via list_schemas. Omit for an untyped document (an untyped document that also carries an `externalId` needs `confirmUntyped`)."
|
|
12093
12195
|
),
|
|
12094
|
-
|
|
12095
|
-
"
|
|
12196
|
+
confirmUntyped: z21.boolean().optional().describe(
|
|
12197
|
+
"Set true to confirm that an UNTYPED document is what you intend when you pass `externalId` without `schemaId`. Without it the platform refuses that combination (400): externalId is unique per schema, so a forgotten `schemaId` would otherwise quietly create a separate untyped copy instead of reaching the typed document you meant. Do not set it just to get past that error \u2014 check that the document really is untyped first. Ignored when `schemaId` is given or `externalId` is omitted."
|
|
12096
12198
|
),
|
|
12097
|
-
payload:
|
|
12199
|
+
payload: z21.record(z21.string(), z21.unknown()).optional().describe(
|
|
12098
12200
|
"The document's structured data \u2014 a flat key/value object. With `schemaId`, declared fields are validated and lookup fields indexed; undeclared keys pass through as free-form and are searchable via the hybrid_search `filters` param. Without a schema it is stored as free-form metadata. Every number must fall within the signed 64-bit range \u2014 send a larger whole number as a STRING (stored exactly, exact-match lookup), else the ingest is refused with a 400 naming the field."
|
|
12099
12201
|
),
|
|
12100
12202
|
// Inline text mode (mutually exclusive with filePath):
|
|
12101
|
-
text:
|
|
12102
|
-
storeText:
|
|
12203
|
+
text: z21.string().min(1).optional().describe("Text body to ingest inline. Mutually exclusive with filePath. Either text or filePath is required."),
|
|
12204
|
+
storeText: z21.boolean().optional().describe(
|
|
12103
12205
|
"FILE MODE ONLY. Whether the uploaded file's EXTRACTED text is retained after indexing (default true), fixed at ingest. true keeps the extracted text retrievable via document_get(includeText:true) and usable by document_ask; false discards it once indexing completes \u2014 search still works and the original file remains downloadable, but includeText returns textAvailable:false and document_ask is unavailable. NOT accepted with `text`: a text-ingested body is the document itself and is ALWAYS retained, so the backend has no storeText knob on the text path \u2014 passing it with `text` is rejected rather than silently ignored."
|
|
12104
12206
|
),
|
|
12105
12207
|
// File upload mode (mutually exclusive with text; stdio-transport-only):
|
|
12106
|
-
filePath:
|
|
12208
|
+
filePath: z21.string().min(1).optional().describe(
|
|
12107
12209
|
"Local filesystem path to upload. Mutually exclusive with text. STDIO TRANSPORT ONLY \u2014 rejected on HTTP transport (remote MCP servers can't read your filesystem; use text mode or call the SDK's uploadDocument directly). Must resolve INSIDE the configured ingest root (VECTROS_MCP_INGEST_ROOT, else the server's working directory); paths that escape it (traversal/absolute/symlink) or match a sensitive pattern are rejected."
|
|
12108
12210
|
),
|
|
12109
|
-
fileType:
|
|
12211
|
+
fileType: z21.string().optional().describe('MIME type of the file (e.g. "application/pdf"). Inferred from filePath extension if omitted.'),
|
|
12110
12212
|
// Common (both modes):
|
|
12111
|
-
folderId:
|
|
12112
|
-
userId:
|
|
12113
|
-
scopes:
|
|
12213
|
+
folderId: z21.string().optional().describe("Optional folder to ingest into. Default: tenant root."),
|
|
12214
|
+
userId: z21.string().optional().describe("Owning user ID. Optional."),
|
|
12215
|
+
scopes: z21.array(z21.string()).optional().describe(
|
|
12114
12216
|
"TEXT MODE ONLY. 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 document's COMPLETE scope declaration and values must come from the credential's own identity. An empty array `[]` creates a PRIVATE document owned by the calling user alone. Omit to stamp the credential's full identity \u2014 the default. Rejected with `filePath` (file uploads do not accept a scope declaration): a file-uploaded document is stamped with the credential's full identity."
|
|
12115
12217
|
)
|
|
12116
12218
|
};
|
|
12117
12219
|
var documentIngest = ({ client, log, transport, ingestRoot }) => ({
|
|
12118
12220
|
name: "document_ingest",
|
|
12119
12221
|
title: "Ingest a new document (text body or file upload)",
|
|
12120
|
-
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
|
|
12222
|
+
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 `document_get` until indexStatus is INDEXED. EXCEPTION \u2014 re-ingesting file mode against an externalId that already has a document (response `created:false`): the file body is replaced by ANY such re-ingest, whether or not `upsert` was set (`upsert` there only additionally applies `payload`/`title` to the matched document). The document keeps serving the OLD file's bytes until the new one is adopted, and indexStatus already reads INDEXED left over from that old file, so polling it returns immediately without waiting for the new content. Poll `document_get` and watch `fileItemId` instead \u2014 once it differs from the value it held before this call, the new file has been adopted. Re-request any download URL after that: one minted before adoption can stop working even within its stated `downloadExpires`.\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; in FILE MODE a re-ingest against an existing externalId needs documents:u). TEXT MODE: without `upsert`, the existing document's content is genuinely unchanged. FILE MODE: as noted above, a re-ingest against an existing externalId always replaces the file body regardless of `upsert` \u2014 only the `payload`/`title` metadata overwrite is gated by 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). An `externalId` with no `schemaId` is refused (400) unless you also pass `confirmUntyped:true` to confirm that an untyped document is intended. 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`.",
|
|
12121
12223
|
inputSchema: inputSchema21,
|
|
12122
12224
|
// Creates by default, idempotent ONLY when the caller supplies `externalId` (optional,
|
|
12123
12225
|
// per the doc comment above) — re-ingest then returns the existing document rather than
|
|
@@ -12135,6 +12237,7 @@ var documentIngest = ({ client, log, transport, ingestRoot }) => ({
|
|
|
12135
12237
|
const filePath = args.filePath;
|
|
12136
12238
|
const schemaId = args.schemaId;
|
|
12137
12239
|
const upsert = args.upsert;
|
|
12240
|
+
const confirmUntyped = args.confirmUntyped;
|
|
12138
12241
|
const indexMode = args.indexMode ?? (schemaId ? void 0 : "HYBRID");
|
|
12139
12242
|
if (!text && !filePath) {
|
|
12140
12243
|
return toolError(
|
|
@@ -12183,6 +12286,7 @@ var documentIngest = ({ client, log, transport, ingestRoot }) => ({
|
|
|
12183
12286
|
if (text) {
|
|
12184
12287
|
const result = await client.documents.ingestDocument({
|
|
12185
12288
|
upsert,
|
|
12289
|
+
confirmUntyped,
|
|
12186
12290
|
body: {
|
|
12187
12291
|
title,
|
|
12188
12292
|
text,
|
|
@@ -12223,6 +12327,7 @@ var documentIngest = ({ client, log, transport, ingestRoot }) => ({
|
|
|
12223
12327
|
const storeTextFile = args.storeText ?? true;
|
|
12224
12328
|
const upload = await client.documents.uploadDocument({
|
|
12225
12329
|
upsert,
|
|
12330
|
+
confirmUntyped,
|
|
12226
12331
|
fileName,
|
|
12227
12332
|
fileType,
|
|
12228
12333
|
indexMode,
|
|
@@ -12255,6 +12360,8 @@ var documentIngest = ({ client, log, transport, ingestRoot }) => ({
|
|
|
12255
12360
|
{ tool: "document_ingest", mode: "file", id: docId, fileName, fileType, bytes: bytes.length },
|
|
12256
12361
|
"document_ingest file ok"
|
|
12257
12362
|
);
|
|
12363
|
+
const uploadCreated = upload?.created;
|
|
12364
|
+
const note = uploadCreated === false ? "File replaced: this re-ingest matched an existing externalId, which always replaces that document's file body (upsert or not \u2014 upsert only additionally applies payload/title to it). The next document_get call may already show indexStatus: INDEXED \u2014 that is left over from the PREVIOUS file, not confirmation the new one is ready, and the document keeps serving the old file's bytes until adoption completes. Poll document_get(id) and watch fileItemId instead: once it differs from the value it held before this call, the new file has been adopted. Any download URL already held for this document was minted for the old file and can stop working before its stated downloadExpires once adoption happens \u2014 request a fresh one after fileItemId changes." : "File uploaded; indexing is asynchronous. Poll document_get(id) until indexStatus is INDEXED.";
|
|
12258
12365
|
return {
|
|
12259
12366
|
content: [
|
|
12260
12367
|
{
|
|
@@ -12263,7 +12370,7 @@ var documentIngest = ({ client, log, transport, ingestRoot }) => ({
|
|
|
12263
12370
|
{
|
|
12264
12371
|
...upload,
|
|
12265
12372
|
indexStatus: "PENDING_INDEX",
|
|
12266
|
-
_note:
|
|
12373
|
+
_note: note
|
|
12267
12374
|
},
|
|
12268
12375
|
null,
|
|
12269
12376
|
2
|
|
@@ -12287,29 +12394,29 @@ function presignedUploadHeaders(response) {
|
|
|
12287
12394
|
}
|
|
12288
12395
|
|
|
12289
12396
|
// src/tools/lookup_principal.ts
|
|
12290
|
-
import { z as
|
|
12397
|
+
import { z as z22 } from "zod";
|
|
12291
12398
|
var MCP_DEFAULT_LIMIT5 = 10;
|
|
12292
12399
|
var MCP_MAX_LIMIT5 = 100;
|
|
12293
12400
|
var inputSchema22 = {
|
|
12294
|
-
kind:
|
|
12401
|
+
kind: z22.string().describe(
|
|
12295
12402
|
'Which principal to look up: "user" (the fixed principal surface), or an entity namespace \u2014 "org", "client" (reserved, registered like any other), or a namespace you registered.'
|
|
12296
12403
|
),
|
|
12297
|
-
externalId:
|
|
12404
|
+
externalId: z22.string().optional().describe(
|
|
12298
12405
|
"Resolve mode: your own stable identifier for the principal. Returns the single matching principal (with its Vectros UUID), or an empty array if none. The fastest path to the UUID the ownership filters need. Takes precedence if both this and a `field` lookup are supplied."
|
|
12299
12406
|
),
|
|
12300
|
-
contextId:
|
|
12407
|
+
contextId: z22.string().optional().describe(
|
|
12301
12408
|
"Entity kinds only (not `user`, which is always tenant-wide): the app context to look up entities in, for a namespace registered as context-owned rather than tenant-wide. A context-confined credential's own context is used automatically without this; supply it to name a context explicitly (required for an unconfined/root credential to reach a context-owned namespace). Rejected if the namespace turns out to be tenant-wide."
|
|
12302
12409
|
),
|
|
12303
12410
|
// Lookup-mode args — provide `field` plus EXACTLY ONE of: value | from+to | prefix.
|
|
12304
|
-
type:
|
|
12305
|
-
field:
|
|
12306
|
-
value:
|
|
12307
|
-
from:
|
|
12308
|
-
to:
|
|
12309
|
-
prefix:
|
|
12310
|
-
order:
|
|
12311
|
-
startFrom:
|
|
12312
|
-
limit:
|
|
12411
|
+
type: z22.string().optional().describe('Lookup mode: the identity schema\'s record type (e.g. "person_v1"). Required with `field`.'),
|
|
12412
|
+
field: z22.string().optional().describe('Lookup mode: name of the schema-declared lookup field to query by (e.g. "email").'),
|
|
12413
|
+
value: z22.string().optional().describe("Lookup mode (equality): exact-match value for `field`. Works on sensitive fields."),
|
|
12414
|
+
from: z22.string().optional().describe("Lookup mode (range): inclusive lower bound; requires `to`. Non-sensitive fields only."),
|
|
12415
|
+
to: z22.string().optional().describe("Lookup mode (range): inclusive upper bound; requires `from`."),
|
|
12416
|
+
prefix: z22.string().optional().describe("Lookup mode (prefix): match values starting with this. Range-enabled string fields only."),
|
|
12417
|
+
order: z22.enum(["asc", "desc"]).optional().describe("Lookup mode: sort direction by the looked-up field. `asc` (default) or `desc`."),
|
|
12418
|
+
startFrom: z22.string().optional().describe("Lookup mode: pagination cursor \u2014 pass the `nextCursor` from the previous page to fetch the next."),
|
|
12419
|
+
limit: z22.number().int().min(1).max(MCP_MAX_LIMIT5).optional().describe(
|
|
12313
12420
|
`Max principals per page. Defaults to ${MCP_DEFAULT_LIMIT5}; raise up to ${MCP_MAX_LIMIT5} (the principals API max) in one call when you can accept the payload, or page with \`startFrom\`.`
|
|
12314
12421
|
)
|
|
12315
12422
|
};
|
|
@@ -12393,11 +12500,11 @@ var lookupPrincipal = ({ client, log }) => ({
|
|
|
12393
12500
|
var lookup_principal_default = lookupPrincipal;
|
|
12394
12501
|
|
|
12395
12502
|
// src/tools/version_history.ts
|
|
12396
|
-
import { z as
|
|
12503
|
+
import { z as z23 } from "zod";
|
|
12397
12504
|
var inputSchema23 = {
|
|
12398
|
-
resourceType:
|
|
12399
|
-
id:
|
|
12400
|
-
startFrom:
|
|
12505
|
+
resourceType: z23.enum(["record", "document"]).describe("Which kind of entity the id refers to: a record or a document."),
|
|
12506
|
+
id: z23.string().min(1, "id is required").describe("The Vectros id of the record or document whose history you want."),
|
|
12507
|
+
startFrom: z23.string().optional().describe("Pagination cursor \u2014 pass the `nextCursor` from the previous page to fetch older entries.")
|
|
12401
12508
|
};
|
|
12402
12509
|
var versionHistory = ({ client, log }) => ({
|
|
12403
12510
|
name: "version_history",
|
|
@@ -12521,7 +12628,7 @@ var ALL_RESOURCE_FACTORIES = {
|
|
|
12521
12628
|
};
|
|
12522
12629
|
|
|
12523
12630
|
// src/zod-to-json-schema.ts
|
|
12524
|
-
import { z as
|
|
12631
|
+
import { z as z24 } from "zod";
|
|
12525
12632
|
function zodShapeToJsonSchema(shape) {
|
|
12526
12633
|
const properties = {};
|
|
12527
12634
|
const required = [];
|
|
@@ -12536,40 +12643,40 @@ function zodShapeToJsonSchema(shape) {
|
|
|
12536
12643
|
function zodTypeToJsonSchema(schema) {
|
|
12537
12644
|
const description = schema.description;
|
|
12538
12645
|
let current = schema;
|
|
12539
|
-
while (current instanceof
|
|
12646
|
+
while (current instanceof z24.ZodOptional || current instanceof z24.ZodDefault || current instanceof z24.ZodNullable) {
|
|
12540
12647
|
current = current._def.innerType;
|
|
12541
12648
|
}
|
|
12542
12649
|
const base = description ? { description } : {};
|
|
12543
|
-
if (current instanceof
|
|
12650
|
+
if (current instanceof z24.ZodString) {
|
|
12544
12651
|
return { ...base, type: "string" };
|
|
12545
12652
|
}
|
|
12546
|
-
if (current instanceof
|
|
12653
|
+
if (current instanceof z24.ZodNumber) {
|
|
12547
12654
|
return { ...base, type: "number" };
|
|
12548
12655
|
}
|
|
12549
|
-
if (current instanceof
|
|
12656
|
+
if (current instanceof z24.ZodBoolean) {
|
|
12550
12657
|
return { ...base, type: "boolean" };
|
|
12551
12658
|
}
|
|
12552
|
-
if (current instanceof
|
|
12659
|
+
if (current instanceof z24.ZodEnum) {
|
|
12553
12660
|
return {
|
|
12554
12661
|
...base,
|
|
12555
12662
|
type: "string",
|
|
12556
12663
|
enum: current.options
|
|
12557
12664
|
};
|
|
12558
12665
|
}
|
|
12559
|
-
if (current instanceof
|
|
12666
|
+
if (current instanceof z24.ZodArray) {
|
|
12560
12667
|
return {
|
|
12561
12668
|
...base,
|
|
12562
12669
|
type: "array",
|
|
12563
12670
|
items: zodTypeToJsonSchema(current.element)
|
|
12564
12671
|
};
|
|
12565
12672
|
}
|
|
12566
|
-
if (current instanceof
|
|
12673
|
+
if (current instanceof z24.ZodObject) {
|
|
12567
12674
|
return {
|
|
12568
12675
|
...base,
|
|
12569
12676
|
...zodShapeToJsonSchema(current.shape)
|
|
12570
12677
|
};
|
|
12571
12678
|
}
|
|
12572
|
-
if (current instanceof
|
|
12679
|
+
if (current instanceof z24.ZodRecord) {
|
|
12573
12680
|
const valueType = current._def.valueType;
|
|
12574
12681
|
return {
|
|
12575
12682
|
...base,
|
|
@@ -12698,7 +12805,7 @@ var VectrosMCPServer = class {
|
|
|
12698
12805
|
if (!tool) {
|
|
12699
12806
|
result = toolError(req.params.name ?? "unknown", new Error("No such tool."));
|
|
12700
12807
|
} else {
|
|
12701
|
-
const parsed =
|
|
12808
|
+
const parsed = z25.object(tool.inputSchema).strict().safeParse(req.params.arguments ?? {});
|
|
12702
12809
|
if (!parsed.success) {
|
|
12703
12810
|
result = toolError(tool.name, new Error(formatArgError(tool, parsed.error)));
|
|
12704
12811
|
} else {
|