@apify/actors-mcp-server 0.20.1-beta.8 → 0.20.1

package/dist/tools/structured_output_schemas.d.ts

@@ -365,372 +365,114 @@ export declare const actorInfoSchema: {
     };
     required: string[];
 };
+/** Schema for fetch-actor-mcp-tool-list output: the remote tool definitions as `tools/list` returned them. */
+export declare const actorMcpToolListOutputSchema: {
+    type: "object";
+    properties: {
+        tools: {
+            type: string;
+            items: {
+                type: string;
+            };
+            description: string;
+        };
+    };
+    required: string[];
+};
 /**
- * Schema for Actor details output (fetch-actor-details tool)
- * All fields are optional since the tool supports selective output via the 'output' parameter
- *
- * NOTE on `readme`: This field contains the abridged README summary when the Actor has one,
- * falling back to the full README otherwise. The field is named `readme` (not `readmeSummary`)
- * to stay consistent with the widget UI contract. Most Actors should have a summary defined,
- * so the full README fallback is only expected in niche cases.
+ * Schema for fetch-actor-details-widget output.
+ * Widget-only; renders as an interactive UI element in apps mode.
+ * `actorInfo` is the widget-shaped actor (from `formatActorForWidget`), kept as a loose
+ * object because it doesn't align with `actorInfoSchema` (adds `currentPricingInfo` etc.).
  */
