@apify/actors-mcp-server 0.1.22-beta.14 → 0.1.22-beta.15

package/dist/tools/utils.js

@@ -1,202 +0,0 @@
-import { ACTOR_ENUM_MAX_LENGTH, ACTOR_MAX_DESCRIPTION_LENGTH } from '../const.js';
-export function actorNameToToolName(actorName) {
-    return actorName
-        .replace(/\//g, '-slash-')
-        .replace(/\./g, '-dot-')
-        .slice(0, 64);
-}
-/**
- * Builds nested properties for object types in the schema.
- *
- * Specifically handles special cases like proxy configuration and request list sources
- * by adding predefined nested properties to these object types.
- * This is necessary for the agent to correctly infer how to structure object inputs
- * when passing arguments to the Actor.
- *
- * For proxy objects (type='object', editor='proxy'), adds 'useApifyProxy' property.
- * For request list sources (type='array', editor='requestListSources'), adds URL structure to items.
- *
- * @param {Record<string, ISchemaProperties>} properties - The input schema properties
- * @returns {Record<string, ISchemaProperties>} Modified properties with nested properties
- */
-export function buildNestedProperties(properties) {
-    const clonedProperties = { ...properties };
-    for (const [propertyName, property] of Object.entries(clonedProperties)) {
-        if (property.type === 'object' && property.editor === 'proxy') {
-            clonedProperties[propertyName] = {
-                ...property,
-                properties: {
-                    ...property.properties,
-                    useApifyProxy: {
-                        title: 'Use Apify Proxy',
-                        type: 'boolean',
-                        description: 'Whether to use Apify Proxy - ALWAYS SET TO TRUE.',
-                        default: true,
-                        examples: [true],
-                    },
-                },
-                required: ['useApifyProxy'],
-            };
-        }
-        else if (property.type === 'array' && property.editor === 'requestListSources') {
-            clonedProperties[propertyName] = {
-                ...property,
-                items: {
-                    ...property.items,
-                    type: 'object',
-                    title: 'Request list source',
-                    description: 'Request list source',
-                    properties: {
-                        url: {
-                            title: 'URL',
-                            type: 'string',
-                            description: 'URL of the request list source',
-                        },
-                    },
-                },
-            };
-        }
-    }
-    return clonedProperties;
-}
-/**
- * Filters schema properties to include only the necessary fields.
- *
- * This is done to reduce the size of the input schema and to make it more readable.
- *
- * @param properties
- */
-export function filterSchemaProperties(properties) {
-    var _a, _b, _c;
-    const filteredProperties = {};
-    for (const [key, property] of Object.entries(properties)) {
-        filteredProperties[key] = {
-            title: property.title,
-            description: property.description,
-            enum: property.enum,
-            type: property.type,
-            default: property.default,
-            prefill: property.prefill,
-            properties: property.properties,
-            items: property.items,
-            required: property.required,
-        };
-        if (property.type === 'array' && !((_a = property.items) === null || _a === void 0 ? void 0 : _a.type)) {
-            const itemsType = inferArrayItemType(property);
-            if (itemsType) {
-                filteredProperties[key].items = {
-                    ...filteredProperties[key].items,
-                    title: (_b = filteredProperties[key].title) !== null && _b !== void 0 ? _b : 'Item',
-                    description: (_c = filteredProperties[key].description) !== null && _c !== void 0 ? _c : 'Item',
-                    type: itemsType,
-                };
-            }
-        }
-    }
-    return filteredProperties;
-}
-/**
- * Marks input properties as required by adding a "REQUIRED" prefix to their descriptions.
- * Takes an IActorInput object and returns a modified Record of SchemaProperties.
- *
- * This is done for maximum compatibility in case where library or agent framework does not consider
- * required fields and does not handle the JSON schema properly: we are prepending this to the description
- * as a preventive measure.
- * @param {IActorInputSchema} input - Actor input object containing properties and required fields
- * @returns {Record<string, ISchemaProperties>} - Modified properties with required fields marked
- */
-export function markInputPropertiesAsRequired(input) {
-    const { required = [], properties } = input;
-    for (const property of Object.keys(properties)) {
-        if (required.includes(property)) {
-            properties[property] = {
-                ...properties[property],
-                description: `**REQUIRED** ${properties[property].description}`,
-            };
-        }
-    }
-    return properties;
-}
-/**
- * Helps determine the type of items in an array schema property.
- * Priority order: explicit type in items > prefill type > default value type > editor type.
- *
- * Based on JSON schema, the array needs a type, and most of the time Actor input schema does not have this, so we need to infer that.
- *
- */
-export function inferArrayItemType(property) {
-    var _a;
-    return ((_a = property.items) === null || _a === void 0 ? void 0 : _a.type)
-        || (Array.isArray(property.prefill) && property.prefill.length > 0 && typeof property.prefill[0])
-        || (Array.isArray(property.default) && property.default.length > 0 && typeof property.default[0])
-        || (property.editor && getEditorItemType(property.editor))
-        || null;
-    function getEditorItemType(editor) {
-        const editorTypeMap = {
-            requestListSources: 'object',
-            stringList: 'string',
-            json: 'object',
-            globs: 'object',
-        };
-        return editorTypeMap[editor] || null;
-    }
-}
-/**
- * Add enum values as string to property descriptions.
- *
- * This is done as a preventive measure to prevent cases where library or agent framework
- * does not handle enums or examples based on JSON schema definition.
- *
- * https://json-schema.org/understanding-json-schema/reference/enum
- * https://json-schema.org/understanding-json-schema/reference/annotations
- *
- * @param properties
- */
-export function addEnumsToDescriptionsWithExamples(properties) {
-    var _a;
-    for (const property of Object.values(properties)) {
-        if (property.enum && property.enum.length > 0) {
-            property.description = `${property.description}\nPossible values: ${property.enum.slice(0, 20).join(',')}`;
-        }
-        const value = (_a = property.prefill) !== null && _a !== void 0 ? _a : property.default;
-        if (value && !(Array.isArray(value) && value.length === 0)) {
-            property.examples = Array.isArray(value) ? value : [value];
-            property.description = `${property.description}\nExample values: ${JSON.stringify(value)}`;
-        }
-    }
-    return properties;
-}
-/**
- * Helper function to shorten the enum list if it is too long.
- *
- * @param {string[]} enumList - The list of enum values to be shortened.
- * @returns {string[] | undefined} - The shortened enum list or undefined if the list is too long.
- */
-export function shortenEnum(enumList) {
-    let charCount = 0;
-    const resultEnumList = enumList.filter((enumValue) => {
-        charCount += enumValue.length;
-        return charCount <= ACTOR_ENUM_MAX_LENGTH;
-    });
-    return resultEnumList.length > 0 ? resultEnumList : undefined;
-}
-/**
- * Shortens the description, enum, and items.enum properties of the schema properties.
- * @param properties
- */
-export function shortenProperties(properties) {
-    var _a, _b;
-    for (const property of Object.values(properties)) {
-        if (property.description.length > ACTOR_MAX_DESCRIPTION_LENGTH) {
-            property.description = `${property.description.slice(0, ACTOR_MAX_DESCRIPTION_LENGTH)}...`;
-        }
-        if (property.enum && ((_a = property.enum) === null || _a === void 0 ? void 0 : _a.length) > 0) {
-            property.enum = shortenEnum(property.enum);
-        }
-        if (((_b = property.items) === null || _b === void 0 ? void 0 : _b.enum) && property.items.enum.length > 0) {
-            property.items.enum = shortenEnum(property.items.enum);
-        }
-    }
-    return properties;
-}
-//# sourceMappingURL=utils.js.map

package/dist/tools/utils.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/tools/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,4BAA4B,EAAE,MAAM,aAAa,CAAC;AAGlF,MAAM,UAAU,mBAAmB,CAAC,SAAiB;IACjD,OAAO,SAAS;SACX,OAAO,CAAC,KAAK,EAAE,SAAS,CAAC;SACzB,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC;SACvB,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;AACtB,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,qBAAqB,CAAC,UAA6C;IAC/E,MAAM,gBAAgB,GAAG,EAAE,GAAG,UAAU,EAAE,CAAC;IAE3C,KAAK,MAAM,CAAC,YAAY,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAE,CAAC;QACtE,IAAI,QAAQ,CAAC,IAAI,KAAK,QAAQ,IAAI,QAAQ,CAAC,MAAM,KAAK,OAAO,EAAE,CAAC;YAC5D,gBAAgB,CAAC,YAAY,CAAC,GAAG;gBAC7B,GAAG,QAAQ;gBACX,UAAU,EAAE;oBACR,GAAG,QAAQ,CAAC,UAAU;oBACtB,aAAa,EAAE;wBACX,KAAK,EAAE,iBAAiB;wBACxB,IAAI,EAAE,SAAS;wBACf,WAAW,EAAE,kDAAkD;wBAC/D,OAAO,EAAE,IAAI;wBACb,QAAQ,EAAE,CAAC,IAAI,CAAC;qBACnB;iBACJ;gBACD,QAAQ,EAAE,CAAC,eAAe,CAAC;aAC9B,CAAC;QACN,CAAC;aAAM,IAAI,QAAQ,CAAC,IAAI,KAAK,OAAO,IAAI,QAAQ,CAAC,MAAM,KAAK,oBAAoB,EAAE,CAAC;YAC/E,gBAAgB,CAAC,YAAY,CAAC,GAAG;gBAC7B,GAAG,QAAQ;gBACX,KAAK,EAAE;oBACH,GAAG,QAAQ,CAAC,KAAK;oBACjB,IAAI,EAAE,QAAQ;oBACd,KAAK,EAAE,qBAAqB;oBAC5B,WAAW,EAAE,qBAAqB;oBAClC,UAAU,EAAE;wBACR,GAAG,EAAE;4BACD,KAAK,EAAE,KAAK;4BACZ,IAAI,EAAE,QAAQ;4BACd,WAAW,EAAE,gCAAgC;yBAChD;qBACJ;iBACJ;aACJ,CAAC;QACN,CAAC;IACL,CAAC;IAED,OAAO,gBAAgB,CAAC;AAC5B,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,sBAAsB,CAAC,UAAgD;;IAGnF,MAAM,kBAAkB,GAAyC,EAAE,CAAC;IACpE,KAAK,MAAM,CAAC,GAAG,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;QACvD,kBAAkB,CAAC,GAAG,CAAC,GAAG;YACtB,KAAK,EAAE,QAAQ,CAAC,KAAK;YACrB,WAAW,EAAE,QAAQ,CAAC,WAAW;YACjC,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,OAAO,EAAE,QAAQ,CAAC,OAAO;YACzB,OAAO,EAAE,QAAQ,CAAC,OAAO;YACzB,UAAU,EAAE,QAAQ,CAAC,UAAU;YAC/B,KAAK,EAAE,QAAQ,CAAC,KAAK;YACrB,QAAQ,EAAE,QAAQ,CAAC,QAAQ;SAC9B,CAAC;QACF,IAAI,QAAQ,CAAC,IAAI,KAAK,OAAO,IAAI,CAAC,CAAA,MAAA,QAAQ,CAAC,KAAK,0CAAE,IAAI,CAAA,EAAE,CAAC;YACrD,MAAM,SAAS,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;YAC/C,IAAI,SAAS,EAAE,CAAC;gBACZ,kBAAkB,CAAC,GAAG,CAAC,CAAC,KAAK,GAAG;oBAC5B,GAAG,kBAAkB,CAAC,GAAG,CAAC,CAAC,KAAK;oBAChC,KAAK,EAAE,MAAA,kBAAkB,CAAC,GAAG,CAAC,CAAC,KAAK,mCAAI,MAAM;oBAC9C,WAAW,EAAE,MAAA,kBAAkB,CAAC,GAAG,CAAC,CAAC,WAAW,mCAAI,MAAM;oBAC1D,IAAI,EAAE,SAAS;iBAClB,CAAC;YACN,CAAC;QACL,CAAC;IACL,CAAC;IACD,OAAO,kBAAkB,CAAC;AAC9B,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,6BAA6B,CAAC,KAAwB;IAClE,MAAM,EAAE,QAAQ,GAAG,EAAE,EAAE,UAAU,EAAE,GAAG,KAAK,CAAC;IAE5C,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;QAC7C,IAAI,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC9B,UAAU,CAAC,QAAQ,CAAC,GAAG;gBACnB,GAAG,UAAU,CAAC,QAAQ,CAAC;gBACvB,WAAW,EAAE,gBAAgB,UAAU,CAAC,QAAQ,CAAC,CAAC,WAAW,EAAE;aAClE,CAAC;QACN,CAAC;IACL,CAAC;IAED,OAAO,UAAU,CAAC;AACtB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,kBAAkB,CAAC,QAA2B;;IAC1D,OAAO,CAAA,MAAA,QAAQ,CAAC,KAAK,0CAAE,IAAI;WACpB,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,QAAQ,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,OAAO,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;WAC9F,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,QAAQ,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,OAAO,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;WAC9F,CAAC,QAAQ,CAAC,MAAM,IAAI,iBAAiB,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;WACvD,IAAI,CAAC;IAEZ,SAAS,iBAAiB,CAAC,MAAc;QACrC,MAAM,aAAa,GAA2B;YAC1C,kBAAkB,EAAE,QAAQ;YAC5B,UAAU,EAAE,QAAQ;YACpB,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,QAAQ;SAClB,CAAC;QACF,OAAO,aAAa,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC;IACzC,CAAC;AACL,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,kCAAkC,CAAC,UAA6C;;IAC5F,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC;QAC/C,IAAI,QAAQ,CAAC,IAAI,IAAI,QAAQ,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC5C,QAAQ,CAAC,WAAW,GAAG,GAAG,QAAQ,CAAC,WAAW,sBAAsB,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QAC/G,CAAC;QACD,MAAM,KAAK,GAAG,MAAA,QAAQ,CAAC,OAAO,mCAAI,QAAQ,CAAC,OAAO,CAAC;QACnD,IAAI,KAAK,IAAI,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC,EAAE,CAAC;YACzD,QAAQ,CAAC,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;YAC3D,QAAQ,CAAC,WAAW,GAAG,GAAG,QAAQ,CAAC,WAAW,qBAAqB,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;QAC/F,CAAC;IACL,CAAC;IACD,OAAO,UAAU,CAAC;AACtB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,WAAW,CAAC,QAAkB;IAC1C,IAAI,SAAS,GAAG,CAAC,CAAC;IAClB,MAAM,cAAc,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,SAAS,EAAE,EAAE;QACjD,SAAS,IAAI,SAAS,CAAC,MAAM,CAAC;QAC9B,OAAO,SAAS,IAAI,qBAAqB,CAAC;IAC9C,CAAC,CAAC,CAAC;IAEH,OAAO,cAAc,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,SAAS,CAAC;AAClE,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,iBAAiB,CAAC,UAAgD;;IAG9E,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC;QAC/C,IAAI,QAAQ,CAAC,WAAW,CAAC,MAAM,GAAG,4BAA4B,EAAE,CAAC;YAC7D,QAAQ,CAAC,WAAW,GAAG,GAAG,QAAQ,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,EAAE,4BAA4B,CAAC,KAAK,CAAC;QAC/F,CAAC;QAED,IAAI,QAAQ,CAAC,IAAI,IAAI,CAAA,MAAA,QAAQ,CAAC,IAAI,0CAAE,MAAM,IAAG,CAAC,EAAE,CAAC;YAC7C,QAAQ,CAAC,IAAI,GAAG,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC/C,CAAC;QAED,IAAI,CAAA,MAAA,QAAQ,CAAC,KAAK,0CAAE,IAAI,KAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACzD,QAAQ,CAAC,KAAK,CAAC,IAAI,GAAG,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC3D,CAAC;IACL,CAAC;IAED,OAAO,UAAU,CAAC;AACtB,CAAC"}