@vectros-ai/mcp-server 0.15.0 → 0.16.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +17 -0
- package/README.md +3 -2
- package/dist/cli-http.js +401 -205
- package/dist/cli-http.js.map +1 -1
- package/dist/cli-http.mjs +401 -205
- package/dist/cli-http.mjs.map +1 -1
- package/dist/cli.js +401 -205
- package/dist/cli.js.map +1 -1
- package/dist/cli.mjs +401 -205
- 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 +401 -205
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +401 -205
- package/dist/index.mjs.map +1 -1
- package/package.json +2 -2
package/dist/cli-http.js
CHANGED
|
@@ -2515,7 +2515,7 @@ var AuthClient = class {
|
|
|
2515
2515
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/admin/keys/scoped");
|
|
2516
2516
|
}
|
|
2517
2517
|
/**
|
|
2518
|
-
* 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
|
|
2518
|
+
* 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.
|
|
2519
2519
|
*
|
|
2520
2520
|
* @param {Vectros.CreateScopedKeyRequest} request
|
|
2521
2521
|
* @param {AuthClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -4011,7 +4011,7 @@ var AuthClient = class {
|
|
|
4011
4011
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/usage");
|
|
4012
4012
|
}
|
|
4013
4013
|
/**
|
|
4014
|
-
* 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.
|
|
4014
|
+
* 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.
|
|
4015
4015
|
*
|
|
4016
4016
|
* @param {Vectros.GetIssuerRequest} request
|
|
4017
4017
|
* @param {AuthClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -4068,6 +4068,73 @@ var AuthClient = class {
|
|
|
4068
4068
|
}
|
|
4069
4069
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/auth/issuers/{issuerId}");
|
|
4070
4070
|
}
|
|
4071
|
+
/**
|
|
4072
|
+
* 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.
|
|
4073
|
+
*
|
|
4074
|
+
* @param {Vectros.IssuerUpdateRequest} request
|
|
4075
|
+
* @param {AuthClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
4076
|
+
*
|
|
4077
|
+
* @throws {@link Vectros.BadRequestError}
|
|
4078
|
+
* @throws {@link Vectros.ForbiddenError}
|
|
4079
|
+
* @throws {@link Vectros.NotFoundError}
|
|
4080
|
+
* @throws {@link Vectros.TooManyRequestsError}
|
|
4081
|
+
*
|
|
4082
|
+
* @example
|
|
4083
|
+
* await client.auth.updateIssuer({
|
|
4084
|
+
* issuerId: "auth0-prod"
|
|
4085
|
+
* })
|
|
4086
|
+
*/
|
|
4087
|
+
updateIssuer(request, requestOptions) {
|
|
4088
|
+
return HttpResponsePromise.fromPromise(this.__updateIssuer(request, requestOptions));
|
|
4089
|
+
}
|
|
4090
|
+
async __updateIssuer(request, requestOptions) {
|
|
4091
|
+
const { issuerId, ..._body } = request;
|
|
4092
|
+
const _authRequest = await this._options.authProvider.getAuthRequest();
|
|
4093
|
+
const _headers = mergeHeaders(
|
|
4094
|
+
_authRequest.headers,
|
|
4095
|
+
this._options?.headers,
|
|
4096
|
+
requestOptions?.headers
|
|
4097
|
+
);
|
|
4098
|
+
const _response = await fetcher({
|
|
4099
|
+
url: url_exports.join(
|
|
4100
|
+
await Supplier.get(this._options.baseUrl) ?? await Supplier.get(this._options.environment),
|
|
4101
|
+
`v1/auth/issuers/${url_exports.encodePathParam(issuerId)}`
|
|
4102
|
+
),
|
|
4103
|
+
method: "PUT",
|
|
4104
|
+
headers: _headers,
|
|
4105
|
+
contentType: "application/json",
|
|
4106
|
+
queryString: url_exports.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
|
|
4107
|
+
requestType: "json",
|
|
4108
|
+
body: _body,
|
|
4109
|
+
timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1e3,
|
|
4110
|
+
maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
|
|
4111
|
+
abortSignal: requestOptions?.abortSignal,
|
|
4112
|
+
fetchFn: this._options?.fetch,
|
|
4113
|
+
logging: this._options.logging
|
|
4114
|
+
});
|
|
4115
|
+
if (_response.ok) {
|
|
4116
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
4117
|
+
}
|
|
4118
|
+
if (_response.error.reason === "status-code") {
|
|
4119
|
+
switch (_response.error.statusCode) {
|
|
4120
|
+
case 400:
|
|
4121
|
+
throw new BadRequestError(_response.error.body, _response.rawResponse);
|
|
4122
|
+
case 403:
|
|
4123
|
+
throw new ForbiddenError(_response.error.body, _response.rawResponse);
|
|
4124
|
+
case 404:
|
|
4125
|
+
throw new NotFoundError(_response.error.body, _response.rawResponse);
|
|
4126
|
+
case 429:
|
|
4127
|
+
throw new TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
4128
|
+
default:
|
|
4129
|
+
throw new VectrosError({
|
|
4130
|
+
statusCode: _response.error.statusCode,
|
|
4131
|
+
body: _response.error.body,
|
|
4132
|
+
rawResponse: _response.rawResponse
|
|
4133
|
+
});
|
|
4134
|
+
}
|
|
4135
|
+
}
|
|
4136
|
+
return handleNonStatusCodeError(_response.error, _response.rawResponse, "PUT", "/v1/auth/issuers/{issuerId}");
|
|
4137
|
+
}
|
|
4071
4138
|
/**
|
|
4072
4139
|
* 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.
|
|
4073
4140
|
*
|
|
@@ -4138,7 +4205,7 @@ var AuthClient = class {
|
|
|
4138
4205
|
);
|
|
4139
4206
|
}
|
|
4140
4207
|
/**
|
|
4141
|
-
* 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.
|
|
4208
|
+
* 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.
|
|
4142
4209
|
*
|
|
4143
4210
|
* @param {Vectros.ListIssuersRequest} request
|
|
4144
4211
|
* @param {AuthClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -4195,7 +4262,7 @@ var AuthClient = class {
|
|
|
4195
4262
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/auth/issuers");
|
|
4196
4263
|
}
|
|
4197
4264
|
/**
|
|
4198
|
-
* 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`.
|
|
4265
|
+
* 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`.
|
|
4199
4266
|
*
|
|
4200
4267
|
* @param {Vectros.IssuerRequest} request
|
|
4201
4268
|
* @param {AuthClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -4380,6 +4447,7 @@ var AuthClient = class {
|
|
|
4380
4447
|
*
|
|
4381
4448
|
* @throws {@link Vectros.BadRequestError}
|
|
4382
4449
|
* @throws {@link Vectros.ForbiddenError}
|
|
4450
|
+
* @throws {@link Vectros.NotFoundError}
|
|
4383
4451
|
* @throws {@link Vectros.TooManyRequestsError}
|
|
4384
4452
|
*
|
|
4385
4453
|
* @example
|
|
@@ -4433,6 +4501,8 @@ var AuthClient = class {
|
|
|
4433
4501
|
throw new BadRequestError(_response.error.body, _response.rawResponse);
|
|
4434
4502
|
case 403:
|
|
4435
4503
|
throw new ForbiddenError(_response.error.body, _response.rawResponse);
|
|
4504
|
+
case 404:
|
|
4505
|
+
throw new NotFoundError(_response.error.body, _response.rawResponse);
|
|
4436
4506
|
case 429:
|
|
4437
4507
|
throw new TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
4438
4508
|
default:
|
|
@@ -4584,6 +4654,83 @@ var AuthClient = class {
|
|
|
4584
4654
|
}
|
|
4585
4655
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v1/users/invite/resend");
|
|
4586
4656
|
}
|
|
4657
|
+
/**
|
|
4658
|
+
* 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).
|
|
4659
|
+
*
|
|
4660
|
+
* **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.
|
|
4661
|
+
*
|
|
4662
|
+
* **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.
|
|
4663
|
+
*
|
|
4664
|
+
* **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.
|
|
4665
|
+
*
|
|
4666
|
+
* 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.
|
|
4667
|
+
*
|
|
4668
|
+
* @param {Record<string, unknown>} request
|
|
4669
|
+
* @param {AuthClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
4670
|
+
*
|
|
4671
|
+
* @throws {@link Vectros.BadRequestError}
|
|
4672
|
+
* @throws {@link Vectros.UnauthorizedError}
|
|
4673
|
+
* @throws {@link Vectros.ForbiddenError}
|
|
4674
|
+
* @throws {@link Vectros.ConflictError}
|
|
4675
|
+
* @throws {@link Vectros.TooManyRequestsError}
|
|
4676
|
+
*
|
|
4677
|
+
* @example
|
|
4678
|
+
* await client.auth.assumeToken({
|
|
4679
|
+
* "scope:org": "orgB"
|
|
4680
|
+
* })
|
|
4681
|
+
*/
|
|
4682
|
+
assumeToken(request, requestOptions) {
|
|
4683
|
+
return HttpResponsePromise.fromPromise(this.__assumeToken(request, requestOptions));
|
|
4684
|
+
}
|
|
4685
|
+
async __assumeToken(request, requestOptions) {
|
|
4686
|
+
const _authRequest = await this._options.authProvider.getAuthRequest();
|
|
4687
|
+
const _headers = mergeHeaders(
|
|
4688
|
+
_authRequest.headers,
|
|
4689
|
+
this._options?.headers,
|
|
4690
|
+
requestOptions?.headers
|
|
4691
|
+
);
|
|
4692
|
+
const _response = await fetcher({
|
|
4693
|
+
url: url_exports.join(
|
|
4694
|
+
await Supplier.get(this._options.baseUrl) ?? await Supplier.get(this._options.environment),
|
|
4695
|
+
"v1/auth/token/assume"
|
|
4696
|
+
),
|
|
4697
|
+
method: "POST",
|
|
4698
|
+
headers: _headers,
|
|
4699
|
+
contentType: "application/json",
|
|
4700
|
+
queryString: url_exports.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
|
|
4701
|
+
requestType: "json",
|
|
4702
|
+
body: request,
|
|
4703
|
+
timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1e3,
|
|
4704
|
+
maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
|
|
4705
|
+
abortSignal: requestOptions?.abortSignal,
|
|
4706
|
+
fetchFn: this._options?.fetch,
|
|
4707
|
+
logging: this._options.logging
|
|
4708
|
+
});
|
|
4709
|
+
if (_response.ok) {
|
|
4710
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
4711
|
+
}
|
|
4712
|
+
if (_response.error.reason === "status-code") {
|
|
4713
|
+
switch (_response.error.statusCode) {
|
|
4714
|
+
case 400:
|
|
4715
|
+
throw new BadRequestError(_response.error.body, _response.rawResponse);
|
|
4716
|
+
case 401:
|
|
4717
|
+
throw new UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
4718
|
+
case 403:
|
|
4719
|
+
throw new ForbiddenError(_response.error.body, _response.rawResponse);
|
|
4720
|
+
case 409:
|
|
4721
|
+
throw new ConflictError(_response.error.body, _response.rawResponse);
|
|
4722
|
+
case 429:
|
|
4723
|
+
throw new TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
4724
|
+
default:
|
|
4725
|
+
throw new VectrosError({
|
|
4726
|
+
statusCode: _response.error.statusCode,
|
|
4727
|
+
body: _response.error.body,
|
|
4728
|
+
rawResponse: _response.rawResponse
|
|
4729
|
+
});
|
|
4730
|
+
}
|
|
4731
|
+
}
|
|
4732
|
+
return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v1/auth/token/assume");
|
|
4733
|
+
}
|
|
4587
4734
|
/**
|
|
4588
4735
|
* 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.
|
|
4589
4736
|
*
|
|
@@ -4661,9 +4808,9 @@ var ComplianceClient = class {
|
|
|
4661
4808
|
* @param {Vectros.ErasureRequest} request
|
|
4662
4809
|
* @param {ComplianceClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
4663
4810
|
*
|
|
4811
|
+
* @throws {@link Vectros.BadRequestError}
|
|
4664
4812
|
* @throws {@link Vectros.ForbiddenError}
|
|
4665
4813
|
* @throws {@link Vectros.TooManyRequestsError}
|
|
4666
|
-
* @throws {@link Vectros.NotImplementedError}
|
|
4667
4814
|
*
|
|
4668
4815
|
* @example
|
|
4669
4816
|
* await client.compliance.createErasureRequest({
|
|
@@ -4702,12 +4849,12 @@ var ComplianceClient = class {
|
|
|
4702
4849
|
}
|
|
4703
4850
|
if (_response.error.reason === "status-code") {
|
|
4704
4851
|
switch (_response.error.statusCode) {
|
|
4852
|
+
case 400:
|
|
4853
|
+
throw new BadRequestError(_response.error.body, _response.rawResponse);
|
|
4705
4854
|
case 403:
|
|
4706
4855
|
throw new ForbiddenError(_response.error.body, _response.rawResponse);
|
|
4707
4856
|
case 429:
|
|
4708
4857
|
throw new TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
4709
|
-
case 501:
|
|
4710
|
-
throw new NotImplementedError(_response.error.body, _response.rawResponse);
|
|
4711
4858
|
default:
|
|
4712
4859
|
throw new VectrosError({
|
|
4713
4860
|
statusCode: _response.error.statusCode,
|
|
@@ -4726,7 +4873,6 @@ var ComplianceClient = class {
|
|
|
4726
4873
|
*
|
|
4727
4874
|
* @throws {@link Vectros.ForbiddenError}
|
|
4728
4875
|
* @throws {@link Vectros.NotFoundError}
|
|
4729
|
-
* @throws {@link Vectros.NotImplementedError}
|
|
4730
4876
|
*
|
|
4731
4877
|
* @example
|
|
4732
4878
|
* await client.compliance.getErasureRequest({
|
|
@@ -4767,8 +4913,6 @@ var ComplianceClient = class {
|
|
|
4767
4913
|
throw new ForbiddenError(_response.error.body, _response.rawResponse);
|
|
4768
4914
|
case 404:
|
|
4769
4915
|
throw new NotFoundError(_response.error.body, _response.rawResponse);
|
|
4770
|
-
case 501:
|
|
4771
|
-
throw new NotImplementedError(_response.error.body, _response.rawResponse);
|
|
4772
4916
|
default:
|
|
4773
4917
|
throw new VectrosError({
|
|
4774
4918
|
statusCode: _response.error.statusCode,
|
|
@@ -6608,7 +6752,7 @@ var IdentityClient = class {
|
|
|
6608
6752
|
);
|
|
6609
6753
|
}
|
|
6610
6754
|
/**
|
|
6611
|
-
* Retrieves a single scope-namespace registration by name.
|
|
6755
|
+
* Retrieves a single scope-namespace registration by name.
|
|
6612
6756
|
*
|
|
6613
6757
|
* @param {Vectros.GetNamespaceRequest} request
|
|
6614
6758
|
* @param {IdentityClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -6801,7 +6945,7 @@ var IdentityClient = class {
|
|
|
6801
6945
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "DELETE", "/v1/namespaces/{namespace}");
|
|
6802
6946
|
}
|
|
6803
6947
|
/**
|
|
6804
|
-
* Returns the scope namespaces in your account
|
|
6948
|
+
* Returns the scope namespaces registered in your account. Returns a `{data, nextCursor}` envelope.
|
|
6805
6949
|
*
|
|
6806
6950
|
* @param {Vectros.ListNamespacesRequest} request
|
|
6807
6951
|
* @param {IdentityClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -6852,7 +6996,7 @@ var IdentityClient = class {
|
|
|
6852
6996
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/namespaces");
|
|
6853
6997
|
}
|
|
6854
6998
|
/**
|
|
6855
|
-
* 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
|
|
6999
|
+
* 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.
|
|
6856
7000
|
*
|
|
6857
7001
|
* @param {Vectros.RegisterNamespaceRequest} request
|
|
6858
7002
|
* @param {IdentityClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -6922,7 +7066,7 @@ var IdentityClient = class {
|
|
|
6922
7066
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v1/namespaces");
|
|
6923
7067
|
}
|
|
6924
7068
|
/**
|
|
6925
|
-
* 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.
|
|
7069
|
+
* 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.
|
|
6926
7070
|
*
|
|
6927
7071
|
* @param {Vectros.ListUsersRequest} request
|
|
6928
7072
|
* @param {IdentityClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -6987,7 +7131,7 @@ var IdentityClient = class {
|
|
|
6987
7131
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/users");
|
|
6988
7132
|
}
|
|
6989
7133
|
/**
|
|
6990
|
-
* 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.
|
|
7134
|
+
* 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`.
|
|
6991
7135
|
*
|
|
6992
7136
|
* @param {Vectros.CreateUserRequest} request
|
|
6993
7137
|
* @param {IdentityClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -7111,7 +7255,7 @@ var IdentityClient = class {
|
|
|
7111
7255
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/users/{id}");
|
|
7112
7256
|
}
|
|
7113
7257
|
/**
|
|
7114
|
-
* 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.
|
|
7258
|
+
* 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.
|
|
7115
7259
|
*
|
|
7116
7260
|
* @param {Vectros.UpdateUserRequest} request
|
|
7117
7261
|
* @param {IdentityClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -7178,7 +7322,7 @@ var IdentityClient = class {
|
|
|
7178
7322
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "PUT", "/v1/users/{id}");
|
|
7179
7323
|
}
|
|
7180
7324
|
/**
|
|
7181
|
-
* 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.
|
|
7325
|
+
* 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.
|
|
7182
7326
|
*
|
|
7183
7327
|
* @param {Vectros.DeleteUserRequest} request
|
|
7184
7328
|
* @param {IdentityClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -7239,7 +7383,7 @@ var IdentityClient = class {
|
|
|
7239
7383
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "DELETE", "/v1/users/{id}");
|
|
7240
7384
|
}
|
|
7241
7385
|
/**
|
|
7242
|
-
* 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.
|
|
7386
|
+
* 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.
|
|
7243
7387
|
*
|
|
7244
7388
|
* @param {Vectros.IdentityLookupRequest} request
|
|
7245
7389
|
* @param {IdentityClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -7682,14 +7826,14 @@ var RecordsClient = class {
|
|
|
7682
7826
|
this._options = normalizeClientOptionsWithAuth(options);
|
|
7683
7827
|
}
|
|
7684
7828
|
/**
|
|
7685
|
-
*
|
|
7829
|
+
* 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).
|
|
7686
7830
|
*
|
|
7687
7831
|
* @param {Vectros.BatchGetRequest} request
|
|
7688
7832
|
* @param {RecordsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
7689
7833
|
*
|
|
7834
|
+
* @throws {@link Vectros.BadRequestError}
|
|
7690
7835
|
* @throws {@link Vectros.ForbiddenError}
|
|
7691
7836
|
* @throws {@link Vectros.TooManyRequestsError}
|
|
7692
|
-
* @throws {@link Vectros.NotImplementedError}
|
|
7693
7837
|
*
|
|
7694
7838
|
* @example
|
|
7695
7839
|
* await client.records.batchGetRecords()
|
|
@@ -7726,12 +7870,12 @@ var RecordsClient = class {
|
|
|
7726
7870
|
}
|
|
7727
7871
|
if (_response.error.reason === "status-code") {
|
|
7728
7872
|
switch (_response.error.statusCode) {
|
|
7873
|
+
case 400:
|
|
7874
|
+
throw new BadRequestError(_response.error.body, _response.rawResponse);
|
|
7729
7875
|
case 403:
|
|
7730
7876
|
throw new ForbiddenError(_response.error.body, _response.rawResponse);
|
|
7731
7877
|
case 429:
|
|
7732
7878
|
throw new TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
7733
|
-
case 501:
|
|
7734
|
-
throw new NotImplementedError(_response.error.body, _response.rawResponse);
|
|
7735
7879
|
default:
|
|
7736
7880
|
throw new VectrosError({
|
|
7737
7881
|
statusCode: _response.error.statusCode,
|
|
@@ -8545,7 +8689,7 @@ var SchemasClient = class {
|
|
|
8545
8689
|
this._options = normalizeClientOptionsWithAuth(options);
|
|
8546
8690
|
}
|
|
8547
8691
|
/**
|
|
8548
|
-
* 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
|
|
8692
|
+
* 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.
|
|
8549
8693
|
*
|
|
8550
8694
|
* @param {Vectros.ListSchemasRequest} request
|
|
8551
8695
|
* @param {SchemasClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -8833,6 +8977,7 @@ var SchemasClient = class {
|
|
|
8833
8977
|
* @param {Vectros.DeleteSchemaRequest} request
|
|
8834
8978
|
* @param {SchemasClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
8835
8979
|
*
|
|
8980
|
+
* @throws {@link Vectros.ForbiddenError}
|
|
8836
8981
|
* @throws {@link Vectros.NotFoundError}
|
|
8837
8982
|
* @throws {@link Vectros.ConflictError}
|
|
8838
8983
|
* @throws {@link Vectros.TooManyRequestsError}
|
|
@@ -8872,6 +9017,8 @@ var SchemasClient = class {
|
|
|
8872
9017
|
}
|
|
8873
9018
|
if (_response.error.reason === "status-code") {
|
|
8874
9019
|
switch (_response.error.statusCode) {
|
|
9020
|
+
case 403:
|
|
9021
|
+
throw new ForbiddenError(_response.error.body, _response.rawResponse);
|
|
8875
9022
|
case 404:
|
|
8876
9023
|
throw new NotFoundError(_response.error.body, _response.rawResponse);
|
|
8877
9024
|
case 409:
|
|
@@ -9081,7 +9228,7 @@ var logging;
|
|
|
9081
9228
|
|
|
9082
9229
|
// src/server.ts
|
|
9083
9230
|
var import_types3 = require("@modelcontextprotocol/sdk/types.js");
|
|
9084
|
-
var
|
|
9231
|
+
var import_zod23 = require("zod");
|
|
9085
9232
|
|
|
9086
9233
|
// src/auth.ts
|
|
9087
9234
|
var KEY_RE = /^(sk|ssk|st)_(live|test)_/;
|
|
@@ -9125,8 +9272,8 @@ function warnOnSuboptimalKey(key, log) {
|
|
|
9125
9272
|
|
|
9126
9273
|
// src/build-info.ts
|
|
9127
9274
|
var BUILD_INFO = {
|
|
9128
|
-
mcpServer: true ? "0.
|
|
9129
|
-
sdk: true ? "0.
|
|
9275
|
+
mcpServer: true ? "0.16.0" : "dev",
|
|
9276
|
+
sdk: true ? "0.41.0" : "dev"
|
|
9130
9277
|
};
|
|
9131
9278
|
|
|
9132
9279
|
// src/log.ts
|
|
@@ -9808,23 +9955,70 @@ var recordGet = ({ client, log }) => ({
|
|
|
9808
9955
|
});
|
|
9809
9956
|
var record_get_default = recordGet;
|
|
9810
9957
|
|
|
9811
|
-
// src/tools/
|
|
9958
|
+
// src/tools/record_batch_get.ts
|
|
9812
9959
|
var import_zod4 = require("zod");
|
|
9960
|
+
var MAX_PAYLOAD_CHARS2 = 32e3;
|
|
9961
|
+
var MCP_MAX_IDS = 100;
|
|
9813
9962
|
var inputSchema4 = {
|
|
9814
|
-
|
|
9815
|
-
|
|
9963
|
+
ids: import_zod4.z.array(import_zod4.z.string()).min(1).max(MCP_MAX_IDS).describe(
|
|
9964
|
+
`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.`
|
|
9965
|
+
)
|
|
9966
|
+
};
|
|
9967
|
+
var recordBatchGet = ({ client, log }) => ({
|
|
9968
|
+
name: "record_batch_get",
|
|
9969
|
+
title: "Get multiple records by id in one call",
|
|
9970
|
+
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.",
|
|
9971
|
+
inputSchema: inputSchema4,
|
|
9972
|
+
handler: async (args) => {
|
|
9973
|
+
const ids = args.ids;
|
|
9974
|
+
try {
|
|
9975
|
+
const response = await client.records.batchGetRecords({ ids });
|
|
9976
|
+
const records = response.data ?? [];
|
|
9977
|
+
const data = records.map((record) => {
|
|
9978
|
+
const item = { ...record };
|
|
9979
|
+
if (record.payload !== void 0) {
|
|
9980
|
+
const json = JSON.stringify(record.payload);
|
|
9981
|
+
if (json.length > MAX_PAYLOAD_CHARS2) {
|
|
9982
|
+
delete item.payload;
|
|
9983
|
+
item.payloadPreview = json.slice(0, MAX_PAYLOAD_CHARS2);
|
|
9984
|
+
item.payloadTruncated = true;
|
|
9985
|
+
item.payloadTotalChars = json.length;
|
|
9986
|
+
}
|
|
9987
|
+
}
|
|
9988
|
+
return item;
|
|
9989
|
+
});
|
|
9990
|
+
const returnedIds = new Set(records.map((r) => r.id));
|
|
9991
|
+
const missingIds = ids.filter((id) => !returnedIds.has(id));
|
|
9992
|
+
log.debug(
|
|
9993
|
+
{ tool: "record_batch_get", requested: ids.length, returned: data.length, missing: missingIds.length },
|
|
9994
|
+
"record_batch_get ok"
|
|
9995
|
+
);
|
|
9996
|
+
return { content: [{ type: "text", text: JSON.stringify({ data, missingIds }, null, 2) }] };
|
|
9997
|
+
} catch (err) {
|
|
9998
|
+
log.warn({ tool: "record_batch_get", idsCount: ids?.length, err: String(err) }, "record_batch_get failed");
|
|
9999
|
+
return toolError("record_batch_get", err);
|
|
10000
|
+
}
|
|
10001
|
+
}
|
|
10002
|
+
});
|
|
10003
|
+
var record_batch_get_default = recordBatchGet;
|
|
10004
|
+
|
|
10005
|
+
// src/tools/record_create.ts
|
|
10006
|
+
var import_zod5 = require("zod");
|
|
10007
|
+
var inputSchema5 = {
|
|
10008
|
+
type: import_zod5.z.string().min(1, "type is required").describe('Record type / schema name (e.g. "task"). Must match an existing schema \u2014 see list_schemas.'),
|
|
10009
|
+
fields: import_zod5.z.record(import_zod5.z.string(), import_zod5.z.unknown()).describe(
|
|
9816
10010
|
"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."
|
|
9817
10011
|
),
|
|
9818
|
-
externalId:
|
|
10012
|
+
externalId: import_zod5.z.string().optional().describe(
|
|
9819
10013
|
"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."
|
|
9820
10014
|
),
|
|
9821
|
-
indexMode:
|
|
10015
|
+
indexMode: import_zod5.z.enum(["HYBRID", "SEMANTIC", "TEXT", "NONE"]).optional().describe(
|
|
9822
10016
|
"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."
|
|
9823
10017
|
),
|
|
9824
|
-
status:
|
|
9825
|
-
folderId:
|
|
9826
|
-
userId:
|
|
9827
|
-
scopes:
|
|
10018
|
+
status: import_zod5.z.string().optional().describe("Record lifecycle status. Defaults to ACTIVE server-side."),
|
|
10019
|
+
folderId: import_zod5.z.string().optional().describe("Group this record into a folder."),
|
|
10020
|
+
userId: import_zod5.z.string().optional().describe("Owning user id."),
|
|
10021
|
+
scopes: import_zod5.z.array(import_zod5.z.string()).optional().describe(
|
|
9828
10022
|
'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.'
|
|
9829
10023
|
)
|
|
9830
10024
|
};
|
|
@@ -9832,7 +10026,7 @@ var recordCreate = ({ client, log }) => ({
|
|
|
9832
10026
|
name: "record_create",
|
|
9833
10027
|
title: "Create a record",
|
|
9834
10028
|
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).",
|
|
9835
|
-
inputSchema:
|
|
10029
|
+
inputSchema: inputSchema5,
|
|
9836
10030
|
handler: async (args) => {
|
|
9837
10031
|
const type = args.type;
|
|
9838
10032
|
try {
|
|
@@ -9859,18 +10053,18 @@ var recordCreate = ({ client, log }) => ({
|
|
|
9859
10053
|
var record_create_default = recordCreate;
|
|
9860
10054
|
|
|
9861
10055
|
// src/tools/record_update.ts
|
|
9862
|
-
var
|
|
9863
|
-
var
|
|
9864
|
-
id:
|
|
9865
|
-
externalId:
|
|
10056
|
+
var import_zod6 = require("zod");
|
|
10057
|
+
var inputSchema6 = {
|
|
10058
|
+
id: import_zod6.z.string().optional().describe("The Vectros record id to update. Provide this OR externalId+type."),
|
|
10059
|
+
externalId: import_zod6.z.string().optional().describe(
|
|
9866
10060
|
"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."
|
|
9867
10061
|
),
|
|
9868
|
-
type:
|
|
9869
|
-
fields:
|
|
10062
|
+
type: import_zod6.z.string().optional().describe("Record type \u2014 REQUIRED when selecting by `externalId` (externalId is unique within a type)."),
|
|
10063
|
+
fields: import_zod6.z.record(import_zod6.z.string(), import_zod6.z.unknown()).describe(
|
|
9870
10064
|
"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."
|
|
9871
10065
|
),
|
|
9872
|
-
status:
|
|
9873
|
-
expectedVersion:
|
|
10066
|
+
status: import_zod6.z.string().optional().describe("Set the record lifecycle status (e.g. ARCHIVED) \u2014 archive/workflow without physical deletion."),
|
|
10067
|
+
expectedVersion: import_zod6.z.number().int().optional().describe(
|
|
9874
10068
|
"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."
|
|
9875
10069
|
)
|
|
9876
10070
|
};
|
|
@@ -9878,7 +10072,7 @@ var recordUpdate = ({ client, log }) => ({
|
|
|
9878
10072
|
name: "record_update",
|
|
9879
10073
|
title: "Update a record by id or externalId",
|
|
9880
10074
|
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.",
|
|
9881
|
-
inputSchema:
|
|
10075
|
+
inputSchema: inputSchema6,
|
|
9882
10076
|
handler: async (args) => {
|
|
9883
10077
|
const id = args.id;
|
|
9884
10078
|
const externalId = args.externalId;
|
|
@@ -9904,15 +10098,15 @@ var recordUpdate = ({ client, log }) => ({
|
|
|
9904
10098
|
var record_update_default = recordUpdate;
|
|
9905
10099
|
|
|
9906
10100
|
// src/tools/record_delete.ts
|
|
9907
|
-
var
|
|
9908
|
-
var
|
|
9909
|
-
id:
|
|
10101
|
+
var import_zod7 = require("zod");
|
|
10102
|
+
var inputSchema7 = {
|
|
10103
|
+
id: import_zod7.z.string().min(1, "id is required").describe("The Vectros record id to delete.")
|
|
9910
10104
|
};
|
|
9911
10105
|
var recordDelete = ({ client, log }) => ({
|
|
9912
10106
|
name: "record_delete",
|
|
9913
10107
|
title: "Delete a record",
|
|
9914
10108
|
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.",
|
|
9915
|
-
inputSchema:
|
|
10109
|
+
inputSchema: inputSchema7,
|
|
9916
10110
|
handler: async (args) => {
|
|
9917
10111
|
const id = args.id;
|
|
9918
10112
|
try {
|
|
@@ -9928,48 +10122,48 @@ var recordDelete = ({ client, log }) => ({
|
|
|
9928
10122
|
var record_delete_default = recordDelete;
|
|
9929
10123
|
|
|
9930
10124
|
// src/tools/rag_ask.ts
|
|
9931
|
-
var
|
|
10125
|
+
var import_zod8 = require("zod");
|
|
9932
10126
|
var SEARCH_MCP_DEFAULT_LIMIT = 5;
|
|
9933
10127
|
var SEARCH_MCP_MAX_LIMIT = 50;
|
|
9934
|
-
var
|
|
9935
|
-
query:
|
|
9936
|
-
instructions:
|
|
10128
|
+
var inputSchema8 = {
|
|
10129
|
+
query: import_zod8.z.string().min(1, "query must be non-empty").describe("Question to ground against retrieved content."),
|
|
10130
|
+
instructions: import_zod8.z.string().optional().describe(
|
|
9937
10131
|
'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.'
|
|
9938
10132
|
),
|
|
9939
|
-
model:
|
|
10133
|
+
model: import_zod8.z.string().optional().describe(
|
|
9940
10134
|
"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."
|
|
9941
10135
|
),
|
|
9942
|
-
search:
|
|
9943
|
-
mode:
|
|
9944
|
-
limit:
|
|
10136
|
+
search: import_zod8.z.object({
|
|
10137
|
+
mode: import_zod8.z.enum(["HYBRID", "TEXT", "SEMANTIC"]).optional().describe("Retrieval mode. Default HYBRID."),
|
|
10138
|
+
limit: import_zod8.z.number().int().min(1).max(SEARCH_MCP_MAX_LIMIT).optional().describe(
|
|
9945
10139
|
`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.`
|
|
9946
10140
|
),
|
|
9947
10141
|
// Retrieval scoping — parity with hybrid_search so an agent can ground the
|
|
9948
10142
|
// answer on a specific owner / folder / type / metadata subset, not just the
|
|
9949
10143
|
// whole-tenant corpus.
|
|
9950
|
-
userId:
|
|
9951
|
-
scope:
|
|
10144
|
+
userId: import_zod8.z.string().optional().describe("Restrict retrieval to content owned by this user (Vectros UUID)."),
|
|
10145
|
+
scope: import_zod8.z.string().optional().describe(
|
|
9952
10146
|
'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.'
|
|
9953
10147
|
),
|
|
9954
|
-
folderId:
|
|
9955
|
-
rootFolderId:
|
|
9956
|
-
typeName:
|
|
9957
|
-
contentTypes:
|
|
9958
|
-
filters:
|
|
10148
|
+
folderId: import_zod8.z.string().optional().describe("Restrict retrieval to this exact folder."),
|
|
10149
|
+
rootFolderId: import_zod8.z.string().optional().describe("Restrict retrieval to this folder and all its descendants."),
|
|
10150
|
+
typeName: import_zod8.z.string().optional().describe("Restrict record retrieval to this schema type."),
|
|
10151
|
+
contentTypes: import_zod8.z.array(import_zod8.z.enum(["documents", "records"])).optional().describe('Narrow retrieval to content types. ["documents"] or ["records"]; omit for both.'),
|
|
10152
|
+
filters: import_zod8.z.record(import_zod8.z.unknown()).optional().describe(
|
|
9959
10153
|
'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"}.'
|
|
9960
10154
|
),
|
|
9961
|
-
createdAfter:
|
|
9962
|
-
createdBefore:
|
|
9963
|
-
requireComplete:
|
|
10155
|
+
createdAfter: import_zod8.z.string().optional().describe("Restrict to content created at/after this ISO 8601 UTC timestamp."),
|
|
10156
|
+
createdBefore: import_zod8.z.string().optional().describe("Restrict to content created at/before this ISO 8601 UTC timestamp."),
|
|
10157
|
+
requireComplete: import_zod8.z.boolean().optional().describe("Fail closed (503) on a degraded search backend instead of grounding on partial results. Default false.")
|
|
9964
10158
|
}).optional().describe("Retrieval params + scoping. Default mode HYBRID, limit " + SEARCH_MCP_DEFAULT_LIMIT + "."),
|
|
9965
|
-
maxTokens:
|
|
9966
|
-
temperature:
|
|
10159
|
+
maxTokens: import_zod8.z.number().int().min(1).optional().describe("Max output tokens."),
|
|
10160
|
+
temperature: import_zod8.z.number().min(0).max(1).optional().describe("Sampling temperature (0.0\u20131.0). Default 0.3 \u2014 lower favors deterministic, retrieval-grounded answers.")
|
|
9967
10161
|
};
|
|
9968
10162
|
var ragAsk = ({ client, log }) => ({
|
|
9969
10163
|
name: "rag_ask",
|
|
9970
10164
|
title: "RAG ask (corpus-wide)",
|
|
9971
10165
|
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.",
|
|
9972
|
-
inputSchema:
|
|
10166
|
+
inputSchema: inputSchema8,
|
|
9973
10167
|
handler: async (args, extra) => {
|
|
9974
10168
|
try {
|
|
9975
10169
|
const searchArg = args.search ?? {};
|
|
@@ -10045,20 +10239,20 @@ var ragAsk = ({ client, log }) => ({
|
|
|
10045
10239
|
var rag_ask_default = ragAsk;
|
|
10046
10240
|
|
|
10047
10241
|
// src/tools/document_ask.ts
|
|
10048
|
-
var
|
|
10049
|
-
var
|
|
10050
|
-
documentId:
|
|
10051
|
-
prompt:
|
|
10052
|
-
model:
|
|
10242
|
+
var import_zod9 = require("zod");
|
|
10243
|
+
var inputSchema9 = {
|
|
10244
|
+
documentId: import_zod9.z.string().min(1, "documentId is required").describe("ID of the document to ask against."),
|
|
10245
|
+
prompt: import_zod9.z.string().min(1, "prompt is required").describe("Question to ask about the document."),
|
|
10246
|
+
model: import_zod9.z.string().optional().describe(
|
|
10053
10247
|
"Inference model alias. Default = tier-appropriate Haiku. See GET /v1/models for the catalog the calling key can reach."
|
|
10054
10248
|
),
|
|
10055
|
-
maxTokens:
|
|
10249
|
+
maxTokens: import_zod9.z.number().int().min(1).optional().describe("Max output tokens.")
|
|
10056
10250
|
};
|
|
10057
10251
|
var documentAsk = ({ client, log }) => ({
|
|
10058
10252
|
name: "document_ask",
|
|
10059
10253
|
title: "Document ask (single-document)",
|
|
10060
10254
|
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.",
|
|
10061
|
-
inputSchema:
|
|
10255
|
+
inputSchema: inputSchema9,
|
|
10062
10256
|
handler: async (args, extra) => {
|
|
10063
10257
|
try {
|
|
10064
10258
|
const stream = await client.inference.documentAsk({
|
|
@@ -10117,18 +10311,18 @@ var documentAsk = ({ client, log }) => ({
|
|
|
10117
10311
|
var document_ask_default = documentAsk;
|
|
10118
10312
|
|
|
10119
10313
|
// src/tools/list_schemas.ts
|
|
10120
|
-
var
|
|
10121
|
-
var
|
|
10122
|
-
userId:
|
|
10314
|
+
var import_zod10 = require("zod");
|
|
10315
|
+
var inputSchema10 = {
|
|
10316
|
+
userId: import_zod10.z.string().optional().describe(
|
|
10123
10317
|
"Filter to schemas visible to a specific user. Optional; default returns all schemas the credential can see."
|
|
10124
10318
|
),
|
|
10125
|
-
scope:
|
|
10319
|
+
scope: import_zod10.z.string().optional().describe(
|
|
10126
10320
|
'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.'
|
|
10127
10321
|
),
|
|
10128
|
-
surface:
|
|
10322
|
+
surface: import_zod10.z.enum(["record", "document", "user", "entity"]).optional().describe(
|
|
10129
10323
|
"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."
|
|
10130
10324
|
),
|
|
10131
|
-
recordType:
|
|
10325
|
+
recordType: import_zod10.z.string().optional().describe(
|
|
10132
10326
|
'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.'
|
|
10133
10327
|
)
|
|
10134
10328
|
};
|
|
@@ -10136,7 +10330,7 @@ var listSchemas = ({ client, log }) => ({
|
|
|
10136
10330
|
name: "list_schemas",
|
|
10137
10331
|
title: "List record schemas",
|
|
10138
10332
|
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.',
|
|
10139
|
-
inputSchema:
|
|
10333
|
+
inputSchema: inputSchema10,
|
|
10140
10334
|
handler: async (args) => {
|
|
10141
10335
|
const userId = args.userId;
|
|
10142
10336
|
const scope = args.scope;
|
|
@@ -10162,18 +10356,18 @@ var listSchemas = ({ client, log }) => ({
|
|
|
10162
10356
|
var list_schemas_default = listSchemas;
|
|
10163
10357
|
|
|
10164
10358
|
// src/tools/document_get.ts
|
|
10165
|
-
var
|
|
10359
|
+
var import_zod11 = require("zod");
|
|
10166
10360
|
var MAX_TEXT_CHARS = 32e3;
|
|
10167
|
-
var
|
|
10168
|
-
documentId:
|
|
10169
|
-
externalId:
|
|
10361
|
+
var inputSchema11 = {
|
|
10362
|
+
documentId: import_zod11.z.string().optional().describe("The document ID returned by document_ingest or hybrid_search. Provide this OR externalId+type."),
|
|
10363
|
+
externalId: import_zod11.z.string().optional().describe(
|
|
10170
10364
|
"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."
|
|
10171
10365
|
),
|
|
10172
|
-
type:
|
|
10173
|
-
includeText:
|
|
10366
|
+
type: import_zod11.z.string().optional().describe("Document type \u2014 REQUIRED when selecting by `externalId` (externalId is unique within a type)."),
|
|
10367
|
+
includeText: import_zod11.z.boolean().optional().describe(
|
|
10174
10368
|
"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."
|
|
10175
10369
|
),
|
|
10176
|
-
includeDownloadUrl:
|
|
10370
|
+
includeDownloadUrl: import_zod11.z.boolean().optional().describe(
|
|
10177
10371
|
"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."
|
|
10178
10372
|
)
|
|
10179
10373
|
};
|
|
@@ -10190,7 +10384,7 @@ var documentGet = ({ client, log }) => ({
|
|
|
10190
10384
|
name: "document_get",
|
|
10191
10385
|
title: "Get document metadata (and optionally text)",
|
|
10192
10386
|
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.",
|
|
10193
|
-
inputSchema:
|
|
10387
|
+
inputSchema: inputSchema11,
|
|
10194
10388
|
handler: async (args) => {
|
|
10195
10389
|
const documentId = args.documentId;
|
|
10196
10390
|
const externalId = args.externalId;
|
|
@@ -10255,28 +10449,28 @@ var documentGet = ({ client, log }) => ({
|
|
|
10255
10449
|
var document_get_default = documentGet;
|
|
10256
10450
|
|
|
10257
10451
|
// src/tools/document_query.ts
|
|
10258
|
-
var
|
|
10452
|
+
var import_zod12 = require("zod");
|
|
10259
10453
|
var MCP_DEFAULT_LIMIT3 = 3;
|
|
10260
10454
|
var MCP_MAX_LIMIT3 = 100;
|
|
10261
|
-
var
|
|
10455
|
+
var inputSchema12 = {
|
|
10262
10456
|
// Lookup-mode args — provide `field` plus EXACTLY ONE of: value | from+to | prefix.
|
|
10263
|
-
field:
|
|
10264
|
-
value:
|
|
10265
|
-
from:
|
|
10266
|
-
to:
|
|
10267
|
-
prefix:
|
|
10268
|
-
order:
|
|
10457
|
+
field: import_zod12.z.string().optional().describe("Lookup mode: name of the lookup-indexed field to query by."),
|
|
10458
|
+
value: import_zod12.z.string().optional().describe("Lookup mode (equality): exact-match value for `field`. Works on sensitive fields too."),
|
|
10459
|
+
from: import_zod12.z.string().optional().describe("Lookup mode (range): inclusive lower bound; requires `to`. Range-enabled, non-sensitive fields only."),
|
|
10460
|
+
to: import_zod12.z.string().optional().describe("Lookup mode (range): inclusive upper bound; requires `from`."),
|
|
10461
|
+
prefix: import_zod12.z.string().optional().describe("Lookup mode (prefix): match values starting with this. Range-enabled string fields only."),
|
|
10462
|
+
order: import_zod12.z.enum(["asc", "desc"]).optional().describe(
|
|
10269
10463
|
"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."
|
|
10270
10464
|
),
|
|
10271
|
-
type:
|
|
10465
|
+
type: import_zod12.z.string().optional().describe("Lookup mode: the document type (the bound schema's type). Required with `field`."),
|
|
10272
10466
|
// List-mode args:
|
|
10273
|
-
folderId:
|
|
10274
|
-
userId:
|
|
10275
|
-
scope:
|
|
10467
|
+
folderId: import_zod12.z.string().optional().describe("List mode: only documents in this folder (Vectros folder id)."),
|
|
10468
|
+
userId: import_zod12.z.string().optional().describe("List mode: scope to documents owned by this user."),
|
|
10469
|
+
scope: import_zod12.z.string().optional().describe(
|
|
10276
10470
|
'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.'
|
|
10277
10471
|
),
|
|
10278
|
-
startFrom:
|
|
10279
|
-
limit:
|
|
10472
|
+
startFrom: import_zod12.z.string().optional().describe("Pagination cursor \u2014 pass the `nextCursor` from the previous page to fetch the next. Works in both list and lookup mode."),
|
|
10473
|
+
limit: import_zod12.z.number().int().min(1).max(MCP_MAX_LIMIT3).optional().describe(
|
|
10280
10474
|
`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.`
|
|
10281
10475
|
)
|
|
10282
10476
|
};
|
|
@@ -10284,7 +10478,7 @@ var documentQuery = ({ client, log }) => ({
|
|
|
10284
10478
|
name: "document_query",
|
|
10285
10479
|
title: "Document query (list or lookup)",
|
|
10286
10480
|
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.",
|
|
10287
|
-
inputSchema:
|
|
10481
|
+
inputSchema: inputSchema12,
|
|
10288
10482
|
handler: async (args) => {
|
|
10289
10483
|
const limit = args.limit ?? MCP_DEFAULT_LIMIT3;
|
|
10290
10484
|
const field = args.field;
|
|
@@ -10364,29 +10558,29 @@ var documentQuery = ({ client, log }) => ({
|
|
|
10364
10558
|
var document_query_default = documentQuery;
|
|
10365
10559
|
|
|
10366
10560
|
// src/tools/document_update.ts
|
|
10367
|
-
var
|
|
10368
|
-
var
|
|
10369
|
-
documentId:
|
|
10370
|
-
externalId:
|
|
10561
|
+
var import_zod13 = require("zod");
|
|
10562
|
+
var inputSchema13 = {
|
|
10563
|
+
documentId: import_zod13.z.string().optional().describe("The Vectros document id to update. Provide this OR externalId+type."),
|
|
10564
|
+
externalId: import_zod13.z.string().optional().describe(
|
|
10371
10565
|
"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."
|
|
10372
10566
|
),
|
|
10373
|
-
type:
|
|
10374
|
-
title:
|
|
10375
|
-
fields:
|
|
10567
|
+
type: import_zod13.z.string().optional().describe("Document type \u2014 REQUIRED when selecting by `externalId` (externalId is unique within a type)."),
|
|
10568
|
+
title: import_zod13.z.string().optional().describe("New title. Omit to keep the current title."),
|
|
10569
|
+
fields: import_zod13.z.record(import_zod13.z.string(), import_zod13.z.unknown()).optional().describe(
|
|
10376
10570
|
"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."
|
|
10377
10571
|
),
|
|
10378
|
-
text:
|
|
10572
|
+
text: import_zod13.z.string().optional().describe(
|
|
10379
10573
|
"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."
|
|
10380
10574
|
),
|
|
10381
|
-
folderId:
|
|
10382
|
-
status:
|
|
10575
|
+
folderId: import_zod13.z.string().optional().describe("Move the document into this folder (cannot be cleared once set)."),
|
|
10576
|
+
status: import_zod13.z.enum(["ACTIVE", "ARCHIVED"]).optional().describe(
|
|
10383
10577
|
"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."
|
|
10384
10578
|
),
|
|
10385
|
-
userId:
|
|
10386
|
-
scopes:
|
|
10579
|
+
userId: import_zod13.z.string().optional().describe("Reassign the owning user (Vectros UUID)."),
|
|
10580
|
+
scopes: import_zod13.z.array(import_zod13.z.string()).optional().describe(
|
|
10387
10581
|
'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).'
|
|
10388
10582
|
),
|
|
10389
|
-
expectedVersion:
|
|
10583
|
+
expectedVersion: import_zod13.z.number().int().optional().describe(
|
|
10390
10584
|
"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."
|
|
10391
10585
|
)
|
|
10392
10586
|
};
|
|
@@ -10394,7 +10588,7 @@ var documentUpdate = ({ client, log }) => ({
|
|
|
10394
10588
|
name: "document_update",
|
|
10395
10589
|
title: "Update a document",
|
|
10396
10590
|
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.',
|
|
10397
|
-
inputSchema:
|
|
10591
|
+
inputSchema: inputSchema13,
|
|
10398
10592
|
handler: async (args) => {
|
|
10399
10593
|
const documentId = args.documentId;
|
|
10400
10594
|
const externalId = args.externalId;
|
|
@@ -10434,15 +10628,15 @@ var documentUpdate = ({ client, log }) => ({
|
|
|
10434
10628
|
var document_update_default = documentUpdate;
|
|
10435
10629
|
|
|
10436
10630
|
// src/tools/document_delete.ts
|
|
10437
|
-
var
|
|
10438
|
-
var
|
|
10439
|
-
documentId:
|
|
10631
|
+
var import_zod14 = require("zod");
|
|
10632
|
+
var inputSchema14 = {
|
|
10633
|
+
documentId: import_zod14.z.string().min(1, "documentId is required").describe("The Vectros document id to delete.")
|
|
10440
10634
|
};
|
|
10441
10635
|
var documentDelete = ({ client, log }) => ({
|
|
10442
10636
|
name: "document_delete",
|
|
10443
10637
|
title: "Delete a document",
|
|
10444
10638
|
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).',
|
|
10445
|
-
inputSchema:
|
|
10639
|
+
inputSchema: inputSchema14,
|
|
10446
10640
|
handler: async (args) => {
|
|
10447
10641
|
const documentId = args.documentId;
|
|
10448
10642
|
try {
|
|
@@ -10460,18 +10654,18 @@ var documentDelete = ({ client, log }) => ({
|
|
|
10460
10654
|
var document_delete_default = documentDelete;
|
|
10461
10655
|
|
|
10462
10656
|
// src/tools/folder_query.ts
|
|
10463
|
-
var
|
|
10657
|
+
var import_zod15 = require("zod");
|
|
10464
10658
|
var MCP_DEFAULT_LIMIT4 = 10;
|
|
10465
10659
|
var MCP_MAX_LIMIT4 = 100;
|
|
10466
|
-
var
|
|
10467
|
-
id:
|
|
10468
|
-
parentId:
|
|
10469
|
-
userId:
|
|
10470
|
-
scope:
|
|
10660
|
+
var inputSchema15 = {
|
|
10661
|
+
id: import_zod15.z.string().optional().describe("Get mode: fetch this single folder by id."),
|
|
10662
|
+
parentId: import_zod15.z.string().optional().describe("List mode: direct children of this folder (tree navigation). Omit for a flat tenant list."),
|
|
10663
|
+
userId: import_zod15.z.string().optional().describe("List mode: scope to folders owned by this user."),
|
|
10664
|
+
scope: import_zod15.z.string().optional().describe(
|
|
10471
10665
|
'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.'
|
|
10472
10666
|
),
|
|
10473
|
-
startFrom:
|
|
10474
|
-
limit:
|
|
10667
|
+
startFrom: import_zod15.z.string().optional().describe("List mode: pagination cursor \u2014 pass the `nextCursor` from the previous page to fetch the next."),
|
|
10668
|
+
limit: import_zod15.z.number().int().min(1).max(MCP_MAX_LIMIT4).optional().describe(
|
|
10475
10669
|
`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\`.`
|
|
10476
10670
|
)
|
|
10477
10671
|
};
|
|
@@ -10479,7 +10673,7 @@ var folderQuery = ({ client, log }) => ({
|
|
|
10479
10673
|
name: "folder_query",
|
|
10480
10674
|
title: "Folder query (list or get)",
|
|
10481
10675
|
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.",
|
|
10482
|
-
inputSchema:
|
|
10676
|
+
inputSchema: inputSchema15,
|
|
10483
10677
|
handler: async (args) => {
|
|
10484
10678
|
const id = args.id;
|
|
10485
10679
|
try {
|
|
@@ -10509,14 +10703,14 @@ var folderQuery = ({ client, log }) => ({
|
|
|
10509
10703
|
var folder_query_default = folderQuery;
|
|
10510
10704
|
|
|
10511
10705
|
// src/tools/folder_create.ts
|
|
10512
|
-
var
|
|
10513
|
-
var
|
|
10514
|
-
name:
|
|
10515
|
-
description:
|
|
10516
|
-
parentId:
|
|
10517
|
-
slug:
|
|
10518
|
-
userId:
|
|
10519
|
-
scopes:
|
|
10706
|
+
var import_zod16 = require("zod");
|
|
10707
|
+
var inputSchema16 = {
|
|
10708
|
+
name: import_zod16.z.string().min(1, "name is required").describe("Folder display name."),
|
|
10709
|
+
description: import_zod16.z.string().optional().describe("Optional description of the folder's purpose."),
|
|
10710
|
+
parentId: import_zod16.z.string().optional().describe("Parent folder id \u2014 places the folder under this parent. Omit for the context default root. Create-only."),
|
|
10711
|
+
slug: import_zod16.z.string().optional().describe("Optional stable slug (sibling-unique; idempotency key). Lowercase letters/digits/hyphens. Derived from name when omitted."),
|
|
10712
|
+
userId: import_zod16.z.string().optional().describe("Owning user (Vectros UUID)."),
|
|
10713
|
+
scopes: import_zod16.z.array(import_zod16.z.string()).optional().describe(
|
|
10520
10714
|
'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.'
|
|
10521
10715
|
)
|
|
10522
10716
|
};
|
|
@@ -10524,7 +10718,7 @@ var folderCreate = ({ client, log }) => ({
|
|
|
10524
10718
|
name: "folder_create",
|
|
10525
10719
|
title: "Create a folder",
|
|
10526
10720
|
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).",
|
|
10527
|
-
inputSchema:
|
|
10721
|
+
inputSchema: inputSchema16,
|
|
10528
10722
|
handler: async (args) => {
|
|
10529
10723
|
try {
|
|
10530
10724
|
const folder = await client.folders.createFolder({
|
|
@@ -10548,16 +10742,16 @@ var folderCreate = ({ client, log }) => ({
|
|
|
10548
10742
|
var folder_create_default = folderCreate;
|
|
10549
10743
|
|
|
10550
10744
|
// src/tools/folder_update.ts
|
|
10551
|
-
var
|
|
10552
|
-
var
|
|
10553
|
-
id:
|
|
10554
|
-
name:
|
|
10555
|
-
description:
|
|
10556
|
-
userId:
|
|
10557
|
-
scopes:
|
|
10745
|
+
var import_zod17 = require("zod");
|
|
10746
|
+
var inputSchema17 = {
|
|
10747
|
+
id: import_zod17.z.string().min(1, "id is required").describe("The Vectros folder id to update."),
|
|
10748
|
+
name: import_zod17.z.string().optional().describe("New folder name. Omit to keep the current name."),
|
|
10749
|
+
description: import_zod17.z.string().optional().describe("New description. Omit to leave unchanged."),
|
|
10750
|
+
userId: import_zod17.z.string().optional().describe("Reassign the owning user (Vectros UUID)."),
|
|
10751
|
+
scopes: import_zod17.z.array(import_zod17.z.string()).optional().describe(
|
|
10558
10752
|
'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).'
|
|
10559
10753
|
),
|
|
10560
|
-
expectedVersion:
|
|
10754
|
+
expectedVersion: import_zod17.z.number().int().optional().describe(
|
|
10561
10755
|
"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."
|
|
10562
10756
|
)
|
|
10563
10757
|
};
|
|
@@ -10565,7 +10759,7 @@ var folderUpdate = ({ client, log }) => ({
|
|
|
10565
10759
|
name: "folder_update",
|
|
10566
10760
|
title: "Update a folder",
|
|
10567
10761
|
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.",
|
|
10568
|
-
inputSchema:
|
|
10762
|
+
inputSchema: inputSchema17,
|
|
10569
10763
|
handler: async (args) => {
|
|
10570
10764
|
const id = args.id;
|
|
10571
10765
|
const name = args.name;
|
|
@@ -10592,15 +10786,15 @@ var folderUpdate = ({ client, log }) => ({
|
|
|
10592
10786
|
var folder_update_default = folderUpdate;
|
|
10593
10787
|
|
|
10594
10788
|
// src/tools/folder_delete.ts
|
|
10595
|
-
var
|
|
10596
|
-
var
|
|
10597
|
-
id:
|
|
10789
|
+
var import_zod18 = require("zod");
|
|
10790
|
+
var inputSchema18 = {
|
|
10791
|
+
id: import_zod18.z.string().min(1, "id is required").describe("The Vectros folder id to delete.")
|
|
10598
10792
|
};
|
|
10599
10793
|
var folderDelete = ({ client, log }) => ({
|
|
10600
10794
|
name: "folder_delete",
|
|
10601
10795
|
title: "Delete a folder",
|
|
10602
10796
|
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.",
|
|
10603
|
-
inputSchema:
|
|
10797
|
+
inputSchema: inputSchema18,
|
|
10604
10798
|
handler: async (args) => {
|
|
10605
10799
|
const id = args.id;
|
|
10606
10800
|
try {
|
|
@@ -10616,14 +10810,14 @@ var folderDelete = ({ client, log }) => ({
|
|
|
10616
10810
|
var folder_delete_default = folderDelete;
|
|
10617
10811
|
|
|
10618
10812
|
// src/tools/current_identity.ts
|
|
10619
|
-
var
|
|
10813
|
+
var inputSchema19 = {
|
|
10620
10814
|
// No args — current_identity describes the current credential.
|
|
10621
10815
|
};
|
|
10622
10816
|
var currentIdentity = ({ log, apiKey, environment }) => ({
|
|
10623
10817
|
name: "current_identity",
|
|
10624
10818
|
title: "Current identity (tenant + principal scope)",
|
|
10625
10819
|
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 as of API 0.40.0 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.",
|
|
10626
|
-
inputSchema:
|
|
10820
|
+
inputSchema: inputSchema19,
|
|
10627
10821
|
handler: async () => {
|
|
10628
10822
|
try {
|
|
10629
10823
|
const identity = await resolveIdentity({ log, apiKey, environment });
|
|
@@ -10639,7 +10833,7 @@ var currentIdentity = ({ log, apiKey, environment }) => ({
|
|
|
10639
10833
|
var current_identity_default = currentIdentity;
|
|
10640
10834
|
|
|
10641
10835
|
// src/tools/document_ingest.ts
|
|
10642
|
-
var
|
|
10836
|
+
var import_zod19 = require("zod");
|
|
10643
10837
|
var import_promises = require("fs/promises");
|
|
10644
10838
|
var import_node_path = require("path");
|
|
10645
10839
|
var IngestPathError = class extends Error {
|
|
@@ -10714,37 +10908,37 @@ function inferMimeType(filePath) {
|
|
|
10714
10908
|
const ext = (0, import_node_path.extname)(filePath).toLowerCase();
|
|
10715
10909
|
return EXT_TO_MIME[ext] ?? "application/octet-stream";
|
|
10716
10910
|
}
|
|
10717
|
-
var
|
|
10718
|
-
title:
|
|
10719
|
-
indexMode:
|
|
10911
|
+
var inputSchema20 = {
|
|
10912
|
+
title: import_zod19.z.string().min(1, "title is required").describe("Human-readable document title \u2014 appears in search results and the UI."),
|
|
10913
|
+
indexMode: import_zod19.z.enum(["HYBRID", "SEMANTIC", "TEXT", "NONE"]).optional().describe(
|
|
10720
10914
|
"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."
|
|
10721
10915
|
),
|
|
10722
|
-
externalId:
|
|
10916
|
+
externalId: import_zod19.z.string().optional().describe(
|
|
10723
10917
|
'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.'
|
|
10724
10918
|
),
|
|
10725
|
-
upsert:
|
|
10919
|
+
upsert: import_zod19.z.boolean().optional().describe(
|
|
10726
10920
|
"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)."
|
|
10727
10921
|
),
|
|
10728
|
-
schemaId:
|
|
10922
|
+
schemaId: import_zod19.z.string().optional().describe(
|
|
10729
10923
|
"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."
|
|
10730
10924
|
),
|
|
10731
|
-
payload:
|
|
10925
|
+
payload: import_zod19.z.record(import_zod19.z.string(), import_zod19.z.unknown()).optional().describe(
|
|
10732
10926
|
"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."
|
|
10733
10927
|
),
|
|
10734
10928
|
// Inline text mode (mutually exclusive with filePath):
|
|
10735
|
-
text:
|
|
10736
|
-
storeText:
|
|
10929
|
+
text: import_zod19.z.string().min(1).optional().describe("Text body to ingest inline. Mutually exclusive with filePath. Either text or filePath is required."),
|
|
10930
|
+
storeText: import_zod19.z.boolean().optional().describe(
|
|
10737
10931
|
"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."
|
|
10738
10932
|
),
|
|
10739
10933
|
// File upload mode (mutually exclusive with text; stdio-transport-only):
|
|
10740
|
-
filePath:
|
|
10934
|
+
filePath: import_zod19.z.string().min(1).optional().describe(
|
|
10741
10935
|
"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."
|
|
10742
10936
|
),
|
|
10743
|
-
fileType:
|
|
10937
|
+
fileType: import_zod19.z.string().optional().describe('MIME type of the file (e.g. "application/pdf"). Inferred from filePath extension if omitted.'),
|
|
10744
10938
|
// Common (both modes):
|
|
10745
|
-
folderId:
|
|
10746
|
-
userId:
|
|
10747
|
-
scopes:
|
|
10939
|
+
folderId: import_zod19.z.string().optional().describe("Optional folder to ingest into. Default: tenant root."),
|
|
10940
|
+
userId: import_zod19.z.string().optional().describe("Owning user ID. Optional."),
|
|
10941
|
+
scopes: import_zod19.z.array(import_zod19.z.string()).optional().describe(
|
|
10748
10942
|
"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."
|
|
10749
10943
|
)
|
|
10750
10944
|
};
|
|
@@ -10752,7 +10946,7 @@ var documentIngest = ({ client, log, transport, ingestRoot }) => ({
|
|
|
10752
10946
|
name: "document_ingest",
|
|
10753
10947
|
title: "Ingest a new document (text body or file upload)",
|
|
10754
10948
|
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`.",
|
|
10755
|
-
inputSchema:
|
|
10949
|
+
inputSchema: inputSchema20,
|
|
10756
10950
|
handler: async (args) => {
|
|
10757
10951
|
const title = args.title;
|
|
10758
10952
|
const text = args.text;
|
|
@@ -10904,29 +11098,29 @@ var documentIngest = ({ client, log, transport, ingestRoot }) => ({
|
|
|
10904
11098
|
var document_ingest_default = documentIngest;
|
|
10905
11099
|
|
|
10906
11100
|
// src/tools/lookup_principal.ts
|
|
10907
|
-
var
|
|
11101
|
+
var import_zod20 = require("zod");
|
|
10908
11102
|
var MCP_DEFAULT_LIMIT5 = 10;
|
|
10909
11103
|
var MCP_MAX_LIMIT5 = 100;
|
|
10910
|
-
var
|
|
10911
|
-
kind:
|
|
11104
|
+
var inputSchema21 = {
|
|
11105
|
+
kind: import_zod20.z.string().describe(
|
|
10912
11106
|
'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.'
|
|
10913
11107
|
),
|
|
10914
|
-
externalId:
|
|
11108
|
+
externalId: import_zod20.z.string().optional().describe(
|
|
10915
11109
|
"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."
|
|
10916
11110
|
),
|
|
10917
|
-
contextId:
|
|
11111
|
+
contextId: import_zod20.z.string().optional().describe(
|
|
10918
11112
|
"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."
|
|
10919
11113
|
),
|
|
10920
11114
|
// Lookup-mode args — provide `field` plus EXACTLY ONE of: value | from+to | prefix.
|
|
10921
|
-
type:
|
|
10922
|
-
field:
|
|
10923
|
-
value:
|
|
10924
|
-
from:
|
|
10925
|
-
to:
|
|
10926
|
-
prefix:
|
|
10927
|
-
order:
|
|
10928
|
-
startFrom:
|
|
10929
|
-
limit:
|
|
11115
|
+
type: import_zod20.z.string().optional().describe('Lookup mode: the identity schema\'s record type (e.g. "person_v1"). Required with `field`.'),
|
|
11116
|
+
field: import_zod20.z.string().optional().describe('Lookup mode: name of the schema-declared lookup field to query by (e.g. "email").'),
|
|
11117
|
+
value: import_zod20.z.string().optional().describe("Lookup mode (equality): exact-match value for `field`. Works on sensitive fields."),
|
|
11118
|
+
from: import_zod20.z.string().optional().describe("Lookup mode (range): inclusive lower bound; requires `to`. Non-sensitive fields only."),
|
|
11119
|
+
to: import_zod20.z.string().optional().describe("Lookup mode (range): inclusive upper bound; requires `from`."),
|
|
11120
|
+
prefix: import_zod20.z.string().optional().describe("Lookup mode (prefix): match values starting with this. Range-enabled string fields only."),
|
|
11121
|
+
order: import_zod20.z.enum(["asc", "desc"]).optional().describe("Lookup mode: sort direction by the looked-up field. `asc` (default) or `desc`."),
|
|
11122
|
+
startFrom: import_zod20.z.string().optional().describe("Lookup mode: pagination cursor \u2014 pass the `nextCursor` from the previous page to fetch the next."),
|
|
11123
|
+
limit: import_zod20.z.number().int().min(1).max(MCP_MAX_LIMIT5).optional().describe(
|
|
10930
11124
|
`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\`.`
|
|
10931
11125
|
)
|
|
10932
11126
|
};
|
|
@@ -10934,7 +11128,7 @@ var lookupPrincipal = ({ client, log }) => ({
|
|
|
10934
11128
|
name: "lookup_principal",
|
|
10935
11129
|
title: "Look up a user identity or a namespaced identity entity",
|
|
10936
11130
|
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.",
|
|
10937
|
-
inputSchema:
|
|
11131
|
+
inputSchema: inputSchema21,
|
|
10938
11132
|
handler: async (args) => {
|
|
10939
11133
|
const kind = args.kind;
|
|
10940
11134
|
const isUser = kind === "user";
|
|
@@ -11008,17 +11202,17 @@ var lookupPrincipal = ({ client, log }) => ({
|
|
|
11008
11202
|
var lookup_principal_default = lookupPrincipal;
|
|
11009
11203
|
|
|
11010
11204
|
// src/tools/version_history.ts
|
|
11011
|
-
var
|
|
11012
|
-
var
|
|
11013
|
-
resourceType:
|
|
11014
|
-
id:
|
|
11015
|
-
startFrom:
|
|
11205
|
+
var import_zod21 = require("zod");
|
|
11206
|
+
var inputSchema22 = {
|
|
11207
|
+
resourceType: import_zod21.z.enum(["record", "document"]).describe("Which kind of entity the id refers to: a record or a document."),
|
|
11208
|
+
id: import_zod21.z.string().min(1, "id is required").describe("The Vectros id of the record or document whose history you want."),
|
|
11209
|
+
startFrom: import_zod21.z.string().optional().describe("Pagination cursor \u2014 pass the `nextCursor` from the previous page to fetch older entries.")
|
|
11016
11210
|
};
|
|
11017
11211
|
var versionHistory = ({ client, log }) => ({
|
|
11018
11212
|
name: "version_history",
|
|
11019
11213
|
title: "Version history (record or document)",
|
|
11020
11214
|
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.",
|
|
11021
|
-
inputSchema:
|
|
11215
|
+
inputSchema: inputSchema22,
|
|
11022
11216
|
handler: async (args) => {
|
|
11023
11217
|
const resourceType = args.resourceType;
|
|
11024
11218
|
const id = args.id;
|
|
@@ -11045,6 +11239,7 @@ var TOOL_NAMES = [
|
|
|
11045
11239
|
"hybrid_search",
|
|
11046
11240
|
"record_query",
|
|
11047
11241
|
"record_get",
|
|
11242
|
+
"record_batch_get",
|
|
11048
11243
|
"record_create",
|
|
11049
11244
|
"record_update",
|
|
11050
11245
|
"record_delete",
|
|
@@ -11070,6 +11265,7 @@ var ALL_TOOL_FACTORIES = {
|
|
|
11070
11265
|
hybrid_search: hybrid_search_default,
|
|
11071
11266
|
record_query: record_query_default,
|
|
11072
11267
|
record_get: record_get_default,
|
|
11268
|
+
record_batch_get: record_batch_get_default,
|
|
11073
11269
|
record_create: record_create_default,
|
|
11074
11270
|
record_update: record_update_default,
|
|
11075
11271
|
record_delete: record_delete_default,
|
|
@@ -11130,7 +11326,7 @@ var ALL_RESOURCE_FACTORIES = {
|
|
|
11130
11326
|
};
|
|
11131
11327
|
|
|
11132
11328
|
// src/zod-to-json-schema.ts
|
|
11133
|
-
var
|
|
11329
|
+
var import_zod22 = require("zod");
|
|
11134
11330
|
function zodShapeToJsonSchema(shape) {
|
|
11135
11331
|
const properties = {};
|
|
11136
11332
|
const required = [];
|
|
@@ -11145,40 +11341,40 @@ function zodShapeToJsonSchema(shape) {
|
|
|
11145
11341
|
function zodTypeToJsonSchema(schema) {
|
|
11146
11342
|
const description = schema.description;
|
|
11147
11343
|
let current = schema;
|
|
11148
|
-
while (current instanceof
|
|
11344
|
+
while (current instanceof import_zod22.z.ZodOptional || current instanceof import_zod22.z.ZodDefault || current instanceof import_zod22.z.ZodNullable) {
|
|
11149
11345
|
current = current._def.innerType;
|
|
11150
11346
|
}
|
|
11151
11347
|
const base = description ? { description } : {};
|
|
11152
|
-
if (current instanceof
|
|
11348
|
+
if (current instanceof import_zod22.z.ZodString) {
|
|
11153
11349
|
return { ...base, type: "string" };
|
|
11154
11350
|
}
|
|
11155
|
-
if (current instanceof
|
|
11351
|
+
if (current instanceof import_zod22.z.ZodNumber) {
|
|
11156
11352
|
return { ...base, type: "number" };
|
|
11157
11353
|
}
|
|
11158
|
-
if (current instanceof
|
|
11354
|
+
if (current instanceof import_zod22.z.ZodBoolean) {
|
|
11159
11355
|
return { ...base, type: "boolean" };
|
|
11160
11356
|
}
|
|
11161
|
-
if (current instanceof
|
|
11357
|
+
if (current instanceof import_zod22.z.ZodEnum) {
|
|
11162
11358
|
return {
|
|
11163
11359
|
...base,
|
|
11164
11360
|
type: "string",
|
|
11165
11361
|
enum: current.options
|
|
11166
11362
|
};
|
|
11167
11363
|
}
|
|
11168
|
-
if (current instanceof
|
|
11364
|
+
if (current instanceof import_zod22.z.ZodArray) {
|
|
11169
11365
|
return {
|
|
11170
11366
|
...base,
|
|
11171
11367
|
type: "array",
|
|
11172
11368
|
items: zodTypeToJsonSchema(current.element)
|
|
11173
11369
|
};
|
|
11174
11370
|
}
|
|
11175
|
-
if (current instanceof
|
|
11371
|
+
if (current instanceof import_zod22.z.ZodObject) {
|
|
11176
11372
|
return {
|
|
11177
11373
|
...base,
|
|
11178
11374
|
...zodShapeToJsonSchema(current.shape)
|
|
11179
11375
|
};
|
|
11180
11376
|
}
|
|
11181
|
-
if (current instanceof
|
|
11377
|
+
if (current instanceof import_zod22.z.ZodRecord) {
|
|
11182
11378
|
const valueType = current._def.valueType;
|
|
11183
11379
|
return {
|
|
11184
11380
|
...base,
|
|
@@ -11302,7 +11498,7 @@ var VectrosMCPServer = class {
|
|
|
11302
11498
|
if (!tool) {
|
|
11303
11499
|
result = toolError(req.params.name ?? "unknown", new Error("No such tool."));
|
|
11304
11500
|
} else {
|
|
11305
|
-
const parsed =
|
|
11501
|
+
const parsed = import_zod23.z.object(tool.inputSchema).strict().safeParse(req.params.arguments ?? {});
|
|
11306
11502
|
if (!parsed.success) {
|
|
11307
11503
|
result = toolError(tool.name, new Error(formatArgError(tool, parsed.error)));
|
|
11308
11504
|
} else {
|