@vectros-ai/mcp-server 0.5.3 → 0.7.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 +75 -0
- package/README.md +17 -2
- package/dist/cli-http.js +212 -46
- package/dist/cli-http.js.map +1 -1
- package/dist/cli-http.mjs +212 -46
- package/dist/cli-http.mjs.map +1 -1
- package/dist/cli.js +212 -46
- package/dist/cli.js.map +1 -1
- package/dist/cli.mjs +212 -46
- package/dist/cli.mjs.map +1 -1
- package/dist/index.js +212 -46
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +212 -46
- package/dist/index.mjs.map +1 -1
- package/package.json +2 -2
package/dist/index.mjs
CHANGED
|
@@ -479,10 +479,18 @@ var DocumentRequest;
|
|
|
479
479
|
Text: "TEXT",
|
|
480
480
|
None: "NONE"
|
|
481
481
|
};
|
|
482
|
+
DocumentRequest2.Status = {
|
|
483
|
+
Active: "ACTIVE",
|
|
484
|
+
Archived: "ARCHIVED"
|
|
485
|
+
};
|
|
482
486
|
})(DocumentRequest || (DocumentRequest = {}));
|
|
483
487
|
var DocumentResponse;
|
|
484
488
|
((DocumentResponse2) => {
|
|
485
489
|
DocumentResponse2.Status = {
|
|
490
|
+
Active: "ACTIVE",
|
|
491
|
+
Archived: "ARCHIVED"
|
|
492
|
+
};
|
|
493
|
+
DocumentResponse2.IndexStatus = {
|
|
486
494
|
PendingUpload: "PENDING_UPLOAD",
|
|
487
495
|
Uploaded: "UPLOADED",
|
|
488
496
|
Extracting: "EXTRACTING",
|
|
@@ -4888,7 +4896,7 @@ var DocumentsClient = class {
|
|
|
4888
4896
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "DELETE", "/v1/documents/{id}");
|
|
4889
4897
|
}
|
|
4890
4898
|
/**
|
|
4891
|
-
* Partially updates a document using an RFC 7386 JSON Merge Patch. The `payload` object is deep-merged: keys you send overwrite existing values (recursing into nested objects), a key set to `null` is deleted, and keys you omit are preserved — unlike PUT, which replaces the whole payload. Top-level fields (`title`, `
|
|
4899
|
+
* Partially updates a document using an RFC 7386 JSON Merge Patch. The `payload` object is deep-merged: keys you send overwrite existing values (recursing into nested objects), a key set to `null` is deleted, and keys you omit are preserved — unlike PUT, which replaces the whole payload. Top-level fields (`title`, `folderId`, `schemaId`, ownership) are set when present and left unchanged when omitted; sending a top-level field as `null` is rejected. Supplying `text` re-ingests the document body (same as PUT). `indexMode`, `externalId`, and `storeText` (text retention is fixed at ingest) are immutable and rejected if present. The merged result is validated against the bound schema. Pass `expectedVersion` for optimistic concurrency (409 on conflict). Requires the `documents:u` scope.
|
|
4892
4900
|
*
|
|
4893
4901
|
* @param {Vectros.PatchDocumentRequest} request
|
|
4894
4902
|
* @param {DocumentsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -5140,7 +5148,7 @@ var DocumentsClient = class {
|
|
|
5140
5148
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/documents/{id}/download");
|
|
5141
5149
|
}
|
|
5142
5150
|
/**
|
|
5143
|
-
* Returns the full
|
|
5151
|
+
* Returns the document's full text body when it is retained: always available for text-ingested documents, and for file-uploaded documents unless they were uploaded with `storeText=false` (which discards the extracted text once indexing completes — the original file remains available via `GET /{id}/download`). Returns 404 when the document does not exist, its text was not retained, or extraction has not yet completed. Requires the `documents:r` scope.
|
|
5144
5152
|
*
|
|
5145
5153
|
* @param {Vectros.GetDocumentTextRequest} request
|
|
5146
5154
|
* @param {DocumentsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -5253,7 +5261,7 @@ var DocumentsClient = class {
|
|
|
5253
5261
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/documents/{id}/versions");
|
|
5254
5262
|
}
|
|
5255
5263
|
/**
|
|
5256
|
-
* Starts a file-based document by returning a short-lived presigned S3 PUT URL. Upload the file bytes directly to `uploadUrl`; the document is then automatically queued for text extraction and asynchronous indexing. Supplying an `externalId` makes this idempotent — re-initiating an upload with the same `externalId` re-issues a fresh presigned URL to the SAME existing document/object (so a re-upload inherently replaces the file body) rather than creating a duplicate. The response's `created` field (and the HTTP status — 201 when a new document was minted, 200 when an existing one was matched) tells the two apart. With `?upsert=true`, the submitted `payload`/`title` are also applied to the matched document (file-body divergence cannot be diffed at upload-init — the bytes have not arrived yet — so the re-upload itself replaces the body
|
|
5264
|
+
* Starts a file-based document by returning a short-lived presigned S3 PUT URL. Upload the file bytes directly to `uploadUrl`; the document is then automatically queued for text extraction and asynchronous indexing. Supplying an `externalId` makes this idempotent — re-initiating an upload with the same `externalId` re-issues a fresh presigned URL to the SAME existing document/object (so a re-upload inherently replaces the file body) rather than creating a duplicate. The response's `created` field (and the HTTP status — 201 when a new document was minted, 200 when an existing one was matched) tells the two apart. With `?upsert=true`, the submitted `payload`/`title` are also applied to the matched document (file-body divergence cannot be diffed at upload-init — the bytes have not arrived yet — so the re-upload itself replaces the body). Creating a NEW document requires the `documents:c` scope. Re-uploading over an EXISTING document overwrites (and re-indexes) its body, so it is an update: it requires the `documents:u` scope (as does `?upsert=true` for the metadata).
|
|
5257
5265
|
*
|
|
5258
5266
|
* @param {Vectros.FileUploadRequest} request
|
|
5259
5267
|
* @param {DocumentsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -8754,8 +8762,8 @@ function warnOnSuboptimalKey(key, log) {
|
|
|
8754
8762
|
|
|
8755
8763
|
// src/build-info.ts
|
|
8756
8764
|
var BUILD_INFO = {
|
|
8757
|
-
mcpServer: true ? "0.
|
|
8758
|
-
sdk: true ? "0.
|
|
8765
|
+
mcpServer: true ? "0.7.0" : "dev",
|
|
8766
|
+
sdk: true ? "0.33.0" : "dev"
|
|
8759
8767
|
};
|
|
8760
8768
|
|
|
8761
8769
|
// src/log.ts
|
|
@@ -8992,6 +9000,32 @@ ${detail}${pointer}`
|
|
|
8992
9000
|
// src/tools/hybrid_search.ts
|
|
8993
9001
|
var MCP_DEFAULT_LIMIT = 3;
|
|
8994
9002
|
var MCP_MAX_LIMIT = 10;
|
|
9003
|
+
var MCP_RESPONSE_CHAR_BUDGET = 24e3;
|
|
9004
|
+
var SNIPPET_MAX_CHARS = 160;
|
|
9005
|
+
var INTERNAL_METADATA_KEYS = /* @__PURE__ */ new Set(["tenantId", "owner_id", "model_type", "rootFolderId", "folderId"]);
|
|
9006
|
+
function trimMetadata(md) {
|
|
9007
|
+
if (!md || typeof md !== "object" || Array.isArray(md)) return md;
|
|
9008
|
+
const out = {};
|
|
9009
|
+
for (const [k, v] of Object.entries(md)) {
|
|
9010
|
+
if (!INTERNAL_METADATA_KEYS.has(k)) out[k] = v;
|
|
9011
|
+
}
|
|
9012
|
+
return out;
|
|
9013
|
+
}
|
|
9014
|
+
function reshapeHit(hit, includeContext) {
|
|
9015
|
+
const out = { ...hit };
|
|
9016
|
+
if ("metadata" in out) out.metadata = trimMetadata(out.metadata);
|
|
9017
|
+
const chunk = typeof hit.chunkText === "string" ? hit.chunkText : void 0;
|
|
9018
|
+
const ctx = typeof hit.contextText === "string" ? hit.contextText : void 0;
|
|
9019
|
+
if (includeContext) {
|
|
9020
|
+
if (chunk && ctx && ctx.includes(chunk)) delete out.chunkText;
|
|
9021
|
+
} else {
|
|
9022
|
+
delete out.contextText;
|
|
9023
|
+
}
|
|
9024
|
+
if ((out.snippet == null || out.snippet === "") && chunk) {
|
|
9025
|
+
out.snippet = chunk.length > SNIPPET_MAX_CHARS ? chunk.slice(0, SNIPPET_MAX_CHARS) + "\u2026" : chunk;
|
|
9026
|
+
}
|
|
9027
|
+
return out;
|
|
9028
|
+
}
|
|
8995
9029
|
var inputSchema = {
|
|
8996
9030
|
query: z.string().min(1, "query must be non-empty").describe("Natural-language or keyword query."),
|
|
8997
9031
|
mode: z.enum(["HYBRID", "TEXT", "SEMANTIC"]).optional().describe("HYBRID (BM25 + dense, default), TEXT (BM25 only), or SEMANTIC (dense only)."),
|
|
@@ -9006,7 +9040,9 @@ var inputSchema = {
|
|
|
9006
9040
|
rootFolderId: z.string().optional().describe("Scope to content under this folder AND all its descendants (subtree-root folder id)."),
|
|
9007
9041
|
// Content narrowing.
|
|
9008
9042
|
contentTypes: z.array(z.enum(["documents", "records"])).optional().describe('Narrow to content types. ["documents"] or ["records"]; omit for unified (both).'),
|
|
9009
|
-
typeName: z.string().optional().describe(
|
|
9043
|
+
typeName: z.string().optional().describe(
|
|
9044
|
+
'Restrict hits to this schema type (e.g. "patient", "runbook"). Applies to BOTH documents and records \u2014 combine with contentTypes to scope within one content type. Untyped content never matches.'
|
|
9045
|
+
),
|
|
9010
9046
|
filters: z.record(z.unknown()).optional().describe(
|
|
9011
9047
|
'Field-level metadata filters (AND-combined). Value = scalar (equality), array (OR-set), or operator map: $eq/$ne/$gt/$gte/$lt/$lte (scalar) or $in/$nin (array). e.g. {"status":"open"} or {"price":{"$gte":100,"$lte":500}}.'
|
|
9012
9048
|
),
|
|
@@ -9021,6 +9057,9 @@ var inputSchema = {
|
|
|
9021
9057
|
minSimilarity: z.number().min(0).max(1).optional().describe("Minimum semantic similarity (0.0\u20131.0); results below are excluded."),
|
|
9022
9058
|
minTextRelevance: z.number().min(0).max(1).optional().describe("Minimum relative keyword (BM25) relevance (0.0\u20131.0); the keyword-leg analogue of minSimilarity."),
|
|
9023
9059
|
uniqueDocuments: z.boolean().optional().describe("When true, return at most one chunk per source document."),
|
|
9060
|
+
includeContext: z.boolean().optional().describe(
|
|
9061
|
+
"Include the broader passage (contextText) around each matched chunk. Off by default to keep the result compact \u2014 each hit returns its matched chunkText plus a short snippet. Turn this on only when you need more surrounding context inline; for a full deep read, fetch the source with document_get."
|
|
9062
|
+
),
|
|
9024
9063
|
requireComplete: z.boolean().optional().describe(
|
|
9025
9064
|
"When true, fail closed (HTTP 503) if a search backend is unavailable rather than silently returning partial/degraded results. Default false (degrade to the surviving engine; the result still flags degraded)."
|
|
9026
9065
|
)
|
|
@@ -9028,7 +9067,7 @@ var inputSchema = {
|
|
|
9028
9067
|
var hybridSearch = ({ client, log }) => ({
|
|
9029
9068
|
name: "hybrid_search",
|
|
9030
9069
|
title: "Hybrid search",
|
|
9031
|
-
description:
|
|
9070
|
+
description: `Search the partner tenant's indexed content (documents + structured records) using hybrid BM25 + dense ranking. Returns up to 10 results (default 3) with citations and surrounding context for grounding follow-up reasoning. Narrow with contentTypes/typeName/filters, ownership (userId/orgId/clientId), folder scope, a created date window, keyword precision (textMode OR/AND/PHRASE), relevance floors (minSimilarity/minTextRelevance), uniqueDocuments, and requireComplete (fail closed on a degraded backend). Tenant-isolated; the caller's scoped key fully constrains which content is visible. ARCHIVED (soft-retracted) documents never appear in results \u2014 fetch them by id via document_get, or restore them via document_update. To stay within the agent context window each hit returns its matched chunkText + a short snippet by default; set includeContext:true for the broader surrounding passage. If the whole result would be too large it is truncated to the top hits (truncated:true). textLegEmpty:true flags that the keyword leg matched nothing (all textScores 0) \u2014 usually a too-long PHRASE query; retry with textMode:"OR".`,
|
|
9032
9071
|
inputSchema,
|
|
9033
9072
|
handler: async (args) => {
|
|
9034
9073
|
const limit = args.limit ?? MCP_DEFAULT_LIMIT;
|
|
@@ -9055,13 +9094,30 @@ var hybridSearch = ({ client, log }) => ({
|
|
|
9055
9094
|
uniqueDocuments: args.uniqueDocuments,
|
|
9056
9095
|
requireComplete: args.requireComplete
|
|
9057
9096
|
});
|
|
9097
|
+
const hits = Array.isArray(
|
|
9098
|
+
result.results
|
|
9099
|
+
) ? result.results : [];
|
|
9100
|
+
const includeContext = args.includeContext ?? false;
|
|
9101
|
+
let shaped = hits.map((h) => reshapeHit(h, includeContext));
|
|
9102
|
+
const textLegEmpty = mode !== "SEMANTIC" && hits.length > 0 && hits.every((h) => !(Number(h.textScore) > 0));
|
|
9103
|
+
const envelope = {
|
|
9104
|
+
...result,
|
|
9105
|
+
results: shaped
|
|
9106
|
+
};
|
|
9107
|
+
if (textLegEmpty) envelope.textLegEmpty = true;
|
|
9108
|
+
let text = JSON.stringify(envelope, null, 2);
|
|
9109
|
+
while (shaped.length > 1 && text.length > MCP_RESPONSE_CHAR_BUDGET) {
|
|
9110
|
+
shaped = shaped.slice(0, -1);
|
|
9111
|
+
envelope.results = shaped;
|
|
9112
|
+
envelope.truncated = true;
|
|
9113
|
+
envelope.returnedResults = shaped.length;
|
|
9114
|
+
text = JSON.stringify(envelope, null, 2);
|
|
9115
|
+
}
|
|
9058
9116
|
log.debug(
|
|
9059
|
-
{ tool: "hybrid_search", mode, limit, returned:
|
|
9117
|
+
{ tool: "hybrid_search", mode, limit, returned: shaped.length, textLegEmpty },
|
|
9060
9118
|
"hybrid_search ok"
|
|
9061
9119
|
);
|
|
9062
|
-
return {
|
|
9063
|
-
content: [{ type: "text", text: JSON.stringify(result, null, 2) }]
|
|
9064
|
-
};
|
|
9120
|
+
return { content: [{ type: "text", text }] };
|
|
9065
9121
|
} catch (err) {
|
|
9066
9122
|
log.warn({ tool: "hybrid_search", err: String(err) }, "hybrid_search failed");
|
|
9067
9123
|
return toolError("hybrid_search", err);
|
|
@@ -9096,7 +9152,9 @@ var MCP_MAX_LIMIT2 = 10;
|
|
|
9096
9152
|
var inputSchema2 = {
|
|
9097
9153
|
type: z2.string().min(1, "type (record type) is required").describe('Record type / schema name (e.g. "patient", "clinical_note").'),
|
|
9098
9154
|
// Lookup-mode args — provide `field` plus EXACTLY ONE of: value | from+to | prefix.
|
|
9099
|
-
field: z2.string().optional().describe(
|
|
9155
|
+
field: z2.string().optional().describe(
|
|
9156
|
+
'Lookup mode: name of the lookup-indexed field to query by. `externalId` is always queryable \u2014 e.g. `{type:"control", field:"externalId", value:"ctrl-scoped-key"}` finds the record you created under that externalId. (record_get / record_update also accept externalId directly.)'
|
|
9157
|
+
),
|
|
9100
9158
|
value: z2.string().optional().describe("Lookup mode (equality): exact-match value for `field`."),
|
|
9101
9159
|
from: z2.string().optional().describe("Lookup mode (range): inclusive lower bound; requires `to`. Non-sensitive fields only."),
|
|
9102
9160
|
to: z2.string().optional().describe("Lookup mode (range): inclusive upper bound; requires `from`."),
|
|
@@ -9191,19 +9249,77 @@ var record_query_default = recordQuery;
|
|
|
9191
9249
|
|
|
9192
9250
|
// src/tools/record_get.ts
|
|
9193
9251
|
import { z as z3 } from "zod";
|
|
9252
|
+
|
|
9253
|
+
// src/tools/resolve-external-id.ts
|
|
9254
|
+
function validateSelector(sel, entity) {
|
|
9255
|
+
const hasId = sel.id !== void 0 && sel.id !== "";
|
|
9256
|
+
const hasExt = sel.externalId !== void 0 && sel.externalId !== "";
|
|
9257
|
+
if (hasId && hasExt) {
|
|
9258
|
+
return `Provide either id or externalId (not both) to identify the ${entity}.`;
|
|
9259
|
+
}
|
|
9260
|
+
if (!hasId && !hasExt) {
|
|
9261
|
+
return `Provide id, or externalId + type, to identify the ${entity}.`;
|
|
9262
|
+
}
|
|
9263
|
+
if (hasExt && (sel.type === void 0 || sel.type === "")) {
|
|
9264
|
+
return "type is required when selecting by externalId (externalId is unique within a type).";
|
|
9265
|
+
}
|
|
9266
|
+
return void 0;
|
|
9267
|
+
}
|
|
9268
|
+
async function resolveRecordIdByExternalId(client, sel) {
|
|
9269
|
+
const err = validateSelector(sel, "record");
|
|
9270
|
+
if (err) return { error: err };
|
|
9271
|
+
if (sel.id) return { id: sel.id };
|
|
9272
|
+
const page = await client.records.lookupRecordsByBody({
|
|
9273
|
+
type: sel.type,
|
|
9274
|
+
field: "externalId",
|
|
9275
|
+
value: sel.externalId,
|
|
9276
|
+
limit: 1
|
|
9277
|
+
});
|
|
9278
|
+
const items = pageItems(page);
|
|
9279
|
+
if (items.length === 0) {
|
|
9280
|
+
return { error: `No record of type '${sel.type}' with externalId '${sel.externalId}'.` };
|
|
9281
|
+
}
|
|
9282
|
+
return { id: items[0].id };
|
|
9283
|
+
}
|
|
9284
|
+
async function resolveDocumentIdByExternalId(client, sel) {
|
|
9285
|
+
const err = validateSelector(sel, "document");
|
|
9286
|
+
if (err) return { error: err };
|
|
9287
|
+
if (sel.id) return { id: sel.id };
|
|
9288
|
+
const page = await client.documents.lookupDocumentsByBody({
|
|
9289
|
+
type: sel.type,
|
|
9290
|
+
field: "externalId",
|
|
9291
|
+
value: sel.externalId,
|
|
9292
|
+
limit: 1
|
|
9293
|
+
});
|
|
9294
|
+
const items = pageItems(page);
|
|
9295
|
+
if (items.length === 0) {
|
|
9296
|
+
return { error: `No document of type '${sel.type}' with externalId '${sel.externalId}'.` };
|
|
9297
|
+
}
|
|
9298
|
+
return { id: items[0].id };
|
|
9299
|
+
}
|
|
9300
|
+
|
|
9301
|
+
// src/tools/record_get.ts
|
|
9194
9302
|
var MAX_PAYLOAD_CHARS = 32e3;
|
|
9195
9303
|
var inputSchema3 = {
|
|
9196
|
-
id: z3.string().
|
|
9304
|
+
id: z3.string().optional().describe("The Vectros record id (e.g. from record_query or hybrid_search). Provide this OR externalId+type."),
|
|
9305
|
+
externalId: z3.string().optional().describe(
|
|
9306
|
+
"Your caller-owned externalId \u2014 an alternative selector to `id`. Requires `type` (externalId is unique within a type). Resolves to the record without a manual record_query lookup first."
|
|
9307
|
+
),
|
|
9308
|
+
type: z3.string().optional().describe("Record type \u2014 REQUIRED when selecting by `externalId` (externalId is unique within a type).")
|
|
9197
9309
|
};
|
|
9198
9310
|
var recordGet = ({ client, log }) => ({
|
|
9199
9311
|
name: "record_get",
|
|
9200
|
-
title: "Get a record by id",
|
|
9201
|
-
description: "Fetch a single structured record
|
|
9312
|
+
title: "Get a record by id or externalId",
|
|
9313
|
+
description: "Fetch a single structured record, including the full payload. Select it EITHER by its Vectros `id` (e.g. from record_query / hybrid_search) OR by your own `externalId` + `type` \u2014 the same key you passed to record_create, resolved for you (no manual record_query lookup needed). Very large payloads are truncated to protect the agent context window.",
|
|
9202
9314
|
inputSchema: inputSchema3,
|
|
9203
9315
|
handler: async (args) => {
|
|
9204
9316
|
const id = args.id;
|
|
9317
|
+
const externalId = args.externalId;
|
|
9318
|
+
const type = args.type;
|
|
9205
9319
|
try {
|
|
9206
|
-
const
|
|
9320
|
+
const resolved = await resolveRecordIdByExternalId(client, { id, externalId, type });
|
|
9321
|
+
if ("error" in resolved) return toolError("record_get", new Error(resolved.error));
|
|
9322
|
+
const record = await client.records.getRecord({ id: resolved.id });
|
|
9207
9323
|
const out = { ...record };
|
|
9208
9324
|
if (record.payload !== void 0) {
|
|
9209
9325
|
const json = JSON.stringify(record.payload);
|
|
@@ -9215,12 +9331,12 @@ var recordGet = ({ client, log }) => ({
|
|
|
9215
9331
|
}
|
|
9216
9332
|
}
|
|
9217
9333
|
log.debug(
|
|
9218
|
-
{ tool: "record_get", id, truncated: out.payloadTruncated === true },
|
|
9334
|
+
{ tool: "record_get", id: resolved.id, externalId, truncated: out.payloadTruncated === true },
|
|
9219
9335
|
"record_get ok"
|
|
9220
9336
|
);
|
|
9221
9337
|
return { content: [{ type: "text", text: JSON.stringify(out, null, 2) }] };
|
|
9222
9338
|
} catch (err) {
|
|
9223
|
-
log.warn({ tool: "record_get", id, err: String(err) }, "record_get failed");
|
|
9339
|
+
log.warn({ tool: "record_get", id, externalId, type, err: String(err) }, "record_get failed");
|
|
9224
9340
|
return toolError("record_get", err);
|
|
9225
9341
|
}
|
|
9226
9342
|
}
|
|
@@ -9280,7 +9396,11 @@ var record_create_default = recordCreate;
|
|
|
9280
9396
|
// src/tools/record_update.ts
|
|
9281
9397
|
import { z as z5 } from "zod";
|
|
9282
9398
|
var inputSchema5 = {
|
|
9283
|
-
id: z5.string().
|
|
9399
|
+
id: z5.string().optional().describe("The Vectros record id to update. Provide this OR externalId+type."),
|
|
9400
|
+
externalId: z5.string().optional().describe(
|
|
9401
|
+
"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."
|
|
9402
|
+
),
|
|
9403
|
+
type: z5.string().optional().describe("Record type \u2014 REQUIRED when selecting by `externalId` (externalId is unique within a type)."),
|
|
9284
9404
|
fields: z5.record(z5.string(), z5.unknown()).describe(
|
|
9285
9405
|
"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."
|
|
9286
9406
|
),
|
|
@@ -9291,23 +9411,27 @@ var inputSchema5 = {
|
|
|
9291
9411
|
};
|
|
9292
9412
|
var recordUpdate = ({ client, log }) => ({
|
|
9293
9413
|
name: "record_update",
|
|
9294
|
-
title: "Update a record",
|
|
9295
|
-
description: "Update a record by id. 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.",
|
|
9414
|
+
title: "Update a record by id or externalId",
|
|
9415
|
+
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.",
|
|
9296
9416
|
inputSchema: inputSchema5,
|
|
9297
9417
|
handler: async (args) => {
|
|
9298
9418
|
const id = args.id;
|
|
9419
|
+
const externalId = args.externalId;
|
|
9420
|
+
const type = args.type;
|
|
9299
9421
|
const fields = args.fields;
|
|
9300
9422
|
const status = args.status;
|
|
9301
9423
|
const expectedVersion = args.expectedVersion;
|
|
9302
9424
|
try {
|
|
9425
|
+
const resolved = await resolveRecordIdByExternalId(client, { id, externalId, type });
|
|
9426
|
+
if ("error" in resolved) return toolError("record_update", new Error(resolved.error));
|
|
9303
9427
|
const body = { payload: fields };
|
|
9304
9428
|
if (status !== void 0) body.status = status;
|
|
9305
9429
|
if (expectedVersion !== void 0) body.expectedVersion = expectedVersion;
|
|
9306
|
-
const updated = await client.records.patchRecord({ id, body });
|
|
9307
|
-
log.debug({ tool: "record_update", id }, "record_update ok");
|
|
9430
|
+
const updated = await client.records.patchRecord({ id: resolved.id, body });
|
|
9431
|
+
log.debug({ tool: "record_update", id: resolved.id, externalId }, "record_update ok");
|
|
9308
9432
|
return { content: [{ type: "text", text: JSON.stringify(updated, null, 2) }] };
|
|
9309
9433
|
} catch (err) {
|
|
9310
|
-
log.warn({ tool: "record_update", id, err: String(err) }, "record_update failed");
|
|
9434
|
+
log.warn({ tool: "record_update", id, externalId, type, err: String(err) }, "record_update failed");
|
|
9311
9435
|
return toolError("record_update", err);
|
|
9312
9436
|
}
|
|
9313
9437
|
}
|
|
@@ -9574,7 +9698,11 @@ var list_schemas_default = listSchemas;
|
|
|
9574
9698
|
import { z as z10 } from "zod";
|
|
9575
9699
|
var MAX_TEXT_CHARS = 32e3;
|
|
9576
9700
|
var inputSchema10 = {
|
|
9577
|
-
documentId: z10.string().
|
|
9701
|
+
documentId: z10.string().optional().describe("The document ID returned by document_ingest or hybrid_search. Provide this OR externalId+type."),
|
|
9702
|
+
externalId: z10.string().optional().describe(
|
|
9703
|
+
"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."
|
|
9704
|
+
),
|
|
9705
|
+
type: z10.string().optional().describe("Document type \u2014 REQUIRED when selecting by `externalId` (externalId is unique within a type)."),
|
|
9578
9706
|
includeText: z10.boolean().optional().describe(
|
|
9579
9707
|
"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."
|
|
9580
9708
|
),
|
|
@@ -9594,13 +9722,18 @@ function isNotAvailable(err) {
|
|
|
9594
9722
|
var documentGet = ({ client, log }) => ({
|
|
9595
9723
|
name: "document_get",
|
|
9596
9724
|
title: "Get document metadata (and optionally text)",
|
|
9597
|
-
description: "Fetch metadata for a single document by
|
|
9725
|
+
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`.",
|
|
9598
9726
|
inputSchema: inputSchema10,
|
|
9599
9727
|
handler: async (args) => {
|
|
9600
|
-
const
|
|
9728
|
+
const documentId = args.documentId;
|
|
9729
|
+
const externalId = args.externalId;
|
|
9730
|
+
const type = args.type;
|
|
9601
9731
|
const includeText = args.includeText ?? false;
|
|
9602
9732
|
const includeDownloadUrl = args.includeDownloadUrl ?? false;
|
|
9603
9733
|
try {
|
|
9734
|
+
const resolved = await resolveDocumentIdByExternalId(client, { id: documentId, externalId, type });
|
|
9735
|
+
if ("error" in resolved) return toolError("document_get", new Error(resolved.error));
|
|
9736
|
+
const id = resolved.id;
|
|
9604
9737
|
const doc = await client.documents.getDocument({ id });
|
|
9605
9738
|
let extra = {};
|
|
9606
9739
|
if (includeText) {
|
|
@@ -9613,7 +9746,7 @@ var documentGet = ({ client, log }) => ({
|
|
|
9613
9746
|
if (isNotAvailable(textErr)) {
|
|
9614
9747
|
log.debug(
|
|
9615
9748
|
{ tool: "document_get", id },
|
|
9616
|
-
"document_get text unavailable (
|
|
9749
|
+
"document_get text unavailable (not retained \u2014 storeText:false upload)"
|
|
9617
9750
|
);
|
|
9618
9751
|
extra = { ...extra, textAvailable: false };
|
|
9619
9752
|
} else {
|
|
@@ -9647,7 +9780,7 @@ var documentGet = ({ client, log }) => ({
|
|
|
9647
9780
|
]
|
|
9648
9781
|
};
|
|
9649
9782
|
} catch (err) {
|
|
9650
|
-
log.warn({ tool: "document_get",
|
|
9783
|
+
log.warn({ tool: "document_get", documentId, externalId, type, err: String(err) }, "document_get failed");
|
|
9651
9784
|
return toolError("document_get", err);
|
|
9652
9785
|
}
|
|
9653
9786
|
}
|
|
@@ -9762,13 +9895,22 @@ var document_query_default = documentQuery;
|
|
|
9762
9895
|
// src/tools/document_update.ts
|
|
9763
9896
|
import { z as z12 } from "zod";
|
|
9764
9897
|
var inputSchema12 = {
|
|
9765
|
-
documentId: z12.string().
|
|
9898
|
+
documentId: z12.string().optional().describe("The Vectros document id to update. Provide this OR externalId+type."),
|
|
9899
|
+
externalId: z12.string().optional().describe(
|
|
9900
|
+
"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."
|
|
9901
|
+
),
|
|
9902
|
+
type: z12.string().optional().describe("Document type \u2014 REQUIRED when selecting by `externalId` (externalId is unique within a type)."),
|
|
9766
9903
|
title: z12.string().optional().describe("New title. Omit to keep the current title."),
|
|
9767
9904
|
fields: z12.record(z12.string(), z12.unknown()).optional().describe(
|
|
9768
9905
|
"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."
|
|
9769
9906
|
),
|
|
9907
|
+
text: z12.string().optional().describe(
|
|
9908
|
+
"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."
|
|
9909
|
+
),
|
|
9770
9910
|
folderId: z12.string().optional().describe("Move the document into this folder (cannot be cleared once set)."),
|
|
9771
|
-
|
|
9911
|
+
status: z12.enum(["ACTIVE", "ARCHIVED"]).optional().describe(
|
|
9912
|
+
"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."
|
|
9913
|
+
),
|
|
9772
9914
|
userId: z12.string().optional().describe("Reassign the owning user (Vectros UUID)."),
|
|
9773
9915
|
orgId: z12.string().optional().describe("Reassign the owning org (Vectros UUID)."),
|
|
9774
9916
|
clientId: z12.string().optional().describe("Reassign the associated client (Vectros UUID)."),
|
|
@@ -9779,33 +9921,39 @@ var inputSchema12 = {
|
|
|
9779
9921
|
var documentUpdate = ({ client, log }) => ({
|
|
9780
9922
|
name: "document_update",
|
|
9781
9923
|
title: "Update a document",
|
|
9782
|
-
description:
|
|
9924
|
+
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.',
|
|
9783
9925
|
inputSchema: inputSchema12,
|
|
9784
9926
|
handler: async (args) => {
|
|
9785
9927
|
const documentId = args.documentId;
|
|
9928
|
+
const externalId = args.externalId;
|
|
9929
|
+
const type = args.type;
|
|
9786
9930
|
const title = args.title;
|
|
9787
9931
|
const fields = args.fields;
|
|
9932
|
+
const text = args.text;
|
|
9788
9933
|
const folderId = args.folderId;
|
|
9789
|
-
const
|
|
9934
|
+
const status = args.status;
|
|
9790
9935
|
const userId = args.userId;
|
|
9791
9936
|
const orgId = args.orgId;
|
|
9792
9937
|
const clientId = args.clientId;
|
|
9793
9938
|
const expectedVersion = args.expectedVersion;
|
|
9794
9939
|
try {
|
|
9940
|
+
const resolved = await resolveDocumentIdByExternalId(client, { id: documentId, externalId, type });
|
|
9941
|
+
if ("error" in resolved) return toolError("document_update", new Error(resolved.error));
|
|
9795
9942
|
const body = {};
|
|
9796
9943
|
if (title !== void 0) body.title = title;
|
|
9797
9944
|
if (fields !== void 0) body.payload = fields;
|
|
9945
|
+
if (text !== void 0) body.text = text;
|
|
9798
9946
|
if (folderId !== void 0) body.folderId = folderId;
|
|
9799
|
-
if (
|
|
9947
|
+
if (status !== void 0) body.status = status;
|
|
9800
9948
|
if (userId !== void 0) body.userId = userId;
|
|
9801
9949
|
if (orgId !== void 0) body.orgId = orgId;
|
|
9802
9950
|
if (clientId !== void 0) body.clientId = clientId;
|
|
9803
9951
|
if (expectedVersion !== void 0) body.expectedVersion = expectedVersion;
|
|
9804
9952
|
const updated = await client.documents.patchDocument({
|
|
9805
|
-
id:
|
|
9953
|
+
id: resolved.id,
|
|
9806
9954
|
body
|
|
9807
9955
|
});
|
|
9808
|
-
log.debug({ tool: "document_update", documentId }, "document_update ok");
|
|
9956
|
+
log.debug({ tool: "document_update", documentId: resolved.id, externalId }, "document_update ok");
|
|
9809
9957
|
return { content: [{ type: "text", text: JSON.stringify(updated, null, 2) }] };
|
|
9810
9958
|
} catch (err) {
|
|
9811
9959
|
log.warn({ tool: "document_update", documentId, err: String(err) }, "document_update failed");
|
|
@@ -9823,7 +9971,7 @@ var inputSchema13 = {
|
|
|
9823
9971
|
var documentDelete = ({ client, log }) => ({
|
|
9824
9972
|
name: "document_delete",
|
|
9825
9973
|
title: "Delete a document",
|
|
9826
|
-
description:
|
|
9974
|
+
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).',
|
|
9827
9975
|
inputSchema: inputSchema13,
|
|
9828
9976
|
handler: async (args) => {
|
|
9829
9977
|
const documentId = args.documentId;
|
|
@@ -10103,6 +10251,9 @@ var inputSchema19 = {
|
|
|
10103
10251
|
externalId: z18.string().optional().describe(
|
|
10104
10252
|
"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."
|
|
10105
10253
|
),
|
|
10254
|
+
upsert: z18.boolean().optional().describe(
|
|
10255
|
+
"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)."
|
|
10256
|
+
),
|
|
10106
10257
|
schemaId: z18.string().optional().describe(
|
|
10107
10258
|
"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."
|
|
10108
10259
|
),
|
|
@@ -10112,7 +10263,7 @@ var inputSchema19 = {
|
|
|
10112
10263
|
// Inline text mode (mutually exclusive with filePath):
|
|
10113
10264
|
text: z18.string().min(1).optional().describe("Text body to ingest inline. Mutually exclusive with filePath. Either text or filePath is required."),
|
|
10114
10265
|
storeText: z18.boolean().optional().describe(
|
|
10115
|
-
"
|
|
10266
|
+
"Whether the document's text is retained after indexing (default true). Applies to BOTH modes and is fixed at ingest time. Text mode: the ingested body is always retained (this flag is effectively always true \u2014 the body is the document). File mode: true keeps the extracted text retrievable via document_get(includeText:true) and usable by document_ask; false discards the extracted text once indexing completes \u2014 search still works and the original file remains downloadable, but includeText returns textAvailable:false and document_ask is unavailable."
|
|
10116
10267
|
),
|
|
10117
10268
|
// File upload mode (mutually exclusive with text; stdio-transport-only):
|
|
10118
10269
|
filePath: z18.string().min(1).optional().describe(
|
|
@@ -10128,13 +10279,14 @@ var inputSchema19 = {
|
|
|
10128
10279
|
var documentIngest = ({ client, log, transport, ingestRoot }) => ({
|
|
10129
10280
|
name: "document_ingest",
|
|
10130
10281
|
title: "Ingest a new document (text body or file upload)",
|
|
10131
|
-
description: "Create a new document in
|
|
10282
|
+
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). 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 defaults to true and is fixed at ingest: in file mode, false discards the extracted text after indexing (search + file download keep working; text retrieval and document_ask do not). Text-mode bodies are always retained.",
|
|
10132
10283
|
inputSchema: inputSchema19,
|
|
10133
10284
|
handler: async (args) => {
|
|
10134
10285
|
const title = args.title;
|
|
10135
10286
|
const text = args.text;
|
|
10136
10287
|
const filePath = args.filePath;
|
|
10137
10288
|
const schemaId = args.schemaId;
|
|
10289
|
+
const upsert = args.upsert;
|
|
10138
10290
|
const indexMode = args.indexMode ?? (schemaId ? void 0 : "HYBRID");
|
|
10139
10291
|
if (!text && !filePath) {
|
|
10140
10292
|
return toolError(
|
|
@@ -10167,13 +10319,12 @@ var documentIngest = ({ client, log, transport, ingestRoot }) => ({
|
|
|
10167
10319
|
};
|
|
10168
10320
|
try {
|
|
10169
10321
|
if (text) {
|
|
10170
|
-
const storeText = args.storeText ?? true;
|
|
10171
10322
|
const result = await client.documents.ingestDocument({
|
|
10323
|
+
upsert,
|
|
10172
10324
|
body: {
|
|
10173
10325
|
title,
|
|
10174
10326
|
text,
|
|
10175
10327
|
indexMode,
|
|
10176
|
-
storeText,
|
|
10177
10328
|
...common
|
|
10178
10329
|
}
|
|
10179
10330
|
});
|
|
@@ -10204,10 +10355,13 @@ var documentIngest = ({ client, log, transport, ingestRoot }) => ({
|
|
|
10204
10355
|
}
|
|
10205
10356
|
const fileName = basename(safePath);
|
|
10206
10357
|
const fileType = args.fileType ?? inferMimeType(safePath);
|
|
10358
|
+
const storeTextFile = args.storeText ?? true;
|
|
10207
10359
|
const upload = await client.documents.uploadDocument({
|
|
10360
|
+
upsert,
|
|
10208
10361
|
fileName,
|
|
10209
10362
|
fileType,
|
|
10210
10363
|
indexMode,
|
|
10364
|
+
storeText: storeTextFile,
|
|
10211
10365
|
...common
|
|
10212
10366
|
});
|
|
10213
10367
|
const uploadUrl = upload?.uploadUrl;
|
|
@@ -10243,8 +10397,8 @@ var documentIngest = ({ client, log, transport, ingestRoot }) => ({
|
|
|
10243
10397
|
text: JSON.stringify(
|
|
10244
10398
|
{
|
|
10245
10399
|
...upload,
|
|
10246
|
-
|
|
10247
|
-
_note: "File uploaded; indexing is asynchronous. Poll document_get(id) until
|
|
10400
|
+
indexStatus: "PENDING_INDEX",
|
|
10401
|
+
_note: "File uploaded; indexing is asynchronous. Poll document_get(id) until indexStatus is INDEXED."
|
|
10248
10402
|
},
|
|
10249
10403
|
null,
|
|
10250
10404
|
2
|
|
@@ -10541,6 +10695,14 @@ function zodTypeToJsonSchema(schema) {
|
|
|
10541
10695
|
|
|
10542
10696
|
// src/server.ts
|
|
10543
10697
|
var DEFAULT_ENVIRONMENT = "https://api.vectros.ai";
|
|
10698
|
+
function formatArgError(tool, error) {
|
|
10699
|
+
const unknownKeys = error.issues.filter((i) => i.code === "unrecognized_keys").flatMap((i) => i.keys);
|
|
10700
|
+
if (unknownKeys.length > 0) {
|
|
10701
|
+
const valid = Object.keys(tool.inputSchema).join(", ");
|
|
10702
|
+
return `Unknown argument(s): ${unknownKeys.join(", ")}. Valid arguments for ${tool.name}: ${valid}. Pass only these \u2014 an unrecognized argument is rejected, not ignored.`;
|
|
10703
|
+
}
|
|
10704
|
+
return `Invalid arguments: ${error.message}`;
|
|
10705
|
+
}
|
|
10544
10706
|
var VectrosMCPServer = class {
|
|
10545
10707
|
server;
|
|
10546
10708
|
log;
|
|
@@ -10630,7 +10792,11 @@ var VectrosMCPServer = class {
|
|
|
10630
10792
|
name: t.name,
|
|
10631
10793
|
title: t.title,
|
|
10632
10794
|
description: t.description,
|
|
10633
|
-
|
|
10795
|
+
// additionalProperties:false advertises strict argument validation to the
|
|
10796
|
+
// MCP client (a well-behaved client rejects an unknown key before the call).
|
|
10797
|
+
// The server enforces it too (z.object(...).strict() below) so a raw JSON-RPC
|
|
10798
|
+
// call that skips client validation is still rejected — belt and suspenders.
|
|
10799
|
+
inputSchema: { ...zodShapeToJsonSchema(t.inputSchema), additionalProperties: false }
|
|
10634
10800
|
}))
|
|
10635
10801
|
})
|
|
10636
10802
|
);
|
|
@@ -10640,9 +10806,9 @@ var VectrosMCPServer = class {
|
|
|
10640
10806
|
if (!tool) {
|
|
10641
10807
|
result = toolError(req.params.name ?? "unknown", new Error("No such tool."));
|
|
10642
10808
|
} else {
|
|
10643
|
-
const parsed = z22.object(tool.inputSchema).safeParse(req.params.arguments ?? {});
|
|
10809
|
+
const parsed = z22.object(tool.inputSchema).strict().safeParse(req.params.arguments ?? {});
|
|
10644
10810
|
if (!parsed.success) {
|
|
10645
|
-
result = toolError(tool.name, new Error(
|
|
10811
|
+
result = toolError(tool.name, new Error(formatArgError(tool, parsed.error)));
|
|
10646
10812
|
} else {
|
|
10647
10813
|
try {
|
|
10648
10814
|
result = await tool.handler(
|