@vectros-ai/mcp-server 0.15.0 → 0.16.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +42 -0
- package/README.md +22 -6
- package/dist/cli-http.js +422 -210
- package/dist/cli-http.js.map +1 -1
- package/dist/cli-http.mjs +422 -210
- package/dist/cli-http.mjs.map +1 -1
- package/dist/cli.js +422 -210
- package/dist/cli.js.map +1 -1
- package/dist/cli.mjs +422 -210
- package/dist/cli.mjs.map +1 -1
- package/dist/index.d.mts +3 -1
- package/dist/index.d.ts +3 -1
- package/dist/index.js +422 -210
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +422 -210
- package/dist/index.mjs.map +1 -1
- package/package.json +2 -2
package/dist/index.mjs
CHANGED
|
@@ -2490,7 +2490,7 @@ var AuthClient = class {
|
|
|
2490
2490
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/admin/keys/scoped");
|
|
2491
2491
|
}
|
|
2492
2492
|
/**
|
|
2493
|
-
* 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
|
|
2493
|
+
* 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.
|
|
2494
2494
|
*
|
|
2495
2495
|
* @param {Vectros.CreateScopedKeyRequest} request
|
|
2496
2496
|
* @param {AuthClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -3986,7 +3986,7 @@ var AuthClient = class {
|
|
|
3986
3986
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/usage");
|
|
3987
3987
|
}
|
|
3988
3988
|
/**
|
|
3989
|
-
* 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.
|
|
3989
|
+
* 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.
|
|
3990
3990
|
*
|
|
3991
3991
|
* @param {Vectros.GetIssuerRequest} request
|
|
3992
3992
|
* @param {AuthClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -4043,6 +4043,73 @@ var AuthClient = class {
|
|
|
4043
4043
|
}
|
|
4044
4044
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/auth/issuers/{issuerId}");
|
|
4045
4045
|
}
|
|
4046
|
+
/**
|
|
4047
|
+
* 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.
|
|
4048
|
+
*
|
|
4049
|
+
* @param {Vectros.IssuerUpdateRequest} request
|
|
4050
|
+
* @param {AuthClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
4051
|
+
*
|
|
4052
|
+
* @throws {@link Vectros.BadRequestError}
|
|
4053
|
+
* @throws {@link Vectros.ForbiddenError}
|
|
4054
|
+
* @throws {@link Vectros.NotFoundError}
|
|
4055
|
+
* @throws {@link Vectros.TooManyRequestsError}
|
|
4056
|
+
*
|
|
4057
|
+
* @example
|
|
4058
|
+
* await client.auth.updateIssuer({
|
|
4059
|
+
* issuerId: "auth0-prod"
|
|
4060
|
+
* })
|
|
4061
|
+
*/
|
|
4062
|
+
updateIssuer(request, requestOptions) {
|
|
4063
|
+
return HttpResponsePromise.fromPromise(this.__updateIssuer(request, requestOptions));
|
|
4064
|
+
}
|
|
4065
|
+
async __updateIssuer(request, requestOptions) {
|
|
4066
|
+
const { issuerId, ..._body } = request;
|
|
4067
|
+
const _authRequest = await this._options.authProvider.getAuthRequest();
|
|
4068
|
+
const _headers = mergeHeaders(
|
|
4069
|
+
_authRequest.headers,
|
|
4070
|
+
this._options?.headers,
|
|
4071
|
+
requestOptions?.headers
|
|
4072
|
+
);
|
|
4073
|
+
const _response = await fetcher({
|
|
4074
|
+
url: url_exports.join(
|
|
4075
|
+
await Supplier.get(this._options.baseUrl) ?? await Supplier.get(this._options.environment),
|
|
4076
|
+
`v1/auth/issuers/${url_exports.encodePathParam(issuerId)}`
|
|
4077
|
+
),
|
|
4078
|
+
method: "PUT",
|
|
4079
|
+
headers: _headers,
|
|
4080
|
+
contentType: "application/json",
|
|
4081
|
+
queryString: url_exports.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
|
|
4082
|
+
requestType: "json",
|
|
4083
|
+
body: _body,
|
|
4084
|
+
timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1e3,
|
|
4085
|
+
maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
|
|
4086
|
+
abortSignal: requestOptions?.abortSignal,
|
|
4087
|
+
fetchFn: this._options?.fetch,
|
|
4088
|
+
logging: this._options.logging
|
|
4089
|
+
});
|
|
4090
|
+
if (_response.ok) {
|
|
4091
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
4092
|
+
}
|
|
4093
|
+
if (_response.error.reason === "status-code") {
|
|
4094
|
+
switch (_response.error.statusCode) {
|
|
4095
|
+
case 400:
|
|
4096
|
+
throw new BadRequestError(_response.error.body, _response.rawResponse);
|
|
4097
|
+
case 403:
|
|
4098
|
+
throw new ForbiddenError(_response.error.body, _response.rawResponse);
|
|
4099
|
+
case 404:
|
|
4100
|
+
throw new NotFoundError(_response.error.body, _response.rawResponse);
|
|
4101
|
+
case 429:
|
|
4102
|
+
throw new TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
4103
|
+
default:
|
|
4104
|
+
throw new VectrosError({
|
|
4105
|
+
statusCode: _response.error.statusCode,
|
|
4106
|
+
body: _response.error.body,
|
|
4107
|
+
rawResponse: _response.rawResponse
|
|
4108
|
+
});
|
|
4109
|
+
}
|
|
4110
|
+
}
|
|
4111
|
+
return handleNonStatusCodeError(_response.error, _response.rawResponse, "PUT", "/v1/auth/issuers/{issuerId}");
|
|
4112
|
+
}
|
|
4046
4113
|
/**
|
|
4047
4114
|
* 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.
|
|
4048
4115
|
*
|
|
@@ -4113,7 +4180,7 @@ var AuthClient = class {
|
|
|
4113
4180
|
);
|
|
4114
4181
|
}
|
|
4115
4182
|
/**
|
|
4116
|
-
* 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.
|
|
4183
|
+
* 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.
|
|
4117
4184
|
*
|
|
4118
4185
|
* @param {Vectros.ListIssuersRequest} request
|
|
4119
4186
|
* @param {AuthClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -4170,7 +4237,7 @@ var AuthClient = class {
|
|
|
4170
4237
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/auth/issuers");
|
|
4171
4238
|
}
|
|
4172
4239
|
/**
|
|
4173
|
-
* 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`.
|
|
4240
|
+
* 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`.
|
|
4174
4241
|
*
|
|
4175
4242
|
* @param {Vectros.IssuerRequest} request
|
|
4176
4243
|
* @param {AuthClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -4355,6 +4422,7 @@ var AuthClient = class {
|
|
|
4355
4422
|
*
|
|
4356
4423
|
* @throws {@link Vectros.BadRequestError}
|
|
4357
4424
|
* @throws {@link Vectros.ForbiddenError}
|
|
4425
|
+
* @throws {@link Vectros.NotFoundError}
|
|
4358
4426
|
* @throws {@link Vectros.TooManyRequestsError}
|
|
4359
4427
|
*
|
|
4360
4428
|
* @example
|
|
@@ -4408,6 +4476,8 @@ var AuthClient = class {
|
|
|
4408
4476
|
throw new BadRequestError(_response.error.body, _response.rawResponse);
|
|
4409
4477
|
case 403:
|
|
4410
4478
|
throw new ForbiddenError(_response.error.body, _response.rawResponse);
|
|
4479
|
+
case 404:
|
|
4480
|
+
throw new NotFoundError(_response.error.body, _response.rawResponse);
|
|
4411
4481
|
case 429:
|
|
4412
4482
|
throw new TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
4413
4483
|
default:
|
|
@@ -4421,7 +4491,7 @@ var AuthClient = class {
|
|
|
4421
4491
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v1/auth/token");
|
|
4422
4492
|
}
|
|
4423
4493
|
/**
|
|
4424
|
-
* Invite a new member to one of your app contexts by email
|
|
4494
|
+
* 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.
|
|
4425
4495
|
*
|
|
4426
4496
|
* @param {Vectros.CreateInviteRequest} request
|
|
4427
4497
|
* @param {AuthClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -4492,7 +4562,7 @@ var AuthClient = class {
|
|
|
4492
4562
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v1/users/invite");
|
|
4493
4563
|
}
|
|
4494
4564
|
/**
|
|
4495
|
-
* 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.
|
|
4565
|
+
* 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.
|
|
4496
4566
|
*
|
|
4497
4567
|
* @param {Vectros.CreateInviteRequest} request
|
|
4498
4568
|
* @param {AuthClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -4559,6 +4629,83 @@ var AuthClient = class {
|
|
|
4559
4629
|
}
|
|
4560
4630
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v1/users/invite/resend");
|
|
4561
4631
|
}
|
|
4632
|
+
/**
|
|
4633
|
+
* 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).
|
|
4634
|
+
*
|
|
4635
|
+
* **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.
|
|
4636
|
+
*
|
|
4637
|
+
* **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.
|
|
4638
|
+
*
|
|
4639
|
+
* **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.
|
|
4640
|
+
*
|
|
4641
|
+
* 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.
|
|
4642
|
+
*
|
|
4643
|
+
* @param {Record<string, unknown>} request
|
|
4644
|
+
* @param {AuthClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
4645
|
+
*
|
|
4646
|
+
* @throws {@link Vectros.BadRequestError}
|
|
4647
|
+
* @throws {@link Vectros.UnauthorizedError}
|
|
4648
|
+
* @throws {@link Vectros.ForbiddenError}
|
|
4649
|
+
* @throws {@link Vectros.ConflictError}
|
|
4650
|
+
* @throws {@link Vectros.TooManyRequestsError}
|
|
4651
|
+
*
|
|
4652
|
+
* @example
|
|
4653
|
+
* await client.auth.assumeToken({
|
|
4654
|
+
* "scope:org": "orgB"
|
|
4655
|
+
* })
|
|
4656
|
+
*/
|
|
4657
|
+
assumeToken(request, requestOptions) {
|
|
4658
|
+
return HttpResponsePromise.fromPromise(this.__assumeToken(request, requestOptions));
|
|
4659
|
+
}
|
|
4660
|
+
async __assumeToken(request, requestOptions) {
|
|
4661
|
+
const _authRequest = await this._options.authProvider.getAuthRequest();
|
|
4662
|
+
const _headers = mergeHeaders(
|
|
4663
|
+
_authRequest.headers,
|
|
4664
|
+
this._options?.headers,
|
|
4665
|
+
requestOptions?.headers
|
|
4666
|
+
);
|
|
4667
|
+
const _response = await fetcher({
|
|
4668
|
+
url: url_exports.join(
|
|
4669
|
+
await Supplier.get(this._options.baseUrl) ?? await Supplier.get(this._options.environment),
|
|
4670
|
+
"v1/auth/token/assume"
|
|
4671
|
+
),
|
|
4672
|
+
method: "POST",
|
|
4673
|
+
headers: _headers,
|
|
4674
|
+
contentType: "application/json",
|
|
4675
|
+
queryString: url_exports.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
|
|
4676
|
+
requestType: "json",
|
|
4677
|
+
body: request,
|
|
4678
|
+
timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1e3,
|
|
4679
|
+
maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
|
|
4680
|
+
abortSignal: requestOptions?.abortSignal,
|
|
4681
|
+
fetchFn: this._options?.fetch,
|
|
4682
|
+
logging: this._options.logging
|
|
4683
|
+
});
|
|
4684
|
+
if (_response.ok) {
|
|
4685
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
4686
|
+
}
|
|
4687
|
+
if (_response.error.reason === "status-code") {
|
|
4688
|
+
switch (_response.error.statusCode) {
|
|
4689
|
+
case 400:
|
|
4690
|
+
throw new BadRequestError(_response.error.body, _response.rawResponse);
|
|
4691
|
+
case 401:
|
|
4692
|
+
throw new UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
4693
|
+
case 403:
|
|
4694
|
+
throw new ForbiddenError(_response.error.body, _response.rawResponse);
|
|
4695
|
+
case 409:
|
|
4696
|
+
throw new ConflictError(_response.error.body, _response.rawResponse);
|
|
4697
|
+
case 429:
|
|
4698
|
+
throw new TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
4699
|
+
default:
|
|
4700
|
+
throw new VectrosError({
|
|
4701
|
+
statusCode: _response.error.statusCode,
|
|
4702
|
+
body: _response.error.body,
|
|
4703
|
+
rawResponse: _response.rawResponse
|
|
4704
|
+
});
|
|
4705
|
+
}
|
|
4706
|
+
}
|
|
4707
|
+
return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v1/auth/token/assume");
|
|
4708
|
+
}
|
|
4562
4709
|
/**
|
|
4563
4710
|
* 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.
|
|
4564
4711
|
*
|
|
@@ -4636,9 +4783,9 @@ var ComplianceClient = class {
|
|
|
4636
4783
|
* @param {Vectros.ErasureRequest} request
|
|
4637
4784
|
* @param {ComplianceClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
4638
4785
|
*
|
|
4786
|
+
* @throws {@link Vectros.BadRequestError}
|
|
4639
4787
|
* @throws {@link Vectros.ForbiddenError}
|
|
4640
4788
|
* @throws {@link Vectros.TooManyRequestsError}
|
|
4641
|
-
* @throws {@link Vectros.NotImplementedError}
|
|
4642
4789
|
*
|
|
4643
4790
|
* @example
|
|
4644
4791
|
* await client.compliance.createErasureRequest({
|
|
@@ -4677,12 +4824,12 @@ var ComplianceClient = class {
|
|
|
4677
4824
|
}
|
|
4678
4825
|
if (_response.error.reason === "status-code") {
|
|
4679
4826
|
switch (_response.error.statusCode) {
|
|
4827
|
+
case 400:
|
|
4828
|
+
throw new BadRequestError(_response.error.body, _response.rawResponse);
|
|
4680
4829
|
case 403:
|
|
4681
4830
|
throw new ForbiddenError(_response.error.body, _response.rawResponse);
|
|
4682
4831
|
case 429:
|
|
4683
4832
|
throw new TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
4684
|
-
case 501:
|
|
4685
|
-
throw new NotImplementedError(_response.error.body, _response.rawResponse);
|
|
4686
4833
|
default:
|
|
4687
4834
|
throw new VectrosError({
|
|
4688
4835
|
statusCode: _response.error.statusCode,
|
|
@@ -4701,7 +4848,6 @@ var ComplianceClient = class {
|
|
|
4701
4848
|
*
|
|
4702
4849
|
* @throws {@link Vectros.ForbiddenError}
|
|
4703
4850
|
* @throws {@link Vectros.NotFoundError}
|
|
4704
|
-
* @throws {@link Vectros.NotImplementedError}
|
|
4705
4851
|
*
|
|
4706
4852
|
* @example
|
|
4707
4853
|
* await client.compliance.getErasureRequest({
|
|
@@ -4742,8 +4888,6 @@ var ComplianceClient = class {
|
|
|
4742
4888
|
throw new ForbiddenError(_response.error.body, _response.rawResponse);
|
|
4743
4889
|
case 404:
|
|
4744
4890
|
throw new NotFoundError(_response.error.body, _response.rawResponse);
|
|
4745
|
-
case 501:
|
|
4746
|
-
throw new NotImplementedError(_response.error.body, _response.rawResponse);
|
|
4747
4891
|
default:
|
|
4748
4892
|
throw new VectrosError({
|
|
4749
4893
|
statusCode: _response.error.statusCode,
|
|
@@ -5291,7 +5435,21 @@ var DocumentsClient = class {
|
|
|
5291
5435
|
return HttpResponsePromise.fromPromise(this.__lookupDocuments(request, requestOptions));
|
|
5292
5436
|
}
|
|
5293
5437
|
async __lookupDocuments(request, requestOptions) {
|
|
5294
|
-
const {
|
|
5438
|
+
const {
|
|
5439
|
+
type: type_,
|
|
5440
|
+
field,
|
|
5441
|
+
value,
|
|
5442
|
+
from: from_,
|
|
5443
|
+
to,
|
|
5444
|
+
prefix,
|
|
5445
|
+
sortFrom,
|
|
5446
|
+
sortTo,
|
|
5447
|
+
startFrom,
|
|
5448
|
+
limit,
|
|
5449
|
+
order,
|
|
5450
|
+
userId,
|
|
5451
|
+
scope
|
|
5452
|
+
} = request;
|
|
5295
5453
|
const _queryParams = {
|
|
5296
5454
|
type: type_,
|
|
5297
5455
|
field,
|
|
@@ -5299,6 +5457,8 @@ var DocumentsClient = class {
|
|
|
5299
5457
|
from: from_,
|
|
5300
5458
|
to,
|
|
5301
5459
|
prefix,
|
|
5460
|
+
sortFrom,
|
|
5461
|
+
sortTo,
|
|
5302
5462
|
startFrom,
|
|
5303
5463
|
limit,
|
|
5304
5464
|
order: order != null ? order : void 0,
|
|
@@ -6583,7 +6743,7 @@ var IdentityClient = class {
|
|
|
6583
6743
|
);
|
|
6584
6744
|
}
|
|
6585
6745
|
/**
|
|
6586
|
-
* Retrieves a single scope-namespace registration by name.
|
|
6746
|
+
* Retrieves a single scope-namespace registration by name.
|
|
6587
6747
|
*
|
|
6588
6748
|
* @param {Vectros.GetNamespaceRequest} request
|
|
6589
6749
|
* @param {IdentityClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -6776,7 +6936,7 @@ var IdentityClient = class {
|
|
|
6776
6936
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "DELETE", "/v1/namespaces/{namespace}");
|
|
6777
6937
|
}
|
|
6778
6938
|
/**
|
|
6779
|
-
* Returns the scope namespaces in your account
|
|
6939
|
+
* Returns the scope namespaces registered in your account. Returns a `{data, nextCursor}` envelope.
|
|
6780
6940
|
*
|
|
6781
6941
|
* @param {Vectros.ListNamespacesRequest} request
|
|
6782
6942
|
* @param {IdentityClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -6827,7 +6987,7 @@ var IdentityClient = class {
|
|
|
6827
6987
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/namespaces");
|
|
6828
6988
|
}
|
|
6829
6989
|
/**
|
|
6830
|
-
* 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
|
|
6990
|
+
* 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.
|
|
6831
6991
|
*
|
|
6832
6992
|
* @param {Vectros.RegisterNamespaceRequest} request
|
|
6833
6993
|
* @param {IdentityClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -6897,7 +7057,7 @@ var IdentityClient = class {
|
|
|
6897
7057
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v1/namespaces");
|
|
6898
7058
|
}
|
|
6899
7059
|
/**
|
|
6900
|
-
* 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.
|
|
7060
|
+
* 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.
|
|
6901
7061
|
*
|
|
6902
7062
|
* @param {Vectros.ListUsersRequest} request
|
|
6903
7063
|
* @param {IdentityClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -6962,7 +7122,7 @@ var IdentityClient = class {
|
|
|
6962
7122
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/users");
|
|
6963
7123
|
}
|
|
6964
7124
|
/**
|
|
6965
|
-
* 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.
|
|
7125
|
+
* 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`.
|
|
6966
7126
|
*
|
|
6967
7127
|
* @param {Vectros.CreateUserRequest} request
|
|
6968
7128
|
* @param {IdentityClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -7086,7 +7246,7 @@ var IdentityClient = class {
|
|
|
7086
7246
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/users/{id}");
|
|
7087
7247
|
}
|
|
7088
7248
|
/**
|
|
7089
|
-
* 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.
|
|
7249
|
+
* 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.
|
|
7090
7250
|
*
|
|
7091
7251
|
* @param {Vectros.UpdateUserRequest} request
|
|
7092
7252
|
* @param {IdentityClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -7153,7 +7313,7 @@ var IdentityClient = class {
|
|
|
7153
7313
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "PUT", "/v1/users/{id}");
|
|
7154
7314
|
}
|
|
7155
7315
|
/**
|
|
7156
|
-
* 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.
|
|
7316
|
+
* 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.
|
|
7157
7317
|
*
|
|
7158
7318
|
* @param {Vectros.DeleteUserRequest} request
|
|
7159
7319
|
* @param {IdentityClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -7214,7 +7374,7 @@ var IdentityClient = class {
|
|
|
7214
7374
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "DELETE", "/v1/users/{id}");
|
|
7215
7375
|
}
|
|
7216
7376
|
/**
|
|
7217
|
-
* 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.
|
|
7377
|
+
* 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.
|
|
7218
7378
|
*
|
|
7219
7379
|
* @param {Vectros.IdentityLookupRequest} request
|
|
7220
7380
|
* @param {IdentityClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -7657,14 +7817,14 @@ var RecordsClient = class {
|
|
|
7657
7817
|
this._options = normalizeClientOptionsWithAuth(options);
|
|
7658
7818
|
}
|
|
7659
7819
|
/**
|
|
7660
|
-
*
|
|
7820
|
+
* 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).
|
|
7661
7821
|
*
|
|
7662
7822
|
* @param {Vectros.BatchGetRequest} request
|
|
7663
7823
|
* @param {RecordsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
7664
7824
|
*
|
|
7825
|
+
* @throws {@link Vectros.BadRequestError}
|
|
7665
7826
|
* @throws {@link Vectros.ForbiddenError}
|
|
7666
7827
|
* @throws {@link Vectros.TooManyRequestsError}
|
|
7667
|
-
* @throws {@link Vectros.NotImplementedError}
|
|
7668
7828
|
*
|
|
7669
7829
|
* @example
|
|
7670
7830
|
* await client.records.batchGetRecords()
|
|
@@ -7701,12 +7861,12 @@ var RecordsClient = class {
|
|
|
7701
7861
|
}
|
|
7702
7862
|
if (_response.error.reason === "status-code") {
|
|
7703
7863
|
switch (_response.error.statusCode) {
|
|
7864
|
+
case 400:
|
|
7865
|
+
throw new BadRequestError(_response.error.body, _response.rawResponse);
|
|
7704
7866
|
case 403:
|
|
7705
7867
|
throw new ForbiddenError(_response.error.body, _response.rawResponse);
|
|
7706
7868
|
case 429:
|
|
7707
7869
|
throw new TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
7708
|
-
case 501:
|
|
7709
|
-
throw new NotImplementedError(_response.error.body, _response.rawResponse);
|
|
7710
7870
|
default:
|
|
7711
7871
|
throw new VectrosError({
|
|
7712
7872
|
statusCode: _response.error.statusCode,
|
|
@@ -8520,7 +8680,7 @@ var SchemasClient = class {
|
|
|
8520
8680
|
this._options = normalizeClientOptionsWithAuth(options);
|
|
8521
8681
|
}
|
|
8522
8682
|
/**
|
|
8523
|
-
* 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
|
|
8683
|
+
* 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.
|
|
8524
8684
|
*
|
|
8525
8685
|
* @param {Vectros.ListSchemasRequest} request
|
|
8526
8686
|
* @param {SchemasClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -8808,6 +8968,7 @@ var SchemasClient = class {
|
|
|
8808
8968
|
* @param {Vectros.DeleteSchemaRequest} request
|
|
8809
8969
|
* @param {SchemasClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
8810
8970
|
*
|
|
8971
|
+
* @throws {@link Vectros.ForbiddenError}
|
|
8811
8972
|
* @throws {@link Vectros.NotFoundError}
|
|
8812
8973
|
* @throws {@link Vectros.ConflictError}
|
|
8813
8974
|
* @throws {@link Vectros.TooManyRequestsError}
|
|
@@ -8847,6 +9008,8 @@ var SchemasClient = class {
|
|
|
8847
9008
|
}
|
|
8848
9009
|
if (_response.error.reason === "status-code") {
|
|
8849
9010
|
switch (_response.error.statusCode) {
|
|
9011
|
+
case 403:
|
|
9012
|
+
throw new ForbiddenError(_response.error.body, _response.rawResponse);
|
|
8850
9013
|
case 404:
|
|
8851
9014
|
throw new NotFoundError(_response.error.body, _response.rawResponse);
|
|
8852
9015
|
case 409:
|
|
@@ -9061,7 +9224,7 @@ import {
|
|
|
9061
9224
|
ListToolsRequestSchema,
|
|
9062
9225
|
ReadResourceRequestSchema
|
|
9063
9226
|
} from "@modelcontextprotocol/sdk/types.js";
|
|
9064
|
-
import { z as
|
|
9227
|
+
import { z as z23 } from "zod";
|
|
9065
9228
|
|
|
9066
9229
|
// src/auth.ts
|
|
9067
9230
|
var KEY_RE = /^(sk|ssk|st)_(live|test)_/;
|
|
@@ -9105,8 +9268,8 @@ function warnOnSuboptimalKey(key, log) {
|
|
|
9105
9268
|
|
|
9106
9269
|
// src/build-info.ts
|
|
9107
9270
|
var BUILD_INFO = {
|
|
9108
|
-
mcpServer: true ? "0.
|
|
9109
|
-
sdk: true ? "0.
|
|
9271
|
+
mcpServer: true ? "0.16.1" : "dev",
|
|
9272
|
+
sdk: true ? "0.42.0" : "dev"
|
|
9110
9273
|
};
|
|
9111
9274
|
|
|
9112
9275
|
// src/log.ts
|
|
@@ -9788,23 +9951,70 @@ var recordGet = ({ client, log }) => ({
|
|
|
9788
9951
|
});
|
|
9789
9952
|
var record_get_default = recordGet;
|
|
9790
9953
|
|
|
9791
|
-
// src/tools/
|
|
9954
|
+
// src/tools/record_batch_get.ts
|
|
9792
9955
|
import { z as z4 } from "zod";
|
|
9956
|
+
var MAX_PAYLOAD_CHARS2 = 32e3;
|
|
9957
|
+
var MCP_MAX_IDS = 100;
|
|
9793
9958
|
var inputSchema4 = {
|
|
9794
|
-
|
|
9795
|
-
|
|
9959
|
+
ids: z4.array(z4.string()).min(1).max(MCP_MAX_IDS).describe(
|
|
9960
|
+
`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.`
|
|
9961
|
+
)
|
|
9962
|
+
};
|
|
9963
|
+
var recordBatchGet = ({ client, log }) => ({
|
|
9964
|
+
name: "record_batch_get",
|
|
9965
|
+
title: "Get multiple records by id in one call",
|
|
9966
|
+
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.",
|
|
9967
|
+
inputSchema: inputSchema4,
|
|
9968
|
+
handler: async (args) => {
|
|
9969
|
+
const ids = args.ids;
|
|
9970
|
+
try {
|
|
9971
|
+
const response = await client.records.batchGetRecords({ ids });
|
|
9972
|
+
const records = response.data ?? [];
|
|
9973
|
+
const data = records.map((record) => {
|
|
9974
|
+
const item = { ...record };
|
|
9975
|
+
if (record.payload !== void 0) {
|
|
9976
|
+
const json = JSON.stringify(record.payload);
|
|
9977
|
+
if (json.length > MAX_PAYLOAD_CHARS2) {
|
|
9978
|
+
delete item.payload;
|
|
9979
|
+
item.payloadPreview = json.slice(0, MAX_PAYLOAD_CHARS2);
|
|
9980
|
+
item.payloadTruncated = true;
|
|
9981
|
+
item.payloadTotalChars = json.length;
|
|
9982
|
+
}
|
|
9983
|
+
}
|
|
9984
|
+
return item;
|
|
9985
|
+
});
|
|
9986
|
+
const returnedIds = new Set(records.map((r) => r.id));
|
|
9987
|
+
const missingIds = ids.filter((id) => !returnedIds.has(id));
|
|
9988
|
+
log.debug(
|
|
9989
|
+
{ tool: "record_batch_get", requested: ids.length, returned: data.length, missing: missingIds.length },
|
|
9990
|
+
"record_batch_get ok"
|
|
9991
|
+
);
|
|
9992
|
+
return { content: [{ type: "text", text: JSON.stringify({ data, missingIds }, null, 2) }] };
|
|
9993
|
+
} catch (err) {
|
|
9994
|
+
log.warn({ tool: "record_batch_get", idsCount: ids?.length, err: String(err) }, "record_batch_get failed");
|
|
9995
|
+
return toolError("record_batch_get", err);
|
|
9996
|
+
}
|
|
9997
|
+
}
|
|
9998
|
+
});
|
|
9999
|
+
var record_batch_get_default = recordBatchGet;
|
|
10000
|
+
|
|
10001
|
+
// src/tools/record_create.ts
|
|
10002
|
+
import { z as z5 } from "zod";
|
|
10003
|
+
var inputSchema5 = {
|
|
10004
|
+
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.'),
|
|
10005
|
+
fields: z5.record(z5.string(), z5.unknown()).describe(
|
|
9796
10006
|
"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."
|
|
9797
10007
|
),
|
|
9798
|
-
externalId:
|
|
10008
|
+
externalId: z5.string().optional().describe(
|
|
9799
10009
|
"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."
|
|
9800
10010
|
),
|
|
9801
|
-
indexMode:
|
|
10011
|
+
indexMode: z5.enum(["HYBRID", "SEMANTIC", "TEXT", "NONE"]).optional().describe(
|
|
9802
10012
|
"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."
|
|
9803
10013
|
),
|
|
9804
|
-
status:
|
|
9805
|
-
folderId:
|
|
9806
|
-
userId:
|
|
9807
|
-
scopes:
|
|
10014
|
+
status: z5.string().optional().describe("Record lifecycle status. Defaults to ACTIVE server-side."),
|
|
10015
|
+
folderId: z5.string().optional().describe("Group this record into a folder."),
|
|
10016
|
+
userId: z5.string().optional().describe("Owning user id."),
|
|
10017
|
+
scopes: z5.array(z5.string()).optional().describe(
|
|
9808
10018
|
'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.'
|
|
9809
10019
|
)
|
|
9810
10020
|
};
|
|
@@ -9812,7 +10022,7 @@ var recordCreate = ({ client, log }) => ({
|
|
|
9812
10022
|
name: "record_create",
|
|
9813
10023
|
title: "Create a record",
|
|
9814
10024
|
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).",
|
|
9815
|
-
inputSchema:
|
|
10025
|
+
inputSchema: inputSchema5,
|
|
9816
10026
|
handler: async (args) => {
|
|
9817
10027
|
const type = args.type;
|
|
9818
10028
|
try {
|
|
@@ -9839,18 +10049,18 @@ var recordCreate = ({ client, log }) => ({
|
|
|
9839
10049
|
var record_create_default = recordCreate;
|
|
9840
10050
|
|
|
9841
10051
|
// src/tools/record_update.ts
|
|
9842
|
-
import { z as
|
|
9843
|
-
var
|
|
9844
|
-
id:
|
|
9845
|
-
externalId:
|
|
10052
|
+
import { z as z6 } from "zod";
|
|
10053
|
+
var inputSchema6 = {
|
|
10054
|
+
id: z6.string().optional().describe("The Vectros record id to update. Provide this OR externalId+type."),
|
|
10055
|
+
externalId: z6.string().optional().describe(
|
|
9846
10056
|
"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."
|
|
9847
10057
|
),
|
|
9848
|
-
type:
|
|
9849
|
-
fields:
|
|
10058
|
+
type: z6.string().optional().describe("Record type \u2014 REQUIRED when selecting by `externalId` (externalId is unique within a type)."),
|
|
10059
|
+
fields: z6.record(z6.string(), z6.unknown()).describe(
|
|
9850
10060
|
"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."
|
|
9851
10061
|
),
|
|
9852
|
-
status:
|
|
9853
|
-
expectedVersion:
|
|
10062
|
+
status: z6.string().optional().describe("Set the record lifecycle status (e.g. ARCHIVED) \u2014 archive/workflow without physical deletion."),
|
|
10063
|
+
expectedVersion: z6.number().int().optional().describe(
|
|
9854
10064
|
"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."
|
|
9855
10065
|
)
|
|
9856
10066
|
};
|
|
@@ -9858,7 +10068,7 @@ var recordUpdate = ({ client, log }) => ({
|
|
|
9858
10068
|
name: "record_update",
|
|
9859
10069
|
title: "Update a record by id or externalId",
|
|
9860
10070
|
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.",
|
|
9861
|
-
inputSchema:
|
|
10071
|
+
inputSchema: inputSchema6,
|
|
9862
10072
|
handler: async (args) => {
|
|
9863
10073
|
const id = args.id;
|
|
9864
10074
|
const externalId = args.externalId;
|
|
@@ -9884,15 +10094,15 @@ var recordUpdate = ({ client, log }) => ({
|
|
|
9884
10094
|
var record_update_default = recordUpdate;
|
|
9885
10095
|
|
|
9886
10096
|
// src/tools/record_delete.ts
|
|
9887
|
-
import { z as
|
|
9888
|
-
var
|
|
9889
|
-
id:
|
|
10097
|
+
import { z as z7 } from "zod";
|
|
10098
|
+
var inputSchema7 = {
|
|
10099
|
+
id: z7.string().min(1, "id is required").describe("The Vectros record id to delete.")
|
|
9890
10100
|
};
|
|
9891
10101
|
var recordDelete = ({ client, log }) => ({
|
|
9892
10102
|
name: "record_delete",
|
|
9893
10103
|
title: "Delete a record",
|
|
9894
10104
|
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.",
|
|
9895
|
-
inputSchema:
|
|
10105
|
+
inputSchema: inputSchema7,
|
|
9896
10106
|
handler: async (args) => {
|
|
9897
10107
|
const id = args.id;
|
|
9898
10108
|
try {
|
|
@@ -9908,48 +10118,48 @@ var recordDelete = ({ client, log }) => ({
|
|
|
9908
10118
|
var record_delete_default = recordDelete;
|
|
9909
10119
|
|
|
9910
10120
|
// src/tools/rag_ask.ts
|
|
9911
|
-
import { z as
|
|
10121
|
+
import { z as z8 } from "zod";
|
|
9912
10122
|
var SEARCH_MCP_DEFAULT_LIMIT = 5;
|
|
9913
10123
|
var SEARCH_MCP_MAX_LIMIT = 50;
|
|
9914
|
-
var
|
|
9915
|
-
query:
|
|
9916
|
-
instructions:
|
|
10124
|
+
var inputSchema8 = {
|
|
10125
|
+
query: z8.string().min(1, "query must be non-empty").describe("Question to ground against retrieved content."),
|
|
10126
|
+
instructions: z8.string().optional().describe(
|
|
9917
10127
|
'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.'
|
|
9918
10128
|
),
|
|
9919
|
-
model:
|
|
10129
|
+
model: z8.string().optional().describe(
|
|
9920
10130
|
"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."
|
|
9921
10131
|
),
|
|
9922
|
-
search:
|
|
9923
|
-
mode:
|
|
9924
|
-
limit:
|
|
10132
|
+
search: z8.object({
|
|
10133
|
+
mode: z8.enum(["HYBRID", "TEXT", "SEMANTIC"]).optional().describe("Retrieval mode. Default HYBRID."),
|
|
10134
|
+
limit: z8.number().int().min(1).max(SEARCH_MCP_MAX_LIMIT).optional().describe(
|
|
9925
10135
|
`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.`
|
|
9926
10136
|
),
|
|
9927
10137
|
// Retrieval scoping — parity with hybrid_search so an agent can ground the
|
|
9928
10138
|
// answer on a specific owner / folder / type / metadata subset, not just the
|
|
9929
10139
|
// whole-tenant corpus.
|
|
9930
|
-
userId:
|
|
9931
|
-
scope:
|
|
10140
|
+
userId: z8.string().optional().describe("Restrict retrieval to content owned by this user (Vectros UUID)."),
|
|
10141
|
+
scope: z8.string().optional().describe(
|
|
9932
10142
|
'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.'
|
|
9933
10143
|
),
|
|
9934
|
-
folderId:
|
|
9935
|
-
rootFolderId:
|
|
9936
|
-
typeName:
|
|
9937
|
-
contentTypes:
|
|
9938
|
-
filters:
|
|
10144
|
+
folderId: z8.string().optional().describe("Restrict retrieval to this exact folder."),
|
|
10145
|
+
rootFolderId: z8.string().optional().describe("Restrict retrieval to this folder and all its descendants."),
|
|
10146
|
+
typeName: z8.string().optional().describe("Restrict record retrieval to this schema type."),
|
|
10147
|
+
contentTypes: z8.array(z8.enum(["documents", "records"])).optional().describe('Narrow retrieval to content types. ["documents"] or ["records"]; omit for both.'),
|
|
10148
|
+
filters: z8.record(z8.unknown()).optional().describe(
|
|
9939
10149
|
'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"}.'
|
|
9940
10150
|
),
|
|
9941
|
-
createdAfter:
|
|
9942
|
-
createdBefore:
|
|
9943
|
-
requireComplete:
|
|
10151
|
+
createdAfter: z8.string().optional().describe("Restrict to content created at/after this ISO 8601 UTC timestamp."),
|
|
10152
|
+
createdBefore: z8.string().optional().describe("Restrict to content created at/before this ISO 8601 UTC timestamp."),
|
|
10153
|
+
requireComplete: z8.boolean().optional().describe("Fail closed (503) on a degraded search backend instead of grounding on partial results. Default false.")
|
|
9944
10154
|
}).optional().describe("Retrieval params + scoping. Default mode HYBRID, limit " + SEARCH_MCP_DEFAULT_LIMIT + "."),
|
|
9945
|
-
maxTokens:
|
|
9946
|
-
temperature:
|
|
10155
|
+
maxTokens: z8.number().int().min(1).optional().describe("Max output tokens."),
|
|
10156
|
+
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.")
|
|
9947
10157
|
};
|
|
9948
10158
|
var ragAsk = ({ client, log }) => ({
|
|
9949
10159
|
name: "rag_ask",
|
|
9950
10160
|
title: "RAG ask (corpus-wide)",
|
|
9951
10161
|
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.",
|
|
9952
|
-
inputSchema:
|
|
10162
|
+
inputSchema: inputSchema8,
|
|
9953
10163
|
handler: async (args, extra) => {
|
|
9954
10164
|
try {
|
|
9955
10165
|
const searchArg = args.search ?? {};
|
|
@@ -10025,20 +10235,20 @@ var ragAsk = ({ client, log }) => ({
|
|
|
10025
10235
|
var rag_ask_default = ragAsk;
|
|
10026
10236
|
|
|
10027
10237
|
// src/tools/document_ask.ts
|
|
10028
|
-
import { z as
|
|
10029
|
-
var
|
|
10030
|
-
documentId:
|
|
10031
|
-
prompt:
|
|
10032
|
-
model:
|
|
10238
|
+
import { z as z9 } from "zod";
|
|
10239
|
+
var inputSchema9 = {
|
|
10240
|
+
documentId: z9.string().min(1, "documentId is required").describe("ID of the document to ask against."),
|
|
10241
|
+
prompt: z9.string().min(1, "prompt is required").describe("Question to ask about the document."),
|
|
10242
|
+
model: z9.string().optional().describe(
|
|
10033
10243
|
"Inference model alias. Default = tier-appropriate Haiku. See GET /v1/models for the catalog the calling key can reach."
|
|
10034
10244
|
),
|
|
10035
|
-
maxTokens:
|
|
10245
|
+
maxTokens: z9.number().int().min(1).optional().describe("Max output tokens.")
|
|
10036
10246
|
};
|
|
10037
10247
|
var documentAsk = ({ client, log }) => ({
|
|
10038
10248
|
name: "document_ask",
|
|
10039
10249
|
title: "Document ask (single-document)",
|
|
10040
10250
|
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.",
|
|
10041
|
-
inputSchema:
|
|
10251
|
+
inputSchema: inputSchema9,
|
|
10042
10252
|
handler: async (args, extra) => {
|
|
10043
10253
|
try {
|
|
10044
10254
|
const stream = await client.inference.documentAsk({
|
|
@@ -10097,18 +10307,18 @@ var documentAsk = ({ client, log }) => ({
|
|
|
10097
10307
|
var document_ask_default = documentAsk;
|
|
10098
10308
|
|
|
10099
10309
|
// src/tools/list_schemas.ts
|
|
10100
|
-
import { z as
|
|
10101
|
-
var
|
|
10102
|
-
userId:
|
|
10310
|
+
import { z as z10 } from "zod";
|
|
10311
|
+
var inputSchema10 = {
|
|
10312
|
+
userId: z10.string().optional().describe(
|
|
10103
10313
|
"Filter to schemas visible to a specific user. Optional; default returns all schemas the credential can see."
|
|
10104
10314
|
),
|
|
10105
|
-
scope:
|
|
10315
|
+
scope: z10.string().optional().describe(
|
|
10106
10316
|
'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.'
|
|
10107
10317
|
),
|
|
10108
|
-
surface:
|
|
10318
|
+
surface: z10.enum(["record", "document", "user", "entity"]).optional().describe(
|
|
10109
10319
|
"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."
|
|
10110
10320
|
),
|
|
10111
|
-
recordType:
|
|
10321
|
+
recordType: z10.string().optional().describe(
|
|
10112
10322
|
'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.'
|
|
10113
10323
|
)
|
|
10114
10324
|
};
|
|
@@ -10116,7 +10326,7 @@ var listSchemas = ({ client, log }) => ({
|
|
|
10116
10326
|
name: "list_schemas",
|
|
10117
10327
|
title: "List record schemas",
|
|
10118
10328
|
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.',
|
|
10119
|
-
inputSchema:
|
|
10329
|
+
inputSchema: inputSchema10,
|
|
10120
10330
|
handler: async (args) => {
|
|
10121
10331
|
const userId = args.userId;
|
|
10122
10332
|
const scope = args.scope;
|
|
@@ -10142,18 +10352,18 @@ var listSchemas = ({ client, log }) => ({
|
|
|
10142
10352
|
var list_schemas_default = listSchemas;
|
|
10143
10353
|
|
|
10144
10354
|
// src/tools/document_get.ts
|
|
10145
|
-
import { z as
|
|
10355
|
+
import { z as z11 } from "zod";
|
|
10146
10356
|
var MAX_TEXT_CHARS = 32e3;
|
|
10147
|
-
var
|
|
10148
|
-
documentId:
|
|
10149
|
-
externalId:
|
|
10357
|
+
var inputSchema11 = {
|
|
10358
|
+
documentId: z11.string().optional().describe("The document ID returned by document_ingest or hybrid_search. Provide this OR externalId+type."),
|
|
10359
|
+
externalId: z11.string().optional().describe(
|
|
10150
10360
|
"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."
|
|
10151
10361
|
),
|
|
10152
|
-
type:
|
|
10153
|
-
includeText:
|
|
10362
|
+
type: z11.string().optional().describe("Document type \u2014 REQUIRED when selecting by `externalId` (externalId is unique within a type)."),
|
|
10363
|
+
includeText: z11.boolean().optional().describe(
|
|
10154
10364
|
"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."
|
|
10155
10365
|
),
|
|
10156
|
-
includeDownloadUrl:
|
|
10366
|
+
includeDownloadUrl: z11.boolean().optional().describe(
|
|
10157
10367
|
"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."
|
|
10158
10368
|
)
|
|
10159
10369
|
};
|
|
@@ -10170,7 +10380,7 @@ var documentGet = ({ client, log }) => ({
|
|
|
10170
10380
|
name: "document_get",
|
|
10171
10381
|
title: "Get document metadata (and optionally text)",
|
|
10172
10382
|
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.",
|
|
10173
|
-
inputSchema:
|
|
10383
|
+
inputSchema: inputSchema11,
|
|
10174
10384
|
handler: async (args) => {
|
|
10175
10385
|
const documentId = args.documentId;
|
|
10176
10386
|
const externalId = args.externalId;
|
|
@@ -10235,28 +10445,28 @@ var documentGet = ({ client, log }) => ({
|
|
|
10235
10445
|
var document_get_default = documentGet;
|
|
10236
10446
|
|
|
10237
10447
|
// src/tools/document_query.ts
|
|
10238
|
-
import { z as
|
|
10448
|
+
import { z as z12 } from "zod";
|
|
10239
10449
|
var MCP_DEFAULT_LIMIT3 = 3;
|
|
10240
10450
|
var MCP_MAX_LIMIT3 = 100;
|
|
10241
|
-
var
|
|
10451
|
+
var inputSchema12 = {
|
|
10242
10452
|
// Lookup-mode args — provide `field` plus EXACTLY ONE of: value | from+to | prefix.
|
|
10243
|
-
field:
|
|
10244
|
-
value:
|
|
10245
|
-
from:
|
|
10246
|
-
to:
|
|
10247
|
-
prefix:
|
|
10248
|
-
order:
|
|
10453
|
+
field: z12.string().optional().describe("Lookup mode: name of the lookup-indexed field to query by."),
|
|
10454
|
+
value: z12.string().optional().describe("Lookup mode (equality): exact-match value for `field`. Works on sensitive fields too."),
|
|
10455
|
+
from: z12.string().optional().describe("Lookup mode (range): inclusive lower bound; requires `to`. Range-enabled, non-sensitive fields only."),
|
|
10456
|
+
to: z12.string().optional().describe("Lookup mode (range): inclusive upper bound; requires `from`."),
|
|
10457
|
+
prefix: z12.string().optional().describe("Lookup mode (prefix): match values starting with this. Range-enabled string fields only."),
|
|
10458
|
+
order: z12.enum(["asc", "desc"]).optional().describe(
|
|
10249
10459
|
"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."
|
|
10250
10460
|
),
|
|
10251
|
-
type:
|
|
10461
|
+
type: z12.string().optional().describe("Lookup mode: the document type (the bound schema's type). Required with `field`."),
|
|
10252
10462
|
// List-mode args:
|
|
10253
|
-
folderId:
|
|
10254
|
-
userId:
|
|
10255
|
-
scope:
|
|
10463
|
+
folderId: z12.string().optional().describe("List mode: only documents in this folder (Vectros folder id)."),
|
|
10464
|
+
userId: z12.string().optional().describe("List mode: scope to documents owned by this user."),
|
|
10465
|
+
scope: z12.string().optional().describe(
|
|
10256
10466
|
'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.'
|
|
10257
10467
|
),
|
|
10258
|
-
startFrom:
|
|
10259
|
-
limit:
|
|
10468
|
+
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."),
|
|
10469
|
+
limit: z12.number().int().min(1).max(MCP_MAX_LIMIT3).optional().describe(
|
|
10260
10470
|
`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.`
|
|
10261
10471
|
)
|
|
10262
10472
|
};
|
|
@@ -10264,7 +10474,7 @@ var documentQuery = ({ client, log }) => ({
|
|
|
10264
10474
|
name: "document_query",
|
|
10265
10475
|
title: "Document query (list or lookup)",
|
|
10266
10476
|
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.",
|
|
10267
|
-
inputSchema:
|
|
10477
|
+
inputSchema: inputSchema12,
|
|
10268
10478
|
handler: async (args) => {
|
|
10269
10479
|
const limit = args.limit ?? MCP_DEFAULT_LIMIT3;
|
|
10270
10480
|
const field = args.field;
|
|
@@ -10344,29 +10554,29 @@ var documentQuery = ({ client, log }) => ({
|
|
|
10344
10554
|
var document_query_default = documentQuery;
|
|
10345
10555
|
|
|
10346
10556
|
// src/tools/document_update.ts
|
|
10347
|
-
import { z as
|
|
10348
|
-
var
|
|
10349
|
-
documentId:
|
|
10350
|
-
externalId:
|
|
10557
|
+
import { z as z13 } from "zod";
|
|
10558
|
+
var inputSchema13 = {
|
|
10559
|
+
documentId: z13.string().optional().describe("The Vectros document id to update. Provide this OR externalId+type."),
|
|
10560
|
+
externalId: z13.string().optional().describe(
|
|
10351
10561
|
"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."
|
|
10352
10562
|
),
|
|
10353
|
-
type:
|
|
10354
|
-
title:
|
|
10355
|
-
fields:
|
|
10563
|
+
type: z13.string().optional().describe("Document type \u2014 REQUIRED when selecting by `externalId` (externalId is unique within a type)."),
|
|
10564
|
+
title: z13.string().optional().describe("New title. Omit to keep the current title."),
|
|
10565
|
+
fields: z13.record(z13.string(), z13.unknown()).optional().describe(
|
|
10356
10566
|
"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."
|
|
10357
10567
|
),
|
|
10358
|
-
text:
|
|
10568
|
+
text: z13.string().optional().describe(
|
|
10359
10569
|
"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."
|
|
10360
10570
|
),
|
|
10361
|
-
folderId:
|
|
10362
|
-
status:
|
|
10571
|
+
folderId: z13.string().optional().describe("Move the document into this folder (cannot be cleared once set)."),
|
|
10572
|
+
status: z13.enum(["ACTIVE", "ARCHIVED"]).optional().describe(
|
|
10363
10573
|
"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."
|
|
10364
10574
|
),
|
|
10365
|
-
userId:
|
|
10366
|
-
scopes:
|
|
10575
|
+
userId: z13.string().optional().describe("Reassign the owning user (Vectros UUID)."),
|
|
10576
|
+
scopes: z13.array(z13.string()).optional().describe(
|
|
10367
10577
|
'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).'
|
|
10368
10578
|
),
|
|
10369
|
-
expectedVersion:
|
|
10579
|
+
expectedVersion: z13.number().int().optional().describe(
|
|
10370
10580
|
"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."
|
|
10371
10581
|
)
|
|
10372
10582
|
};
|
|
@@ -10374,7 +10584,7 @@ var documentUpdate = ({ client, log }) => ({
|
|
|
10374
10584
|
name: "document_update",
|
|
10375
10585
|
title: "Update a document",
|
|
10376
10586
|
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.',
|
|
10377
|
-
inputSchema:
|
|
10587
|
+
inputSchema: inputSchema13,
|
|
10378
10588
|
handler: async (args) => {
|
|
10379
10589
|
const documentId = args.documentId;
|
|
10380
10590
|
const externalId = args.externalId;
|
|
@@ -10414,15 +10624,15 @@ var documentUpdate = ({ client, log }) => ({
|
|
|
10414
10624
|
var document_update_default = documentUpdate;
|
|
10415
10625
|
|
|
10416
10626
|
// src/tools/document_delete.ts
|
|
10417
|
-
import { z as
|
|
10418
|
-
var
|
|
10419
|
-
documentId:
|
|
10627
|
+
import { z as z14 } from "zod";
|
|
10628
|
+
var inputSchema14 = {
|
|
10629
|
+
documentId: z14.string().min(1, "documentId is required").describe("The Vectros document id to delete.")
|
|
10420
10630
|
};
|
|
10421
10631
|
var documentDelete = ({ client, log }) => ({
|
|
10422
10632
|
name: "document_delete",
|
|
10423
10633
|
title: "Delete a document",
|
|
10424
10634
|
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).',
|
|
10425
|
-
inputSchema:
|
|
10635
|
+
inputSchema: inputSchema14,
|
|
10426
10636
|
handler: async (args) => {
|
|
10427
10637
|
const documentId = args.documentId;
|
|
10428
10638
|
try {
|
|
@@ -10440,18 +10650,18 @@ var documentDelete = ({ client, log }) => ({
|
|
|
10440
10650
|
var document_delete_default = documentDelete;
|
|
10441
10651
|
|
|
10442
10652
|
// src/tools/folder_query.ts
|
|
10443
|
-
import { z as
|
|
10653
|
+
import { z as z15 } from "zod";
|
|
10444
10654
|
var MCP_DEFAULT_LIMIT4 = 10;
|
|
10445
10655
|
var MCP_MAX_LIMIT4 = 100;
|
|
10446
|
-
var
|
|
10447
|
-
id:
|
|
10448
|
-
parentId:
|
|
10449
|
-
userId:
|
|
10450
|
-
scope:
|
|
10656
|
+
var inputSchema15 = {
|
|
10657
|
+
id: z15.string().optional().describe("Get mode: fetch this single folder by id."),
|
|
10658
|
+
parentId: z15.string().optional().describe("List mode: direct children of this folder (tree navigation). Omit for a flat tenant list."),
|
|
10659
|
+
userId: z15.string().optional().describe("List mode: scope to folders owned by this user."),
|
|
10660
|
+
scope: z15.string().optional().describe(
|
|
10451
10661
|
'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.'
|
|
10452
10662
|
),
|
|
10453
|
-
startFrom:
|
|
10454
|
-
limit:
|
|
10663
|
+
startFrom: z15.string().optional().describe("List mode: pagination cursor \u2014 pass the `nextCursor` from the previous page to fetch the next."),
|
|
10664
|
+
limit: z15.number().int().min(1).max(MCP_MAX_LIMIT4).optional().describe(
|
|
10455
10665
|
`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\`.`
|
|
10456
10666
|
)
|
|
10457
10667
|
};
|
|
@@ -10459,7 +10669,7 @@ var folderQuery = ({ client, log }) => ({
|
|
|
10459
10669
|
name: "folder_query",
|
|
10460
10670
|
title: "Folder query (list or get)",
|
|
10461
10671
|
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.",
|
|
10462
|
-
inputSchema:
|
|
10672
|
+
inputSchema: inputSchema15,
|
|
10463
10673
|
handler: async (args) => {
|
|
10464
10674
|
const id = args.id;
|
|
10465
10675
|
try {
|
|
@@ -10489,14 +10699,14 @@ var folderQuery = ({ client, log }) => ({
|
|
|
10489
10699
|
var folder_query_default = folderQuery;
|
|
10490
10700
|
|
|
10491
10701
|
// src/tools/folder_create.ts
|
|
10492
|
-
import { z as
|
|
10493
|
-
var
|
|
10494
|
-
name:
|
|
10495
|
-
description:
|
|
10496
|
-
parentId:
|
|
10497
|
-
slug:
|
|
10498
|
-
userId:
|
|
10499
|
-
scopes:
|
|
10702
|
+
import { z as z16 } from "zod";
|
|
10703
|
+
var inputSchema16 = {
|
|
10704
|
+
name: z16.string().min(1, "name is required").describe("Folder display name."),
|
|
10705
|
+
description: z16.string().optional().describe("Optional description of the folder's purpose."),
|
|
10706
|
+
parentId: z16.string().optional().describe("Parent folder id \u2014 places the folder under this parent. Omit for the context default root. Create-only."),
|
|
10707
|
+
slug: z16.string().optional().describe("Optional stable slug (sibling-unique; idempotency key). Lowercase letters/digits/hyphens. Derived from name when omitted."),
|
|
10708
|
+
userId: z16.string().optional().describe("Owning user (Vectros UUID)."),
|
|
10709
|
+
scopes: z16.array(z16.string()).optional().describe(
|
|
10500
10710
|
'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.'
|
|
10501
10711
|
)
|
|
10502
10712
|
};
|
|
@@ -10504,7 +10714,7 @@ var folderCreate = ({ client, log }) => ({
|
|
|
10504
10714
|
name: "folder_create",
|
|
10505
10715
|
title: "Create a folder",
|
|
10506
10716
|
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).",
|
|
10507
|
-
inputSchema:
|
|
10717
|
+
inputSchema: inputSchema16,
|
|
10508
10718
|
handler: async (args) => {
|
|
10509
10719
|
try {
|
|
10510
10720
|
const folder = await client.folders.createFolder({
|
|
@@ -10528,16 +10738,16 @@ var folderCreate = ({ client, log }) => ({
|
|
|
10528
10738
|
var folder_create_default = folderCreate;
|
|
10529
10739
|
|
|
10530
10740
|
// src/tools/folder_update.ts
|
|
10531
|
-
import { z as
|
|
10532
|
-
var
|
|
10533
|
-
id:
|
|
10534
|
-
name:
|
|
10535
|
-
description:
|
|
10536
|
-
userId:
|
|
10537
|
-
scopes:
|
|
10741
|
+
import { z as z17 } from "zod";
|
|
10742
|
+
var inputSchema17 = {
|
|
10743
|
+
id: z17.string().min(1, "id is required").describe("The Vectros folder id to update."),
|
|
10744
|
+
name: z17.string().optional().describe("New folder name. Omit to keep the current name."),
|
|
10745
|
+
description: z17.string().optional().describe("New description. Omit to leave unchanged."),
|
|
10746
|
+
userId: z17.string().optional().describe("Reassign the owning user (Vectros UUID)."),
|
|
10747
|
+
scopes: z17.array(z17.string()).optional().describe(
|
|
10538
10748
|
'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).'
|
|
10539
10749
|
),
|
|
10540
|
-
expectedVersion:
|
|
10750
|
+
expectedVersion: z17.number().int().optional().describe(
|
|
10541
10751
|
"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."
|
|
10542
10752
|
)
|
|
10543
10753
|
};
|
|
@@ -10545,7 +10755,7 @@ var folderUpdate = ({ client, log }) => ({
|
|
|
10545
10755
|
name: "folder_update",
|
|
10546
10756
|
title: "Update a folder",
|
|
10547
10757
|
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.",
|
|
10548
|
-
inputSchema:
|
|
10758
|
+
inputSchema: inputSchema17,
|
|
10549
10759
|
handler: async (args) => {
|
|
10550
10760
|
const id = args.id;
|
|
10551
10761
|
const name = args.name;
|
|
@@ -10572,15 +10782,15 @@ var folderUpdate = ({ client, log }) => ({
|
|
|
10572
10782
|
var folder_update_default = folderUpdate;
|
|
10573
10783
|
|
|
10574
10784
|
// src/tools/folder_delete.ts
|
|
10575
|
-
import { z as
|
|
10576
|
-
var
|
|
10577
|
-
id:
|
|
10785
|
+
import { z as z18 } from "zod";
|
|
10786
|
+
var inputSchema18 = {
|
|
10787
|
+
id: z18.string().min(1, "id is required").describe("The Vectros folder id to delete.")
|
|
10578
10788
|
};
|
|
10579
10789
|
var folderDelete = ({ client, log }) => ({
|
|
10580
10790
|
name: "folder_delete",
|
|
10581
10791
|
title: "Delete a folder",
|
|
10582
10792
|
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.",
|
|
10583
|
-
inputSchema:
|
|
10793
|
+
inputSchema: inputSchema18,
|
|
10584
10794
|
handler: async (args) => {
|
|
10585
10795
|
const id = args.id;
|
|
10586
10796
|
try {
|
|
@@ -10596,14 +10806,14 @@ var folderDelete = ({ client, log }) => ({
|
|
|
10596
10806
|
var folder_delete_default = folderDelete;
|
|
10597
10807
|
|
|
10598
10808
|
// src/tools/current_identity.ts
|
|
10599
|
-
var
|
|
10809
|
+
var inputSchema19 = {
|
|
10600
10810
|
// No args — current_identity describes the current credential.
|
|
10601
10811
|
};
|
|
10602
10812
|
var currentIdentity = ({ log, apiKey, environment }) => ({
|
|
10603
10813
|
name: "current_identity",
|
|
10604
10814
|
title: "Current identity (tenant + principal scope)",
|
|
10605
|
-
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
|
|
10606
|
-
inputSchema:
|
|
10815
|
+
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.",
|
|
10816
|
+
inputSchema: inputSchema19,
|
|
10607
10817
|
handler: async () => {
|
|
10608
10818
|
try {
|
|
10609
10819
|
const identity = await resolveIdentity({ log, apiKey, environment });
|
|
@@ -10619,7 +10829,7 @@ var currentIdentity = ({ log, apiKey, environment }) => ({
|
|
|
10619
10829
|
var current_identity_default = currentIdentity;
|
|
10620
10830
|
|
|
10621
10831
|
// src/tools/document_ingest.ts
|
|
10622
|
-
import { z as
|
|
10832
|
+
import { z as z19 } from "zod";
|
|
10623
10833
|
import { readFile, realpath } from "fs/promises";
|
|
10624
10834
|
import { basename, extname, resolve, relative, isAbsolute } from "path";
|
|
10625
10835
|
var IngestPathError = class extends Error {
|
|
@@ -10694,37 +10904,37 @@ function inferMimeType(filePath) {
|
|
|
10694
10904
|
const ext = extname(filePath).toLowerCase();
|
|
10695
10905
|
return EXT_TO_MIME[ext] ?? "application/octet-stream";
|
|
10696
10906
|
}
|
|
10697
|
-
var
|
|
10698
|
-
title:
|
|
10699
|
-
indexMode:
|
|
10907
|
+
var inputSchema20 = {
|
|
10908
|
+
title: z19.string().min(1, "title is required").describe("Human-readable document title \u2014 appears in search results and the UI."),
|
|
10909
|
+
indexMode: z19.enum(["HYBRID", "SEMANTIC", "TEXT", "NONE"]).optional().describe(
|
|
10700
10910
|
"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."
|
|
10701
10911
|
),
|
|
10702
|
-
externalId:
|
|
10912
|
+
externalId: z19.string().optional().describe(
|
|
10703
10913
|
'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.'
|
|
10704
10914
|
),
|
|
10705
|
-
upsert:
|
|
10915
|
+
upsert: z19.boolean().optional().describe(
|
|
10706
10916
|
"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)."
|
|
10707
10917
|
),
|
|
10708
|
-
schemaId:
|
|
10918
|
+
schemaId: z19.string().optional().describe(
|
|
10709
10919
|
"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."
|
|
10710
10920
|
),
|
|
10711
|
-
payload:
|
|
10921
|
+
payload: z19.record(z19.string(), z19.unknown()).optional().describe(
|
|
10712
10922
|
"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."
|
|
10713
10923
|
),
|
|
10714
10924
|
// Inline text mode (mutually exclusive with filePath):
|
|
10715
|
-
text:
|
|
10716
|
-
storeText:
|
|
10925
|
+
text: z19.string().min(1).optional().describe("Text body to ingest inline. Mutually exclusive with filePath. Either text or filePath is required."),
|
|
10926
|
+
storeText: z19.boolean().optional().describe(
|
|
10717
10927
|
"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."
|
|
10718
10928
|
),
|
|
10719
10929
|
// File upload mode (mutually exclusive with text; stdio-transport-only):
|
|
10720
|
-
filePath:
|
|
10930
|
+
filePath: z19.string().min(1).optional().describe(
|
|
10721
10931
|
"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."
|
|
10722
10932
|
),
|
|
10723
|
-
fileType:
|
|
10933
|
+
fileType: z19.string().optional().describe('MIME type of the file (e.g. "application/pdf"). Inferred from filePath extension if omitted.'),
|
|
10724
10934
|
// Common (both modes):
|
|
10725
|
-
folderId:
|
|
10726
|
-
userId:
|
|
10727
|
-
scopes:
|
|
10935
|
+
folderId: z19.string().optional().describe("Optional folder to ingest into. Default: tenant root."),
|
|
10936
|
+
userId: z19.string().optional().describe("Owning user ID. Optional."),
|
|
10937
|
+
scopes: z19.array(z19.string()).optional().describe(
|
|
10728
10938
|
"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."
|
|
10729
10939
|
)
|
|
10730
10940
|
};
|
|
@@ -10732,7 +10942,7 @@ var documentIngest = ({ client, log, transport, ingestRoot }) => ({
|
|
|
10732
10942
|
name: "document_ingest",
|
|
10733
10943
|
title: "Ingest a new document (text body or file upload)",
|
|
10734
10944
|
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`.",
|
|
10735
|
-
inputSchema:
|
|
10945
|
+
inputSchema: inputSchema20,
|
|
10736
10946
|
handler: async (args) => {
|
|
10737
10947
|
const title = args.title;
|
|
10738
10948
|
const text = args.text;
|
|
@@ -10884,29 +11094,29 @@ var documentIngest = ({ client, log, transport, ingestRoot }) => ({
|
|
|
10884
11094
|
var document_ingest_default = documentIngest;
|
|
10885
11095
|
|
|
10886
11096
|
// src/tools/lookup_principal.ts
|
|
10887
|
-
import { z as
|
|
11097
|
+
import { z as z20 } from "zod";
|
|
10888
11098
|
var MCP_DEFAULT_LIMIT5 = 10;
|
|
10889
11099
|
var MCP_MAX_LIMIT5 = 100;
|
|
10890
|
-
var
|
|
10891
|
-
kind:
|
|
11100
|
+
var inputSchema21 = {
|
|
11101
|
+
kind: z20.string().describe(
|
|
10892
11102
|
'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.'
|
|
10893
11103
|
),
|
|
10894
|
-
externalId:
|
|
11104
|
+
externalId: z20.string().optional().describe(
|
|
10895
11105
|
"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."
|
|
10896
11106
|
),
|
|
10897
|
-
contextId:
|
|
11107
|
+
contextId: z20.string().optional().describe(
|
|
10898
11108
|
"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."
|
|
10899
11109
|
),
|
|
10900
11110
|
// Lookup-mode args — provide `field` plus EXACTLY ONE of: value | from+to | prefix.
|
|
10901
|
-
type:
|
|
10902
|
-
field:
|
|
10903
|
-
value:
|
|
10904
|
-
from:
|
|
10905
|
-
to:
|
|
10906
|
-
prefix:
|
|
10907
|
-
order:
|
|
10908
|
-
startFrom:
|
|
10909
|
-
limit:
|
|
11111
|
+
type: z20.string().optional().describe('Lookup mode: the identity schema\'s record type (e.g. "person_v1"). Required with `field`.'),
|
|
11112
|
+
field: z20.string().optional().describe('Lookup mode: name of the schema-declared lookup field to query by (e.g. "email").'),
|
|
11113
|
+
value: z20.string().optional().describe("Lookup mode (equality): exact-match value for `field`. Works on sensitive fields."),
|
|
11114
|
+
from: z20.string().optional().describe("Lookup mode (range): inclusive lower bound; requires `to`. Non-sensitive fields only."),
|
|
11115
|
+
to: z20.string().optional().describe("Lookup mode (range): inclusive upper bound; requires `from`."),
|
|
11116
|
+
prefix: z20.string().optional().describe("Lookup mode (prefix): match values starting with this. Range-enabled string fields only."),
|
|
11117
|
+
order: z20.enum(["asc", "desc"]).optional().describe("Lookup mode: sort direction by the looked-up field. `asc` (default) or `desc`."),
|
|
11118
|
+
startFrom: z20.string().optional().describe("Lookup mode: pagination cursor \u2014 pass the `nextCursor` from the previous page to fetch the next."),
|
|
11119
|
+
limit: z20.number().int().min(1).max(MCP_MAX_LIMIT5).optional().describe(
|
|
10910
11120
|
`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\`.`
|
|
10911
11121
|
)
|
|
10912
11122
|
};
|
|
@@ -10914,7 +11124,7 @@ var lookupPrincipal = ({ client, log }) => ({
|
|
|
10914
11124
|
name: "lookup_principal",
|
|
10915
11125
|
title: "Look up a user identity or a namespaced identity entity",
|
|
10916
11126
|
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.",
|
|
10917
|
-
inputSchema:
|
|
11127
|
+
inputSchema: inputSchema21,
|
|
10918
11128
|
handler: async (args) => {
|
|
10919
11129
|
const kind = args.kind;
|
|
10920
11130
|
const isUser = kind === "user";
|
|
@@ -10988,17 +11198,17 @@ var lookupPrincipal = ({ client, log }) => ({
|
|
|
10988
11198
|
var lookup_principal_default = lookupPrincipal;
|
|
10989
11199
|
|
|
10990
11200
|
// src/tools/version_history.ts
|
|
10991
|
-
import { z as
|
|
10992
|
-
var
|
|
10993
|
-
resourceType:
|
|
10994
|
-
id:
|
|
10995
|
-
startFrom:
|
|
11201
|
+
import { z as z21 } from "zod";
|
|
11202
|
+
var inputSchema22 = {
|
|
11203
|
+
resourceType: z21.enum(["record", "document"]).describe("Which kind of entity the id refers to: a record or a document."),
|
|
11204
|
+
id: z21.string().min(1, "id is required").describe("The Vectros id of the record or document whose history you want."),
|
|
11205
|
+
startFrom: z21.string().optional().describe("Pagination cursor \u2014 pass the `nextCursor` from the previous page to fetch older entries.")
|
|
10996
11206
|
};
|
|
10997
11207
|
var versionHistory = ({ client, log }) => ({
|
|
10998
11208
|
name: "version_history",
|
|
10999
11209
|
title: "Version history (record or document)",
|
|
11000
11210
|
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.",
|
|
11001
|
-
inputSchema:
|
|
11211
|
+
inputSchema: inputSchema22,
|
|
11002
11212
|
handler: async (args) => {
|
|
11003
11213
|
const resourceType = args.resourceType;
|
|
11004
11214
|
const id = args.id;
|
|
@@ -11025,6 +11235,7 @@ var TOOL_NAMES = [
|
|
|
11025
11235
|
"hybrid_search",
|
|
11026
11236
|
"record_query",
|
|
11027
11237
|
"record_get",
|
|
11238
|
+
"record_batch_get",
|
|
11028
11239
|
"record_create",
|
|
11029
11240
|
"record_update",
|
|
11030
11241
|
"record_delete",
|
|
@@ -11050,6 +11261,7 @@ var ALL_TOOL_FACTORIES = {
|
|
|
11050
11261
|
hybrid_search: hybrid_search_default,
|
|
11051
11262
|
record_query: record_query_default,
|
|
11052
11263
|
record_get: record_get_default,
|
|
11264
|
+
record_batch_get: record_batch_get_default,
|
|
11053
11265
|
record_create: record_create_default,
|
|
11054
11266
|
record_update: record_update_default,
|
|
11055
11267
|
record_delete: record_delete_default,
|
|
@@ -11091,7 +11303,7 @@ var identityResource = ({ log, apiKey, environment }) => ({
|
|
|
11091
11303
|
name: "identity",
|
|
11092
11304
|
uri: "vectros://identity",
|
|
11093
11305
|
title: "Current identity (tenant + principal scope)",
|
|
11094
|
-
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
|
|
11306
|
+
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.",
|
|
11095
11307
|
mimeType: "application/json",
|
|
11096
11308
|
read: async () => {
|
|
11097
11309
|
const identity = await resolveIdentity({ log, apiKey, environment });
|
|
@@ -11110,7 +11322,7 @@ var ALL_RESOURCE_FACTORIES = {
|
|
|
11110
11322
|
};
|
|
11111
11323
|
|
|
11112
11324
|
// src/zod-to-json-schema.ts
|
|
11113
|
-
import { z as
|
|
11325
|
+
import { z as z22 } from "zod";
|
|
11114
11326
|
function zodShapeToJsonSchema(shape) {
|
|
11115
11327
|
const properties = {};
|
|
11116
11328
|
const required = [];
|
|
@@ -11125,40 +11337,40 @@ function zodShapeToJsonSchema(shape) {
|
|
|
11125
11337
|
function zodTypeToJsonSchema(schema) {
|
|
11126
11338
|
const description = schema.description;
|
|
11127
11339
|
let current = schema;
|
|
11128
|
-
while (current instanceof
|
|
11340
|
+
while (current instanceof z22.ZodOptional || current instanceof z22.ZodDefault || current instanceof z22.ZodNullable) {
|
|
11129
11341
|
current = current._def.innerType;
|
|
11130
11342
|
}
|
|
11131
11343
|
const base = description ? { description } : {};
|
|
11132
|
-
if (current instanceof
|
|
11344
|
+
if (current instanceof z22.ZodString) {
|
|
11133
11345
|
return { ...base, type: "string" };
|
|
11134
11346
|
}
|
|
11135
|
-
if (current instanceof
|
|
11347
|
+
if (current instanceof z22.ZodNumber) {
|
|
11136
11348
|
return { ...base, type: "number" };
|
|
11137
11349
|
}
|
|
11138
|
-
if (current instanceof
|
|
11350
|
+
if (current instanceof z22.ZodBoolean) {
|
|
11139
11351
|
return { ...base, type: "boolean" };
|
|
11140
11352
|
}
|
|
11141
|
-
if (current instanceof
|
|
11353
|
+
if (current instanceof z22.ZodEnum) {
|
|
11142
11354
|
return {
|
|
11143
11355
|
...base,
|
|
11144
11356
|
type: "string",
|
|
11145
11357
|
enum: current.options
|
|
11146
11358
|
};
|
|
11147
11359
|
}
|
|
11148
|
-
if (current instanceof
|
|
11360
|
+
if (current instanceof z22.ZodArray) {
|
|
11149
11361
|
return {
|
|
11150
11362
|
...base,
|
|
11151
11363
|
type: "array",
|
|
11152
11364
|
items: zodTypeToJsonSchema(current.element)
|
|
11153
11365
|
};
|
|
11154
11366
|
}
|
|
11155
|
-
if (current instanceof
|
|
11367
|
+
if (current instanceof z22.ZodObject) {
|
|
11156
11368
|
return {
|
|
11157
11369
|
...base,
|
|
11158
11370
|
...zodShapeToJsonSchema(current.shape)
|
|
11159
11371
|
};
|
|
11160
11372
|
}
|
|
11161
|
-
if (current instanceof
|
|
11373
|
+
if (current instanceof z22.ZodRecord) {
|
|
11162
11374
|
const valueType = current._def.valueType;
|
|
11163
11375
|
return {
|
|
11164
11376
|
...base,
|
|
@@ -11282,7 +11494,7 @@ var VectrosMCPServer = class {
|
|
|
11282
11494
|
if (!tool) {
|
|
11283
11495
|
result = toolError(req.params.name ?? "unknown", new Error("No such tool."));
|
|
11284
11496
|
} else {
|
|
11285
|
-
const parsed =
|
|
11497
|
+
const parsed = z23.object(tool.inputSchema).strict().safeParse(req.params.arguments ?? {});
|
|
11286
11498
|
if (!parsed.success) {
|
|
11287
11499
|
result = toolError(tool.name, new Error(formatArgError(tool, parsed.error)));
|
|
11288
11500
|
} else {
|