@vectros-ai/mcp-server 0.15.0 → 0.16.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 +42 -0
- package/README.md +22 -6
- package/dist/cli-http.js +422 -210
- package/dist/cli-http.js.map +1 -1
- package/dist/cli-http.mjs +422 -210
- package/dist/cli-http.mjs.map +1 -1
- package/dist/cli.js +422 -210
- package/dist/cli.js.map +1 -1
- package/dist/cli.mjs +422 -210
- package/dist/cli.mjs.map +1 -1
- package/dist/index.d.mts +3 -1
- package/dist/index.d.ts +3 -1
- package/dist/index.js +422 -210
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +422 -210
- package/dist/index.mjs.map +1 -1
- package/package.json +2 -2
package/dist/index.js
CHANGED
|
@@ -2531,7 +2531,7 @@ var AuthClient = class {
|
|
|
2531
2531
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/admin/keys/scoped");
|
|
2532
2532
|
}
|
|
2533
2533
|
/**
|
|
2534
|
-
* Creates a scoped API key (an `ssk_*` secret) that inherits its permissions from an existing access profile in your account. The call is idempotent on the combination of tenant, context, user, and key name: re-issuing the same request returns the existing key WITHOUT re-disclosing its raw secret. The raw key is returned ONLY in this response — store it securely, as it cannot be retrieved again. Requires the `keys:c` scope. If you use a scoped credential, `keys:c` alone is not sufficient: because the minted key is durably bound to the profile you name, the profile's effective scopes may not exceed your own, and you may only mint against a profile whose `identityOverrides` values your own identity holds. A root API key (`sk_`) is exempt from
|
|
2534
|
+
* Creates a scoped API key (an `ssk_*` secret) that inherits its permissions from an existing access profile in your account. The call is idempotent on the combination of tenant, context, user, and key name: re-issuing the same request returns the existing key WITHOUT re-disclosing its raw secret. The raw key is returned ONLY in this response — store it securely, as it cannot be retrieved again. Requires the `keys:c` scope. If you use a scoped credential, `keys:c` alone is not sufficient: because the minted key is durably bound to the profile you name, the profile's effective scopes may not exceed your own, and you may only mint against a profile whose `identityOverrides` values your own identity holds. Minting a key bound to your OWN principal needs nothing further; minting one bound to a DIFFERENT principal additionally requires the `delegate-mint` capability (`granted_capabilities`) on your credential — without it the request is refused. A root API key (`sk_`) is exempt from all three bounds.
|
|
2535
2535
|
*
|
|
2536
2536
|
* @param {Vectros.CreateScopedKeyRequest} request
|
|
2537
2537
|
* @param {AuthClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -4027,7 +4027,7 @@ var AuthClient = class {
|
|
|
4027
4027
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/usage");
|
|
4028
4028
|
}
|
|
4029
4029
|
/**
|
|
4030
|
-
* Retrieves a single registered issuer by issuerId. Requires a root API key or the bootstrap's provisioning capability. A credential confined to one app context sees only an issuer registered in that context; naming one registered in another context returns 404, identically to a nonexistent issuerId. A root API key sees every context.
|
|
4030
|
+
* Retrieves a single registered issuer by issuerId. Requires a root API key or the bootstrap's provisioning capability. A credential confined to one app context sees only an issuer registered in that context; naming one registered in another context returns 404, identically to a nonexistent issuerId. A root API key sees every context. An ordinary bootstrap credential that didn't specify a context resolves to the `default` app context specifically, not every context — so this call returns 404 for an issuer registered under any other context unless you re-minted the bootstrap token pinned to that context.
|
|
4031
4031
|
*
|
|
4032
4032
|
* @param {Vectros.GetIssuerRequest} request
|
|
4033
4033
|
* @param {AuthClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -4084,6 +4084,73 @@ var AuthClient = class {
|
|
|
4084
4084
|
}
|
|
4085
4085
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/auth/issuers/{issuerId}");
|
|
4086
4086
|
}
|
|
4087
|
+
/**
|
|
4088
|
+
* 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.
|
|
4089
|
+
*
|
|
4090
|
+
* @param {Vectros.IssuerUpdateRequest} request
|
|
4091
|
+
* @param {AuthClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
4092
|
+
*
|
|
4093
|
+
* @throws {@link Vectros.BadRequestError}
|
|
4094
|
+
* @throws {@link Vectros.ForbiddenError}
|
|
4095
|
+
* @throws {@link Vectros.NotFoundError}
|
|
4096
|
+
* @throws {@link Vectros.TooManyRequestsError}
|
|
4097
|
+
*
|
|
4098
|
+
* @example
|
|
4099
|
+
* await client.auth.updateIssuer({
|
|
4100
|
+
* issuerId: "auth0-prod"
|
|
4101
|
+
* })
|
|
4102
|
+
*/
|
|
4103
|
+
updateIssuer(request, requestOptions) {
|
|
4104
|
+
return HttpResponsePromise.fromPromise(this.__updateIssuer(request, requestOptions));
|
|
4105
|
+
}
|
|
4106
|
+
async __updateIssuer(request, requestOptions) {
|
|
4107
|
+
const { issuerId, ..._body } = request;
|
|
4108
|
+
const _authRequest = await this._options.authProvider.getAuthRequest();
|
|
4109
|
+
const _headers = mergeHeaders(
|
|
4110
|
+
_authRequest.headers,
|
|
4111
|
+
this._options?.headers,
|
|
4112
|
+
requestOptions?.headers
|
|
4113
|
+
);
|
|
4114
|
+
const _response = await fetcher({
|
|
4115
|
+
url: url_exports.join(
|
|
4116
|
+
await Supplier.get(this._options.baseUrl) ?? await Supplier.get(this._options.environment),
|
|
4117
|
+
`v1/auth/issuers/${url_exports.encodePathParam(issuerId)}`
|
|
4118
|
+
),
|
|
4119
|
+
method: "PUT",
|
|
4120
|
+
headers: _headers,
|
|
4121
|
+
contentType: "application/json",
|
|
4122
|
+
queryString: url_exports.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
|
|
4123
|
+
requestType: "json",
|
|
4124
|
+
body: _body,
|
|
4125
|
+
timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1e3,
|
|
4126
|
+
maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
|
|
4127
|
+
abortSignal: requestOptions?.abortSignal,
|
|
4128
|
+
fetchFn: this._options?.fetch,
|
|
4129
|
+
logging: this._options.logging
|
|
4130
|
+
});
|
|
4131
|
+
if (_response.ok) {
|
|
4132
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
4133
|
+
}
|
|
4134
|
+
if (_response.error.reason === "status-code") {
|
|
4135
|
+
switch (_response.error.statusCode) {
|
|
4136
|
+
case 400:
|
|
4137
|
+
throw new BadRequestError(_response.error.body, _response.rawResponse);
|
|
4138
|
+
case 403:
|
|
4139
|
+
throw new ForbiddenError(_response.error.body, _response.rawResponse);
|
|
4140
|
+
case 404:
|
|
4141
|
+
throw new NotFoundError(_response.error.body, _response.rawResponse);
|
|
4142
|
+
case 429:
|
|
4143
|
+
throw new TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
4144
|
+
default:
|
|
4145
|
+
throw new VectrosError({
|
|
4146
|
+
statusCode: _response.error.statusCode,
|
|
4147
|
+
body: _response.error.body,
|
|
4148
|
+
rawResponse: _response.rawResponse
|
|
4149
|
+
});
|
|
4150
|
+
}
|
|
4151
|
+
}
|
|
4152
|
+
return handleNonStatusCodeError(_response.error, _response.rawResponse, "PUT", "/v1/auth/issuers/{issuerId}");
|
|
4153
|
+
}
|
|
4087
4154
|
/**
|
|
4088
4155
|
* Deregisters a trusted third-party IdP issuer. Requires a root API key or the bootstrap's provisioning capability. A credential confined to one app context may only deregister an issuer registered in that context; naming one registered in another context returns 404, identically to a nonexistent issuerId. A root API key may deregister any issuer. Refused if any user account was ever created or matched via this issuer (by a prior self-signup or accepted invite, through `POST /v1/auth/token/exchange`) — that access cannot be silently orphaned. Deactivate the affected users first if you intend to cut off their access, or register a replacement issuer before removing this one. An issuer that has never been used for an exchange (no bound users yet) can always be deregistered.
|
|
4089
4156
|
*
|
|
@@ -4154,7 +4221,7 @@ var AuthClient = class {
|
|
|
4154
4221
|
);
|
|
4155
4222
|
}
|
|
4156
4223
|
/**
|
|
4157
|
-
* Returns the issuers registered in your tenant. Requires a root API key or the bootstrap's provisioning capability. A credential confined to one app context sees only the issuers registered in that context; a root API key sees every context. Returns a `{data, nextCursor}` envelope.
|
|
4224
|
+
* Returns the issuers registered in your tenant. Requires a root API key or the bootstrap's provisioning capability. A credential confined to one app context sees only the issuers registered in that context; a root API key sees every context. An ordinary bootstrap credential that didn't specify a context resolves to the `default` app context specifically, not every context — so this call returns an empty page for a tenant whose issuers are all registered under a different context unless you re-minted the bootstrap token pinned to that context. Returns a `{data, nextCursor}` envelope.
|
|
4158
4225
|
*
|
|
4159
4226
|
* @param {Vectros.ListIssuersRequest} request
|
|
4160
4227
|
* @param {AuthClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -4211,7 +4278,7 @@ var AuthClient = class {
|
|
|
4211
4278
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/auth/issuers");
|
|
4212
4279
|
}
|
|
4213
4280
|
/**
|
|
4214
|
-
* 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. Idempotent by `issuerId` within your tenant; the `(issuer, audience)` pair must not already be registered by a different issuerId/tenant. 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`.
|
|
4281
|
+
* 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`.
|
|
4215
4282
|
*
|
|
4216
4283
|
* @param {Vectros.IssuerRequest} request
|
|
4217
4284
|
* @param {AuthClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -4396,6 +4463,7 @@ var AuthClient = class {
|
|
|
4396
4463
|
*
|
|
4397
4464
|
* @throws {@link Vectros.BadRequestError}
|
|
4398
4465
|
* @throws {@link Vectros.ForbiddenError}
|
|
4466
|
+
* @throws {@link Vectros.NotFoundError}
|
|
4399
4467
|
* @throws {@link Vectros.TooManyRequestsError}
|
|
4400
4468
|
*
|
|
4401
4469
|
* @example
|
|
@@ -4449,6 +4517,8 @@ var AuthClient = class {
|
|
|
4449
4517
|
throw new BadRequestError(_response.error.body, _response.rawResponse);
|
|
4450
4518
|
case 403:
|
|
4451
4519
|
throw new ForbiddenError(_response.error.body, _response.rawResponse);
|
|
4520
|
+
case 404:
|
|
4521
|
+
throw new NotFoundError(_response.error.body, _response.rawResponse);
|
|
4452
4522
|
case 429:
|
|
4453
4523
|
throw new TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
4454
4524
|
default:
|
|
@@ -4462,7 +4532,7 @@ var AuthClient = class {
|
|
|
4462
4532
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v1/auth/token");
|
|
4463
4533
|
}
|
|
4464
4534
|
/**
|
|
4465
|
-
* Invite a new member to one of your app contexts by email
|
|
4535
|
+
* Invite a new member to one of your app contexts by email, OR grant an existing member access to an additional app context by inviting their same email again. Idempotent on the combination of context and email: re-inviting the same email into the SAME context rotates the token and resends the invitation rather than creating a duplicate — this requires the `users:r` and `users:u` scopes in addition to `users:c`, because resending rotates a credential on an existing invitation and invalidates any link already sent. Without them the collision returns 409 instead, with no invitation details and no change to the outstanding invitation. Inviting the SAME email into a DIFFERENT app context in this tenant, where that email already resolves to an existing member: if that member is active AND already has (or, once accepted, will have) a credential that works for the new context's own identity provider, this immediately grants them access to the new context (no email is sent — there is nothing to accept, `emailSent` is false) — this additionally requires the `users:r` scope (no `users:u`, since nothing is mutated), because the response names the existing member's userId, a fact about them your credential could not otherwise learn through this endpoint. If that active member's ONLY existing credential is for a DIFFERENT identity provider than the one the new context uses, a normal, independent invitation is created instead (its own new member id, a real token/accept link) — attaching them silently would leave no way for them to ever actually sign in to that context. If the existing member's original invitation is still pending, this attaches the new context's access to that same outstanding invitation and rotates its token (`users:r`+`users:u`, same as an ordinary resend — both the disclosure and the credential rotation apply here). A SUSPENDED member's email does not get new-context access this way — reactivate them explicitly first. Returns HTTP 201 in every one of those cases. Returns 409 if that email already belongs to an active or suspended member of THIS specific app context, already has a PENDING invitation for THIS specific app context, or resolves to an existing member elsewhere in the tenant and your token lacks the additional scope the grant/attach requires (`users:r`, or `users:r`+`users:u` for the still-pending case). An email that already has an identity in your OTHER tenant (test vs. live) is not a collision either — it creates an additional, independent membership in this tenant for that same identity. When `sendEmail` is false, the response includes the raw token and a ready-to-use accept link so you can deliver the invitation through your own email provider. Requires the `users:c` scope — or, for a credential scoped to a single app context, the `member-lifecycle` capability plus the matching `profiles:c`/`profiles:r`/`profiles:u` grant(s) in that context, as an equally sufficient alternative to every `users:c`/`users:r`/`users:u` requirement in this description.
|
|
4466
4536
|
*
|
|
4467
4537
|
* @param {Vectros.CreateInviteRequest} request
|
|
4468
4538
|
* @param {AuthClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -4533,7 +4603,7 @@ var AuthClient = class {
|
|
|
4533
4603
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v1/users/invite");
|
|
4534
4604
|
}
|
|
4535
4605
|
/**
|
|
4536
|
-
* Resend an outstanding invitation, identified by its email and app context. Rotates the invitation token and extends its expiry, then (when `sendEmail` is true) re-delivers the email. Rotating the token invalidates any previously issued link for this invitation, so only the newest link works. The invitee's pending permissions are left unchanged. Because this rotates a credential on an existing invitation, it requires the `users:c`, `users:r` and `users:u` scopes.
|
|
4606
|
+
* Resend an outstanding invitation, identified by its email and app context. Rotates the invitation token and extends its expiry, then (when `sendEmail` is true) re-delivers the email. Rotating the token invalidates any previously issued link for this invitation, so only the newest link works. The invitee's pending permissions are left unchanged. Because this rotates a credential on an existing invitation, it requires the `users:c`, `users:r` and `users:u` scopes — or, for a credential scoped to a single app context, the `member-lifecycle` capability plus the matching `profiles:c`/`profiles:r`/`profiles:u` grant(s) in that context.
|
|
4537
4607
|
*
|
|
4538
4608
|
* @param {Vectros.CreateInviteRequest} request
|
|
4539
4609
|
* @param {AuthClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -4600,6 +4670,83 @@ var AuthClient = class {
|
|
|
4600
4670
|
}
|
|
4601
4671
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v1/users/invite/resend");
|
|
4602
4672
|
}
|
|
4673
|
+
/**
|
|
4674
|
+
* Re-mints the presented `st_*` scoped token with one or more `identity.<namespace>` values changed — for a caller whose ROLE explicitly grants assuming those values (an invited hr-admin, a multi-org case-handler) and needs to change which value new writes place records under. The request body names one or more namespaces in canonical `scope:<namespace>` form, e.g. `{"scope:org": "orgB"}` — each value must be a plain literal, never a `${{ ... }}` placeholder. When you name MORE THAN ONE namespace, a single one of your roles must grant all of them together: the combination is never assembled from two different roles, because no role author would have vouched for it. `st_*`-only — a root API key or `ssk_*` scoped API key gets 403; neither needs this (root already has full authority, and an `ssk_*`'s identity shape is not what this resolves against).
|
|
4675
|
+
*
|
|
4676
|
+
* **Only an original token may assume.** A token produced BY this endpoint cannot assume again (403) — every assume starts from the token you exchanged for, so the identity you end up with is always one a single role explicitly granted rather than a combination reached by chaining calls. Keep your original token if you need to switch more than once, or exchange for a new one.
|
|
4677
|
+
*
|
|
4678
|
+
* **Entitlement is checked LIVE, against your roles as they are right now** — not against a copy frozen into your token when it was minted. The requested value must be explicitly granted by a role's `assumable` field for that namespace: a POINT check against the one value requested, and a deliberately separate, explicitly-authored question from what the role's `data_scope` permits reading or writing. Holding broad `data_scope` reach in a namespace does NOT by itself grant assuming any value in it.
|
|
4679
|
+
*
|
|
4680
|
+
* **What is preserved, and what is not.** Every clause of your token that does not reference a requested namespace is preserved verbatim, as are all other claims (`partner_user_id`, `context_id`, mint attribution). Clauses that DO reference a requested namespace are kept only if they come from a role that authorized the new value. A role that does not authorize it loses all of its clauses touching that namespace — including any scoped to the value you already held. Assume into a value one role grants and you keep that role's reach, not the reach of roles that never vouched for it.
|
|
4681
|
+
*
|
|
4682
|
+
* The re-minted token's `exp` is IDENTICAL to the presented token's — this call can never extend a session's life. A fresh, independently-revocable `jti` is stamped on every call, and (except when the presented token predates jti support and has none to chain from) the token also carries a `root_jti` revocation-lineage claim so revoking the token you started from closes every value ever assumed from it. Uses the ordinary Vectros `{"message":...}` error shape, not the OAuth envelope `POST /v1/auth/token/exchange` uses — this endpoint's caller is always Vectros-SDK code already holding a bearer token, never generic OAuth tooling.
|
|
4683
|
+
*
|
|
4684
|
+
* @param {Record<string, unknown>} request
|
|
4685
|
+
* @param {AuthClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
4686
|
+
*
|
|
4687
|
+
* @throws {@link Vectros.BadRequestError}
|
|
4688
|
+
* @throws {@link Vectros.UnauthorizedError}
|
|
4689
|
+
* @throws {@link Vectros.ForbiddenError}
|
|
4690
|
+
* @throws {@link Vectros.ConflictError}
|
|
4691
|
+
* @throws {@link Vectros.TooManyRequestsError}
|
|
4692
|
+
*
|
|
4693
|
+
* @example
|
|
4694
|
+
* await client.auth.assumeToken({
|
|
4695
|
+
* "scope:org": "orgB"
|
|
4696
|
+
* })
|
|
4697
|
+
*/
|
|
4698
|
+
assumeToken(request, requestOptions) {
|
|
4699
|
+
return HttpResponsePromise.fromPromise(this.__assumeToken(request, requestOptions));
|
|
4700
|
+
}
|
|
4701
|
+
async __assumeToken(request, requestOptions) {
|
|
4702
|
+
const _authRequest = await this._options.authProvider.getAuthRequest();
|
|
4703
|
+
const _headers = mergeHeaders(
|
|
4704
|
+
_authRequest.headers,
|
|
4705
|
+
this._options?.headers,
|
|
4706
|
+
requestOptions?.headers
|
|
4707
|
+
);
|
|
4708
|
+
const _response = await fetcher({
|
|
4709
|
+
url: url_exports.join(
|
|
4710
|
+
await Supplier.get(this._options.baseUrl) ?? await Supplier.get(this._options.environment),
|
|
4711
|
+
"v1/auth/token/assume"
|
|
4712
|
+
),
|
|
4713
|
+
method: "POST",
|
|
4714
|
+
headers: _headers,
|
|
4715
|
+
contentType: "application/json",
|
|
4716
|
+
queryString: url_exports.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
|
|
4717
|
+
requestType: "json",
|
|
4718
|
+
body: request,
|
|
4719
|
+
timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1e3,
|
|
4720
|
+
maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
|
|
4721
|
+
abortSignal: requestOptions?.abortSignal,
|
|
4722
|
+
fetchFn: this._options?.fetch,
|
|
4723
|
+
logging: this._options.logging
|
|
4724
|
+
});
|
|
4725
|
+
if (_response.ok) {
|
|
4726
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
4727
|
+
}
|
|
4728
|
+
if (_response.error.reason === "status-code") {
|
|
4729
|
+
switch (_response.error.statusCode) {
|
|
4730
|
+
case 400:
|
|
4731
|
+
throw new BadRequestError(_response.error.body, _response.rawResponse);
|
|
4732
|
+
case 401:
|
|
4733
|
+
throw new UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
4734
|
+
case 403:
|
|
4735
|
+
throw new ForbiddenError(_response.error.body, _response.rawResponse);
|
|
4736
|
+
case 409:
|
|
4737
|
+
throw new ConflictError(_response.error.body, _response.rawResponse);
|
|
4738
|
+
case 429:
|
|
4739
|
+
throw new TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
4740
|
+
default:
|
|
4741
|
+
throw new VectrosError({
|
|
4742
|
+
statusCode: _response.error.statusCode,
|
|
4743
|
+
body: _response.error.body,
|
|
4744
|
+
rawResponse: _response.rawResponse
|
|
4745
|
+
});
|
|
4746
|
+
}
|
|
4747
|
+
}
|
|
4748
|
+
return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v1/auth/token/assume");
|
|
4749
|
+
}
|
|
4603
4750
|
/**
|
|
4604
4751
|
* RFC 8693 OAuth 2.0 Token Exchange. Trades a JWT issued by a third-party identity provider you've registered (`POST /v1/auth/issuers`) for a Vectros `st_*` scoped bearer token — no Vectros credential required to call this endpoint. The exchanged token's scope is resolved entirely server-side from the matched user's access profile; this endpoint accepts no caller-supplied scope, resource, or audience parameter (RFC 8693 §2.1's `resource`/`audience`/`scope` are not used in v1 — the registered `(issuer, audience)` pair alone pins the target tenant and app context). On a first-time login (no existing Vectros identity for this subject), two opt-in binding paths exist: `invite_token` (a `PENDING` sub-user invitation), and — if the registration declares one or more self-signup policies — `signup_type` (a brand-new user is created and bound to the policy's configured role). If `invite_token` is present at all, it is the ONLY path tried — a failed invite never falls through to self-signup. Neither field is required for a subject with an existing identity. If your issuer is registered against more than one app context (each via its own audience), `context_id` selects which one to target; omit it when your token's `aud` claim matches only one registered context — the common case, unaffected by this field. Uses the OAuth-standard error envelope (`{"error":..., "error_description":...}`, RFC 6749 §5.2), NOT this API's usual `{"message":...}` shape — its client is generic OAuth tooling, not the Vectros SDK.
|
|
4605
4752
|
*
|
|
@@ -4677,9 +4824,9 @@ var ComplianceClient = class {
|
|
|
4677
4824
|
* @param {Vectros.ErasureRequest} request
|
|
4678
4825
|
* @param {ComplianceClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
4679
4826
|
*
|
|
4827
|
+
* @throws {@link Vectros.BadRequestError}
|
|
4680
4828
|
* @throws {@link Vectros.ForbiddenError}
|
|
4681
4829
|
* @throws {@link Vectros.TooManyRequestsError}
|
|
4682
|
-
* @throws {@link Vectros.NotImplementedError}
|
|
4683
4830
|
*
|
|
4684
4831
|
* @example
|
|
4685
4832
|
* await client.compliance.createErasureRequest({
|
|
@@ -4718,12 +4865,12 @@ var ComplianceClient = class {
|
|
|
4718
4865
|
}
|
|
4719
4866
|
if (_response.error.reason === "status-code") {
|
|
4720
4867
|
switch (_response.error.statusCode) {
|
|
4868
|
+
case 400:
|
|
4869
|
+
throw new BadRequestError(_response.error.body, _response.rawResponse);
|
|
4721
4870
|
case 403:
|
|
4722
4871
|
throw new ForbiddenError(_response.error.body, _response.rawResponse);
|
|
4723
4872
|
case 429:
|
|
4724
4873
|
throw new TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
4725
|
-
case 501:
|
|
4726
|
-
throw new NotImplementedError(_response.error.body, _response.rawResponse);
|
|
4727
4874
|
default:
|
|
4728
4875
|
throw new VectrosError({
|
|
4729
4876
|
statusCode: _response.error.statusCode,
|
|
@@ -4742,7 +4889,6 @@ var ComplianceClient = class {
|
|
|
4742
4889
|
*
|
|
4743
4890
|
* @throws {@link Vectros.ForbiddenError}
|
|
4744
4891
|
* @throws {@link Vectros.NotFoundError}
|
|
4745
|
-
* @throws {@link Vectros.NotImplementedError}
|
|
4746
4892
|
*
|
|
4747
4893
|
* @example
|
|
4748
4894
|
* await client.compliance.getErasureRequest({
|
|
@@ -4783,8 +4929,6 @@ var ComplianceClient = class {
|
|
|
4783
4929
|
throw new ForbiddenError(_response.error.body, _response.rawResponse);
|
|
4784
4930
|
case 404:
|
|
4785
4931
|
throw new NotFoundError(_response.error.body, _response.rawResponse);
|
|
4786
|
-
case 501:
|
|
4787
|
-
throw new NotImplementedError(_response.error.body, _response.rawResponse);
|
|
4788
4932
|
default:
|
|
4789
4933
|
throw new VectrosError({
|
|
4790
4934
|
statusCode: _response.error.statusCode,
|
|
@@ -5332,7 +5476,21 @@ var DocumentsClient = class {
|
|
|
5332
5476
|
return HttpResponsePromise.fromPromise(this.__lookupDocuments(request, requestOptions));
|
|
5333
5477
|
}
|
|
5334
5478
|
async __lookupDocuments(request, requestOptions) {
|
|
5335
|
-
const {
|
|
5479
|
+
const {
|
|
5480
|
+
type: type_,
|
|
5481
|
+
field,
|
|
5482
|
+
value,
|
|
5483
|
+
from: from_,
|
|
5484
|
+
to,
|
|
5485
|
+
prefix,
|
|
5486
|
+
sortFrom,
|
|
5487
|
+
sortTo,
|
|
5488
|
+
startFrom,
|
|
5489
|
+
limit,
|
|
5490
|
+
order,
|
|
5491
|
+
userId,
|
|
5492
|
+
scope
|
|
5493
|
+
} = request;
|
|
5336
5494
|
const _queryParams = {
|
|
5337
5495
|
type: type_,
|
|
5338
5496
|
field,
|
|
@@ -5340,6 +5498,8 @@ var DocumentsClient = class {
|
|
|
5340
5498
|
from: from_,
|
|
5341
5499
|
to,
|
|
5342
5500
|
prefix,
|
|
5501
|
+
sortFrom,
|
|
5502
|
+
sortTo,
|
|
5343
5503
|
startFrom,
|
|
5344
5504
|
limit,
|
|
5345
5505
|
order: order != null ? order : void 0,
|
|
@@ -6624,7 +6784,7 @@ var IdentityClient = class {
|
|
|
6624
6784
|
);
|
|
6625
6785
|
}
|
|
6626
6786
|
/**
|
|
6627
|
-
* Retrieves a single scope-namespace registration by name.
|
|
6787
|
+
* Retrieves a single scope-namespace registration by name.
|
|
6628
6788
|
*
|
|
6629
6789
|
* @param {Vectros.GetNamespaceRequest} request
|
|
6630
6790
|
* @param {IdentityClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -6817,7 +6977,7 @@ var IdentityClient = class {
|
|
|
6817
6977
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "DELETE", "/v1/namespaces/{namespace}");
|
|
6818
6978
|
}
|
|
6819
6979
|
/**
|
|
6820
|
-
* Returns the scope namespaces in your account
|
|
6980
|
+
* Returns the scope namespaces registered in your account. Returns a `{data, nextCursor}` envelope.
|
|
6821
6981
|
*
|
|
6822
6982
|
* @param {Vectros.ListNamespacesRequest} request
|
|
6823
6983
|
* @param {IdentityClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -6868,7 +7028,7 @@ var IdentityClient = class {
|
|
|
6868
7028
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/namespaces");
|
|
6869
7029
|
}
|
|
6870
7030
|
/**
|
|
6871
|
-
* Registers a new scope namespace and declares whether its values resolve to identity entities (`entityBacked`). Also requires `specificityRank`, an explicit, account-unique position in the specificity order used to break recordType schema-resolution ties. Requires a root API key or the CLI bootstrap's provisioning
|
|
7031
|
+
* Registers a new scope namespace and declares whether its values resolve to identity entities (`entityBacked`). Also requires `specificityRank`, an explicit, account-unique position in the specificity order used to break recordType schema-resolution ties. Requires a root API key or one of the CLI bootstrap's two provisioning capabilities — never an ordinary partner-grantable scope. A bootstrap credential's registration is confined to its own app context UNLESS it additionally holds the tenant-wide namespace-provisioning capability and `contextId` is omitted, in which case it may register a TENANT-WIDE namespace (visible to every context). `org` and `client` are reserved names, registered the same way as any other namespace.
|
|
6872
7032
|
*
|
|
6873
7033
|
* @param {Vectros.RegisterNamespaceRequest} request
|
|
6874
7034
|
* @param {IdentityClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -6938,7 +7098,7 @@ var IdentityClient = class {
|
|
|
6938
7098
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v1/namespaces");
|
|
6939
7099
|
}
|
|
6940
7100
|
/**
|
|
6941
|
-
* Returns a paginated list of the users in your account. Pass `externalId` to look up a single user by your own identifier. To filter on schema-declared lookup fields, supply `type` and `field` together with one lookup mode: `value` (exact match), `from`+`to` (range), or `prefix`. Requires the `users:r` scope.
|
|
7101
|
+
* Returns a paginated list of the users in your account. Pass `externalId` to look up a single user by your own identifier. To filter on schema-declared lookup fields, supply `type` and `field` together with one lookup mode: `value` (exact match), `from`+`to` (range), or `prefix`. Requires the `users:r` scope. A context-confined credential only sees users who hold an access profile in the credential's own app context — others are silently absent from the page, not an error.
|
|
6942
7102
|
*
|
|
6943
7103
|
* @param {Vectros.ListUsersRequest} request
|
|
6944
7104
|
* @param {IdentityClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -7003,7 +7163,7 @@ var IdentityClient = class {
|
|
|
7003
7163
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/users");
|
|
7004
7164
|
}
|
|
7005
7165
|
/**
|
|
7006
|
-
* Creates a user identity in your account. The operation is idempotent on `externalId`: if a user with the same `externalId` already exists, the existing record is returned instead of creating a duplicate. The response's `created` field (and the HTTP status — 201 when created, 200 when an existing user was returned) tells the two apart. To overwrite an existing user's mutable fields (email, status, payload, schema binding) instead of returning it unchanged, set `?upsert=true` (this also requires the `users:u` scope). Requires the `users:c` scope to create. Being returned the existing user on a collision is a read of that user's data and additionally requires the `users:r` scope — a credential holding `users:c` alone receives a `400` ("already exists") on collision instead of the user.
|
|
7166
|
+
* Creates a user identity in your account. The operation is idempotent on `externalId`: if a user with the same `externalId` already exists, the existing record is returned instead of creating a duplicate. The response's `created` field (and the HTTP status — 201 when created, 200 when an existing user was returned) tells the two apart. To overwrite an existing user's mutable fields (email, status, payload, schema binding) instead of returning it unchanged, set `?upsert=true` (this also requires the `users:u` scope). Requires the `users:c` scope to create. Being returned the existing user on a collision is a read of that user's data and additionally requires the `users:r` scope — a credential holding `users:c` alone receives a `400` ("already exists") on collision instead of the user. A context-confined credential additionally receives the collision echo (or, with `?upsert=true`, is allowed to overwrite) only when the colliding user holds an access profile in the credential's own app context — a cross-context collision otherwise gets the same uniform `400` instead of the other context's user data. One narrow exception on the plain (non-upsert) echo only: the CLI's no-code bootstrap credential can be echoed a colliding user across app contexts, needed for a blueprint to idempotently re-apply against a service principal it provisioned in a non-default context; this does not extend to `?upsert=true`.
|
|
7007
7167
|
*
|
|
7008
7168
|
* @param {Vectros.CreateUserRequest} request
|
|
7009
7169
|
* @param {IdentityClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -7127,7 +7287,7 @@ var IdentityClient = class {
|
|
|
7127
7287
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/users/{id}");
|
|
7128
7288
|
}
|
|
7129
7289
|
/**
|
|
7130
|
-
* Updates mutable fields on an existing user (such as email, status, payload, or schema binding). The `type` field is immutable after creation, and `email` cannot be changed while an invitation to that user is still outstanding — revoke the invitation, or invite the new address instead. This endpoint also activates an invited user: a PUT that moves a PENDING user to ACTIVE and carries `inviteToken`, `externalSubject`, and `emailVerifiedAttestation=true` completes the invitation. Requires the `users:u` scope.
|
|
7290
|
+
* Updates mutable fields on an existing user (such as email, status, payload, or schema binding). The `type` field is immutable after creation, and `email` cannot be changed while an invitation to that user is still outstanding — revoke the invitation, or invite the new address instead. This endpoint also activates an invited user: a PUT that moves a PENDING user to ACTIVE and carries `inviteToken`, `externalSubject`, and `emailVerifiedAttestation=true` completes the invitation. **`externalSubject` set this way is NOT an authentication binding and does not enable sign-in anywhere** — not the Vectros DevPortal/Admin App/web apps, and not `/v1/auth/token/exchange` either; both are granted only by the invitee authenticating themselves. If the invitee needs dev-portal/web-app access, send them the invitation link and let them accept it directly. If the invitee needs to sign in via token exchange, have them redeem `inviteToken` themselves at `/v1/auth/token/exchange` with their own credential — Vectros verifies it there and computes its own value for this field from the verified credential. The value you send here is stored exactly as-is, with no normalization, and does NOT automatically match or deduplicate against what a later token-exchange sign-in computes for the same real-world identity. Call this endpoint directly only if you run your own backend and want Vectros to record which of your own users a given account corresponds to — treat this field as informational for that purpose, not as a way to pre-authorize sign-in. Requires the `users:u` scope.
|
|
7131
7291
|
*
|
|
7132
7292
|
* @param {Vectros.UpdateUserRequest} request
|
|
7133
7293
|
* @param {IdentityClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -7194,7 +7354,7 @@ var IdentityClient = class {
|
|
|
7194
7354
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "PUT", "/v1/users/{id}");
|
|
7195
7355
|
}
|
|
7196
7356
|
/**
|
|
7197
|
-
* Permanently deletes a user identity. This cannot be undone. If the user is a pending invitation, the associated access profile created for that invitation is also removed. Requires the `users:d` scope. Deleting your account's last OWNER is refused (409) — an account must always retain at least one owner.
|
|
7357
|
+
* Permanently deletes a user identity. This cannot be undone. If the user is a pending invitation, the associated access profile created for that invitation is also removed. Requires the `users:d` scope. Deleting your account's last OWNER is refused (409) — an account must always retain at least one owner. Called by a context-confined credential, deletion is also refused (409) when the user holds access in an app context other than the caller's own — remove the user from the caller's own context first, or use a credential with cross-context reach.
|
|
7198
7358
|
*
|
|
7199
7359
|
* @param {Vectros.DeleteUserRequest} request
|
|
7200
7360
|
* @param {IdentityClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -7255,7 +7415,7 @@ var IdentityClient = class {
|
|
|
7255
7415
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "DELETE", "/v1/users/{id}");
|
|
7256
7416
|
}
|
|
7257
7417
|
/**
|
|
7258
|
-
* Looks up users by a schema lookup field, with the query criteria carried in the request body rather than the URL. Use this when looking up by a sensitive (blind-indexed) field: the value is blind-indexed server-side and never appears in the URL, request logs, or proxies. The query semantics are identical to the GET /v1/users lookup, which rejects sensitive-field values and directs you here. Returns a page in the `{data, nextCursor}` envelope. Requires the `users:r` scope.
|
|
7418
|
+
* Looks up users by a schema lookup field, with the query criteria carried in the request body rather than the URL. Use this when looking up by a sensitive (blind-indexed) field: the value is blind-indexed server-side and never appears in the URL, request logs, or proxies. The query semantics are identical to the GET /v1/users lookup, which rejects sensitive-field values and directs you here. Returns a page in the `{data, nextCursor}` envelope. Requires the `users:r` scope. A context-confined credential only sees users who hold an access profile in the credential's own app context — others are silently absent from the page, not an error.
|
|
7259
7419
|
*
|
|
7260
7420
|
* @param {Vectros.IdentityLookupRequest} request
|
|
7261
7421
|
* @param {IdentityClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -7698,14 +7858,14 @@ var RecordsClient = class {
|
|
|
7698
7858
|
this._options = normalizeClientOptionsWithAuth(options);
|
|
7699
7859
|
}
|
|
7700
7860
|
/**
|
|
7701
|
-
*
|
|
7861
|
+
* Fetches multiple records by ID in one call (`ids`, maximum 100). The response contains only the records you can access — any id that does not exist, belongs to another account/AppContext, or is outside your token's scope is silently omitted, with no per-id existence signal, matching the not-found behavior of the single-record GET. Payloads are hydrated the same way a by-id GET hydrates them (payloads externalized to object storage are rehydrated for this response). Requires the `records:r` scope (and, for a scoped token, `records:r:<type>` per record type).
|
|
7702
7862
|
*
|
|
7703
7863
|
* @param {Vectros.BatchGetRequest} request
|
|
7704
7864
|
* @param {RecordsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
7705
7865
|
*
|
|
7866
|
+
* @throws {@link Vectros.BadRequestError}
|
|
7706
7867
|
* @throws {@link Vectros.ForbiddenError}
|
|
7707
7868
|
* @throws {@link Vectros.TooManyRequestsError}
|
|
7708
|
-
* @throws {@link Vectros.NotImplementedError}
|
|
7709
7869
|
*
|
|
7710
7870
|
* @example
|
|
7711
7871
|
* await client.records.batchGetRecords()
|
|
@@ -7742,12 +7902,12 @@ var RecordsClient = class {
|
|
|
7742
7902
|
}
|
|
7743
7903
|
if (_response.error.reason === "status-code") {
|
|
7744
7904
|
switch (_response.error.statusCode) {
|
|
7905
|
+
case 400:
|
|
7906
|
+
throw new BadRequestError(_response.error.body, _response.rawResponse);
|
|
7745
7907
|
case 403:
|
|
7746
7908
|
throw new ForbiddenError(_response.error.body, _response.rawResponse);
|
|
7747
7909
|
case 429:
|
|
7748
7910
|
throw new TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
7749
|
-
case 501:
|
|
7750
|
-
throw new NotImplementedError(_response.error.body, _response.rawResponse);
|
|
7751
7911
|
default:
|
|
7752
7912
|
throw new VectrosError({
|
|
7753
7913
|
statusCode: _response.error.statusCode,
|
|
@@ -8561,7 +8721,7 @@ var SchemasClient = class {
|
|
|
8561
8721
|
this._options = normalizeClientOptionsWithAuth(options);
|
|
8562
8722
|
}
|
|
8563
8723
|
/**
|
|
8564
|
-
* Returns a paginated list of the record schemas defined in your account. Filter by `userId` or `scope` to scope to an owner, by `surface` to list the types bindable to one surface, or by `recordType` to resolve the single schema for a type directly. Filtering by
|
|
8724
|
+
* Returns a paginated list of the record schemas defined in your account. Filter by `userId` or `scope` to scope to an owner, by `surface` to list the types bindable to one surface, or by `recordType` to resolve the single schema for a type directly. Filtering by `surface=user` lists your account-wide identity schemas regardless of the calling context (a `user`-surfaced schema always has one tenant-wide home). Filtering by `surface=entity` reads your own app context's entity schemas AND the tenant-wide home together, newest first, through a single cursor — an entity schema may live in either home depending on where its namespace is placed (see `POST /v1/namespaces`). Filtering by `record` or `document` lists within the calling context only. Requires the `schemas:r` scope.
|
|
8565
8725
|
*
|
|
8566
8726
|
* @param {Vectros.ListSchemasRequest} request
|
|
8567
8727
|
* @param {SchemasClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -8849,6 +9009,7 @@ var SchemasClient = class {
|
|
|
8849
9009
|
* @param {Vectros.DeleteSchemaRequest} request
|
|
8850
9010
|
* @param {SchemasClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
8851
9011
|
*
|
|
9012
|
+
* @throws {@link Vectros.ForbiddenError}
|
|
8852
9013
|
* @throws {@link Vectros.NotFoundError}
|
|
8853
9014
|
* @throws {@link Vectros.ConflictError}
|
|
8854
9015
|
* @throws {@link Vectros.TooManyRequestsError}
|
|
@@ -8888,6 +9049,8 @@ var SchemasClient = class {
|
|
|
8888
9049
|
}
|
|
8889
9050
|
if (_response.error.reason === "status-code") {
|
|
8890
9051
|
switch (_response.error.statusCode) {
|
|
9052
|
+
case 403:
|
|
9053
|
+
throw new ForbiddenError(_response.error.body, _response.rawResponse);
|
|
8891
9054
|
case 404:
|
|
8892
9055
|
throw new NotFoundError(_response.error.body, _response.rawResponse);
|
|
8893
9056
|
case 409:
|
|
@@ -9097,7 +9260,7 @@ var logging;
|
|
|
9097
9260
|
|
|
9098
9261
|
// src/server.ts
|
|
9099
9262
|
var import_types3 = require("@modelcontextprotocol/sdk/types.js");
|
|
9100
|
-
var
|
|
9263
|
+
var import_zod23 = require("zod");
|
|
9101
9264
|
|
|
9102
9265
|
// src/auth.ts
|
|
9103
9266
|
var KEY_RE = /^(sk|ssk|st)_(live|test)_/;
|
|
@@ -9141,8 +9304,8 @@ function warnOnSuboptimalKey(key, log) {
|
|
|
9141
9304
|
|
|
9142
9305
|
// src/build-info.ts
|
|
9143
9306
|
var BUILD_INFO = {
|
|
9144
|
-
mcpServer: true ? "0.
|
|
9145
|
-
sdk: true ? "0.
|
|
9307
|
+
mcpServer: true ? "0.16.1" : "dev",
|
|
9308
|
+
sdk: true ? "0.42.0" : "dev"
|
|
9146
9309
|
};
|
|
9147
9310
|
|
|
9148
9311
|
// src/log.ts
|
|
@@ -9824,23 +9987,70 @@ var recordGet = ({ client, log }) => ({
|
|
|
9824
9987
|
});
|
|
9825
9988
|
var record_get_default = recordGet;
|
|
9826
9989
|
|
|
9827
|
-
// src/tools/
|
|
9990
|
+
// src/tools/record_batch_get.ts
|
|
9828
9991
|
var import_zod4 = require("zod");
|
|
9992
|
+
var MAX_PAYLOAD_CHARS2 = 32e3;
|
|
9993
|
+
var MCP_MAX_IDS = 100;
|
|
9829
9994
|
var inputSchema4 = {
|
|
9830
|
-
|
|
9831
|
-
|
|
9995
|
+
ids: import_zod4.z.array(import_zod4.z.string()).min(1).max(MCP_MAX_IDS).describe(
|
|
9996
|
+
`Record ids to fetch in one call (1-${MCP_MAX_IDS}). Any id you cannot access \u2014 nonexistent, wrong account, or outside your token's scope \u2014 is silently omitted from the response (no per-id existence signal); compare against the response's \`missingIds\` to see which requested ids came back empty.`
|
|
9997
|
+
)
|
|
9998
|
+
};
|
|
9999
|
+
var recordBatchGet = ({ client, log }) => ({
|
|
10000
|
+
name: "record_batch_get",
|
|
10001
|
+
title: "Get multiple records by id in one call",
|
|
10002
|
+
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.",
|
|
10003
|
+
inputSchema: inputSchema4,
|
|
10004
|
+
handler: async (args) => {
|
|
10005
|
+
const ids = args.ids;
|
|
10006
|
+
try {
|
|
10007
|
+
const response = await client.records.batchGetRecords({ ids });
|
|
10008
|
+
const records = response.data ?? [];
|
|
10009
|
+
const data = records.map((record) => {
|
|
10010
|
+
const item = { ...record };
|
|
10011
|
+
if (record.payload !== void 0) {
|
|
10012
|
+
const json = JSON.stringify(record.payload);
|
|
10013
|
+
if (json.length > MAX_PAYLOAD_CHARS2) {
|
|
10014
|
+
delete item.payload;
|
|
10015
|
+
item.payloadPreview = json.slice(0, MAX_PAYLOAD_CHARS2);
|
|
10016
|
+
item.payloadTruncated = true;
|
|
10017
|
+
item.payloadTotalChars = json.length;
|
|
10018
|
+
}
|
|
10019
|
+
}
|
|
10020
|
+
return item;
|
|
10021
|
+
});
|
|
10022
|
+
const returnedIds = new Set(records.map((r) => r.id));
|
|
10023
|
+
const missingIds = ids.filter((id) => !returnedIds.has(id));
|
|
10024
|
+
log.debug(
|
|
10025
|
+
{ tool: "record_batch_get", requested: ids.length, returned: data.length, missing: missingIds.length },
|
|
10026
|
+
"record_batch_get ok"
|
|
10027
|
+
);
|
|
10028
|
+
return { content: [{ type: "text", text: JSON.stringify({ data, missingIds }, null, 2) }] };
|
|
10029
|
+
} catch (err) {
|
|
10030
|
+
log.warn({ tool: "record_batch_get", idsCount: ids?.length, err: String(err) }, "record_batch_get failed");
|
|
10031
|
+
return toolError("record_batch_get", err);
|
|
10032
|
+
}
|
|
10033
|
+
}
|
|
10034
|
+
});
|
|
10035
|
+
var record_batch_get_default = recordBatchGet;
|
|
10036
|
+
|
|
10037
|
+
// src/tools/record_create.ts
|
|
10038
|
+
var import_zod5 = require("zod");
|
|
10039
|
+
var inputSchema5 = {
|
|
10040
|
+
type: import_zod5.z.string().min(1, "type is required").describe('Record type / schema name (e.g. "task"). Must match an existing schema \u2014 see list_schemas.'),
|
|
10041
|
+
fields: import_zod5.z.record(import_zod5.z.string(), import_zod5.z.unknown()).describe(
|
|
9832
10042
|
"The record payload \u2014 a JSON object of field\u2192value, validated against the type schema. Call list_schemas to learn required fields, types, and enum values. Every number must fall within the signed 64-bit range (a value outside it, or with >38 significant digits, is refused with a 400 naming the field) \u2014 send a larger whole number (e.g. a big external id) as a STRING, which stores it exactly and supports exact-match lookup."
|
|
9833
10043
|
),
|
|
9834
|
-
externalId:
|
|
10044
|
+
externalId: import_zod5.z.string().optional().describe(
|
|
9835
10045
|
"Stable caller-supplied id. Immutable; unique per type. Re-creating with the same externalId returns the existing record (idempotent) \u2014 use it to make creates safely retryable."
|
|
9836
10046
|
),
|
|
9837
|
-
indexMode:
|
|
10047
|
+
indexMode: import_zod5.z.enum(["HYBRID", "SEMANTIC", "TEXT", "NONE"]).optional().describe(
|
|
9838
10048
|
"Search-index strategy for this record, set at create only (immutable after). HYBRID (BM25 + dense), SEMANTIC (dense only), TEXT (BM25 only), NONE (store-only \u2014 never appears in hybrid_search/rag_ask; still retrievable by id and structured-field lookup). Omit to inherit the type schema's default; if the schema default is NONE and you want this record searchable, set it here \u2014 it cannot be changed later."
|
|
9839
10049
|
),
|
|
9840
|
-
status:
|
|
9841
|
-
folderId:
|
|
9842
|
-
userId:
|
|
9843
|
-
scopes:
|
|
10050
|
+
status: import_zod5.z.string().optional().describe("Record lifecycle status. Defaults to ACTIVE server-side."),
|
|
10051
|
+
folderId: import_zod5.z.string().optional().describe("Group this record into a folder."),
|
|
10052
|
+
userId: import_zod5.z.string().optional().describe("Owning user id."),
|
|
10053
|
+
scopes: import_zod5.z.array(import_zod5.z.string()).optional().describe(
|
|
9844
10054
|
'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 record\'s COMPLETE scope declaration and values must come from the credential\'s own identity. An empty array `[]` creates a PRIVATE record owned by the calling user alone. Omit to stamp the credential\'s full identity \u2014 the default.'
|
|
9845
10055
|
)
|
|
9846
10056
|
};
|
|
@@ -9848,7 +10058,7 @@ var recordCreate = ({ client, log }) => ({
|
|
|
9848
10058
|
name: "record_create",
|
|
9849
10059
|
title: "Create a record",
|
|
9850
10060
|
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).",
|
|
9851
|
-
inputSchema:
|
|
10061
|
+
inputSchema: inputSchema5,
|
|
9852
10062
|
handler: async (args) => {
|
|
9853
10063
|
const type = args.type;
|
|
9854
10064
|
try {
|
|
@@ -9875,18 +10085,18 @@ var recordCreate = ({ client, log }) => ({
|
|
|
9875
10085
|
var record_create_default = recordCreate;
|
|
9876
10086
|
|
|
9877
10087
|
// src/tools/record_update.ts
|
|
9878
|
-
var
|
|
9879
|
-
var
|
|
9880
|
-
id:
|
|
9881
|
-
externalId:
|
|
10088
|
+
var import_zod6 = require("zod");
|
|
10089
|
+
var inputSchema6 = {
|
|
10090
|
+
id: import_zod6.z.string().optional().describe("The Vectros record id to update. Provide this OR externalId+type."),
|
|
10091
|
+
externalId: import_zod6.z.string().optional().describe(
|
|
9882
10092
|
"Your caller-owned externalId \u2014 an alternative selector to `id` (requires `type`). Updates the record you created under that externalId without a manual record_query lookup first."
|
|
9883
10093
|
),
|
|
9884
|
-
type:
|
|
9885
|
-
fields:
|
|
10094
|
+
type: import_zod6.z.string().optional().describe("Record type \u2014 REQUIRED when selecting by `externalId` (externalId is unique within a type)."),
|
|
10095
|
+
fields: import_zod6.z.record(import_zod6.z.string(), import_zod6.z.unknown()).describe(
|
|
9886
10096
|
"Field\u2192value changes DEEP-MERGED into the existing payload: keys you send overwrite (recursing into nested objects), a key set to `null` is deleted, and unspecified fields are preserved."
|
|
9887
10097
|
),
|
|
9888
|
-
status:
|
|
9889
|
-
expectedVersion:
|
|
10098
|
+
status: import_zod6.z.string().optional().describe("Set the record lifecycle status (e.g. ARCHIVED) \u2014 archive/workflow without physical deletion."),
|
|
10099
|
+
expectedVersion: import_zod6.z.number().int().optional().describe(
|
|
9890
10100
|
"Optimistic concurrency: the version you last read. If the record changed since, the update is refused as a conflict (re-read and retry). Omit for last-write-wins."
|
|
9891
10101
|
)
|
|
9892
10102
|
};
|
|
@@ -9894,7 +10104,7 @@ var recordUpdate = ({ client, log }) => ({
|
|
|
9894
10104
|
name: "record_update",
|
|
9895
10105
|
title: "Update a record by id or externalId",
|
|
9896
10106
|
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.",
|
|
9897
|
-
inputSchema:
|
|
10107
|
+
inputSchema: inputSchema6,
|
|
9898
10108
|
handler: async (args) => {
|
|
9899
10109
|
const id = args.id;
|
|
9900
10110
|
const externalId = args.externalId;
|
|
@@ -9920,15 +10130,15 @@ var recordUpdate = ({ client, log }) => ({
|
|
|
9920
10130
|
var record_update_default = recordUpdate;
|
|
9921
10131
|
|
|
9922
10132
|
// src/tools/record_delete.ts
|
|
9923
|
-
var
|
|
9924
|
-
var
|
|
9925
|
-
id:
|
|
10133
|
+
var import_zod7 = require("zod");
|
|
10134
|
+
var inputSchema7 = {
|
|
10135
|
+
id: import_zod7.z.string().min(1, "id is required").describe("The Vectros record id to delete.")
|
|
9926
10136
|
};
|
|
9927
10137
|
var recordDelete = ({ client, log }) => ({
|
|
9928
10138
|
name: "record_delete",
|
|
9929
10139
|
title: "Delete a record",
|
|
9930
10140
|
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.",
|
|
9931
|
-
inputSchema:
|
|
10141
|
+
inputSchema: inputSchema7,
|
|
9932
10142
|
handler: async (args) => {
|
|
9933
10143
|
const id = args.id;
|
|
9934
10144
|
try {
|
|
@@ -9944,48 +10154,48 @@ var recordDelete = ({ client, log }) => ({
|
|
|
9944
10154
|
var record_delete_default = recordDelete;
|
|
9945
10155
|
|
|
9946
10156
|
// src/tools/rag_ask.ts
|
|
9947
|
-
var
|
|
10157
|
+
var import_zod8 = require("zod");
|
|
9948
10158
|
var SEARCH_MCP_DEFAULT_LIMIT = 5;
|
|
9949
10159
|
var SEARCH_MCP_MAX_LIMIT = 50;
|
|
9950
|
-
var
|
|
9951
|
-
query:
|
|
9952
|
-
instructions:
|
|
10160
|
+
var inputSchema8 = {
|
|
10161
|
+
query: import_zod8.z.string().min(1, "query must be non-empty").describe("Question to ground against retrieved content."),
|
|
10162
|
+
instructions: import_zod8.z.string().optional().describe(
|
|
9953
10163
|
'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.'
|
|
9954
10164
|
),
|
|
9955
|
-
model:
|
|
10165
|
+
model: import_zod8.z.string().optional().describe(
|
|
9956
10166
|
"Inference model alias (e.g. claude-haiku-4-5, claude-sonnet-5, claude-opus-4-8). Default = tier-appropriate Haiku. See GET /v1/models for the catalog the calling key can reach."
|
|
9957
10167
|
),
|
|
9958
|
-
search:
|
|
9959
|
-
mode:
|
|
9960
|
-
limit:
|
|
10168
|
+
search: import_zod8.z.object({
|
|
10169
|
+
mode: import_zod8.z.enum(["HYBRID", "TEXT", "SEMANTIC"]).optional().describe("Retrieval mode. Default HYBRID."),
|
|
10170
|
+
limit: import_zod8.z.number().int().min(1).max(SEARCH_MCP_MAX_LIMIT).optional().describe(
|
|
9961
10171
|
`Passages to retrieve before generating (the grounding-corpus size). Default ${SEARCH_MCP_DEFAULT_LIMIT}; raise up to ${SEARCH_MCP_MAX_LIMIT} (the RAG search API max) for a broader corpus when the extra grounding is worth the larger prompt.`
|
|
9962
10172
|
),
|
|
9963
10173
|
// Retrieval scoping — parity with hybrid_search so an agent can ground the
|
|
9964
10174
|
// answer on a specific owner / folder / type / metadata subset, not just the
|
|
9965
10175
|
// whole-tenant corpus.
|
|
9966
|
-
userId:
|
|
9967
|
-
scope:
|
|
10176
|
+
userId: import_zod8.z.string().optional().describe("Restrict retrieval to content owned by this user (Vectros UUID)."),
|
|
10177
|
+
scope: import_zod8.z.string().optional().describe(
|
|
9968
10178
|
'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.'
|
|
9969
10179
|
),
|
|
9970
|
-
folderId:
|
|
9971
|
-
rootFolderId:
|
|
9972
|
-
typeName:
|
|
9973
|
-
contentTypes:
|
|
9974
|
-
filters:
|
|
10180
|
+
folderId: import_zod8.z.string().optional().describe("Restrict retrieval to this exact folder."),
|
|
10181
|
+
rootFolderId: import_zod8.z.string().optional().describe("Restrict retrieval to this folder and all its descendants."),
|
|
10182
|
+
typeName: import_zod8.z.string().optional().describe("Restrict record retrieval to this schema type."),
|
|
10183
|
+
contentTypes: import_zod8.z.array(import_zod8.z.enum(["documents", "records"])).optional().describe('Narrow retrieval to content types. ["documents"] or ["records"]; omit for both.'),
|
|
10184
|
+
filters: import_zod8.z.record(import_zod8.z.unknown()).optional().describe(
|
|
9975
10185
|
'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"}.'
|
|
9976
10186
|
),
|
|
9977
|
-
createdAfter:
|
|
9978
|
-
createdBefore:
|
|
9979
|
-
requireComplete:
|
|
10187
|
+
createdAfter: import_zod8.z.string().optional().describe("Restrict to content created at/after this ISO 8601 UTC timestamp."),
|
|
10188
|
+
createdBefore: import_zod8.z.string().optional().describe("Restrict to content created at/before this ISO 8601 UTC timestamp."),
|
|
10189
|
+
requireComplete: import_zod8.z.boolean().optional().describe("Fail closed (503) on a degraded search backend instead of grounding on partial results. Default false.")
|
|
9980
10190
|
}).optional().describe("Retrieval params + scoping. Default mode HYBRID, limit " + SEARCH_MCP_DEFAULT_LIMIT + "."),
|
|
9981
|
-
maxTokens:
|
|
9982
|
-
temperature:
|
|
10191
|
+
maxTokens: import_zod8.z.number().int().min(1).optional().describe("Max output tokens."),
|
|
10192
|
+
temperature: import_zod8.z.number().min(0).max(1).optional().describe("Sampling temperature (0.0\u20131.0). Default 0.3 \u2014 lower favors deterministic, retrieval-grounded answers.")
|
|
9983
10193
|
};
|
|
9984
10194
|
var ragAsk = ({ client, log }) => ({
|
|
9985
10195
|
name: "rag_ask",
|
|
9986
10196
|
title: "RAG ask (corpus-wide)",
|
|
9987
10197
|
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, 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.",
|
|
9988
|
-
inputSchema:
|
|
10198
|
+
inputSchema: inputSchema8,
|
|
9989
10199
|
handler: async (args, extra) => {
|
|
9990
10200
|
try {
|
|
9991
10201
|
const searchArg = args.search ?? {};
|
|
@@ -10061,20 +10271,20 @@ var ragAsk = ({ client, log }) => ({
|
|
|
10061
10271
|
var rag_ask_default = ragAsk;
|
|
10062
10272
|
|
|
10063
10273
|
// src/tools/document_ask.ts
|
|
10064
|
-
var
|
|
10065
|
-
var
|
|
10066
|
-
documentId:
|
|
10067
|
-
prompt:
|
|
10068
|
-
model:
|
|
10274
|
+
var import_zod9 = require("zod");
|
|
10275
|
+
var inputSchema9 = {
|
|
10276
|
+
documentId: import_zod9.z.string().min(1, "documentId is required").describe("ID of the document to ask against."),
|
|
10277
|
+
prompt: import_zod9.z.string().min(1, "prompt is required").describe("Question to ask about the document."),
|
|
10278
|
+
model: import_zod9.z.string().optional().describe(
|
|
10069
10279
|
"Inference model alias. Default = tier-appropriate Haiku. See GET /v1/models for the catalog the calling key can reach."
|
|
10070
10280
|
),
|
|
10071
|
-
maxTokens:
|
|
10281
|
+
maxTokens: import_zod9.z.number().int().min(1).optional().describe("Max output tokens.")
|
|
10072
10282
|
};
|
|
10073
10283
|
var documentAsk = ({ client, log }) => ({
|
|
10074
10284
|
name: "document_ask",
|
|
10075
10285
|
title: "Document ask (single-document)",
|
|
10076
10286
|
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.",
|
|
10077
|
-
inputSchema:
|
|
10287
|
+
inputSchema: inputSchema9,
|
|
10078
10288
|
handler: async (args, extra) => {
|
|
10079
10289
|
try {
|
|
10080
10290
|
const stream = await client.inference.documentAsk({
|
|
@@ -10133,18 +10343,18 @@ var documentAsk = ({ client, log }) => ({
|
|
|
10133
10343
|
var document_ask_default = documentAsk;
|
|
10134
10344
|
|
|
10135
10345
|
// src/tools/list_schemas.ts
|
|
10136
|
-
var
|
|
10137
|
-
var
|
|
10138
|
-
userId:
|
|
10346
|
+
var import_zod10 = require("zod");
|
|
10347
|
+
var inputSchema10 = {
|
|
10348
|
+
userId: import_zod10.z.string().optional().describe(
|
|
10139
10349
|
"Filter to schemas visible to a specific user. Optional; default returns all schemas the credential can see."
|
|
10140
10350
|
),
|
|
10141
|
-
scope:
|
|
10351
|
+
scope: import_zod10.z.string().optional().describe(
|
|
10142
10352
|
'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.'
|
|
10143
10353
|
),
|
|
10144
|
-
surface:
|
|
10354
|
+
surface: import_zod10.z.enum(["record", "document", "user", "entity"]).optional().describe(
|
|
10145
10355
|
"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."
|
|
10146
10356
|
),
|
|
10147
|
-
recordType:
|
|
10357
|
+
recordType: import_zod10.z.string().optional().describe(
|
|
10148
10358
|
'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.'
|
|
10149
10359
|
)
|
|
10150
10360
|
};
|
|
@@ -10152,7 +10362,7 @@ var listSchemas = ({ client, log }) => ({
|
|
|
10152
10362
|
name: "list_schemas",
|
|
10153
10363
|
title: "List record schemas",
|
|
10154
10364
|
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.',
|
|
10155
|
-
inputSchema:
|
|
10365
|
+
inputSchema: inputSchema10,
|
|
10156
10366
|
handler: async (args) => {
|
|
10157
10367
|
const userId = args.userId;
|
|
10158
10368
|
const scope = args.scope;
|
|
@@ -10178,18 +10388,18 @@ var listSchemas = ({ client, log }) => ({
|
|
|
10178
10388
|
var list_schemas_default = listSchemas;
|
|
10179
10389
|
|
|
10180
10390
|
// src/tools/document_get.ts
|
|
10181
|
-
var
|
|
10391
|
+
var import_zod11 = require("zod");
|
|
10182
10392
|
var MAX_TEXT_CHARS = 32e3;
|
|
10183
|
-
var
|
|
10184
|
-
documentId:
|
|
10185
|
-
externalId:
|
|
10393
|
+
var inputSchema11 = {
|
|
10394
|
+
documentId: import_zod11.z.string().optional().describe("The document ID returned by document_ingest or hybrid_search. Provide this OR externalId+type."),
|
|
10395
|
+
externalId: import_zod11.z.string().optional().describe(
|
|
10186
10396
|
"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."
|
|
10187
10397
|
),
|
|
10188
|
-
type:
|
|
10189
|
-
includeText:
|
|
10398
|
+
type: import_zod11.z.string().optional().describe("Document type \u2014 REQUIRED when selecting by `externalId` (externalId is unique within a type)."),
|
|
10399
|
+
includeText: import_zod11.z.boolean().optional().describe(
|
|
10190
10400
|
"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."
|
|
10191
10401
|
),
|
|
10192
|
-
includeDownloadUrl:
|
|
10402
|
+
includeDownloadUrl: import_zod11.z.boolean().optional().describe(
|
|
10193
10403
|
"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."
|
|
10194
10404
|
)
|
|
10195
10405
|
};
|
|
@@ -10206,7 +10416,7 @@ var documentGet = ({ client, log }) => ({
|
|
|
10206
10416
|
name: "document_get",
|
|
10207
10417
|
title: "Get document metadata (and optionally text)",
|
|
10208
10418
|
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.",
|
|
10209
|
-
inputSchema:
|
|
10419
|
+
inputSchema: inputSchema11,
|
|
10210
10420
|
handler: async (args) => {
|
|
10211
10421
|
const documentId = args.documentId;
|
|
10212
10422
|
const externalId = args.externalId;
|
|
@@ -10271,28 +10481,28 @@ var documentGet = ({ client, log }) => ({
|
|
|
10271
10481
|
var document_get_default = documentGet;
|
|
10272
10482
|
|
|
10273
10483
|
// src/tools/document_query.ts
|
|
10274
|
-
var
|
|
10484
|
+
var import_zod12 = require("zod");
|
|
10275
10485
|
var MCP_DEFAULT_LIMIT3 = 3;
|
|
10276
10486
|
var MCP_MAX_LIMIT3 = 100;
|
|
10277
|
-
var
|
|
10487
|
+
var inputSchema12 = {
|
|
10278
10488
|
// Lookup-mode args — provide `field` plus EXACTLY ONE of: value | from+to | prefix.
|
|
10279
|
-
field:
|
|
10280
|
-
value:
|
|
10281
|
-
from:
|
|
10282
|
-
to:
|
|
10283
|
-
prefix:
|
|
10284
|
-
order:
|
|
10489
|
+
field: import_zod12.z.string().optional().describe("Lookup mode: name of the lookup-indexed field to query by."),
|
|
10490
|
+
value: import_zod12.z.string().optional().describe("Lookup mode (equality): exact-match value for `field`. Works on sensitive fields too."),
|
|
10491
|
+
from: import_zod12.z.string().optional().describe("Lookup mode (range): inclusive lower bound; requires `to`. Range-enabled, non-sensitive fields only."),
|
|
10492
|
+
to: import_zod12.z.string().optional().describe("Lookup mode (range): inclusive upper bound; requires `from`."),
|
|
10493
|
+
prefix: import_zod12.z.string().optional().describe("Lookup mode (prefix): match values starting with this. Range-enabled string fields only."),
|
|
10494
|
+
order: import_zod12.z.enum(["asc", "desc"]).optional().describe(
|
|
10285
10495
|
"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."
|
|
10286
10496
|
),
|
|
10287
|
-
type:
|
|
10497
|
+
type: import_zod12.z.string().optional().describe("Lookup mode: the document type (the bound schema's type). Required with `field`."),
|
|
10288
10498
|
// List-mode args:
|
|
10289
|
-
folderId:
|
|
10290
|
-
userId:
|
|
10291
|
-
scope:
|
|
10499
|
+
folderId: import_zod12.z.string().optional().describe("List mode: only documents in this folder (Vectros folder id)."),
|
|
10500
|
+
userId: import_zod12.z.string().optional().describe("List mode: scope to documents owned by this user."),
|
|
10501
|
+
scope: import_zod12.z.string().optional().describe(
|
|
10292
10502
|
'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.'
|
|
10293
10503
|
),
|
|
10294
|
-
startFrom:
|
|
10295
|
-
limit:
|
|
10504
|
+
startFrom: import_zod12.z.string().optional().describe("Pagination cursor \u2014 pass the `nextCursor` from the previous page to fetch the next. Works in both list and lookup mode."),
|
|
10505
|
+
limit: import_zod12.z.number().int().min(1).max(MCP_MAX_LIMIT3).optional().describe(
|
|
10296
10506
|
`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.`
|
|
10297
10507
|
)
|
|
10298
10508
|
};
|
|
@@ -10300,7 +10510,7 @@ var documentQuery = ({ client, log }) => ({
|
|
|
10300
10510
|
name: "document_query",
|
|
10301
10511
|
title: "Document query (list or lookup)",
|
|
10302
10512
|
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.",
|
|
10303
|
-
inputSchema:
|
|
10513
|
+
inputSchema: inputSchema12,
|
|
10304
10514
|
handler: async (args) => {
|
|
10305
10515
|
const limit = args.limit ?? MCP_DEFAULT_LIMIT3;
|
|
10306
10516
|
const field = args.field;
|
|
@@ -10380,29 +10590,29 @@ var documentQuery = ({ client, log }) => ({
|
|
|
10380
10590
|
var document_query_default = documentQuery;
|
|
10381
10591
|
|
|
10382
10592
|
// src/tools/document_update.ts
|
|
10383
|
-
var
|
|
10384
|
-
var
|
|
10385
|
-
documentId:
|
|
10386
|
-
externalId:
|
|
10593
|
+
var import_zod13 = require("zod");
|
|
10594
|
+
var inputSchema13 = {
|
|
10595
|
+
documentId: import_zod13.z.string().optional().describe("The Vectros document id to update. Provide this OR externalId+type."),
|
|
10596
|
+
externalId: import_zod13.z.string().optional().describe(
|
|
10387
10597
|
"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."
|
|
10388
10598
|
),
|
|
10389
|
-
type:
|
|
10390
|
-
title:
|
|
10391
|
-
fields:
|
|
10599
|
+
type: import_zod13.z.string().optional().describe("Document type \u2014 REQUIRED when selecting by `externalId` (externalId is unique within a type)."),
|
|
10600
|
+
title: import_zod13.z.string().optional().describe("New title. Omit to keep the current title."),
|
|
10601
|
+
fields: import_zod13.z.record(import_zod13.z.string(), import_zod13.z.unknown()).optional().describe(
|
|
10392
10602
|
"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."
|
|
10393
10603
|
),
|
|
10394
|
-
text:
|
|
10604
|
+
text: import_zod13.z.string().optional().describe(
|
|
10395
10605
|
"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."
|
|
10396
10606
|
),
|
|
10397
|
-
folderId:
|
|
10398
|
-
status:
|
|
10607
|
+
folderId: import_zod13.z.string().optional().describe("Move the document into this folder (cannot be cleared once set)."),
|
|
10608
|
+
status: import_zod13.z.enum(["ACTIVE", "ARCHIVED"]).optional().describe(
|
|
10399
10609
|
"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."
|
|
10400
10610
|
),
|
|
10401
|
-
userId:
|
|
10402
|
-
scopes:
|
|
10611
|
+
userId: import_zod13.z.string().optional().describe("Reassign the owning user (Vectros UUID)."),
|
|
10612
|
+
scopes: import_zod13.z.array(import_zod13.z.string()).optional().describe(
|
|
10403
10613
|
'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).'
|
|
10404
10614
|
),
|
|
10405
|
-
expectedVersion:
|
|
10615
|
+
expectedVersion: import_zod13.z.number().int().optional().describe(
|
|
10406
10616
|
"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."
|
|
10407
10617
|
)
|
|
10408
10618
|
};
|
|
@@ -10410,7 +10620,7 @@ var documentUpdate = ({ client, log }) => ({
|
|
|
10410
10620
|
name: "document_update",
|
|
10411
10621
|
title: "Update a document",
|
|
10412
10622
|
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.',
|
|
10413
|
-
inputSchema:
|
|
10623
|
+
inputSchema: inputSchema13,
|
|
10414
10624
|
handler: async (args) => {
|
|
10415
10625
|
const documentId = args.documentId;
|
|
10416
10626
|
const externalId = args.externalId;
|
|
@@ -10450,15 +10660,15 @@ var documentUpdate = ({ client, log }) => ({
|
|
|
10450
10660
|
var document_update_default = documentUpdate;
|
|
10451
10661
|
|
|
10452
10662
|
// src/tools/document_delete.ts
|
|
10453
|
-
var
|
|
10454
|
-
var
|
|
10455
|
-
documentId:
|
|
10663
|
+
var import_zod14 = require("zod");
|
|
10664
|
+
var inputSchema14 = {
|
|
10665
|
+
documentId: import_zod14.z.string().min(1, "documentId is required").describe("The Vectros document id to delete.")
|
|
10456
10666
|
};
|
|
10457
10667
|
var documentDelete = ({ client, log }) => ({
|
|
10458
10668
|
name: "document_delete",
|
|
10459
10669
|
title: "Delete a document",
|
|
10460
10670
|
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).',
|
|
10461
|
-
inputSchema:
|
|
10671
|
+
inputSchema: inputSchema14,
|
|
10462
10672
|
handler: async (args) => {
|
|
10463
10673
|
const documentId = args.documentId;
|
|
10464
10674
|
try {
|
|
@@ -10476,18 +10686,18 @@ var documentDelete = ({ client, log }) => ({
|
|
|
10476
10686
|
var document_delete_default = documentDelete;
|
|
10477
10687
|
|
|
10478
10688
|
// src/tools/folder_query.ts
|
|
10479
|
-
var
|
|
10689
|
+
var import_zod15 = require("zod");
|
|
10480
10690
|
var MCP_DEFAULT_LIMIT4 = 10;
|
|
10481
10691
|
var MCP_MAX_LIMIT4 = 100;
|
|
10482
|
-
var
|
|
10483
|
-
id:
|
|
10484
|
-
parentId:
|
|
10485
|
-
userId:
|
|
10486
|
-
scope:
|
|
10692
|
+
var inputSchema15 = {
|
|
10693
|
+
id: import_zod15.z.string().optional().describe("Get mode: fetch this single folder by id."),
|
|
10694
|
+
parentId: import_zod15.z.string().optional().describe("List mode: direct children of this folder (tree navigation). Omit for a flat tenant list."),
|
|
10695
|
+
userId: import_zod15.z.string().optional().describe("List mode: scope to folders owned by this user."),
|
|
10696
|
+
scope: import_zod15.z.string().optional().describe(
|
|
10487
10697
|
'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.'
|
|
10488
10698
|
),
|
|
10489
|
-
startFrom:
|
|
10490
|
-
limit:
|
|
10699
|
+
startFrom: import_zod15.z.string().optional().describe("List mode: pagination cursor \u2014 pass the `nextCursor` from the previous page to fetch the next."),
|
|
10700
|
+
limit: import_zod15.z.number().int().min(1).max(MCP_MAX_LIMIT4).optional().describe(
|
|
10491
10701
|
`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\`.`
|
|
10492
10702
|
)
|
|
10493
10703
|
};
|
|
@@ -10495,7 +10705,7 @@ var folderQuery = ({ client, log }) => ({
|
|
|
10495
10705
|
name: "folder_query",
|
|
10496
10706
|
title: "Folder query (list or get)",
|
|
10497
10707
|
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.",
|
|
10498
|
-
inputSchema:
|
|
10708
|
+
inputSchema: inputSchema15,
|
|
10499
10709
|
handler: async (args) => {
|
|
10500
10710
|
const id = args.id;
|
|
10501
10711
|
try {
|
|
@@ -10525,14 +10735,14 @@ var folderQuery = ({ client, log }) => ({
|
|
|
10525
10735
|
var folder_query_default = folderQuery;
|
|
10526
10736
|
|
|
10527
10737
|
// src/tools/folder_create.ts
|
|
10528
|
-
var
|
|
10529
|
-
var
|
|
10530
|
-
name:
|
|
10531
|
-
description:
|
|
10532
|
-
parentId:
|
|
10533
|
-
slug:
|
|
10534
|
-
userId:
|
|
10535
|
-
scopes:
|
|
10738
|
+
var import_zod16 = require("zod");
|
|
10739
|
+
var inputSchema16 = {
|
|
10740
|
+
name: import_zod16.z.string().min(1, "name is required").describe("Folder display name."),
|
|
10741
|
+
description: import_zod16.z.string().optional().describe("Optional description of the folder's purpose."),
|
|
10742
|
+
parentId: import_zod16.z.string().optional().describe("Parent folder id \u2014 places the folder under this parent. Omit for the context default root. Create-only."),
|
|
10743
|
+
slug: import_zod16.z.string().optional().describe("Optional stable slug (sibling-unique; idempotency key). Lowercase letters/digits/hyphens. Derived from name when omitted."),
|
|
10744
|
+
userId: import_zod16.z.string().optional().describe("Owning user (Vectros UUID)."),
|
|
10745
|
+
scopes: import_zod16.z.array(import_zod16.z.string()).optional().describe(
|
|
10536
10746
|
'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.'
|
|
10537
10747
|
)
|
|
10538
10748
|
};
|
|
@@ -10540,7 +10750,7 @@ var folderCreate = ({ client, log }) => ({
|
|
|
10540
10750
|
name: "folder_create",
|
|
10541
10751
|
title: "Create a folder",
|
|
10542
10752
|
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).",
|
|
10543
|
-
inputSchema:
|
|
10753
|
+
inputSchema: inputSchema16,
|
|
10544
10754
|
handler: async (args) => {
|
|
10545
10755
|
try {
|
|
10546
10756
|
const folder = await client.folders.createFolder({
|
|
@@ -10564,16 +10774,16 @@ var folderCreate = ({ client, log }) => ({
|
|
|
10564
10774
|
var folder_create_default = folderCreate;
|
|
10565
10775
|
|
|
10566
10776
|
// src/tools/folder_update.ts
|
|
10567
|
-
var
|
|
10568
|
-
var
|
|
10569
|
-
id:
|
|
10570
|
-
name:
|
|
10571
|
-
description:
|
|
10572
|
-
userId:
|
|
10573
|
-
scopes:
|
|
10777
|
+
var import_zod17 = require("zod");
|
|
10778
|
+
var inputSchema17 = {
|
|
10779
|
+
id: import_zod17.z.string().min(1, "id is required").describe("The Vectros folder id to update."),
|
|
10780
|
+
name: import_zod17.z.string().optional().describe("New folder name. Omit to keep the current name."),
|
|
10781
|
+
description: import_zod17.z.string().optional().describe("New description. Omit to leave unchanged."),
|
|
10782
|
+
userId: import_zod17.z.string().optional().describe("Reassign the owning user (Vectros UUID)."),
|
|
10783
|
+
scopes: import_zod17.z.array(import_zod17.z.string()).optional().describe(
|
|
10574
10784
|
'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).'
|
|
10575
10785
|
),
|
|
10576
|
-
expectedVersion:
|
|
10786
|
+
expectedVersion: import_zod17.z.number().int().optional().describe(
|
|
10577
10787
|
"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."
|
|
10578
10788
|
)
|
|
10579
10789
|
};
|
|
@@ -10581,7 +10791,7 @@ var folderUpdate = ({ client, log }) => ({
|
|
|
10581
10791
|
name: "folder_update",
|
|
10582
10792
|
title: "Update a folder",
|
|
10583
10793
|
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.",
|
|
10584
|
-
inputSchema:
|
|
10794
|
+
inputSchema: inputSchema17,
|
|
10585
10795
|
handler: async (args) => {
|
|
10586
10796
|
const id = args.id;
|
|
10587
10797
|
const name = args.name;
|
|
@@ -10608,15 +10818,15 @@ var folderUpdate = ({ client, log }) => ({
|
|
|
10608
10818
|
var folder_update_default = folderUpdate;
|
|
10609
10819
|
|
|
10610
10820
|
// src/tools/folder_delete.ts
|
|
10611
|
-
var
|
|
10612
|
-
var
|
|
10613
|
-
id:
|
|
10821
|
+
var import_zod18 = require("zod");
|
|
10822
|
+
var inputSchema18 = {
|
|
10823
|
+
id: import_zod18.z.string().min(1, "id is required").describe("The Vectros folder id to delete.")
|
|
10614
10824
|
};
|
|
10615
10825
|
var folderDelete = ({ client, log }) => ({
|
|
10616
10826
|
name: "folder_delete",
|
|
10617
10827
|
title: "Delete a folder",
|
|
10618
10828
|
description: "Permanently delete a folder by id. 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.",
|
|
10619
|
-
inputSchema:
|
|
10829
|
+
inputSchema: inputSchema18,
|
|
10620
10830
|
handler: async (args) => {
|
|
10621
10831
|
const id = args.id;
|
|
10622
10832
|
try {
|
|
@@ -10632,14 +10842,14 @@ var folderDelete = ({ client, log }) => ({
|
|
|
10632
10842
|
var folder_delete_default = folderDelete;
|
|
10633
10843
|
|
|
10634
10844
|
// src/tools/current_identity.ts
|
|
10635
|
-
var
|
|
10845
|
+
var inputSchema19 = {
|
|
10636
10846
|
// No args — current_identity describes the current credential.
|
|
10637
10847
|
};
|
|
10638
10848
|
var currentIdentity = ({ log, apiKey, environment }) => ({
|
|
10639
10849
|
name: "current_identity",
|
|
10640
10850
|
title: "Current identity (tenant + principal scope)",
|
|
10641
|
-
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) \u2014 a separate reach dimension a scope clause can carry
|
|
10642
|
-
inputSchema:
|
|
10851
|
+
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.",
|
|
10852
|
+
inputSchema: inputSchema19,
|
|
10643
10853
|
handler: async () => {
|
|
10644
10854
|
try {
|
|
10645
10855
|
const identity = await resolveIdentity({ log, apiKey, environment });
|
|
@@ -10655,7 +10865,7 @@ var currentIdentity = ({ log, apiKey, environment }) => ({
|
|
|
10655
10865
|
var current_identity_default = currentIdentity;
|
|
10656
10866
|
|
|
10657
10867
|
// src/tools/document_ingest.ts
|
|
10658
|
-
var
|
|
10868
|
+
var import_zod19 = require("zod");
|
|
10659
10869
|
var import_promises = require("fs/promises");
|
|
10660
10870
|
var import_node_path = require("path");
|
|
10661
10871
|
var IngestPathError = class extends Error {
|
|
@@ -10730,37 +10940,37 @@ function inferMimeType(filePath) {
|
|
|
10730
10940
|
const ext = (0, import_node_path.extname)(filePath).toLowerCase();
|
|
10731
10941
|
return EXT_TO_MIME[ext] ?? "application/octet-stream";
|
|
10732
10942
|
}
|
|
10733
|
-
var
|
|
10734
|
-
title:
|
|
10735
|
-
indexMode:
|
|
10943
|
+
var inputSchema20 = {
|
|
10944
|
+
title: import_zod19.z.string().min(1, "title is required").describe("Human-readable document title \u2014 appears in search results and the UI."),
|
|
10945
|
+
indexMode: import_zod19.z.enum(["HYBRID", "SEMANTIC", "TEXT", "NONE"]).optional().describe(
|
|
10736
10946
|
"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."
|
|
10737
10947
|
),
|
|
10738
|
-
externalId:
|
|
10948
|
+
externalId: import_zod19.z.string().optional().describe(
|
|
10739
10949
|
'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.'
|
|
10740
10950
|
),
|
|
10741
|
-
upsert:
|
|
10951
|
+
upsert: import_zod19.z.boolean().optional().describe(
|
|
10742
10952
|
"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, so omitting schemaId resolves in the untyped namespace and mints a duplicate instead of updating. The response `created` flag confirms which happened (created:true = a new document was minted)."
|
|
10743
10953
|
),
|
|
10744
|
-
schemaId:
|
|
10954
|
+
schemaId: import_zod19.z.string().optional().describe(
|
|
10745
10955
|
"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."
|
|
10746
10956
|
),
|
|
10747
|
-
payload:
|
|
10957
|
+
payload: import_zod19.z.record(import_zod19.z.string(), import_zod19.z.unknown()).optional().describe(
|
|
10748
10958
|
"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."
|
|
10749
10959
|
),
|
|
10750
10960
|
// Inline text mode (mutually exclusive with filePath):
|
|
10751
|
-
text:
|
|
10752
|
-
storeText:
|
|
10961
|
+
text: import_zod19.z.string().min(1).optional().describe("Text body to ingest inline. Mutually exclusive with filePath. Either text or filePath is required."),
|
|
10962
|
+
storeText: import_zod19.z.boolean().optional().describe(
|
|
10753
10963
|
"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."
|
|
10754
10964
|
),
|
|
10755
10965
|
// File upload mode (mutually exclusive with text; stdio-transport-only):
|
|
10756
|
-
filePath:
|
|
10966
|
+
filePath: import_zod19.z.string().min(1).optional().describe(
|
|
10757
10967
|
"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."
|
|
10758
10968
|
),
|
|
10759
|
-
fileType:
|
|
10969
|
+
fileType: import_zod19.z.string().optional().describe('MIME type of the file (e.g. "application/pdf"). Inferred from filePath extension if omitted.'),
|
|
10760
10970
|
// Common (both modes):
|
|
10761
|
-
folderId:
|
|
10762
|
-
userId:
|
|
10763
|
-
scopes:
|
|
10971
|
+
folderId: import_zod19.z.string().optional().describe("Optional folder to ingest into. Default: tenant root."),
|
|
10972
|
+
userId: import_zod19.z.string().optional().describe("Owning user ID. Optional."),
|
|
10973
|
+
scopes: import_zod19.z.array(import_zod19.z.string()).optional().describe(
|
|
10764
10974
|
"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."
|
|
10765
10975
|
)
|
|
10766
10976
|
};
|
|
@@ -10768,7 +10978,7 @@ var documentIngest = ({ client, log, transport, ingestRoot }) => ({
|
|
|
10768
10978
|
name: "document_ingest",
|
|
10769
10979
|
title: "Ingest a new document (text body or file upload)",
|
|
10770
10980
|
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`.",
|
|
10771
|
-
inputSchema:
|
|
10981
|
+
inputSchema: inputSchema20,
|
|
10772
10982
|
handler: async (args) => {
|
|
10773
10983
|
const title = args.title;
|
|
10774
10984
|
const text = args.text;
|
|
@@ -10920,29 +11130,29 @@ var documentIngest = ({ client, log, transport, ingestRoot }) => ({
|
|
|
10920
11130
|
var document_ingest_default = documentIngest;
|
|
10921
11131
|
|
|
10922
11132
|
// src/tools/lookup_principal.ts
|
|
10923
|
-
var
|
|
11133
|
+
var import_zod20 = require("zod");
|
|
10924
11134
|
var MCP_DEFAULT_LIMIT5 = 10;
|
|
10925
11135
|
var MCP_MAX_LIMIT5 = 100;
|
|
10926
|
-
var
|
|
10927
|
-
kind:
|
|
11136
|
+
var inputSchema21 = {
|
|
11137
|
+
kind: import_zod20.z.string().describe(
|
|
10928
11138
|
'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.'
|
|
10929
11139
|
),
|
|
10930
|
-
externalId:
|
|
11140
|
+
externalId: import_zod20.z.string().optional().describe(
|
|
10931
11141
|
"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."
|
|
10932
11142
|
),
|
|
10933
|
-
contextId:
|
|
11143
|
+
contextId: import_zod20.z.string().optional().describe(
|
|
10934
11144
|
"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."
|
|
10935
11145
|
),
|
|
10936
11146
|
// Lookup-mode args — provide `field` plus EXACTLY ONE of: value | from+to | prefix.
|
|
10937
|
-
type:
|
|
10938
|
-
field:
|
|
10939
|
-
value:
|
|
10940
|
-
from:
|
|
10941
|
-
to:
|
|
10942
|
-
prefix:
|
|
10943
|
-
order:
|
|
10944
|
-
startFrom:
|
|
10945
|
-
limit:
|
|
11147
|
+
type: import_zod20.z.string().optional().describe('Lookup mode: the identity schema\'s record type (e.g. "person_v1"). Required with `field`.'),
|
|
11148
|
+
field: import_zod20.z.string().optional().describe('Lookup mode: name of the schema-declared lookup field to query by (e.g. "email").'),
|
|
11149
|
+
value: import_zod20.z.string().optional().describe("Lookup mode (equality): exact-match value for `field`. Works on sensitive fields."),
|
|
11150
|
+
from: import_zod20.z.string().optional().describe("Lookup mode (range): inclusive lower bound; requires `to`. Non-sensitive fields only."),
|
|
11151
|
+
to: import_zod20.z.string().optional().describe("Lookup mode (range): inclusive upper bound; requires `from`."),
|
|
11152
|
+
prefix: import_zod20.z.string().optional().describe("Lookup mode (prefix): match values starting with this. Range-enabled string fields only."),
|
|
11153
|
+
order: import_zod20.z.enum(["asc", "desc"]).optional().describe("Lookup mode: sort direction by the looked-up field. `asc` (default) or `desc`."),
|
|
11154
|
+
startFrom: import_zod20.z.string().optional().describe("Lookup mode: pagination cursor \u2014 pass the `nextCursor` from the previous page to fetch the next."),
|
|
11155
|
+
limit: import_zod20.z.number().int().min(1).max(MCP_MAX_LIMIT5).optional().describe(
|
|
10946
11156
|
`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\`.`
|
|
10947
11157
|
)
|
|
10948
11158
|
};
|
|
@@ -10950,7 +11160,7 @@ var lookupPrincipal = ({ client, log }) => ({
|
|
|
10950
11160
|
name: "lookup_principal",
|
|
10951
11161
|
title: "Look up a user identity or a namespaced identity entity",
|
|
10952
11162
|
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.",
|
|
10953
|
-
inputSchema:
|
|
11163
|
+
inputSchema: inputSchema21,
|
|
10954
11164
|
handler: async (args) => {
|
|
10955
11165
|
const kind = args.kind;
|
|
10956
11166
|
const isUser = kind === "user";
|
|
@@ -11024,17 +11234,17 @@ var lookupPrincipal = ({ client, log }) => ({
|
|
|
11024
11234
|
var lookup_principal_default = lookupPrincipal;
|
|
11025
11235
|
|
|
11026
11236
|
// src/tools/version_history.ts
|
|
11027
|
-
var
|
|
11028
|
-
var
|
|
11029
|
-
resourceType:
|
|
11030
|
-
id:
|
|
11031
|
-
startFrom:
|
|
11237
|
+
var import_zod21 = require("zod");
|
|
11238
|
+
var inputSchema22 = {
|
|
11239
|
+
resourceType: import_zod21.z.enum(["record", "document"]).describe("Which kind of entity the id refers to: a record or a document."),
|
|
11240
|
+
id: import_zod21.z.string().min(1, "id is required").describe("The Vectros id of the record or document whose history you want."),
|
|
11241
|
+
startFrom: import_zod21.z.string().optional().describe("Pagination cursor \u2014 pass the `nextCursor` from the previous page to fetch older entries.")
|
|
11032
11242
|
};
|
|
11033
11243
|
var versionHistory = ({ client, log }) => ({
|
|
11034
11244
|
name: "version_history",
|
|
11035
11245
|
title: "Version history (record or document)",
|
|
11036
11246
|
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.",
|
|
11037
|
-
inputSchema:
|
|
11247
|
+
inputSchema: inputSchema22,
|
|
11038
11248
|
handler: async (args) => {
|
|
11039
11249
|
const resourceType = args.resourceType;
|
|
11040
11250
|
const id = args.id;
|
|
@@ -11061,6 +11271,7 @@ var TOOL_NAMES = [
|
|
|
11061
11271
|
"hybrid_search",
|
|
11062
11272
|
"record_query",
|
|
11063
11273
|
"record_get",
|
|
11274
|
+
"record_batch_get",
|
|
11064
11275
|
"record_create",
|
|
11065
11276
|
"record_update",
|
|
11066
11277
|
"record_delete",
|
|
@@ -11086,6 +11297,7 @@ var ALL_TOOL_FACTORIES = {
|
|
|
11086
11297
|
hybrid_search: hybrid_search_default,
|
|
11087
11298
|
record_query: record_query_default,
|
|
11088
11299
|
record_get: record_get_default,
|
|
11300
|
+
record_batch_get: record_batch_get_default,
|
|
11089
11301
|
record_create: record_create_default,
|
|
11090
11302
|
record_update: record_update_default,
|
|
11091
11303
|
record_delete: record_delete_default,
|
|
@@ -11127,7 +11339,7 @@ var identityResource = ({ log, apiKey, environment }) => ({
|
|
|
11127
11339
|
name: "identity",
|
|
11128
11340
|
uri: "vectros://identity",
|
|
11129
11341
|
title: "Current identity (tenant + principal scope)",
|
|
11130
|
-
description: "The tenant + principal scope the MCP server is authenticated as. Returns the same payload as the `current_identity` tool: status, tenantId, environment, principalType, principalKeyId, principalLabel, (for scoped credentials) allowedActions + dataScope ({ userId, scopes[] }). Note: this does not yet include granted_capabilities (member-lifecycle / forensic-read / context-directory-read / delegate-mint) \u2014 a separate reach dimension a scope clause can carry
|
|
11342
|
+
description: "The tenant + principal scope the MCP server is authenticated as. Returns the same payload as the `current_identity` tool: status, tenantId, environment, principalType, principalKeyId, principalLabel, (for scoped credentials) allowedActions + dataScope ({ userId, scopes[] }). 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 and sdkVersion (this build's own version and the bundled @vectros-ai/sdk version). The /v1/ping backing call ships the extended shape today; the version fields are always client-derived.",
|
|
11131
11343
|
mimeType: "application/json",
|
|
11132
11344
|
read: async () => {
|
|
11133
11345
|
const identity = await resolveIdentity({ log, apiKey, environment });
|
|
@@ -11146,7 +11358,7 @@ var ALL_RESOURCE_FACTORIES = {
|
|
|
11146
11358
|
};
|
|
11147
11359
|
|
|
11148
11360
|
// src/zod-to-json-schema.ts
|
|
11149
|
-
var
|
|
11361
|
+
var import_zod22 = require("zod");
|
|
11150
11362
|
function zodShapeToJsonSchema(shape) {
|
|
11151
11363
|
const properties = {};
|
|
11152
11364
|
const required = [];
|
|
@@ -11161,40 +11373,40 @@ function zodShapeToJsonSchema(shape) {
|
|
|
11161
11373
|
function zodTypeToJsonSchema(schema) {
|
|
11162
11374
|
const description = schema.description;
|
|
11163
11375
|
let current = schema;
|
|
11164
|
-
while (current instanceof
|
|
11376
|
+
while (current instanceof import_zod22.z.ZodOptional || current instanceof import_zod22.z.ZodDefault || current instanceof import_zod22.z.ZodNullable) {
|
|
11165
11377
|
current = current._def.innerType;
|
|
11166
11378
|
}
|
|
11167
11379
|
const base = description ? { description } : {};
|
|
11168
|
-
if (current instanceof
|
|
11380
|
+
if (current instanceof import_zod22.z.ZodString) {
|
|
11169
11381
|
return { ...base, type: "string" };
|
|
11170
11382
|
}
|
|
11171
|
-
if (current instanceof
|
|
11383
|
+
if (current instanceof import_zod22.z.ZodNumber) {
|
|
11172
11384
|
return { ...base, type: "number" };
|
|
11173
11385
|
}
|
|
11174
|
-
if (current instanceof
|
|
11386
|
+
if (current instanceof import_zod22.z.ZodBoolean) {
|
|
11175
11387
|
return { ...base, type: "boolean" };
|
|
11176
11388
|
}
|
|
11177
|
-
if (current instanceof
|
|
11389
|
+
if (current instanceof import_zod22.z.ZodEnum) {
|
|
11178
11390
|
return {
|
|
11179
11391
|
...base,
|
|
11180
11392
|
type: "string",
|
|
11181
11393
|
enum: current.options
|
|
11182
11394
|
};
|
|
11183
11395
|
}
|
|
11184
|
-
if (current instanceof
|
|
11396
|
+
if (current instanceof import_zod22.z.ZodArray) {
|
|
11185
11397
|
return {
|
|
11186
11398
|
...base,
|
|
11187
11399
|
type: "array",
|
|
11188
11400
|
items: zodTypeToJsonSchema(current.element)
|
|
11189
11401
|
};
|
|
11190
11402
|
}
|
|
11191
|
-
if (current instanceof
|
|
11403
|
+
if (current instanceof import_zod22.z.ZodObject) {
|
|
11192
11404
|
return {
|
|
11193
11405
|
...base,
|
|
11194
11406
|
...zodShapeToJsonSchema(current.shape)
|
|
11195
11407
|
};
|
|
11196
11408
|
}
|
|
11197
|
-
if (current instanceof
|
|
11409
|
+
if (current instanceof import_zod22.z.ZodRecord) {
|
|
11198
11410
|
const valueType = current._def.valueType;
|
|
11199
11411
|
return {
|
|
11200
11412
|
...base,
|
|
@@ -11318,7 +11530,7 @@ var VectrosMCPServer = class {
|
|
|
11318
11530
|
if (!tool) {
|
|
11319
11531
|
result = toolError(req.params.name ?? "unknown", new Error("No such tool."));
|
|
11320
11532
|
} else {
|
|
11321
|
-
const parsed =
|
|
11533
|
+
const parsed = import_zod23.z.object(tool.inputSchema).strict().safeParse(req.params.arguments ?? {});
|
|
11322
11534
|
if (!parsed.success) {
|
|
11323
11535
|
result = toolError(tool.name, new Error(formatArgError(tool, parsed.error)));
|
|
11324
11536
|
} else {
|