-export declare const actorDetailsOutputSchema: {
+export declare const actorDetailsWidgetOutputSchema: {
     type: "object";
     properties: {
-        actorInfo: {
+        actorDetails: {
             type: "object";
             properties: {
-                title: {
-                    type: string;
-                    description: string;
-                };
-                url: {
-                    type: string;
-                    description: string;
-                };
-                id: {
-                    type: string;
+                actorInfo: {
+                    type: "object";
                     description: string;
                 };
-                fullName: {
+                actorCard: {
                     type: string;
                     description: string;
                 };
-                pictureUrl: {
+                readme: {
                     type: string;
                     description: string;
                 };
-                developer: {
-                    type: "object";
-                    properties: {
-                        username: {
-                            type: string;
-                            description: string;
-                        };
-                        isOfficialApify: {
-                            type: string;
-                            description: string;
-                        };
-                        url: {
-                            type: string;
-                            description: string;
-                        };
+            };
+            required: string[];
+            additionalProperties: boolean;
+        };
+    };
+    required: string[];
+    additionalProperties: boolean;
+};
+/**
+ * Schema for search results output (store-search tool)
+ */
+export declare const actorSearchOutputSchema: {
+    type: "object";
+    properties: {
+        actors: {
+            type: "array";
+            items: {
+                type: "object";
+                properties: {
+                    title: {
+                        type: string;
+                        description: string;
                     };
-                    required: string[];
-                };
-                description: {
-                    type: string;
-                    description: string;
-                };
-                categories: {
-                    type: "array";
-                    items: {
+                    url: {
                         type: string;
+                        description: string;
                     };
-                    description: string;
-                };
-                pricing: {
-                    type: "object";
-                    properties: {
-                        model: {
-                            type: string;
-                            description: string;
-                        };
-                        userTier: {
-                            type: string;
-                            enum: string[];
-                            description: string;
-                        };
-                        pricePerUnit: {
-                            type: string;
-                            description: string;
-                        };
-                        unitName: {
-                            type: string;
-                            description: string;
-                        };
-                        trialMinutes: {
-                            type: string;
-                            description: string;
-                        };
-                        tieredPricing: {
-                            type: "array";
-                            items: {
-                                type: "object";
-                                properties: {
-                                    tier: {
-                                        type: string;
-                                        description: string;
-                                    };
-                                    pricePerUnit: {
-                                        type: string;
-                                        description: string;
-                                    };
-                                };
+                    id: {
+                        type: string;
+                        description: string;
+                    };
+                    fullName: {
+                        type: string;
+                        description: string;
+                    };
+                    pictureUrl: {
+                        type: string;
+                        description: string;
+                    };
+                    developer: {
+                        type: "object";
+                        properties: {
+                            username: {
+                                type: string;
+                                description: string;
                             };
-                            description: string;
-                        };
-                        events: {
-                            type: "array";
-                            items: {
-                                type: "object";
-                                properties: {
-                                    title: {
-                                        type: string;
-                                        description: string;
-                                    };
-                                    description: {
-                                        type: string;
-                                        description: string;
-                                    };
-                                    priceUsd: {
-                                        type: string;
-                                        description: string;
-                                    };
-                                    tieredPricing: {
-                                        type: "array";
-                                        items: {
-                                            type: "object";
-                                            properties: {
-                                                tier: {
-                                                    type: string;
-                                                };
-                                                priceUsd: {
-                                                    type: string;
-                                                };
-                                            };
-                                        };
-                                    };
-                                };
+                            isOfficialApify: {
+                                type: string;
+                                description: string;
+                            };
+                            url: {
+                                type: string;
+                                description: string;
                             };
-                            description: string;
-                        };
-                        pricingNote: {
-                            type: string;
-                            description: string;
-                        };
-                        eventDescriptionsOmitted: {
-                            type: string;
-                            description: string;
-                        };
-                        eventDescriptionsNote: {
-                            type: string;
-                            description: string;
                         };
+                        required: string[];
                     };
-                    required: string[];
-                };
-                stats: {
-                    type: "object";
-                    properties: {
-                        totalUsers: {
-                            type: string;
-                            description: string;
-                        };
-                        monthlyUsers: {
-                            type: string;
-                            description: string;
-                        };
+                    description: {
+                        type: string;
+                        description: string;
                     };
-                };
-                rating: {
-                    type: "object";
-                    properties: {
-                        average: {
-                            type: string;
-                            description: string;
-                        };
-                        count: {
+                    categories: {
+                        type: "array";
+                        items: {
                             type: string;
-                            description: string;
                         };
+                        description: string;
                     };
-                };
-                modifiedAt: {
-                    type: string;
-                    description: string;
-                };
-                isDeprecated: {
-                    type: string;
-                    description: string;
-                };
-                inputFields: {
-                    type: "object";
-                    description: string;
-                    properties: {
-                        type: {
-                            type: string;
-                            description: string;
-                        };
-                        properties: {
-                            type: "object";
-                            description: string;
-                            additionalProperties: {
-                                type: "object";
-                                properties: {
-                                    type: {
-                                        anyOf: ({
-                                            type: string;
-                                            items?: undefined;
-                                        } | {
-                                            type: string;
-                                            items: {
-                                                type: string;
-                                            };
-                                        })[];
-                                        description: string;
-                                    };
-                                };
-                                required: string[];
-                            };
-                        };
-                        required: {
-                            type: "array";
-                            items: {
-                                type: string;
-                            };
-                            description: string;
-                        };
-                    };
-                    required: string[];
-                };
-                inputFieldsTruncated: {
-                    type: string;
-                    description: string;
-                };
-                inputFieldsTotalCount: {
-                    type: string;
-                    description: string;
-                };
-            };
-            required: string[];
-        };
-        readme: {
-            type: string;
-            description: string;
-        };
-        inputSchema: {
-            type: "object";
-            description: string;
-        };
-        outputSchema: {
-            type: "object";
-            description: string;
-        };
-        serverInterface: {
-            type: string;
-            description: string;
-        };
-    };
-};
-/** Schema for fetch-actor-mcp-tool-list output: the remote tool definitions as `tools/list` returned them. */
-export declare const actorMcpToolListOutputSchema: {
-    type: "object";
-    properties: {
-        tools: {
-            type: string;
-            items: {
-                type: string;
-            };
-            description: string;
-        };
-    };
-    required: string[];
-};
-/**
- * Schema for fetch-actor-details-widget output.
- * Widget-only; renders as an interactive UI element in apps mode.
- * `actorInfo` is the widget-shaped actor (from `formatActorForWidget`), kept as a loose
- * object because it doesn't align with `actorInfoSchema` (adds `currentPricingInfo` etc.).
- */
-export declare const actorDetailsWidgetOutputSchema: {
-    type: "object";
-    properties: {
-        actorDetails: {
-            type: "object";
-            properties: {
-                actorInfo: {
-                    type: "object";
-                    description: string;
-                };
-                actorCard: {
-                    type: string;
-                    description: string;
-                };
-                readme: {
-                    type: string;
-                    description: string;
-                };
-            };
-            required: string[];
-            additionalProperties: boolean;
-        };
-    };
-    required: string[];
-    additionalProperties: boolean;
-};
-/**
- * Schema for search results output (store-search tool)
- */
-export declare const actorSearchOutputSchema: {
-    type: "object";
-    properties: {
-        actors: {
-            type: "array";
-            items: {
-                type: "object";
-                properties: {
-                    title: {
-                        type: string;
-                        description: string;
-                    };
-                    url: {
-                        type: string;
-                        description: string;
-                    };
-                    id: {
-                        type: string;
-                        description: string;
-                    };
-                    fullName: {
-                        type: string;
-                        description: string;
-                    };
-                    pictureUrl: {
-                        type: string;
-                        description: string;
-                    };
-                    developer: {
-                        type: "object";
-                        properties: {
-                            username: {
-                                type: string;
-                                description: string;
-                            };
-                            isOfficialApify: {
-                                type: string;
-                                description: string;
-                            };
-                            url: {
-                                type: string;
-                                description: string;
-                            };
-                        };
-                        required: string[];
-                    };
-                    description: {
-                        type: string;
-                        description: string;
-                    };
-                    categories: {
-                        type: "array";
-                        items: {
-                            type: string;
-                        };
-                        description: string;
-                    };
-                    pricing: {
-                        type: "object";
+                    pricing: {
+                        type: "object";
                         properties: {
                             model: {
                                 type: string;
@@ -2811,180 +2553,589 @@ export declare const keyValueStoreKeysOutputSchema: {
                         description: string;
                     };
                 };
-                required: string[];
+                required: string[];
+            };
+            description: string;
+        };
+        count: {
+            type: string;
+            description: string;
+        };
+        isTruncated: {
+            type: string;
+            description: string;
+        };
+        nextExclusiveStartKey: {
+            description: string;
+            anyOf: {
+                type: string;
+            }[];
+        };
+        summary: {
+            type: "string";
+            description: string;
+        };
+        nextStep: {
+            type: "string";
+            description: string;
+        };
+    };
+    required: string[];
+};
+/**
+ * Schema for a single record (get-key-value-store-record). Terminal: no nextStep.
+ */
+export declare const keyValueStoreRecordOutputSchema: {
+    type: "object";
+    properties: {
+        keyValueStoreId: {
+            type: string;
+            description: string;
+        };
+        key: {
+            type: string;
+            description: string;
+        };
+        value: {
+            description: string;
+            anyOf: {
+                type: string;
+            }[];
+        };
+        contentType: {
+            type: string;
+            description: string;
+        };
+        summary: {
+            type: "string";
+            description: string;
+        };
+    };
+    required: string[];
+};
+/**
+ * Schema for the operations found by apify-api-search.
+ */
+export declare const apifyApiSearchOutputSchema: {
+    type: "object";
+    properties: {
+        operations: {
+            type: "array";
+            items: {
+                type: "object";
+                properties: {
+                    method: {
+                        type: string;
+                        description: string;
+                    };
+                    path: {
+                        type: string;
+                        description: string;
+                    };
+                    summary: {
+                        type: string;
+                        description: string;
+                    };
+                    docsUrl: {
+                        type: string;
+                        description: string;
+                    };
+                };
+                required: string[];
+            };
+        };
+    };
+    required: string[];
+};
+/**
+ * Schema for the operations on one path (apify-api-details).
+ */
+export declare const apifyApiDetailsOutputSchema: {
+    type: "object";
+    properties: {
+        operations: {
+            type: "array";
+            items: {
+                type: "object";
+                properties: {
+                    method: {
+                        type: string;
+                        description: string;
+                    };
+                    path: {
+                        type: string;
+                        description: string;
+                    };
+                    summary: {
+                        type: string;
+                        description: string;
+                    };
+                    description: {
+                        type: string;
+                        description: string;
+                    };
+                    parameters: {
+                        type: "array";
+                        items: {
+                            type: "object";
+                            properties: {
+                                name: {
+                                    type: string;
+                                    description: string;
+                                };
+                                in: {
+                                    type: string;
+                                    enum: string[];
+                                    description: string;
+                                };
+                                isRequired: {
+                                    type: string;
+                                    description: string;
+                                };
+                                description: {
+                                    type: string;
+                                    description: string;
+                                };
+                                schema: {
+                                    type: string;
+                                    description: string;
+                                };
+                            };
+                            required: string[];
+                        };
+                        description: string;
+                    };
+                    requestBody: {
+                        type: "object";
+                        properties: {
+                            isRequired: {
+                                type: string;
+                                description: string;
+                            };
+                            schema: {
+                                type: string;
+                                description: string;
+                            };
+                        };
+                        required: string[];
+                        description: string;
+                    };
+                };
+                required: string[];
+            };
+            description: string;
+        };
+    };
+    required: string[];
+};
+/**
+ * Schema for Actor details output (fetch-actor-details tool)
+ * All fields are optional since the tool supports selective output via the 'output' parameter
+ *
+ * NOTE on `readme`: This field contains the abridged README summary when the Actor has one,
+ * falling back to the full README otherwise. The field is named `readme` (not `readmeSummary`)
+ * to stay consistent with the widget UI contract. Most Actors should have a summary defined,
+ * so the full README fallback is only expected in niche cases.
+ */
+export declare const actorDetailsOutputSchema: {
+    type: "object";
+    properties: {
+        actorInfo: {
+            type: "object";
+            properties: {
+                title: {
+                    type: string;
+                    description: string;
+                };
+                url: {
+                    type: string;
+                    description: string;
+                };
+                id: {
+                    type: string;
+                    description: string;
+                };
+                fullName: {
+                    type: string;
+                    description: string;
+                };
+                pictureUrl: {
+                    type: string;
+                    description: string;
+                };
+                developer: {
+                    type: "object";
+                    properties: {
+                        username: {
+                            type: string;
+                            description: string;
+                        };
+                        isOfficialApify: {
+                            type: string;
+                            description: string;
+                        };
+                        url: {
+                            type: string;
+                            description: string;
+                        };
+                    };
+                    required: string[];
+                };
+                description: {
+                    type: string;
+                    description: string;
+                };
+                categories: {
+                    type: "array";
+                    items: {
+                        type: string;
+                    };
+                    description: string;
+                };
+                pricing: {
+                    type: "object";
+                    properties: {
+                        model: {
+                            type: string;
+                            description: string;
+                        };
+                        userTier: {
+                            type: string;
+                            enum: string[];
+                            description: string;
+                        };
+                        pricePerUnit: {
+                            type: string;
+                            description: string;
+                        };
+                        unitName: {
+                            type: string;
+                            description: string;
+                        };
+                        trialMinutes: {
+                            type: string;
+                            description: string;
+                        };
+                        tieredPricing: {
+                            type: "array";
+                            items: {
+                                type: "object";
+                                properties: {
+                                    tier: {
+                                        type: string;
+                                        description: string;
+                                    };
+                                    pricePerUnit: {
+                                        type: string;
+                                        description: string;
+                                    };
+                                };
+                            };
+                            description: string;
+                        };
+                        events: {
+                            type: "array";
+                            items: {
+                                type: "object";
+                                properties: {
+                                    title: {
+                                        type: string;
+                                        description: string;
+                                    };
+                                    description: {
+                                        type: string;
+                                        description: string;
+                                    };
+                                    priceUsd: {
+                                        type: string;
+                                        description: string;
+                                    };
+                                    tieredPricing: {
+                                        type: "array";
+                                        items: {
+                                            type: "object";
+                                            properties: {
+                                                tier: {
+                                                    type: string;
+                                                };
+                                                priceUsd: {
+                                                    type: string;
+                                                };
+                                            };
+                                        };
+                                    };
+                                };
+                            };
+                            description: string;
+                        };
+                        pricingNote: {
+                            type: string;
+                            description: string;
+                        };
+                        eventDescriptionsOmitted: {
+                            type: string;
+                            description: string;
+                        };
+                        eventDescriptionsNote: {
+                            type: string;
+                            description: string;
+                        };
+                    };
+                    required: string[];
+                };
+                stats: {
+                    type: "object";
+                    properties: {
+                        totalUsers: {
+                            type: string;
+                            description: string;
+                        };
+                        monthlyUsers: {
+                            type: string;
+                            description: string;
+                        };
+                    };
+                };
+                rating: {
+                    type: "object";
+                    properties: {
+                        average: {
+                            type: string;
+                            description: string;
+                        };
+                        count: {
+                            type: string;
+                            description: string;
+                        };
+                    };
+                };
+                modifiedAt: {
+                    type: string;
+                    description: string;
+                };
+                isDeprecated: {
+                    type: string;
+                    description: string;
+                };
+                inputFields: {
+                    type: "object";
+                    description: string;
+                    properties: {
+                        type: {
+                            type: string;
+                            description: string;
+                        };
+                        properties: {
+                            type: "object";
+                            description: string;
+                            additionalProperties: {
+                                type: "object";
+                                properties: {
+                                    type: {
+                                        anyOf: ({
+                                            type: string;
+                                            items?: undefined;
+                                        } | {
+                                            type: string;
+                                            items: {
+                                                type: string;
+                                            };
+                                        })[];
+                                        description: string;
+                                    };
+                                };
+                                required: string[];
+                            };
+                        };
+                        required: {
+                            type: "array";
+                            items: {
+                                type: string;
+                            };
+                            description: string;
+                        };
+                    };
+                    required: string[];
+                };
+                inputFieldsTruncated: {
+                    type: string;
+                    description: string;
+                };
+                inputFieldsTotalCount: {
+                    type: string;
+                    description: string;
+                };
             };
-            description: string;
-        };
-        count: {
-            type: string;
-            description: string;
-        };
-        isTruncated: {
-            type: string;
-            description: string;
-        };
-        nextExclusiveStartKey: {
-            description: string;
-            anyOf: {
-                type: string;
-            }[];
-        };
-        summary: {
-            type: "string";
-            description: string;
-        };
-        nextStep: {
-            type: "string";
-            description: string;
-        };
-    };
-    required: string[];
-};
-/**
- * Schema for a single record (get-key-value-store-record). Terminal: no nextStep.
- */
-export declare const keyValueStoreRecordOutputSchema: {
-    type: "object";
-    properties: {
-        keyValueStoreId: {
-            type: string;
-            description: string;
+            required: string[];
         };
-        key: {
+        readme: {
             type: string;
             description: string;
         };
-        value: {
-            description: string;
-            anyOf: {
-                type: string;
-            }[];
-        };
-        contentType: {
-            type: string;
+        inputSchema: {
+            type: "object";
             description: string;
         };
-        summary: {
-            type: "string";
+        outputSchema: {
+            type: "object";
             description: string;
         };
-    };
-    required: string[];
-};
-/**
- * Schema for the operations found by apify-api-search.
- */
-export declare const apifyApiSearchOutputSchema: {
-    type: "object";
-    properties: {
-        operations: {
-            type: "array";
-            items: {
-                type: "object";
-                properties: {
-                    method: {
-                        type: string;
-                        description: string;
-                    };
-                    path: {
-                        type: string;
-                        description: string;
-                    };
-                    summary: {
-                        type: string;
-                        description: string;
-                    };
-                    docsUrl: {
-                        type: string;
-                        description: string;
-                    };
+        serverInterface: {
+            type: "object";
+            properties: {
+                tenancy: {
+                    type: string;
+                    enum: ("single-tenant" | "multi-tenant")[];
+                    description: string;
                 };
-                required: string[];
-            };
-        };
-    };
-    required: string[];
-};
-/**
- * Schema for the operations on one path (apify-api-details).
- */
-export declare const apifyApiDetailsOutputSchema: {
-    type: "object";
-    properties: {
-        operations: {
-            type: "array";
-            items: {
-                type: "object";
-                properties: {
-                    method: {
-                        type: string;
-                        description: string;
-                    };
-                    path: {
-                        type: string;
-                        description: string;
-                    };
-                    summary: {
-                        type: string;
-                        description: string;
-                    };
-                    description: {
-                        type: string;
-                        description: string;
-                    };
-                    parameters: {
-                        type: "array";
-                        items: {
-                            type: "object";
-                            properties: {
-                                name: {
-                                    type: string;
-                                    description: string;
-                                };
-                                in: {
-                                    type: string;
-                                    enum: string[];
-                                    description: string;
-                                };
-                                isRequired: {
-                                    type: string;
-                                    description: string;
-                                };
-                                description: {
-                                    type: string;
-                                    description: string;
+                idleTimeoutSecs: {
+                    type: string;
+                    description: string;
+                };
+                baseUrl: {
+                    type: string;
+                    description: string;
+                };
+                operationCount: {
+                    type: string;
+                    description: string;
+                };
+                operations: {
+                    type: "array";
+                    items: {
+                        type: "object";
+                        properties: {
+                            parameters: {
+                                items: {
+                                    properties: {
+                                        example: {
+                                            description: string;
+                                            anyOf: {
+                                                type: string;
+                                            }[];
+                                        };
+                                        examples: {
+                                            type: string;
+                                            description: string;
+                                        };
+                                        name: {
+                                            type: string;
+                                            description: string;
+                                        };
+                                        in: {
+                                            type: string;
+                                            enum: string[];
+                                            description: string;
+                                        };
+                                        isRequired: {
+                                            type: string;
+                                            description: string;
+                                        };
+                                        description: {
+                                            type: string;
+                                            description: string;
+                                        };
+                                        schema: {
+                                            type: string;
+                                            description: string;
+                                        };
+                                    };
+                                    type: "object";
+                                    required: string[];
                                 };
-                                schema: {
-                                    type: string;
-                                    description: string;
+                                type: "array";
+                                description: string;
+                            };
+                            requestBody: {
+                                type: "object";
+                                properties: {
+                                    contentTypes: {
+                                        type: "array";
+                                        items: {
+                                            type: string;
+                                        };
+                                        description: string;
+                                    };
+                                    example: {
+                                        description: string;
+                                        anyOf: {
+                                            type: string;
+                                        }[];
+                                    };
+                                    examples: {
+                                        type: string;
+                                        description: string;
+                                    };
+                                    isRequired: {
+                                        type: string;
+                                        description: string;
+                                    };
+                                    schema: {
+                                        type: string;
+                                        description: string;
+                                    };
                                 };
+                                required: string[];
+                                description: string;
+                            };
+                            method: {
+                                type: string;
+                                description: string;
+                            };
+                            path: {
+                                type: string;
+                                description: string;
+                            };
+                            summary: {
+                                type: string;
+                                description: string;
+                            };
+                            description: {
+                                type: string;
+                                description: string;
                             };
-                            required: string[];
                         };
-                        description: string;
+                        required: string[];
                     };
-                    requestBody: {
+                    description: string;
+                };
+                operationIndex: {
+                    type: "array";
+                    items: {
                         type: "object";
                         properties: {
-                            isRequired: {
+                            method: {
                                 type: string;
                                 description: string;
                             };
-                            schema: {
+                            path: {
+                                type: string;
+                                description: string;
+                            };
+                            summary: {
                                 type: string;
                                 description: string;
                             };
+                            requiredInputs: {
+                                type: "array";
+                                items: {
+                                    type: string;
+                                };
+                                description: string;
+                            };
                         };
                         required: string[];
-                        description: string;
                     };
+                    description: string;
+                };
+                omittedOperationCount: {
+                    type: string;
+                    description: string;
                 };
-                required: string[];
             };
-            description: string;
+            required: string[];
         };
     };
-    required: string[];
 };
 /**
  * Schema for the response of an API call (apify-api-read, apify-api-write).