@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/cli.mjs
CHANGED
|
@@ -2492,7 +2492,7 @@ var AuthClient = class {
|
|
|
2492
2492
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/admin/keys/scoped");
|
|
2493
2493
|
}
|
|
2494
2494
|
/**
|
|
2495
|
-
* 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
|
|
2495
|
+
* 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.
|
|
2496
2496
|
*
|
|
2497
2497
|
* @param {Vectros.CreateScopedKeyRequest} request
|
|
2498
2498
|
* @param {AuthClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -3988,7 +3988,7 @@ var AuthClient = class {
|
|
|
3988
3988
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/usage");
|
|
3989
3989
|
}
|
|
3990
3990
|
/**
|
|
3991
|
-
* 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.
|
|
3991
|
+
* 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.
|
|
3992
3992
|
*
|
|
3993
3993
|
* @param {Vectros.GetIssuerRequest} request
|
|
3994
3994
|
* @param {AuthClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -4045,6 +4045,73 @@ var AuthClient = class {
|
|
|
4045
4045
|
}
|
|
4046
4046
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/auth/issuers/{issuerId}");
|
|
4047
4047
|
}
|
|
4048
|
+
/**
|
|
4049
|
+
* 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.
|
|
4050
|
+
*
|
|
4051
|
+
* @param {Vectros.IssuerUpdateRequest} request
|
|
4052
|
+
* @param {AuthClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
4053
|
+
*
|
|
4054
|
+
* @throws {@link Vectros.BadRequestError}
|
|
4055
|
+
* @throws {@link Vectros.ForbiddenError}
|
|
4056
|
+
* @throws {@link Vectros.NotFoundError}
|
|
4057
|
+
* @throws {@link Vectros.TooManyRequestsError}
|
|
4058
|
+
*
|
|
4059
|
+
* @example
|
|
4060
|
+
* await client.auth.updateIssuer({
|
|
4061
|
+
* issuerId: "auth0-prod"
|
|
4062
|
+
* })
|
|
4063
|
+
*/
|
|
4064
|
+
updateIssuer(request, requestOptions) {
|
|
4065
|
+
return HttpResponsePromise.fromPromise(this.__updateIssuer(request, requestOptions));
|
|
4066
|
+
}
|
|
4067
|
+
async __updateIssuer(request, requestOptions) {
|
|
4068
|
+
const { issuerId, ..._body } = request;
|
|
4069
|
+
const _authRequest = await this._options.authProvider.getAuthRequest();
|
|
4070
|
+
const _headers = mergeHeaders(
|
|
4071
|
+
_authRequest.headers,
|
|
4072
|
+
this._options?.headers,
|
|
4073
|
+
requestOptions?.headers
|
|
4074
|
+
);
|
|
4075
|
+
const _response = await fetcher({
|
|
4076
|
+
url: url_exports.join(
|
|
4077
|
+
await Supplier.get(this._options.baseUrl) ?? await Supplier.get(this._options.environment),
|
|
4078
|
+
`v1/auth/issuers/${url_exports.encodePathParam(issuerId)}`
|
|
4079
|
+
),
|
|
4080
|
+
method: "PUT",
|
|
4081
|
+
headers: _headers,
|
|
4082
|
+
contentType: "application/json",
|
|
4083
|
+
queryString: url_exports.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
|
|
4084
|
+
requestType: "json",
|
|
4085
|
+
body: _body,
|
|
4086
|
+
timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1e3,
|
|
4087
|
+
maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
|
|
4088
|
+
abortSignal: requestOptions?.abortSignal,
|
|
4089
|
+
fetchFn: this._options?.fetch,
|
|
4090
|
+
logging: this._options.logging
|
|
4091
|
+
});
|
|
4092
|
+
if (_response.ok) {
|
|
4093
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
4094
|
+
}
|
|
4095
|
+
if (_response.error.reason === "status-code") {
|
|
4096
|
+
switch (_response.error.statusCode) {
|
|
4097
|
+
case 400:
|
|
4098
|
+
throw new BadRequestError(_response.error.body, _response.rawResponse);
|
|
4099
|
+
case 403:
|
|
4100
|
+
throw new ForbiddenError(_response.error.body, _response.rawResponse);
|
|
4101
|
+
case 404:
|
|
4102
|
+
throw new NotFoundError(_response.error.body, _response.rawResponse);
|
|
4103
|
+
case 429:
|
|
4104
|
+
throw new TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
4105
|
+
default:
|
|
4106
|
+
throw new VectrosError({
|
|
4107
|
+
statusCode: _response.error.statusCode,
|
|
4108
|
+
body: _response.error.body,
|
|
4109
|
+
rawResponse: _response.rawResponse
|
|
4110
|
+
});
|
|
4111
|
+
}
|
|
4112
|
+
}
|
|
4113
|
+
return handleNonStatusCodeError(_response.error, _response.rawResponse, "PUT", "/v1/auth/issuers/{issuerId}");
|
|
4114
|
+
}
|
|
4048
4115
|
/**
|
|
4049
4116
|
* 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.
|
|
4050
4117
|
*
|
|
@@ -4115,7 +4182,7 @@ var AuthClient = class {
|
|
|
4115
4182
|
);
|
|
4116
4183
|
}
|
|
4117
4184
|
/**
|
|
4118
|
-
* 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.
|
|
4185
|
+
* 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.
|
|
4119
4186
|
*
|
|
4120
4187
|
* @param {Vectros.ListIssuersRequest} request
|
|
4121
4188
|
* @param {AuthClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -4172,7 +4239,7 @@ var AuthClient = class {
|
|
|
4172
4239
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/auth/issuers");
|
|
4173
4240
|
}
|
|
4174
4241
|
/**
|
|
4175
|
-
* 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`.
|
|
4242
|
+
* 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`.
|
|
4176
4243
|
*
|
|
4177
4244
|
* @param {Vectros.IssuerRequest} request
|
|
4178
4245
|
* @param {AuthClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -4357,6 +4424,7 @@ var AuthClient = class {
|
|
|
4357
4424
|
*
|
|
4358
4425
|
* @throws {@link Vectros.BadRequestError}
|
|
4359
4426
|
* @throws {@link Vectros.ForbiddenError}
|
|
4427
|
+
* @throws {@link Vectros.NotFoundError}
|
|
4360
4428
|
* @throws {@link Vectros.TooManyRequestsError}
|
|
4361
4429
|
*
|
|
4362
4430
|
* @example
|
|
@@ -4410,6 +4478,8 @@ var AuthClient = class {
|
|
|
4410
4478
|
throw new BadRequestError(_response.error.body, _response.rawResponse);
|
|
4411
4479
|
case 403:
|
|
4412
4480
|
throw new ForbiddenError(_response.error.body, _response.rawResponse);
|
|
4481
|
+
case 404:
|
|
4482
|
+
throw new NotFoundError(_response.error.body, _response.rawResponse);
|
|
4413
4483
|
case 429:
|
|
4414
4484
|
throw new TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
4415
4485
|
default:
|
|
@@ -4423,7 +4493,7 @@ var AuthClient = class {
|
|
|
4423
4493
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v1/auth/token");
|
|
4424
4494
|
}
|
|
4425
4495
|
/**
|
|
4426
|
-
* Invite a new member to one of your app contexts by email
|
|
4496
|
+
* 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.
|
|
4427
4497
|
*
|
|
4428
4498
|
* @param {Vectros.CreateInviteRequest} request
|
|
4429
4499
|
* @param {AuthClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -4494,7 +4564,7 @@ var AuthClient = class {
|
|
|
4494
4564
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v1/users/invite");
|
|
4495
4565
|
}
|
|
4496
4566
|
/**
|
|
4497
|
-
* 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.
|
|
4567
|
+
* 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.
|
|
4498
4568
|
*
|
|
4499
4569
|
* @param {Vectros.CreateInviteRequest} request
|
|
4500
4570
|
* @param {AuthClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -4561,6 +4631,83 @@ var AuthClient = class {
|
|
|
4561
4631
|
}
|
|
4562
4632
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v1/users/invite/resend");
|
|
4563
4633
|
}
|
|
4634
|
+
/**
|
|
4635
|
+
* 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).
|
|
4636
|
+
*
|
|
4637
|
+
* **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.
|
|
4638
|
+
*
|
|
4639
|
+
* **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.
|
|
4640
|
+
*
|
|
4641
|
+
* **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.
|
|
4642
|
+
*
|
|
4643
|
+
* 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.
|
|
4644
|
+
*
|
|
4645
|
+
* @param {Record<string, unknown>} request
|
|
4646
|
+
* @param {AuthClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
4647
|
+
*
|
|
4648
|
+
* @throws {@link Vectros.BadRequestError}
|
|
4649
|
+
* @throws {@link Vectros.UnauthorizedError}
|
|
4650
|
+
* @throws {@link Vectros.ForbiddenError}
|
|
4651
|
+
* @throws {@link Vectros.ConflictError}
|
|
4652
|
+
* @throws {@link Vectros.TooManyRequestsError}
|
|
4653
|
+
*
|
|
4654
|
+
* @example
|
|
4655
|
+
* await client.auth.assumeToken({
|
|
4656
|
+
* "scope:org": "orgB"
|
|
4657
|
+
* })
|
|
4658
|
+
*/
|
|
4659
|
+
assumeToken(request, requestOptions) {
|
|
4660
|
+
return HttpResponsePromise.fromPromise(this.__assumeToken(request, requestOptions));
|
|
4661
|
+
}
|
|
4662
|
+
async __assumeToken(request, requestOptions) {
|
|
4663
|
+
const _authRequest = await this._options.authProvider.getAuthRequest();
|
|
4664
|
+
const _headers = mergeHeaders(
|
|
4665
|
+
_authRequest.headers,
|
|
4666
|
+
this._options?.headers,
|
|
4667
|
+
requestOptions?.headers
|
|
4668
|
+
);
|
|
4669
|
+
const _response = await fetcher({
|
|
4670
|
+
url: url_exports.join(
|
|
4671
|
+
await Supplier.get(this._options.baseUrl) ?? await Supplier.get(this._options.environment),
|
|
4672
|
+
"v1/auth/token/assume"
|
|
4673
|
+
),
|
|
4674
|
+
method: "POST",
|
|
4675
|
+
headers: _headers,
|
|
4676
|
+
contentType: "application/json",
|
|
4677
|
+
queryString: url_exports.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
|
|
4678
|
+
requestType: "json",
|
|
4679
|
+
body: request,
|
|
4680
|
+
timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1e3,
|
|
4681
|
+
maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
|
|
4682
|
+
abortSignal: requestOptions?.abortSignal,
|
|
4683
|
+
fetchFn: this._options?.fetch,
|
|
4684
|
+
logging: this._options.logging
|
|
4685
|
+
});
|
|
4686
|
+
if (_response.ok) {
|
|
4687
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
4688
|
+
}
|
|
4689
|
+
if (_response.error.reason === "status-code") {
|
|
4690
|
+
switch (_response.error.statusCode) {
|
|
4691
|
+
case 400:
|
|
4692
|
+
throw new BadRequestError(_response.error.body, _response.rawResponse);
|
|
4693
|
+
case 401:
|
|
4694
|
+
throw new UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
4695
|
+
case 403:
|
|
4696
|
+
throw new ForbiddenError(_response.error.body, _response.rawResponse);
|
|
4697
|
+
case 409:
|
|
4698
|
+
throw new ConflictError(_response.error.body, _response.rawResponse);
|
|
4699
|
+
case 429:
|
|
4700
|
+
throw new TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
4701
|
+
default:
|
|
4702
|
+
throw new VectrosError({
|
|
4703
|
+
statusCode: _response.error.statusCode,
|
|
4704
|
+
body: _response.error.body,
|
|
4705
|
+
rawResponse: _response.rawResponse
|
|
4706
|
+
});
|
|
4707
|
+
}
|
|
4708
|
+
}
|
|
4709
|
+
return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v1/auth/token/assume");
|
|
4710
|
+
}
|
|
4564
4711
|
/**
|
|
4565
4712
|
* 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.
|
|
4566
4713
|
*
|
|
@@ -4638,9 +4785,9 @@ var ComplianceClient = class {
|
|
|
4638
4785
|
* @param {Vectros.ErasureRequest} request
|
|
4639
4786
|
* @param {ComplianceClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
4640
4787
|
*
|
|
4788
|
+
* @throws {@link Vectros.BadRequestError}
|
|
4641
4789
|
* @throws {@link Vectros.ForbiddenError}
|
|
4642
4790
|
* @throws {@link Vectros.TooManyRequestsError}
|
|
4643
|
-
* @throws {@link Vectros.NotImplementedError}
|
|
4644
4791
|
*
|
|
4645
4792
|
* @example
|
|
4646
4793
|
* await client.compliance.createErasureRequest({
|
|
@@ -4679,12 +4826,12 @@ var ComplianceClient = class {
|
|
|
4679
4826
|
}
|
|
4680
4827
|
if (_response.error.reason === "status-code") {
|
|
4681
4828
|
switch (_response.error.statusCode) {
|
|
4829
|
+
case 400:
|
|
4830
|
+
throw new BadRequestError(_response.error.body, _response.rawResponse);
|
|
4682
4831
|
case 403:
|
|
4683
4832
|
throw new ForbiddenError(_response.error.body, _response.rawResponse);
|
|
4684
4833
|
case 429:
|
|
4685
4834
|
throw new TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
4686
|
-
case 501:
|
|
4687
|
-
throw new NotImplementedError(_response.error.body, _response.rawResponse);
|
|
4688
4835
|
default:
|
|
4689
4836
|
throw new VectrosError({
|
|
4690
4837
|
statusCode: _response.error.statusCode,
|
|
@@ -4703,7 +4850,6 @@ var ComplianceClient = class {
|
|
|
4703
4850
|
*
|
|
4704
4851
|
* @throws {@link Vectros.ForbiddenError}
|
|
4705
4852
|
* @throws {@link Vectros.NotFoundError}
|
|
4706
|
-
* @throws {@link Vectros.NotImplementedError}
|
|
4707
4853
|
*
|
|
4708
4854
|
* @example
|
|
4709
4855
|
* await client.compliance.getErasureRequest({
|
|
@@ -4744,8 +4890,6 @@ var ComplianceClient = class {
|
|
|
4744
4890
|
throw new ForbiddenError(_response.error.body, _response.rawResponse);
|
|
4745
4891
|
case 404:
|
|
4746
4892
|
throw new NotFoundError(_response.error.body, _response.rawResponse);
|
|
4747
|
-
case 501:
|
|
4748
|
-
throw new NotImplementedError(_response.error.body, _response.rawResponse);
|
|
4749
4893
|
default:
|
|
4750
4894
|
throw new VectrosError({
|
|
4751
4895
|
statusCode: _response.error.statusCode,
|
|
@@ -5293,7 +5437,21 @@ var DocumentsClient = class {
|
|
|
5293
5437
|
return HttpResponsePromise.fromPromise(this.__lookupDocuments(request, requestOptions));
|
|
5294
5438
|
}
|
|
5295
5439
|
async __lookupDocuments(request, requestOptions) {
|
|
5296
|
-
const {
|
|
5440
|
+
const {
|
|
5441
|
+
type: type_,
|
|
5442
|
+
field,
|
|
5443
|
+
value,
|
|
5444
|
+
from: from_,
|
|
5445
|
+
to,
|
|
5446
|
+
prefix,
|
|
5447
|
+
sortFrom,
|
|
5448
|
+
sortTo,
|
|
5449
|
+
startFrom,
|
|
5450
|
+
limit,
|
|
5451
|
+
order,
|
|
5452
|
+
userId,
|
|
5453
|
+
scope
|
|
5454
|
+
} = request;
|
|
5297
5455
|
const _queryParams = {
|
|
5298
5456
|
type: type_,
|
|
5299
5457
|
field,
|
|
@@ -5301,6 +5459,8 @@ var DocumentsClient = class {
|
|
|
5301
5459
|
from: from_,
|
|
5302
5460
|
to,
|
|
5303
5461
|
prefix,
|
|
5462
|
+
sortFrom,
|
|
5463
|
+
sortTo,
|
|
5304
5464
|
startFrom,
|
|
5305
5465
|
limit,
|
|
5306
5466
|
order: order != null ? order : void 0,
|
|
@@ -6585,7 +6745,7 @@ var IdentityClient = class {
|
|
|
6585
6745
|
);
|
|
6586
6746
|
}
|
|
6587
6747
|
/**
|
|
6588
|
-
* Retrieves a single scope-namespace registration by name.
|
|
6748
|
+
* Retrieves a single scope-namespace registration by name.
|
|
6589
6749
|
*
|
|
6590
6750
|
* @param {Vectros.GetNamespaceRequest} request
|
|
6591
6751
|
* @param {IdentityClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -6778,7 +6938,7 @@ var IdentityClient = class {
|
|
|
6778
6938
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "DELETE", "/v1/namespaces/{namespace}");
|
|
6779
6939
|
}
|
|
6780
6940
|
/**
|
|
6781
|
-
* Returns the scope namespaces in your account
|
|
6941
|
+
* Returns the scope namespaces registered in your account. Returns a `{data, nextCursor}` envelope.
|
|
6782
6942
|
*
|
|
6783
6943
|
* @param {Vectros.ListNamespacesRequest} request
|
|
6784
6944
|
* @param {IdentityClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -6829,7 +6989,7 @@ var IdentityClient = class {
|
|
|
6829
6989
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/namespaces");
|
|
6830
6990
|
}
|
|
6831
6991
|
/**
|
|
6832
|
-
* 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
|
|
6992
|
+
* 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.
|
|
6833
6993
|
*
|
|
6834
6994
|
* @param {Vectros.RegisterNamespaceRequest} request
|
|
6835
6995
|
* @param {IdentityClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -6899,7 +7059,7 @@ var IdentityClient = class {
|
|
|
6899
7059
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v1/namespaces");
|
|
6900
7060
|
}
|
|
6901
7061
|
/**
|
|
6902
|
-
* 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.
|
|
7062
|
+
* 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.
|
|
6903
7063
|
*
|
|
6904
7064
|
* @param {Vectros.ListUsersRequest} request
|
|
6905
7065
|
* @param {IdentityClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -6964,7 +7124,7 @@ var IdentityClient = class {
|
|
|
6964
7124
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/users");
|
|
6965
7125
|
}
|
|
6966
7126
|
/**
|
|
6967
|
-
* 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.
|
|
7127
|
+
* 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`.
|
|
6968
7128
|
*
|
|
6969
7129
|
* @param {Vectros.CreateUserRequest} request
|
|
6970
7130
|
* @param {IdentityClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -7088,7 +7248,7 @@ var IdentityClient = class {
|
|
|
7088
7248
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/users/{id}");
|
|
7089
7249
|
}
|
|
7090
7250
|
/**
|
|
7091
|
-
* 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.
|
|
7251
|
+
* 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.
|
|
7092
7252
|
*
|
|
7093
7253
|
* @param {Vectros.UpdateUserRequest} request
|
|
7094
7254
|
* @param {IdentityClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -7155,7 +7315,7 @@ var IdentityClient = class {
|
|
|
7155
7315
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "PUT", "/v1/users/{id}");
|
|
7156
7316
|
}
|
|
7157
7317
|
/**
|
|
7158
|
-
* 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.
|
|
7318
|
+
* 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.
|
|
7159
7319
|
*
|
|
7160
7320
|
* @param {Vectros.DeleteUserRequest} request
|
|
7161
7321
|
* @param {IdentityClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -7216,7 +7376,7 @@ var IdentityClient = class {
|
|
|
7216
7376
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "DELETE", "/v1/users/{id}");
|
|
7217
7377
|
}
|
|
7218
7378
|
/**
|
|
7219
|
-
* 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.
|
|
7379
|
+
* 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.
|
|
7220
7380
|
*
|
|
7221
7381
|
* @param {Vectros.IdentityLookupRequest} request
|
|
7222
7382
|
* @param {IdentityClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -7659,14 +7819,14 @@ var RecordsClient = class {
|
|
|
7659
7819
|
this._options = normalizeClientOptionsWithAuth(options);
|
|
7660
7820
|
}
|
|
7661
7821
|
/**
|
|
7662
|
-
*
|
|
7822
|
+
* 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).
|
|
7663
7823
|
*
|
|
7664
7824
|
* @param {Vectros.BatchGetRequest} request
|
|
7665
7825
|
* @param {RecordsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
7666
7826
|
*
|
|
7827
|
+
* @throws {@link Vectros.BadRequestError}
|
|
7667
7828
|
* @throws {@link Vectros.ForbiddenError}
|
|
7668
7829
|
* @throws {@link Vectros.TooManyRequestsError}
|
|
7669
|
-
* @throws {@link Vectros.NotImplementedError}
|
|
7670
7830
|
*
|
|
7671
7831
|
* @example
|
|
7672
7832
|
* await client.records.batchGetRecords()
|
|
@@ -7703,12 +7863,12 @@ var RecordsClient = class {
|
|
|
7703
7863
|
}
|
|
7704
7864
|
if (_response.error.reason === "status-code") {
|
|
7705
7865
|
switch (_response.error.statusCode) {
|
|
7866
|
+
case 400:
|
|
7867
|
+
throw new BadRequestError(_response.error.body, _response.rawResponse);
|
|
7706
7868
|
case 403:
|
|
7707
7869
|
throw new ForbiddenError(_response.error.body, _response.rawResponse);
|
|
7708
7870
|
case 429:
|
|
7709
7871
|
throw new TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
7710
|
-
case 501:
|
|
7711
|
-
throw new NotImplementedError(_response.error.body, _response.rawResponse);
|
|
7712
7872
|
default:
|
|
7713
7873
|
throw new VectrosError({
|
|
7714
7874
|
statusCode: _response.error.statusCode,
|
|
@@ -8522,7 +8682,7 @@ var SchemasClient = class {
|
|
|
8522
8682
|
this._options = normalizeClientOptionsWithAuth(options);
|
|
8523
8683
|
}
|
|
8524
8684
|
/**
|
|
8525
|
-
* 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
|
|
8685
|
+
* 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.
|
|
8526
8686
|
*
|
|
8527
8687
|
* @param {Vectros.ListSchemasRequest} request
|
|
8528
8688
|
* @param {SchemasClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -8810,6 +8970,7 @@ var SchemasClient = class {
|
|
|
8810
8970
|
* @param {Vectros.DeleteSchemaRequest} request
|
|
8811
8971
|
* @param {SchemasClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
8812
8972
|
*
|
|
8973
|
+
* @throws {@link Vectros.ForbiddenError}
|
|
8813
8974
|
* @throws {@link Vectros.NotFoundError}
|
|
8814
8975
|
* @throws {@link Vectros.ConflictError}
|
|
8815
8976
|
* @throws {@link Vectros.TooManyRequestsError}
|
|
@@ -8849,6 +9010,8 @@ var SchemasClient = class {
|
|
|
8849
9010
|
}
|
|
8850
9011
|
if (_response.error.reason === "status-code") {
|
|
8851
9012
|
switch (_response.error.statusCode) {
|
|
9013
|
+
case 403:
|
|
9014
|
+
throw new ForbiddenError(_response.error.body, _response.rawResponse);
|
|
8852
9015
|
case 404:
|
|
8853
9016
|
throw new NotFoundError(_response.error.body, _response.rawResponse);
|
|
8854
9017
|
case 409:
|
|
@@ -9063,7 +9226,7 @@ import {
|
|
|
9063
9226
|
ListToolsRequestSchema,
|
|
9064
9227
|
ReadResourceRequestSchema
|
|
9065
9228
|
} from "@modelcontextprotocol/sdk/types.js";
|
|
9066
|
-
import { z as
|
|
9229
|
+
import { z as z23 } from "zod";
|
|
9067
9230
|
|
|
9068
9231
|
// src/auth.ts
|
|
9069
9232
|
var KEY_RE = /^(sk|ssk|st)_(live|test)_/;
|
|
@@ -9107,8 +9270,8 @@ function warnOnSuboptimalKey(key, log) {
|
|
|
9107
9270
|
|
|
9108
9271
|
// src/build-info.ts
|
|
9109
9272
|
var BUILD_INFO = {
|
|
9110
|
-
mcpServer: true ? "0.
|
|
9111
|
-
sdk: true ? "0.
|
|
9273
|
+
mcpServer: true ? "0.16.1" : "dev",
|
|
9274
|
+
sdk: true ? "0.42.0" : "dev"
|
|
9112
9275
|
};
|
|
9113
9276
|
function formatBuildInfo() {
|
|
9114
9277
|
return `vectros-mcp-server ${BUILD_INFO.mcpServer} (sdk ${BUILD_INFO.sdk})`;
|
|
@@ -9793,23 +9956,70 @@ var recordGet = ({ client, log }) => ({
|
|
|
9793
9956
|
});
|
|
9794
9957
|
var record_get_default = recordGet;
|
|
9795
9958
|
|
|
9796
|
-
// src/tools/
|
|
9959
|
+
// src/tools/record_batch_get.ts
|
|
9797
9960
|
import { z as z4 } from "zod";
|
|
9961
|
+
var MAX_PAYLOAD_CHARS2 = 32e3;
|
|
9962
|
+
var MCP_MAX_IDS = 100;
|
|
9798
9963
|
var inputSchema4 = {
|
|
9799
|
-
|
|
9800
|
-
|
|
9964
|
+
ids: z4.array(z4.string()).min(1).max(MCP_MAX_IDS).describe(
|
|
9965
|
+
`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.`
|
|
9966
|
+
)
|
|
9967
|
+
};
|
|
9968
|
+
var recordBatchGet = ({ client, log }) => ({
|
|
9969
|
+
name: "record_batch_get",
|
|
9970
|
+
title: "Get multiple records by id in one call",
|
|
9971
|
+
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.",
|
|
9972
|
+
inputSchema: inputSchema4,
|
|
9973
|
+
handler: async (args) => {
|
|
9974
|
+
const ids = args.ids;
|
|
9975
|
+
try {
|
|
9976
|
+
const response = await client.records.batchGetRecords({ ids });
|
|
9977
|
+
const records = response.data ?? [];
|
|
9978
|
+
const data = records.map((record) => {
|
|
9979
|
+
const item = { ...record };
|
|
9980
|
+
if (record.payload !== void 0) {
|
|
9981
|
+
const json = JSON.stringify(record.payload);
|
|
9982
|
+
if (json.length > MAX_PAYLOAD_CHARS2) {
|
|
9983
|
+
delete item.payload;
|
|
9984
|
+
item.payloadPreview = json.slice(0, MAX_PAYLOAD_CHARS2);
|
|
9985
|
+
item.payloadTruncated = true;
|
|
9986
|
+
item.payloadTotalChars = json.length;
|
|
9987
|
+
}
|
|
9988
|
+
}
|
|
9989
|
+
return item;
|
|
9990
|
+
});
|
|
9991
|
+
const returnedIds = new Set(records.map((r) => r.id));
|
|
9992
|
+
const missingIds = ids.filter((id) => !returnedIds.has(id));
|
|
9993
|
+
log.debug(
|
|
9994
|
+
{ tool: "record_batch_get", requested: ids.length, returned: data.length, missing: missingIds.length },
|
|
9995
|
+
"record_batch_get ok"
|
|
9996
|
+
);
|
|
9997
|
+
return { content: [{ type: "text", text: JSON.stringify({ data, missingIds }, null, 2) }] };
|
|
9998
|
+
} catch (err) {
|
|
9999
|
+
log.warn({ tool: "record_batch_get", idsCount: ids?.length, err: String(err) }, "record_batch_get failed");
|
|
10000
|
+
return toolError("record_batch_get", err);
|
|
10001
|
+
}
|
|
10002
|
+
}
|
|
10003
|
+
});
|
|
10004
|
+
var record_batch_get_default = recordBatchGet;
|
|
10005
|
+
|
|
10006
|
+
// src/tools/record_create.ts
|
|
10007
|
+
import { z as z5 } from "zod";
|
|
10008
|
+
var inputSchema5 = {
|
|
10009
|
+
type: z5.string().min(1, "type is required").describe('Record type / schema name (e.g. "task"). Must match an existing schema \u2014 see list_schemas.'),
|
|
10010
|
+
fields: z5.record(z5.string(), z5.unknown()).describe(
|
|
9801
10011
|
"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."
|
|
9802
10012
|
),
|
|
9803
|
-
externalId:
|
|
10013
|
+
externalId: z5.string().optional().describe(
|
|
9804
10014
|
"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."
|
|
9805
10015
|
),
|
|
9806
|
-
indexMode:
|
|
10016
|
+
indexMode: z5.enum(["HYBRID", "SEMANTIC", "TEXT", "NONE"]).optional().describe(
|
|
9807
10017
|
"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."
|
|
9808
10018
|
),
|
|
9809
|
-
status:
|
|
9810
|
-
folderId:
|
|
9811
|
-
userId:
|
|
9812
|
-
scopes:
|
|
10019
|
+
status: z5.string().optional().describe("Record lifecycle status. Defaults to ACTIVE server-side."),
|
|
10020
|
+
folderId: z5.string().optional().describe("Group this record into a folder."),
|
|
10021
|
+
userId: z5.string().optional().describe("Owning user id."),
|
|
10022
|
+
scopes: z5.array(z5.string()).optional().describe(
|
|
9813
10023
|
'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.'
|
|
9814
10024
|
)
|
|
9815
10025
|
};
|
|
@@ -9817,7 +10027,7 @@ var recordCreate = ({ client, log }) => ({
|
|
|
9817
10027
|
name: "record_create",
|
|
9818
10028
|
title: "Create a record",
|
|
9819
10029
|
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).",
|
|
9820
|
-
inputSchema:
|
|
10030
|
+
inputSchema: inputSchema5,
|
|
9821
10031
|
handler: async (args) => {
|
|
9822
10032
|
const type = args.type;
|
|
9823
10033
|
try {
|
|
@@ -9844,18 +10054,18 @@ var recordCreate = ({ client, log }) => ({
|
|
|
9844
10054
|
var record_create_default = recordCreate;
|
|
9845
10055
|
|
|
9846
10056
|
// src/tools/record_update.ts
|
|
9847
|
-
import { z as
|
|
9848
|
-
var
|
|
9849
|
-
id:
|
|
9850
|
-
externalId:
|
|
10057
|
+
import { z as z6 } from "zod";
|
|
10058
|
+
var inputSchema6 = {
|
|
10059
|
+
id: z6.string().optional().describe("The Vectros record id to update. Provide this OR externalId+type."),
|
|
10060
|
+
externalId: z6.string().optional().describe(
|
|
9851
10061
|
"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."
|
|
9852
10062
|
),
|
|
9853
|
-
type:
|
|
9854
|
-
fields:
|
|
10063
|
+
type: z6.string().optional().describe("Record type \u2014 REQUIRED when selecting by `externalId` (externalId is unique within a type)."),
|
|
10064
|
+
fields: z6.record(z6.string(), z6.unknown()).describe(
|
|
9855
10065
|
"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."
|
|
9856
10066
|
),
|
|
9857
|
-
status:
|
|
9858
|
-
expectedVersion:
|
|
10067
|
+
status: z6.string().optional().describe("Set the record lifecycle status (e.g. ARCHIVED) \u2014 archive/workflow without physical deletion."),
|
|
10068
|
+
expectedVersion: z6.number().int().optional().describe(
|
|
9859
10069
|
"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."
|
|
9860
10070
|
)
|
|
9861
10071
|
};
|
|
@@ -9863,7 +10073,7 @@ var recordUpdate = ({ client, log }) => ({
|
|
|
9863
10073
|
name: "record_update",
|
|
9864
10074
|
title: "Update a record by id or externalId",
|
|
9865
10075
|
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.",
|
|
9866
|
-
inputSchema:
|
|
10076
|
+
inputSchema: inputSchema6,
|
|
9867
10077
|
handler: async (args) => {
|
|
9868
10078
|
const id = args.id;
|
|
9869
10079
|
const externalId = args.externalId;
|
|
@@ -9889,15 +10099,15 @@ var recordUpdate = ({ client, log }) => ({
|
|
|
9889
10099
|
var record_update_default = recordUpdate;
|
|
9890
10100
|
|
|
9891
10101
|
// src/tools/record_delete.ts
|
|
9892
|
-
import { z as
|
|
9893
|
-
var
|
|
9894
|
-
id:
|
|
10102
|
+
import { z as z7 } from "zod";
|
|
10103
|
+
var inputSchema7 = {
|
|
10104
|
+
id: z7.string().min(1, "id is required").describe("The Vectros record id to delete.")
|
|
9895
10105
|
};
|
|
9896
10106
|
var recordDelete = ({ client, log }) => ({
|
|
9897
10107
|
name: "record_delete",
|
|
9898
10108
|
title: "Delete a record",
|
|
9899
10109
|
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.",
|
|
9900
|
-
inputSchema:
|
|
10110
|
+
inputSchema: inputSchema7,
|
|
9901
10111
|
handler: async (args) => {
|
|
9902
10112
|
const id = args.id;
|
|
9903
10113
|
try {
|
|
@@ -9913,48 +10123,48 @@ var recordDelete = ({ client, log }) => ({
|
|
|
9913
10123
|
var record_delete_default = recordDelete;
|
|
9914
10124
|
|
|
9915
10125
|
// src/tools/rag_ask.ts
|
|
9916
|
-
import { z as
|
|
10126
|
+
import { z as z8 } from "zod";
|
|
9917
10127
|
var SEARCH_MCP_DEFAULT_LIMIT = 5;
|
|
9918
10128
|
var SEARCH_MCP_MAX_LIMIT = 50;
|
|
9919
|
-
var
|
|
9920
|
-
query:
|
|
9921
|
-
instructions:
|
|
10129
|
+
var inputSchema8 = {
|
|
10130
|
+
query: z8.string().min(1, "query must be non-empty").describe("Question to ground against retrieved content."),
|
|
10131
|
+
instructions: z8.string().optional().describe(
|
|
9922
10132
|
'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.'
|
|
9923
10133
|
),
|
|
9924
|
-
model:
|
|
10134
|
+
model: z8.string().optional().describe(
|
|
9925
10135
|
"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."
|
|
9926
10136
|
),
|
|
9927
|
-
search:
|
|
9928
|
-
mode:
|
|
9929
|
-
limit:
|
|
10137
|
+
search: z8.object({
|
|
10138
|
+
mode: z8.enum(["HYBRID", "TEXT", "SEMANTIC"]).optional().describe("Retrieval mode. Default HYBRID."),
|
|
10139
|
+
limit: z8.number().int().min(1).max(SEARCH_MCP_MAX_LIMIT).optional().describe(
|
|
9930
10140
|
`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.`
|
|
9931
10141
|
),
|
|
9932
10142
|
// Retrieval scoping — parity with hybrid_search so an agent can ground the
|
|
9933
10143
|
// answer on a specific owner / folder / type / metadata subset, not just the
|
|
9934
10144
|
// whole-tenant corpus.
|
|
9935
|
-
userId:
|
|
9936
|
-
scope:
|
|
10145
|
+
userId: z8.string().optional().describe("Restrict retrieval to content owned by this user (Vectros UUID)."),
|
|
10146
|
+
scope: z8.string().optional().describe(
|
|
9937
10147
|
'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.'
|
|
9938
10148
|
),
|
|
9939
|
-
folderId:
|
|
9940
|
-
rootFolderId:
|
|
9941
|
-
typeName:
|
|
9942
|
-
contentTypes:
|
|
9943
|
-
filters:
|
|
10149
|
+
folderId: z8.string().optional().describe("Restrict retrieval to this exact folder."),
|
|
10150
|
+
rootFolderId: z8.string().optional().describe("Restrict retrieval to this folder and all its descendants."),
|
|
10151
|
+
typeName: z8.string().optional().describe("Restrict record retrieval to this schema type."),
|
|
10152
|
+
contentTypes: z8.array(z8.enum(["documents", "records"])).optional().describe('Narrow retrieval to content types. ["documents"] or ["records"]; omit for both.'),
|
|
10153
|
+
filters: z8.record(z8.unknown()).optional().describe(
|
|
9944
10154
|
'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"}.'
|
|
9945
10155
|
),
|
|
9946
|
-
createdAfter:
|
|
9947
|
-
createdBefore:
|
|
9948
|
-
requireComplete:
|
|
10156
|
+
createdAfter: z8.string().optional().describe("Restrict to content created at/after this ISO 8601 UTC timestamp."),
|
|
10157
|
+
createdBefore: z8.string().optional().describe("Restrict to content created at/before this ISO 8601 UTC timestamp."),
|
|
10158
|
+
requireComplete: z8.boolean().optional().describe("Fail closed (503) on a degraded search backend instead of grounding on partial results. Default false.")
|
|
9949
10159
|
}).optional().describe("Retrieval params + scoping. Default mode HYBRID, limit " + SEARCH_MCP_DEFAULT_LIMIT + "."),
|
|
9950
|
-
maxTokens:
|
|
9951
|
-
temperature:
|
|
10160
|
+
maxTokens: z8.number().int().min(1).optional().describe("Max output tokens."),
|
|
10161
|
+
temperature: z8.number().min(0).max(1).optional().describe("Sampling temperature (0.0\u20131.0). Default 0.3 \u2014 lower favors deterministic, retrieval-grounded answers.")
|
|
9952
10162
|
};
|
|
9953
10163
|
var ragAsk = ({ client, log }) => ({
|
|
9954
10164
|
name: "rag_ask",
|
|
9955
10165
|
title: "RAG ask (corpus-wide)",
|
|
9956
10166
|
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.",
|
|
9957
|
-
inputSchema:
|
|
10167
|
+
inputSchema: inputSchema8,
|
|
9958
10168
|
handler: async (args, extra) => {
|
|
9959
10169
|
try {
|
|
9960
10170
|
const searchArg = args.search ?? {};
|
|
@@ -10030,20 +10240,20 @@ var ragAsk = ({ client, log }) => ({
|
|
|
10030
10240
|
var rag_ask_default = ragAsk;
|
|
10031
10241
|
|
|
10032
10242
|
// src/tools/document_ask.ts
|
|
10033
|
-
import { z as
|
|
10034
|
-
var
|
|
10035
|
-
documentId:
|
|
10036
|
-
prompt:
|
|
10037
|
-
model:
|
|
10243
|
+
import { z as z9 } from "zod";
|
|
10244
|
+
var inputSchema9 = {
|
|
10245
|
+
documentId: z9.string().min(1, "documentId is required").describe("ID of the document to ask against."),
|
|
10246
|
+
prompt: z9.string().min(1, "prompt is required").describe("Question to ask about the document."),
|
|
10247
|
+
model: z9.string().optional().describe(
|
|
10038
10248
|
"Inference model alias. Default = tier-appropriate Haiku. See GET /v1/models for the catalog the calling key can reach."
|
|
10039
10249
|
),
|
|
10040
|
-
maxTokens:
|
|
10250
|
+
maxTokens: z9.number().int().min(1).optional().describe("Max output tokens.")
|
|
10041
10251
|
};
|
|
10042
10252
|
var documentAsk = ({ client, log }) => ({
|
|
10043
10253
|
name: "document_ask",
|
|
10044
10254
|
title: "Document ask (single-document)",
|
|
10045
10255
|
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.",
|
|
10046
|
-
inputSchema:
|
|
10256
|
+
inputSchema: inputSchema9,
|
|
10047
10257
|
handler: async (args, extra) => {
|
|
10048
10258
|
try {
|
|
10049
10259
|
const stream = await client.inference.documentAsk({
|
|
@@ -10102,18 +10312,18 @@ var documentAsk = ({ client, log }) => ({
|
|
|
10102
10312
|
var document_ask_default = documentAsk;
|
|
10103
10313
|
|
|
10104
10314
|
// src/tools/list_schemas.ts
|
|
10105
|
-
import { z as
|
|
10106
|
-
var
|
|
10107
|
-
userId:
|
|
10315
|
+
import { z as z10 } from "zod";
|
|
10316
|
+
var inputSchema10 = {
|
|
10317
|
+
userId: z10.string().optional().describe(
|
|
10108
10318
|
"Filter to schemas visible to a specific user. Optional; default returns all schemas the credential can see."
|
|
10109
10319
|
),
|
|
10110
|
-
scope:
|
|
10320
|
+
scope: z10.string().optional().describe(
|
|
10111
10321
|
'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.'
|
|
10112
10322
|
),
|
|
10113
|
-
surface:
|
|
10323
|
+
surface: z10.enum(["record", "document", "user", "entity"]).optional().describe(
|
|
10114
10324
|
"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."
|
|
10115
10325
|
),
|
|
10116
|
-
recordType:
|
|
10326
|
+
recordType: z10.string().optional().describe(
|
|
10117
10327
|
'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.'
|
|
10118
10328
|
)
|
|
10119
10329
|
};
|
|
@@ -10121,7 +10331,7 @@ var listSchemas = ({ client, log }) => ({
|
|
|
10121
10331
|
name: "list_schemas",
|
|
10122
10332
|
title: "List record schemas",
|
|
10123
10333
|
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.',
|
|
10124
|
-
inputSchema:
|
|
10334
|
+
inputSchema: inputSchema10,
|
|
10125
10335
|
handler: async (args) => {
|
|
10126
10336
|
const userId = args.userId;
|
|
10127
10337
|
const scope = args.scope;
|
|
@@ -10147,18 +10357,18 @@ var listSchemas = ({ client, log }) => ({
|
|
|
10147
10357
|
var list_schemas_default = listSchemas;
|
|
10148
10358
|
|
|
10149
10359
|
// src/tools/document_get.ts
|
|
10150
|
-
import { z as
|
|
10360
|
+
import { z as z11 } from "zod";
|
|
10151
10361
|
var MAX_TEXT_CHARS = 32e3;
|
|
10152
|
-
var
|
|
10153
|
-
documentId:
|
|
10154
|
-
externalId:
|
|
10362
|
+
var inputSchema11 = {
|
|
10363
|
+
documentId: z11.string().optional().describe("The document ID returned by document_ingest or hybrid_search. Provide this OR externalId+type."),
|
|
10364
|
+
externalId: z11.string().optional().describe(
|
|
10155
10365
|
"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."
|
|
10156
10366
|
),
|
|
10157
|
-
type:
|
|
10158
|
-
includeText:
|
|
10367
|
+
type: z11.string().optional().describe("Document type \u2014 REQUIRED when selecting by `externalId` (externalId is unique within a type)."),
|
|
10368
|
+
includeText: z11.boolean().optional().describe(
|
|
10159
10369
|
"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."
|
|
10160
10370
|
),
|
|
10161
|
-
includeDownloadUrl:
|
|
10371
|
+
includeDownloadUrl: z11.boolean().optional().describe(
|
|
10162
10372
|
"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."
|
|
10163
10373
|
)
|
|
10164
10374
|
};
|
|
@@ -10175,7 +10385,7 @@ var documentGet = ({ client, log }) => ({
|
|
|
10175
10385
|
name: "document_get",
|
|
10176
10386
|
title: "Get document metadata (and optionally text)",
|
|
10177
10387
|
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.",
|
|
10178
|
-
inputSchema:
|
|
10388
|
+
inputSchema: inputSchema11,
|
|
10179
10389
|
handler: async (args) => {
|
|
10180
10390
|
const documentId = args.documentId;
|
|
10181
10391
|
const externalId = args.externalId;
|
|
@@ -10240,28 +10450,28 @@ var documentGet = ({ client, log }) => ({
|
|
|
10240
10450
|
var document_get_default = documentGet;
|
|
10241
10451
|
|
|
10242
10452
|
// src/tools/document_query.ts
|
|
10243
|
-
import { z as
|
|
10453
|
+
import { z as z12 } from "zod";
|
|
10244
10454
|
var MCP_DEFAULT_LIMIT3 = 3;
|
|
10245
10455
|
var MCP_MAX_LIMIT3 = 100;
|
|
10246
|
-
var
|
|
10456
|
+
var inputSchema12 = {
|
|
10247
10457
|
// Lookup-mode args — provide `field` plus EXACTLY ONE of: value | from+to | prefix.
|
|
10248
|
-
field:
|
|
10249
|
-
value:
|
|
10250
|
-
from:
|
|
10251
|
-
to:
|
|
10252
|
-
prefix:
|
|
10253
|
-
order:
|
|
10458
|
+
field: z12.string().optional().describe("Lookup mode: name of the lookup-indexed field to query by."),
|
|
10459
|
+
value: z12.string().optional().describe("Lookup mode (equality): exact-match value for `field`. Works on sensitive fields too."),
|
|
10460
|
+
from: z12.string().optional().describe("Lookup mode (range): inclusive lower bound; requires `to`. Range-enabled, non-sensitive fields only."),
|
|
10461
|
+
to: z12.string().optional().describe("Lookup mode (range): inclusive upper bound; requires `from`."),
|
|
10462
|
+
prefix: z12.string().optional().describe("Lookup mode (prefix): match values starting with this. Range-enabled string fields only."),
|
|
10463
|
+
order: z12.enum(["asc", "desc"]).optional().describe(
|
|
10254
10464
|
"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."
|
|
10255
10465
|
),
|
|
10256
|
-
type:
|
|
10466
|
+
type: z12.string().optional().describe("Lookup mode: the document type (the bound schema's type). Required with `field`."),
|
|
10257
10467
|
// List-mode args:
|
|
10258
|
-
folderId:
|
|
10259
|
-
userId:
|
|
10260
|
-
scope:
|
|
10468
|
+
folderId: z12.string().optional().describe("List mode: only documents in this folder (Vectros folder id)."),
|
|
10469
|
+
userId: z12.string().optional().describe("List mode: scope to documents owned by this user."),
|
|
10470
|
+
scope: z12.string().optional().describe(
|
|
10261
10471
|
'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.'
|
|
10262
10472
|
),
|
|
10263
|
-
startFrom:
|
|
10264
|
-
limit:
|
|
10473
|
+
startFrom: z12.string().optional().describe("Pagination cursor \u2014 pass the `nextCursor` from the previous page to fetch the next. Works in both list and lookup mode."),
|
|
10474
|
+
limit: z12.number().int().min(1).max(MCP_MAX_LIMIT3).optional().describe(
|
|
10265
10475
|
`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.`
|
|
10266
10476
|
)
|
|
10267
10477
|
};
|
|
@@ -10269,7 +10479,7 @@ var documentQuery = ({ client, log }) => ({
|
|
|
10269
10479
|
name: "document_query",
|
|
10270
10480
|
title: "Document query (list or lookup)",
|
|
10271
10481
|
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.",
|
|
10272
|
-
inputSchema:
|
|
10482
|
+
inputSchema: inputSchema12,
|
|
10273
10483
|
handler: async (args) => {
|
|
10274
10484
|
const limit = args.limit ?? MCP_DEFAULT_LIMIT3;
|
|
10275
10485
|
const field = args.field;
|
|
@@ -10349,29 +10559,29 @@ var documentQuery = ({ client, log }) => ({
|
|
|
10349
10559
|
var document_query_default = documentQuery;
|
|
10350
10560
|
|
|
10351
10561
|
// src/tools/document_update.ts
|
|
10352
|
-
import { z as
|
|
10353
|
-
var
|
|
10354
|
-
documentId:
|
|
10355
|
-
externalId:
|
|
10562
|
+
import { z as z13 } from "zod";
|
|
10563
|
+
var inputSchema13 = {
|
|
10564
|
+
documentId: z13.string().optional().describe("The Vectros document id to update. Provide this OR externalId+type."),
|
|
10565
|
+
externalId: z13.string().optional().describe(
|
|
10356
10566
|
"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."
|
|
10357
10567
|
),
|
|
10358
|
-
type:
|
|
10359
|
-
title:
|
|
10360
|
-
fields:
|
|
10568
|
+
type: z13.string().optional().describe("Document type \u2014 REQUIRED when selecting by `externalId` (externalId is unique within a type)."),
|
|
10569
|
+
title: z13.string().optional().describe("New title. Omit to keep the current title."),
|
|
10570
|
+
fields: z13.record(z13.string(), z13.unknown()).optional().describe(
|
|
10361
10571
|
"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."
|
|
10362
10572
|
),
|
|
10363
|
-
text:
|
|
10573
|
+
text: z13.string().optional().describe(
|
|
10364
10574
|
"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."
|
|
10365
10575
|
),
|
|
10366
|
-
folderId:
|
|
10367
|
-
status:
|
|
10576
|
+
folderId: z13.string().optional().describe("Move the document into this folder (cannot be cleared once set)."),
|
|
10577
|
+
status: z13.enum(["ACTIVE", "ARCHIVED"]).optional().describe(
|
|
10368
10578
|
"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."
|
|
10369
10579
|
),
|
|
10370
|
-
userId:
|
|
10371
|
-
scopes:
|
|
10580
|
+
userId: z13.string().optional().describe("Reassign the owning user (Vectros UUID)."),
|
|
10581
|
+
scopes: z13.array(z13.string()).optional().describe(
|
|
10372
10582
|
'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).'
|
|
10373
10583
|
),
|
|
10374
|
-
expectedVersion:
|
|
10584
|
+
expectedVersion: z13.number().int().optional().describe(
|
|
10375
10585
|
"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."
|
|
10376
10586
|
)
|
|
10377
10587
|
};
|
|
@@ -10379,7 +10589,7 @@ var documentUpdate = ({ client, log }) => ({
|
|
|
10379
10589
|
name: "document_update",
|
|
10380
10590
|
title: "Update a document",
|
|
10381
10591
|
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.',
|
|
10382
|
-
inputSchema:
|
|
10592
|
+
inputSchema: inputSchema13,
|
|
10383
10593
|
handler: async (args) => {
|
|
10384
10594
|
const documentId = args.documentId;
|
|
10385
10595
|
const externalId = args.externalId;
|
|
@@ -10419,15 +10629,15 @@ var documentUpdate = ({ client, log }) => ({
|
|
|
10419
10629
|
var document_update_default = documentUpdate;
|
|
10420
10630
|
|
|
10421
10631
|
// src/tools/document_delete.ts
|
|
10422
|
-
import { z as
|
|
10423
|
-
var
|
|
10424
|
-
documentId:
|
|
10632
|
+
import { z as z14 } from "zod";
|
|
10633
|
+
var inputSchema14 = {
|
|
10634
|
+
documentId: z14.string().min(1, "documentId is required").describe("The Vectros document id to delete.")
|
|
10425
10635
|
};
|
|
10426
10636
|
var documentDelete = ({ client, log }) => ({
|
|
10427
10637
|
name: "document_delete",
|
|
10428
10638
|
title: "Delete a document",
|
|
10429
10639
|
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).',
|
|
10430
|
-
inputSchema:
|
|
10640
|
+
inputSchema: inputSchema14,
|
|
10431
10641
|
handler: async (args) => {
|
|
10432
10642
|
const documentId = args.documentId;
|
|
10433
10643
|
try {
|
|
@@ -10445,18 +10655,18 @@ var documentDelete = ({ client, log }) => ({
|
|
|
10445
10655
|
var document_delete_default = documentDelete;
|
|
10446
10656
|
|
|
10447
10657
|
// src/tools/folder_query.ts
|
|
10448
|
-
import { z as
|
|
10658
|
+
import { z as z15 } from "zod";
|
|
10449
10659
|
var MCP_DEFAULT_LIMIT4 = 10;
|
|
10450
10660
|
var MCP_MAX_LIMIT4 = 100;
|
|
10451
|
-
var
|
|
10452
|
-
id:
|
|
10453
|
-
parentId:
|
|
10454
|
-
userId:
|
|
10455
|
-
scope:
|
|
10661
|
+
var inputSchema15 = {
|
|
10662
|
+
id: z15.string().optional().describe("Get mode: fetch this single folder by id."),
|
|
10663
|
+
parentId: z15.string().optional().describe("List mode: direct children of this folder (tree navigation). Omit for a flat tenant list."),
|
|
10664
|
+
userId: z15.string().optional().describe("List mode: scope to folders owned by this user."),
|
|
10665
|
+
scope: z15.string().optional().describe(
|
|
10456
10666
|
'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.'
|
|
10457
10667
|
),
|
|
10458
|
-
startFrom:
|
|
10459
|
-
limit:
|
|
10668
|
+
startFrom: z15.string().optional().describe("List mode: pagination cursor \u2014 pass the `nextCursor` from the previous page to fetch the next."),
|
|
10669
|
+
limit: z15.number().int().min(1).max(MCP_MAX_LIMIT4).optional().describe(
|
|
10460
10670
|
`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\`.`
|
|
10461
10671
|
)
|
|
10462
10672
|
};
|
|
@@ -10464,7 +10674,7 @@ var folderQuery = ({ client, log }) => ({
|
|
|
10464
10674
|
name: "folder_query",
|
|
10465
10675
|
title: "Folder query (list or get)",
|
|
10466
10676
|
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.",
|
|
10467
|
-
inputSchema:
|
|
10677
|
+
inputSchema: inputSchema15,
|
|
10468
10678
|
handler: async (args) => {
|
|
10469
10679
|
const id = args.id;
|
|
10470
10680
|
try {
|
|
@@ -10494,14 +10704,14 @@ var folderQuery = ({ client, log }) => ({
|
|
|
10494
10704
|
var folder_query_default = folderQuery;
|
|
10495
10705
|
|
|
10496
10706
|
// src/tools/folder_create.ts
|
|
10497
|
-
import { z as
|
|
10498
|
-
var
|
|
10499
|
-
name:
|
|
10500
|
-
description:
|
|
10501
|
-
parentId:
|
|
10502
|
-
slug:
|
|
10503
|
-
userId:
|
|
10504
|
-
scopes:
|
|
10707
|
+
import { z as z16 } from "zod";
|
|
10708
|
+
var inputSchema16 = {
|
|
10709
|
+
name: z16.string().min(1, "name is required").describe("Folder display name."),
|
|
10710
|
+
description: z16.string().optional().describe("Optional description of the folder's purpose."),
|
|
10711
|
+
parentId: z16.string().optional().describe("Parent folder id \u2014 places the folder under this parent. Omit for the context default root. Create-only."),
|
|
10712
|
+
slug: z16.string().optional().describe("Optional stable slug (sibling-unique; idempotency key). Lowercase letters/digits/hyphens. Derived from name when omitted."),
|
|
10713
|
+
userId: z16.string().optional().describe("Owning user (Vectros UUID)."),
|
|
10714
|
+
scopes: z16.array(z16.string()).optional().describe(
|
|
10505
10715
|
'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.'
|
|
10506
10716
|
)
|
|
10507
10717
|
};
|
|
@@ -10509,7 +10719,7 @@ var folderCreate = ({ client, log }) => ({
|
|
|
10509
10719
|
name: "folder_create",
|
|
10510
10720
|
title: "Create a folder",
|
|
10511
10721
|
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).",
|
|
10512
|
-
inputSchema:
|
|
10722
|
+
inputSchema: inputSchema16,
|
|
10513
10723
|
handler: async (args) => {
|
|
10514
10724
|
try {
|
|
10515
10725
|
const folder = await client.folders.createFolder({
|
|
@@ -10533,16 +10743,16 @@ var folderCreate = ({ client, log }) => ({
|
|
|
10533
10743
|
var folder_create_default = folderCreate;
|
|
10534
10744
|
|
|
10535
10745
|
// src/tools/folder_update.ts
|
|
10536
|
-
import { z as
|
|
10537
|
-
var
|
|
10538
|
-
id:
|
|
10539
|
-
name:
|
|
10540
|
-
description:
|
|
10541
|
-
userId:
|
|
10542
|
-
scopes:
|
|
10746
|
+
import { z as z17 } from "zod";
|
|
10747
|
+
var inputSchema17 = {
|
|
10748
|
+
id: z17.string().min(1, "id is required").describe("The Vectros folder id to update."),
|
|
10749
|
+
name: z17.string().optional().describe("New folder name. Omit to keep the current name."),
|
|
10750
|
+
description: z17.string().optional().describe("New description. Omit to leave unchanged."),
|
|
10751
|
+
userId: z17.string().optional().describe("Reassign the owning user (Vectros UUID)."),
|
|
10752
|
+
scopes: z17.array(z17.string()).optional().describe(
|
|
10543
10753
|
'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).'
|
|
10544
10754
|
),
|
|
10545
|
-
expectedVersion:
|
|
10755
|
+
expectedVersion: z17.number().int().optional().describe(
|
|
10546
10756
|
"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."
|
|
10547
10757
|
)
|
|
10548
10758
|
};
|
|
@@ -10550,7 +10760,7 @@ var folderUpdate = ({ client, log }) => ({
|
|
|
10550
10760
|
name: "folder_update",
|
|
10551
10761
|
title: "Update a folder",
|
|
10552
10762
|
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.",
|
|
10553
|
-
inputSchema:
|
|
10763
|
+
inputSchema: inputSchema17,
|
|
10554
10764
|
handler: async (args) => {
|
|
10555
10765
|
const id = args.id;
|
|
10556
10766
|
const name = args.name;
|
|
@@ -10577,15 +10787,15 @@ var folderUpdate = ({ client, log }) => ({
|
|
|
10577
10787
|
var folder_update_default = folderUpdate;
|
|
10578
10788
|
|
|
10579
10789
|
// src/tools/folder_delete.ts
|
|
10580
|
-
import { z as
|
|
10581
|
-
var
|
|
10582
|
-
id:
|
|
10790
|
+
import { z as z18 } from "zod";
|
|
10791
|
+
var inputSchema18 = {
|
|
10792
|
+
id: z18.string().min(1, "id is required").describe("The Vectros folder id to delete.")
|
|
10583
10793
|
};
|
|
10584
10794
|
var folderDelete = ({ client, log }) => ({
|
|
10585
10795
|
name: "folder_delete",
|
|
10586
10796
|
title: "Delete a folder",
|
|
10587
10797
|
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.",
|
|
10588
|
-
inputSchema:
|
|
10798
|
+
inputSchema: inputSchema18,
|
|
10589
10799
|
handler: async (args) => {
|
|
10590
10800
|
const id = args.id;
|
|
10591
10801
|
try {
|
|
@@ -10601,14 +10811,14 @@ var folderDelete = ({ client, log }) => ({
|
|
|
10601
10811
|
var folder_delete_default = folderDelete;
|
|
10602
10812
|
|
|
10603
10813
|
// src/tools/current_identity.ts
|
|
10604
|
-
var
|
|
10814
|
+
var inputSchema19 = {
|
|
10605
10815
|
// No args — current_identity describes the current credential.
|
|
10606
10816
|
};
|
|
10607
10817
|
var currentIdentity = ({ log, apiKey, environment }) => ({
|
|
10608
10818
|
name: "current_identity",
|
|
10609
10819
|
title: "Current identity (tenant + principal scope)",
|
|
10610
|
-
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
|
|
10611
|
-
inputSchema:
|
|
10820
|
+
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.",
|
|
10821
|
+
inputSchema: inputSchema19,
|
|
10612
10822
|
handler: async () => {
|
|
10613
10823
|
try {
|
|
10614
10824
|
const identity = await resolveIdentity({ log, apiKey, environment });
|
|
@@ -10624,7 +10834,7 @@ var currentIdentity = ({ log, apiKey, environment }) => ({
|
|
|
10624
10834
|
var current_identity_default = currentIdentity;
|
|
10625
10835
|
|
|
10626
10836
|
// src/tools/document_ingest.ts
|
|
10627
|
-
import { z as
|
|
10837
|
+
import { z as z19 } from "zod";
|
|
10628
10838
|
import { readFile, realpath } from "fs/promises";
|
|
10629
10839
|
import { basename, extname, resolve, relative, isAbsolute } from "path";
|
|
10630
10840
|
var IngestPathError = class extends Error {
|
|
@@ -10699,37 +10909,37 @@ function inferMimeType(filePath) {
|
|
|
10699
10909
|
const ext = extname(filePath).toLowerCase();
|
|
10700
10910
|
return EXT_TO_MIME[ext] ?? "application/octet-stream";
|
|
10701
10911
|
}
|
|
10702
|
-
var
|
|
10703
|
-
title:
|
|
10704
|
-
indexMode:
|
|
10912
|
+
var inputSchema20 = {
|
|
10913
|
+
title: z19.string().min(1, "title is required").describe("Human-readable document title \u2014 appears in search results and the UI."),
|
|
10914
|
+
indexMode: z19.enum(["HYBRID", "SEMANTIC", "TEXT", "NONE"]).optional().describe(
|
|
10705
10915
|
"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."
|
|
10706
10916
|
),
|
|
10707
|
-
externalId:
|
|
10917
|
+
externalId: z19.string().optional().describe(
|
|
10708
10918
|
'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.'
|
|
10709
10919
|
),
|
|
10710
|
-
upsert:
|
|
10920
|
+
upsert: z19.boolean().optional().describe(
|
|
10711
10921
|
"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)."
|
|
10712
10922
|
),
|
|
10713
|
-
schemaId:
|
|
10923
|
+
schemaId: z19.string().optional().describe(
|
|
10714
10924
|
"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."
|
|
10715
10925
|
),
|
|
10716
|
-
payload:
|
|
10926
|
+
payload: z19.record(z19.string(), z19.unknown()).optional().describe(
|
|
10717
10927
|
"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."
|
|
10718
10928
|
),
|
|
10719
10929
|
// Inline text mode (mutually exclusive with filePath):
|
|
10720
|
-
text:
|
|
10721
|
-
storeText:
|
|
10930
|
+
text: z19.string().min(1).optional().describe("Text body to ingest inline. Mutually exclusive with filePath. Either text or filePath is required."),
|
|
10931
|
+
storeText: z19.boolean().optional().describe(
|
|
10722
10932
|
"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."
|
|
10723
10933
|
),
|
|
10724
10934
|
// File upload mode (mutually exclusive with text; stdio-transport-only):
|
|
10725
|
-
filePath:
|
|
10935
|
+
filePath: z19.string().min(1).optional().describe(
|
|
10726
10936
|
"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."
|
|
10727
10937
|
),
|
|
10728
|
-
fileType:
|
|
10938
|
+
fileType: z19.string().optional().describe('MIME type of the file (e.g. "application/pdf"). Inferred from filePath extension if omitted.'),
|
|
10729
10939
|
// Common (both modes):
|
|
10730
|
-
folderId:
|
|
10731
|
-
userId:
|
|
10732
|
-
scopes:
|
|
10940
|
+
folderId: z19.string().optional().describe("Optional folder to ingest into. Default: tenant root."),
|
|
10941
|
+
userId: z19.string().optional().describe("Owning user ID. Optional."),
|
|
10942
|
+
scopes: z19.array(z19.string()).optional().describe(
|
|
10733
10943
|
"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."
|
|
10734
10944
|
)
|
|
10735
10945
|
};
|
|
@@ -10737,7 +10947,7 @@ var documentIngest = ({ client, log, transport, ingestRoot }) => ({
|
|
|
10737
10947
|
name: "document_ingest",
|
|
10738
10948
|
title: "Ingest a new document (text body or file upload)",
|
|
10739
10949
|
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`.",
|
|
10740
|
-
inputSchema:
|
|
10950
|
+
inputSchema: inputSchema20,
|
|
10741
10951
|
handler: async (args) => {
|
|
10742
10952
|
const title = args.title;
|
|
10743
10953
|
const text = args.text;
|
|
@@ -10889,29 +11099,29 @@ var documentIngest = ({ client, log, transport, ingestRoot }) => ({
|
|
|
10889
11099
|
var document_ingest_default = documentIngest;
|
|
10890
11100
|
|
|
10891
11101
|
// src/tools/lookup_principal.ts
|
|
10892
|
-
import { z as
|
|
11102
|
+
import { z as z20 } from "zod";
|
|
10893
11103
|
var MCP_DEFAULT_LIMIT5 = 10;
|
|
10894
11104
|
var MCP_MAX_LIMIT5 = 100;
|
|
10895
|
-
var
|
|
10896
|
-
kind:
|
|
11105
|
+
var inputSchema21 = {
|
|
11106
|
+
kind: z20.string().describe(
|
|
10897
11107
|
'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.'
|
|
10898
11108
|
),
|
|
10899
|
-
externalId:
|
|
11109
|
+
externalId: z20.string().optional().describe(
|
|
10900
11110
|
"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."
|
|
10901
11111
|
),
|
|
10902
|
-
contextId:
|
|
11112
|
+
contextId: z20.string().optional().describe(
|
|
10903
11113
|
"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."
|
|
10904
11114
|
),
|
|
10905
11115
|
// Lookup-mode args — provide `field` plus EXACTLY ONE of: value | from+to | prefix.
|
|
10906
|
-
type:
|
|
10907
|
-
field:
|
|
10908
|
-
value:
|
|
10909
|
-
from:
|
|
10910
|
-
to:
|
|
10911
|
-
prefix:
|
|
10912
|
-
order:
|
|
10913
|
-
startFrom:
|
|
10914
|
-
limit:
|
|
11116
|
+
type: z20.string().optional().describe('Lookup mode: the identity schema\'s record type (e.g. "person_v1"). Required with `field`.'),
|
|
11117
|
+
field: z20.string().optional().describe('Lookup mode: name of the schema-declared lookup field to query by (e.g. "email").'),
|
|
11118
|
+
value: z20.string().optional().describe("Lookup mode (equality): exact-match value for `field`. Works on sensitive fields."),
|
|
11119
|
+
from: z20.string().optional().describe("Lookup mode (range): inclusive lower bound; requires `to`. Non-sensitive fields only."),
|
|
11120
|
+
to: z20.string().optional().describe("Lookup mode (range): inclusive upper bound; requires `from`."),
|
|
11121
|
+
prefix: z20.string().optional().describe("Lookup mode (prefix): match values starting with this. Range-enabled string fields only."),
|
|
11122
|
+
order: z20.enum(["asc", "desc"]).optional().describe("Lookup mode: sort direction by the looked-up field. `asc` (default) or `desc`."),
|
|
11123
|
+
startFrom: z20.string().optional().describe("Lookup mode: pagination cursor \u2014 pass the `nextCursor` from the previous page to fetch the next."),
|
|
11124
|
+
limit: z20.number().int().min(1).max(MCP_MAX_LIMIT5).optional().describe(
|
|
10915
11125
|
`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\`.`
|
|
10916
11126
|
)
|
|
10917
11127
|
};
|
|
@@ -10919,7 +11129,7 @@ var lookupPrincipal = ({ client, log }) => ({
|
|
|
10919
11129
|
name: "lookup_principal",
|
|
10920
11130
|
title: "Look up a user identity or a namespaced identity entity",
|
|
10921
11131
|
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.",
|
|
10922
|
-
inputSchema:
|
|
11132
|
+
inputSchema: inputSchema21,
|
|
10923
11133
|
handler: async (args) => {
|
|
10924
11134
|
const kind = args.kind;
|
|
10925
11135
|
const isUser = kind === "user";
|
|
@@ -10993,17 +11203,17 @@ var lookupPrincipal = ({ client, log }) => ({
|
|
|
10993
11203
|
var lookup_principal_default = lookupPrincipal;
|
|
10994
11204
|
|
|
10995
11205
|
// src/tools/version_history.ts
|
|
10996
|
-
import { z as
|
|
10997
|
-
var
|
|
10998
|
-
resourceType:
|
|
10999
|
-
id:
|
|
11000
|
-
startFrom:
|
|
11206
|
+
import { z as z21 } from "zod";
|
|
11207
|
+
var inputSchema22 = {
|
|
11208
|
+
resourceType: z21.enum(["record", "document"]).describe("Which kind of entity the id refers to: a record or a document."),
|
|
11209
|
+
id: z21.string().min(1, "id is required").describe("The Vectros id of the record or document whose history you want."),
|
|
11210
|
+
startFrom: z21.string().optional().describe("Pagination cursor \u2014 pass the `nextCursor` from the previous page to fetch older entries.")
|
|
11001
11211
|
};
|
|
11002
11212
|
var versionHistory = ({ client, log }) => ({
|
|
11003
11213
|
name: "version_history",
|
|
11004
11214
|
title: "Version history (record or document)",
|
|
11005
11215
|
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.",
|
|
11006
|
-
inputSchema:
|
|
11216
|
+
inputSchema: inputSchema22,
|
|
11007
11217
|
handler: async (args) => {
|
|
11008
11218
|
const resourceType = args.resourceType;
|
|
11009
11219
|
const id = args.id;
|
|
@@ -11030,6 +11240,7 @@ var TOOL_NAMES = [
|
|
|
11030
11240
|
"hybrid_search",
|
|
11031
11241
|
"record_query",
|
|
11032
11242
|
"record_get",
|
|
11243
|
+
"record_batch_get",
|
|
11033
11244
|
"record_create",
|
|
11034
11245
|
"record_update",
|
|
11035
11246
|
"record_delete",
|
|
@@ -11055,6 +11266,7 @@ var ALL_TOOL_FACTORIES = {
|
|
|
11055
11266
|
hybrid_search: hybrid_search_default,
|
|
11056
11267
|
record_query: record_query_default,
|
|
11057
11268
|
record_get: record_get_default,
|
|
11269
|
+
record_batch_get: record_batch_get_default,
|
|
11058
11270
|
record_create: record_create_default,
|
|
11059
11271
|
record_update: record_update_default,
|
|
11060
11272
|
record_delete: record_delete_default,
|
|
@@ -11096,7 +11308,7 @@ var identityResource = ({ log, apiKey, environment }) => ({
|
|
|
11096
11308
|
name: "identity",
|
|
11097
11309
|
uri: "vectros://identity",
|
|
11098
11310
|
title: "Current identity (tenant + principal scope)",
|
|
11099
|
-
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
|
|
11311
|
+
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.",
|
|
11100
11312
|
mimeType: "application/json",
|
|
11101
11313
|
read: async () => {
|
|
11102
11314
|
const identity = await resolveIdentity({ log, apiKey, environment });
|
|
@@ -11115,7 +11327,7 @@ var ALL_RESOURCE_FACTORIES = {
|
|
|
11115
11327
|
};
|
|
11116
11328
|
|
|
11117
11329
|
// src/zod-to-json-schema.ts
|
|
11118
|
-
import { z as
|
|
11330
|
+
import { z as z22 } from "zod";
|
|
11119
11331
|
function zodShapeToJsonSchema(shape) {
|
|
11120
11332
|
const properties = {};
|
|
11121
11333
|
const required = [];
|
|
@@ -11130,40 +11342,40 @@ function zodShapeToJsonSchema(shape) {
|
|
|
11130
11342
|
function zodTypeToJsonSchema(schema) {
|
|
11131
11343
|
const description = schema.description;
|
|
11132
11344
|
let current = schema;
|
|
11133
|
-
while (current instanceof
|
|
11345
|
+
while (current instanceof z22.ZodOptional || current instanceof z22.ZodDefault || current instanceof z22.ZodNullable) {
|
|
11134
11346
|
current = current._def.innerType;
|
|
11135
11347
|
}
|
|
11136
11348
|
const base = description ? { description } : {};
|
|
11137
|
-
if (current instanceof
|
|
11349
|
+
if (current instanceof z22.ZodString) {
|
|
11138
11350
|
return { ...base, type: "string" };
|
|
11139
11351
|
}
|
|
11140
|
-
if (current instanceof
|
|
11352
|
+
if (current instanceof z22.ZodNumber) {
|
|
11141
11353
|
return { ...base, type: "number" };
|
|
11142
11354
|
}
|
|
11143
|
-
if (current instanceof
|
|
11355
|
+
if (current instanceof z22.ZodBoolean) {
|
|
11144
11356
|
return { ...base, type: "boolean" };
|
|
11145
11357
|
}
|
|
11146
|
-
if (current instanceof
|
|
11358
|
+
if (current instanceof z22.ZodEnum) {
|
|
11147
11359
|
return {
|
|
11148
11360
|
...base,
|
|
11149
11361
|
type: "string",
|
|
11150
11362
|
enum: current.options
|
|
11151
11363
|
};
|
|
11152
11364
|
}
|
|
11153
|
-
if (current instanceof
|
|
11365
|
+
if (current instanceof z22.ZodArray) {
|
|
11154
11366
|
return {
|
|
11155
11367
|
...base,
|
|
11156
11368
|
type: "array",
|
|
11157
11369
|
items: zodTypeToJsonSchema(current.element)
|
|
11158
11370
|
};
|
|
11159
11371
|
}
|
|
11160
|
-
if (current instanceof
|
|
11372
|
+
if (current instanceof z22.ZodObject) {
|
|
11161
11373
|
return {
|
|
11162
11374
|
...base,
|
|
11163
11375
|
...zodShapeToJsonSchema(current.shape)
|
|
11164
11376
|
};
|
|
11165
11377
|
}
|
|
11166
|
-
if (current instanceof
|
|
11378
|
+
if (current instanceof z22.ZodRecord) {
|
|
11167
11379
|
const valueType = current._def.valueType;
|
|
11168
11380
|
return {
|
|
11169
11381
|
...base,
|
|
@@ -11287,7 +11499,7 @@ var VectrosMCPServer = class {
|
|
|
11287
11499
|
if (!tool) {
|
|
11288
11500
|
result = toolError(req.params.name ?? "unknown", new Error("No such tool."));
|
|
11289
11501
|
} else {
|
|
11290
|
-
const parsed =
|
|
11502
|
+
const parsed = z23.object(tool.inputSchema).strict().safeParse(req.params.arguments ?? {});
|
|
11291
11503
|
if (!parsed.success) {
|
|
11292
11504
|
result = toolError(tool.name, new Error(formatArgError(tool, parsed.error)));
|
|
11293
11505
|
} else {
|