@tryfinch/finch-api-mcp 6.30.0 → 7.0.0

package/tools/jobs/automated/create-jobs-automated.mjs

@@ -1,12 +1,18 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { isJqError, maybeFilter } from '@tryfinch/finch-api-mcp/filtering';
+import { asErrorResult, asTextContentResult } from '@tryfinch/finch-api-mcp/tools/types';
+import Finch from '@tryfinch/finch-api';
 export const metadata = {
     resource: 'jobs.automated',
     operation: 'write',
     tags: [],
+    httpMethod: 'post',
+    httpPath: '/jobs/automated',
+    operationId: 'post-jobs-automated',
 };
 export const tool = {
     name: 'create_jobs_automated',
-    description: 'Enqueue an automated job.\n\n`data_sync_all`: Enqueue a job to re-sync all data for a connection. `data_sync_all` has a concurrency limit of 1 job at a time per connection. This means that if this endpoint is called while a job is already in progress for this connection, Finch will return the `job_id` of the job that is currently in progress. Finch allows a fixed window rate limit of 1 forced refresh per hour per connection.\n\n`w4_form_employee_sync`: Enqueues a job for sync W-4 data for a particular individual, identified by `individual_id`. This feature is currently in beta.\n\nThis endpoint is available for *Scale* tier customers as an add-on. To request access to this endpoint, please contact your Finch account manager.',
+    description: "When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance.\n\nOnly omit if you're sure you don't need the data.\n\nEnqueue an automated job.\n\n`data_sync_all`: Enqueue a job to re-sync all data for a connection. `data_sync_all` has a concurrency limit of 1 job at a time per connection. This means that if this endpoint is called while a job is already in progress for this connection, Finch will return the `job_id` of the job that is currently in progress. Finch allows a fixed window rate limit of 1 forced refresh per hour per connection.\n\n`w4_form_employee_sync`: Enqueues a job for sync W-4 data for a particular individual, identified by `individual_id`. This feature is currently in beta.\n\nThis endpoint is available for *Scale* tier customers as an add-on. To request access to this endpoint, please contact your Finch account manager.\n\n# Response Schema\n```json\n{\n  $ref: '#/$defs/automated_create_response',\n  $defs: {\n    automated_create_response: {\n      type: 'object',\n      properties: {\n        allowed_refreshes: {\n          type: 'integer',\n          description: 'The number of allowed refreshes per hour (per hour, fixed window)'\n        },\n        remaining_refreshes: {\n          type: 'integer',\n          description: 'The number of remaining refreshes available (per hour, fixed window)'\n        },\n        job_id: {\n          type: 'string',\n          description: 'The id of the job that has been created.'\n        },\n        job_url: {\n          type: 'string',\n          description: 'The url that can be used to retrieve the job status'\n        },\n        retry_at: {\n          type: 'string',\n          description: 'ISO 8601 timestamp indicating when to retry the request'\n        }\n      },\n      required: [        'allowed_refreshes',\n        'remaining_refreshes'\n      ]\n    }\n  }\n}\n```",
     inputSchema: {
         type: 'object',
         anyOf: [
@@ -19,6 +25,7 @@ export const tool = {
                         enum: ['data_sync_all'],
                     },
                 },
+                required: ['type'],
             },
             {
                 type: 'object',
@@ -39,13 +46,30 @@ export const tool = {
                         enum: ['w4_form_employee_sync'],
                     },
                 },
+                required: ['params', 'type'],
             },
         ],
+        properties: {
+            jq_filter: {
+                type: 'string',
+                title: 'jq Filter',
+                description: 'A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide ".results[].name".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/).',
+            },
+        },
     },
+    annotations: {},
 };
-export const handler = (client, args) => {
-    const body = args;
-    return client.jobs.automated.create(body);
+export const handler = async (client, args) => {
+    const { jq_filter, ...body } = args;
+    try {
+        return asTextContentResult(await maybeFilter(jq_filter, await client.jobs.automated.create(body)));
+    }
+    catch (error) {
+        if (error instanceof Finch.APIError || isJqError(error)) {
+            return asErrorResult(error.message);
+        }
+        throw error;
+    }
 };
 export default { metadata, tool, handler };
 //# sourceMappingURL=create-jobs-automated.mjs.map

package/tools/jobs/automated/create-jobs-automated.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"create-jobs-automated.mjs","sourceRoot":"","sources":["../../../src/tools/jobs/automated/create-jobs-automated.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAMtF,MAAM,CAAC,MAAM,QAAQ,GAAa;IAChC,QAAQ,EAAE,gBAAgB;IAC1B,SAAS,EAAE,OAAO;IAClB,IAAI,EAAE,EAAE;CACT,CAAC;AAEF,MAAM,CAAC,MAAM,IAAI,GAAS;IACxB,IAAI,EAAE,uBAAuB;IAC7B,WAAW,EACT,guBAAguB;IACluB,WAAW,EAAE;QACX,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE;YACL;gBACE,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACV,IAAI,EAAE;wBACJ,IAAI,EAAE,QAAQ;wBACd,WAAW,EAAE,2BAA2B;wBACxC,IAAI,EAAE,CAAC,eAAe,CAAC;qBACxB;iBACF;aACF;YACD;gBACE,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACV,MAAM,EAAE;wBACN,IAAI,EAAE,QAAQ;wBACd,UAAU,EAAE;4BACV,aAAa,EAAE;gCACb,IAAI,EAAE,QAAQ;gCACd,WAAW,EAAE,oDAAoD;6BAClE;yBACF;wBACD,QAAQ,EAAE,CAAC,eAAe,CAAC;qBAC5B;oBACD,IAAI,EAAE;wBACJ,IAAI,EAAE,QAAQ;wBACd,WAAW,EAAE,2BAA2B;wBACxC,IAAI,EAAE,CAAC,uBAAuB,CAAC;qBAChC;iBACF;aACF;SACF;KACF;CACF,CAAC;AAEF,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,MAAa,EAAE,IAAyC,EAAE,EAAE;IAClF,MAAM,IAAI,GAAG,IAAW,CAAC;IACzB,OAAO,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;AAC5C,CAAC,CAAC;AAEF,eAAe,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC"}
+{"version":3,"file":"create-jobs-automated.mjs","sourceRoot":"","sources":["../../../src/tools/jobs/automated/create-jobs-automated.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,mCAAmC;OACnE,EAAY,aAAa,EAAE,mBAAmB,EAAE,MAAM,qCAAqC;OAG3F,KAAK,MAAM,qBAAqB;AAEvC,MAAM,CAAC,MAAM,QAAQ,GAAa;IAChC,QAAQ,EAAE,gBAAgB;IAC1B,SAAS,EAAE,OAAO;IAClB,IAAI,EAAE,EAAE;IACR,UAAU,EAAE,MAAM;IAClB,QAAQ,EAAE,iBAAiB;IAC3B,WAAW,EAAE,qBAAqB;CACnC,CAAC;AAEF,MAAM,CAAC,MAAM,IAAI,GAAS;IACxB,IAAI,EAAE,uBAAuB;IAC7B,WAAW,EACT,k4DAAk4D;IACp4D,WAAW,EAAE;QACX,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE;YACL;gBACE,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACV,IAAI,EAAE;wBACJ,IAAI,EAAE,QAAQ;wBACd,WAAW,EAAE,2BAA2B;wBACxC,IAAI,EAAE,CAAC,eAAe,CAAC;qBACxB;iBACF;gBACD,QAAQ,EAAE,CAAC,MAAM,CAAC;aACnB;YACD;gBACE,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACV,MAAM,EAAE;wBACN,IAAI,EAAE,QAAQ;wBACd,UAAU,EAAE;4BACV,aAAa,EAAE;gCACb,IAAI,EAAE,QAAQ;gCACd,WAAW,EAAE,oDAAoD;6BAClE;yBACF;wBACD,QAAQ,EAAE,CAAC,eAAe,CAAC;qBAC5B;oBACD,IAAI,EAAE;wBACJ,IAAI,EAAE,QAAQ;wBACd,WAAW,EAAE,2BAA2B;wBACxC,IAAI,EAAE,CAAC,uBAAuB,CAAC;qBAChC;iBACF;gBACD,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,CAAC;aAC7B;SACF;QACD,UAAU,EAAE;YACV,SAAS,EAAE;gBACT,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,WAAW;gBAClB,WAAW,EACT,kWAAkW;aACrW;SACF;KACF;IACD,WAAW,EAAE,EAAE;CAChB,CAAC;AAEF,MAAM,CAAC,MAAM,OAAO,GAAG,KAAK,EAAE,MAAa,EAAE,IAAyC,EAAE,EAAE;IACxF,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,IAAW,CAAC;IAC3C,IAAI,CAAC;QACH,OAAO,mBAAmB,CAAC,MAAM,WAAW,CAAC,SAAS,EAAE,MAAM,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACrG,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,KAAK,CAAC,QAAQ,IAAI,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;YACxD,OAAO,aAAa,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,CAAC;QACD,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC,CAAC;AAEF,eAAe,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC"}

package/tools/jobs/automated/list-jobs-automated.d.mts

@@ -1,32 +1,51 @@
+import { Metadata } from '@tryfinch/finch-api-mcp/tools/types';
 import { Tool } from '@modelcontextprotocol/sdk/types.js';
-import type { Metadata } from "../..//index.mjs";
 import Finch from '@tryfinch/finch-api';
 export declare const metadata: Metadata;
 export declare const tool: Tool;
-export declare const handler: (client: Finch, args: Record<string, unknown> | undefined) => import("@tryfinch/finch-api/core").APIPromise<Finch.Jobs.Automated.AutomatedListResponse>;
+export declare const handler: (client: Finch, args: Record<string, unknown> | undefined) => Promise<import("@tryfinch/finch-api-mcp/tools/types").ToolCallResult>;
 declare const _default: {
     metadata: Metadata;
     tool: {
-        [x: string]: unknown;
-        name: string;
         inputSchema: {
             [x: string]: unknown;
             type: "object";
             properties?: {
-                [x: string]: unknown;
+                [x: string]: object;
             } | undefined;
+            required?: string[] | undefined;
         };
+        name: string;
         description?: string | undefined;
-        annotations?: {
+        outputSchema?: {
             [x: string]: unknown;
+            type: "object";
+            properties?: {
+                [x: string]: object;
+            } | undefined;
+            required?: string[] | undefined;
+        } | undefined;
+        annotations?: {
             title?: string | undefined;
             readOnlyHint?: boolean | undefined;
             destructiveHint?: boolean | undefined;
             idempotentHint?: boolean | undefined;
             openWorldHint?: boolean | undefined;
         } | undefined;
+        execution?: {
+            taskSupport?: "optional" | "required" | "forbidden" | undefined;
+        } | undefined;
+        _meta?: {
+            [x: string]: unknown;
+        } | undefined;
+        icons?: {
+            src: string;
+            mimeType?: string | undefined;
+            sizes?: string[] | undefined;
+        }[] | undefined;
+        title?: string | undefined;
     };
-    handler: (client: Finch, args: Record<string, unknown> | undefined) => import("@tryfinch/finch-api/core").APIPromise<Finch.Jobs.Automated.AutomatedListResponse>;
+    handler: (client: Finch, args: Record<string, unknown> | undefined) => Promise<import("@tryfinch/finch-api-mcp/tools/types").ToolCallResult>;
 };
 export default _default;
 //# sourceMappingURL=list-jobs-automated.d.mts.map

package/tools/jobs/automated/list-jobs-automated.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"list-jobs-automated.d.mts","sourceRoot":"","sources":["../../../src/tools/jobs/automated/list-jobs-automated.ts"],"names":[],"mappings":"OAEO,EAAE,IAAI,EAAE,MAAM,oCAAoC;OAClD,KAAK,EAAE,QAAQ,EAAE;OACjB,KAAK,MAAM,qBAAqB;AAEvC,eAAO,MAAM,QAAQ,EAAE,QAItB,CAAC;AAEF,eAAO,MAAM,IAAI,EAAE,IAiBlB,CAAC;AAEF,eAAO,MAAM,OAAO,GAAI,QAAQ,KAAK,EAAE,MAAM,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,8FAG/E,CAAC;;;;;;;;;;;;;;;;;;;;;;;sBAH8B,KAAK,QAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS;;AAKhF,wBAA2C"}
+{"version":3,"file":"list-jobs-automated.d.mts","sourceRoot":"","sources":["../../../src/tools/jobs/automated/list-jobs-automated.ts"],"names":[],"mappings":"OAGO,EAAE,QAAQ,EAAsC,MAAM,qCAAqC;OAE3F,EAAE,IAAI,EAAE,MAAM,oCAAoC;OAClD,KAAK,MAAM,qBAAqB;AAEvC,eAAO,MAAM,QAAQ,EAAE,QAOtB,CAAC;AAEF,eAAO,MAAM,IAAI,EAAE,IA2BlB,CAAC;AAEF,eAAO,MAAM,OAAO,GAAU,QAAQ,KAAK,EAAE,MAAM,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,0EAUrF,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;sBAVoC,KAAK,QAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS;;AAYtF,wBAA2C"}

package/tools/jobs/automated/list-jobs-automated.d.ts

@@ -1,32 +1,51 @@
+import { Metadata } from '@tryfinch/finch-api-mcp/tools/types';
 import { Tool } from '@modelcontextprotocol/sdk/types.js';
-import type { Metadata } from "../..//index.js";
 import Finch from '@tryfinch/finch-api';
 export declare const metadata: Metadata;
 export declare const tool: Tool;
-export declare const handler: (client: Finch, args: Record<string, unknown> | undefined) => import("@tryfinch/finch-api/core").APIPromise<Finch.Jobs.Automated.AutomatedListResponse>;
+export declare const handler: (client: Finch, args: Record<string, unknown> | undefined) => Promise<import("@tryfinch/finch-api-mcp/tools/types").ToolCallResult>;
 declare const _default: {
     metadata: Metadata;
     tool: {
-        [x: string]: unknown;
-        name: string;
         inputSchema: {
             [x: string]: unknown;
             type: "object";
             properties?: {
-                [x: string]: unknown;
+                [x: string]: object;
             } | undefined;
+            required?: string[] | undefined;
         };
+        name: string;
         description?: string | undefined;
-        annotations?: {
+        outputSchema?: {
             [x: string]: unknown;
+            type: "object";
+            properties?: {
+                [x: string]: object;
+            } | undefined;
+            required?: string[] | undefined;
+        } | undefined;
+        annotations?: {
             title?: string | undefined;
             readOnlyHint?: boolean | undefined;
             destructiveHint?: boolean | undefined;
             idempotentHint?: boolean | undefined;
             openWorldHint?: boolean | undefined;
         } | undefined;
+        execution?: {
+            taskSupport?: "optional" | "required" | "forbidden" | undefined;
+        } | undefined;
+        _meta?: {
+            [x: string]: unknown;
+        } | undefined;
+        icons?: {
+            src: string;
+            mimeType?: string | undefined;
+            sizes?: string[] | undefined;
+        }[] | undefined;
+        title?: string | undefined;
     };
-    handler: (client: Finch, args: Record<string, unknown> | undefined) => import("@tryfinch/finch-api/core").APIPromise<Finch.Jobs.Automated.AutomatedListResponse>;
+    handler: (client: Finch, args: Record<string, unknown> | undefined) => Promise<import("@tryfinch/finch-api-mcp/tools/types").ToolCallResult>;
 };
 export default _default;
 //# sourceMappingURL=list-jobs-automated.d.ts.map

package/tools/jobs/automated/list-jobs-automated.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"list-jobs-automated.d.ts","sourceRoot":"","sources":["../../../src/tools/jobs/automated/list-jobs-automated.ts"],"names":[],"mappings":"OAEO,EAAE,IAAI,EAAE,MAAM,oCAAoC;OAClD,KAAK,EAAE,QAAQ,EAAE;OACjB,KAAK,MAAM,qBAAqB;AAEvC,eAAO,MAAM,QAAQ,EAAE,QAItB,CAAC;AAEF,eAAO,MAAM,IAAI,EAAE,IAiBlB,CAAC;AAEF,eAAO,MAAM,OAAO,GAAI,QAAQ,KAAK,EAAE,MAAM,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,8FAG/E,CAAC;;;;;;;;;;;;;;;;;;;;;;;sBAH8B,KAAK,QAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS;;AAKhF,wBAA2C"}
+{"version":3,"file":"list-jobs-automated.d.ts","sourceRoot":"","sources":["../../../src/tools/jobs/automated/list-jobs-automated.ts"],"names":[],"mappings":"OAGO,EAAE,QAAQ,EAAsC,MAAM,qCAAqC;OAE3F,EAAE,IAAI,EAAE,MAAM,oCAAoC;OAClD,KAAK,MAAM,qBAAqB;AAEvC,eAAO,MAAM,QAAQ,EAAE,QAOtB,CAAC;AAEF,eAAO,MAAM,IAAI,EAAE,IA2BlB,CAAC;AAEF,eAAO,MAAM,OAAO,GAAU,QAAQ,KAAK,EAAE,MAAM,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,0EAUrF,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;sBAVoC,KAAK,QAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS;;AAYtF,wBAA2C"}

package/tools/jobs/automated/list-jobs-automated.js

@@ -1,15 +1,24 @@
 "use strict";
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.handler = exports.tool = exports.metadata = void 0;
+const filtering_1 = require("@tryfinch/finch-api-mcp/filtering");
+const types_1 = require("@tryfinch/finch-api-mcp/tools/types");
+const finch_api_1 = __importDefault(require("@tryfinch/finch-api"));
 exports.metadata = {
     resource: 'jobs.automated',
     operation: 'read',
     tags: [],
+    httpMethod: 'get',
+    httpPath: '/jobs/automated',
+    operationId: 'get-jobs-automated',
 };
 exports.tool = {
     name: 'list_jobs_automated',
-    description: 'Get all automated jobs. Automated jobs are completed by a machine. By default, jobs are sorted in descending order by submission time. For scheduled jobs such as data syncs, only the next scheduled job is shown.',
+    description: "When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance.\n\nOnly omit if you're sure you don't need the data.\n\nGet all automated jobs. Automated jobs are completed by a machine. By default, jobs are sorted in descending order by submission time. For scheduled jobs such as data syncs, only the next scheduled job is shown.\n\n# Response Schema\n```json\n{\n  $ref: '#/$defs/automated_list_response',\n  $defs: {\n    automated_list_response: {\n      type: 'object',\n      properties: {\n        data: {\n          type: 'array',\n          items: {\n            $ref: '#/$defs/automated_async_job'\n          }\n        },\n        meta: {\n          type: 'object',\n          properties: {\n            quotas: {\n              type: 'object',\n              description: 'Information about remaining quotas for this connection. Only applicable for customers opted in to use Finch\\'s Data Sync Refresh endpoint (`POST /jobs/automated`). Please contact a Finch representative for more details.',\n              properties: {\n                data_sync_all: {\n                  type: 'object',\n                  properties: {\n                    allowed_refreshes: {\n                      type: 'integer'\n                    },\n                    remaining_refreshes: {\n                      type: 'integer'\n                    }\n                  }\n                }\n              }\n            }\n          }\n        }\n      },\n      required: [        'data',\n        'meta'\n      ]\n    },\n    automated_async_job: {\n      type: 'object',\n      title: 'AutomatedAsyncJob',\n      properties: {\n        completed_at: {\n          type: 'string',\n          description: 'The datetime the job completed.',\n          format: 'date-time'\n        },\n        created_at: {\n          type: 'string',\n          description: 'The datetime when the job was created. for scheduled jobs, this will be the initial connection time. For ad-hoc jobs, this will be the time the creation request was received.',\n          format: 'date-time'\n        },\n        job_id: {\n          type: 'string',\n          description: 'The id of the job that has been created.'\n        },\n        job_url: {\n          type: 'string',\n          description: 'The url that can be used to retrieve the job status'\n        },\n        params: {\n          type: 'object',\n          description: 'The input parameters for the job.',\n          properties: {\n            individual_id: {\n              type: 'string',\n              description: 'The ID of the individual that the job was completed for.'\n            }\n          }\n        },\n        scheduled_at: {\n          type: 'string',\n          description: 'The datetime a job is scheduled to be run. For scheduled jobs, this datetime can be in the future if the job has not yet been enqueued. For ad-hoc jobs, this field will be null.',\n          format: 'date-time'\n        },\n        started_at: {\n          type: 'string',\n          description: 'The datetime a job entered into the job queue.',\n          format: 'date-time'\n        },\n        status: {\n          type: 'string',\n          enum: [            'pending',\n            'in_progress',\n            'complete',\n            'error',\n            'reauth_error',\n            'permissions_error'\n          ]\n        },\n        type: {\n          type: 'string',\n          description: 'The type of automated job',\n          enum: [            'data_sync_all',\n            'w4_form_employee_sync'\n          ]\n        }\n      },\n      required: [        'completed_at',\n        'created_at',\n        'job_id',\n        'job_url',\n        'params',\n        'scheduled_at',\n        'started_at',\n        'status',\n        'type'\n      ]\n    }\n  }\n}\n```",
     inputSchema: {
         type: 'object',
         properties: {
@@ -21,12 +30,29 @@ exports.tool = {
                 type: 'integer',
                 description: 'Index to start from (defaults to 0)',
             },
+            jq_filter: {
+                type: 'string',
+                title: 'jq Filter',
+                description: 'A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide ".results[].name".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/).',
+            },
         },
+        required: [],
+    },
+    annotations: {
+        readOnlyHint: true,
     },
 };
-const handler = (client, args) => {
-    const body = args;
-    return client.jobs.automated.list(body);
+const handler = async (client, args) => {
+    const { jq_filter, ...body } = args;
+    try {
+        return (0, types_1.asTextContentResult)(await (0, filtering_1.maybeFilter)(jq_filter, await client.jobs.automated.list(body)));
+    }
+    catch (error) {
+        if (error instanceof finch_api_1.default.APIError || (0, filtering_1.isJqError)(error)) {
+            return (0, types_1.asErrorResult)(error.message);
+        }
+        throw error;
+    }
 };
 exports.handler = handler;
 exports.default = { metadata: exports.metadata, tool: exports.tool, handler: exports.handler };

package/tools/jobs/automated/list-jobs-automated.js.map

@@ -1 +1 @@
-{"version":3,"file":"list-jobs-automated.js","sourceRoot":"","sources":["../../../src/tools/jobs/automated/list-jobs-automated.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAMzE,QAAA,QAAQ,GAAa;IAChC,QAAQ,EAAE,gBAAgB;IAC1B,SAAS,EAAE,MAAM;IACjB,IAAI,EAAE,EAAE;CACT,CAAC;AAEW,QAAA,IAAI,GAAS;IACxB,IAAI,EAAE,qBAAqB;IAC3B,WAAW,EACT,qNAAqN;IACvN,WAAW,EAAE;QACX,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE;YACV,KAAK,EAAE;gBACL,IAAI,EAAE,SAAS;gBACf,WAAW,EAAE,2BAA2B;aACzC;YACD,MAAM,EAAE;gBACN,IAAI,EAAE,SAAS;gBACf,WAAW,EAAE,qCAAqC;aACnD;SACF;KACF;CACF,CAAC;AAEK,MAAM,OAAO,GAAG,CAAC,MAAa,EAAE,IAAyC,EAAE,EAAE;IAClF,MAAM,IAAI,GAAG,IAAW,CAAC;IACzB,OAAO,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1C,CAAC,CAAC;AAHW,QAAA,OAAO,WAGlB;AAEF,kBAAe,EAAE,QAAQ,EAAR,gBAAQ,EAAE,IAAI,EAAJ,YAAI,EAAE,OAAO,EAAP,eAAO,EAAE,CAAC"}
+{"version":3,"file":"list-jobs-automated.js","sourceRoot":"","sources":["../../../src/tools/jobs/automated/list-jobs-automated.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;AAEtF,iEAA2E;AAC3E,+DAAmG;AAGnG,oEAAwC;AAE3B,QAAA,QAAQ,GAAa;IAChC,QAAQ,EAAE,gBAAgB;IAC1B,SAAS,EAAE,MAAM;IACjB,IAAI,EAAE,EAAE;IACR,UAAU,EAAE,KAAK;IACjB,QAAQ,EAAE,iBAAiB;IAC3B,WAAW,EAAE,oBAAoB;CAClC,CAAC;AAEW,QAAA,IAAI,GAAS;IACxB,IAAI,EAAE,qBAAqB;IAC3B,WAAW,EACT,qyHAAqyH;IACvyH,WAAW,EAAE;QACX,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE;YACV,KAAK,EAAE;gBACL,IAAI,EAAE,SAAS;gBACf,WAAW,EAAE,2BAA2B;aACzC;YACD,MAAM,EAAE;gBACN,IAAI,EAAE,SAAS;gBACf,WAAW,EAAE,qCAAqC;aACnD;YACD,SAAS,EAAE;gBACT,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,WAAW;gBAClB,WAAW,EACT,kWAAkW;aACrW;SACF;QACD,QAAQ,EAAE,EAAE;KACb;IACD,WAAW,EAAE;QACX,YAAY,EAAE,IAAI;KACnB;CACF,CAAC;AAEK,MAAM,OAAO,GAAG,KAAK,EAAE,MAAa,EAAE,IAAyC,EAAE,EAAE;IACxF,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,IAAW,CAAC;IAC3C,IAAI,CAAC;QACH,OAAO,IAAA,2BAAmB,EAAC,MAAM,IAAA,uBAAW,EAAC,SAAS,EAAE,MAAM,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACnG,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,mBAAK,CAAC,QAAQ,IAAI,IAAA,qBAAS,EAAC,KAAK,CAAC,EAAE,CAAC;YACxD,OAAO,IAAA,qBAAa,EAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,CAAC;QACD,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC,CAAC;AAVW,QAAA,OAAO,WAUlB;AAEF,kBAAe,EAAE,QAAQ,EAAR,gBAAQ,EAAE,IAAI,EAAJ,YAAI,EAAE,OAAO,EAAP,eAAO,EAAE,CAAC"}

package/tools/jobs/automated/list-jobs-automated.mjs

@@ -1,12 +1,18 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { isJqError, maybeFilter } from '@tryfinch/finch-api-mcp/filtering';
+import { asErrorResult, asTextContentResult } from '@tryfinch/finch-api-mcp/tools/types';
+import Finch from '@tryfinch/finch-api';
 export const metadata = {
     resource: 'jobs.automated',
     operation: 'read',
     tags: [],
+    httpMethod: 'get',
+    httpPath: '/jobs/automated',
+    operationId: 'get-jobs-automated',
 };
 export const tool = {
     name: 'list_jobs_automated',
-    description: 'Get all automated jobs. Automated jobs are completed by a machine. By default, jobs are sorted in descending order by submission time. For scheduled jobs such as data syncs, only the next scheduled job is shown.',
+    description: "When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance.\n\nOnly omit if you're sure you don't need the data.\n\nGet all automated jobs. Automated jobs are completed by a machine. By default, jobs are sorted in descending order by submission time. For scheduled jobs such as data syncs, only the next scheduled job is shown.\n\n# Response Schema\n```json\n{\n  $ref: '#/$defs/automated_list_response',\n  $defs: {\n    automated_list_response: {\n      type: 'object',\n      properties: {\n        data: {\n          type: 'array',\n          items: {\n            $ref: '#/$defs/automated_async_job'\n          }\n        },\n        meta: {\n          type: 'object',\n          properties: {\n            quotas: {\n              type: 'object',\n              description: 'Information about remaining quotas for this connection. Only applicable for customers opted in to use Finch\\'s Data Sync Refresh endpoint (`POST /jobs/automated`). Please contact a Finch representative for more details.',\n              properties: {\n                data_sync_all: {\n                  type: 'object',\n                  properties: {\n                    allowed_refreshes: {\n                      type: 'integer'\n                    },\n                    remaining_refreshes: {\n                      type: 'integer'\n                    }\n                  }\n                }\n              }\n            }\n          }\n        }\n      },\n      required: [        'data',\n        'meta'\n      ]\n    },\n    automated_async_job: {\n      type: 'object',\n      title: 'AutomatedAsyncJob',\n      properties: {\n        completed_at: {\n          type: 'string',\n          description: 'The datetime the job completed.',\n          format: 'date-time'\n        },\n        created_at: {\n          type: 'string',\n          description: 'The datetime when the job was created. for scheduled jobs, this will be the initial connection time. For ad-hoc jobs, this will be the time the creation request was received.',\n          format: 'date-time'\n        },\n        job_id: {\n          type: 'string',\n          description: 'The id of the job that has been created.'\n        },\n        job_url: {\n          type: 'string',\n          description: 'The url that can be used to retrieve the job status'\n        },\n        params: {\n          type: 'object',\n          description: 'The input parameters for the job.',\n          properties: {\n            individual_id: {\n              type: 'string',\n              description: 'The ID of the individual that the job was completed for.'\n            }\n          }\n        },\n        scheduled_at: {\n          type: 'string',\n          description: 'The datetime a job is scheduled to be run. For scheduled jobs, this datetime can be in the future if the job has not yet been enqueued. For ad-hoc jobs, this field will be null.',\n          format: 'date-time'\n        },\n        started_at: {\n          type: 'string',\n          description: 'The datetime a job entered into the job queue.',\n          format: 'date-time'\n        },\n        status: {\n          type: 'string',\n          enum: [            'pending',\n            'in_progress',\n            'complete',\n            'error',\n            'reauth_error',\n            'permissions_error'\n          ]\n        },\n        type: {\n          type: 'string',\n          description: 'The type of automated job',\n          enum: [            'data_sync_all',\n            'w4_form_employee_sync'\n          ]\n        }\n      },\n      required: [        'completed_at',\n        'created_at',\n        'job_id',\n        'job_url',\n        'params',\n        'scheduled_at',\n        'started_at',\n        'status',\n        'type'\n      ]\n    }\n  }\n}\n```",
     inputSchema: {
         type: 'object',
         properties: {
@@ -18,12 +24,29 @@ export const tool = {
                 type: 'integer',
                 description: 'Index to start from (defaults to 0)',
             },
+            jq_filter: {
+                type: 'string',
+                title: 'jq Filter',
+                description: 'A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide ".results[].name".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/).',
+            },
         },
+        required: [],
+    },
+    annotations: {
+        readOnlyHint: true,
     },
 };
-export const handler = (client, args) => {
-    const body = args;
-    return client.jobs.automated.list(body);
+export const handler = async (client, args) => {
+    const { jq_filter, ...body } = args;
+    try {
+        return asTextContentResult(await maybeFilter(jq_filter, await client.jobs.automated.list(body)));
+    }
+    catch (error) {
+        if (error instanceof Finch.APIError || isJqError(error)) {
+            return asErrorResult(error.message);
+        }
+        throw error;
+    }
 };
 export default { metadata, tool, handler };
 //# sourceMappingURL=list-jobs-automated.mjs.map

package/tools/jobs/automated/list-jobs-automated.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"list-jobs-automated.mjs","sourceRoot":"","sources":["../../../src/tools/jobs/automated/list-jobs-automated.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAMtF,MAAM,CAAC,MAAM,QAAQ,GAAa;IAChC,QAAQ,EAAE,gBAAgB;IAC1B,SAAS,EAAE,MAAM;IACjB,IAAI,EAAE,EAAE;CACT,CAAC;AAEF,MAAM,CAAC,MAAM,IAAI,GAAS;IACxB,IAAI,EAAE,qBAAqB;IAC3B,WAAW,EACT,qNAAqN;IACvN,WAAW,EAAE;QACX,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE;YACV,KAAK,EAAE;gBACL,IAAI,EAAE,SAAS;gBACf,WAAW,EAAE,2BAA2B;aACzC;YACD,MAAM,EAAE;gBACN,IAAI,EAAE,SAAS;gBACf,WAAW,EAAE,qCAAqC;aACnD;SACF;KACF;CACF,CAAC;AAEF,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,MAAa,EAAE,IAAyC,EAAE,EAAE;IAClF,MAAM,IAAI,GAAG,IAAW,CAAC;IACzB,OAAO,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1C,CAAC,CAAC;AAEF,eAAe,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC"}
+{"version":3,"file":"list-jobs-automated.mjs","sourceRoot":"","sources":["../../../src/tools/jobs/automated/list-jobs-automated.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,mCAAmC;OACnE,EAAY,aAAa,EAAE,mBAAmB,EAAE,MAAM,qCAAqC;OAG3F,KAAK,MAAM,qBAAqB;AAEvC,MAAM,CAAC,MAAM,QAAQ,GAAa;IAChC,QAAQ,EAAE,gBAAgB;IAC1B,SAAS,EAAE,MAAM;IACjB,IAAI,EAAE,EAAE;IACR,UAAU,EAAE,KAAK;IACjB,QAAQ,EAAE,iBAAiB;IAC3B,WAAW,EAAE,oBAAoB;CAClC,CAAC;AAEF,MAAM,CAAC,MAAM,IAAI,GAAS;IACxB,IAAI,EAAE,qBAAqB;IAC3B,WAAW,EACT,qyHAAqyH;IACvyH,WAAW,EAAE;QACX,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE;YACV,KAAK,EAAE;gBACL,IAAI,EAAE,SAAS;gBACf,WAAW,EAAE,2BAA2B;aACzC;YACD,MAAM,EAAE;gBACN,IAAI,EAAE,SAAS;gBACf,WAAW,EAAE,qCAAqC;aACnD;YACD,SAAS,EAAE;gBACT,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,WAAW;gBAClB,WAAW,EACT,kWAAkW;aACrW;SACF;QACD,QAAQ,EAAE,EAAE;KACb;IACD,WAAW,EAAE;QACX,YAAY,EAAE,IAAI;KACnB;CACF,CAAC;AAEF,MAAM,CAAC,MAAM,OAAO,GAAG,KAAK,EAAE,MAAa,EAAE,IAAyC,EAAE,EAAE;IACxF,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,IAAW,CAAC;IAC3C,IAAI,CAAC;QACH,OAAO,mBAAmB,CAAC,MAAM,WAAW,CAAC,SAAS,EAAE,MAAM,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACnG,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,KAAK,CAAC,QAAQ,IAAI,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;YACxD,OAAO,aAAa,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,CAAC;QACD,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC,CAAC;AAEF,eAAe,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC"}

package/tools/jobs/automated/retrieve-jobs-automated.d.mts

@@ -1,32 +1,51 @@
+import { Metadata } from '@tryfinch/finch-api-mcp/tools/types';
 import { Tool } from '@modelcontextprotocol/sdk/types.js';
-import type { Metadata } from "../..//index.mjs";
 import Finch from '@tryfinch/finch-api';
 export declare const metadata: Metadata;
 export declare const tool: Tool;
-export declare const handler: (client: Finch, args: Record<string, unknown> | undefined) => import("@tryfinch/finch-api/core").APIPromise<Finch.Jobs.Automated.AutomatedAsyncJob>;
+export declare const handler: (client: Finch, args: Record<string, unknown> | undefined) => Promise<import("@tryfinch/finch-api-mcp/tools/types").ToolCallResult>;
 declare const _default: {
     metadata: Metadata;
     tool: {
-        [x: string]: unknown;
-        name: string;
         inputSchema: {
             [x: string]: unknown;
             type: "object";
             properties?: {
-                [x: string]: unknown;
+                [x: string]: object;
             } | undefined;
+            required?: string[] | undefined;
         };
+        name: string;
         description?: string | undefined;
-        annotations?: {
+        outputSchema?: {
             [x: string]: unknown;
+            type: "object";
+            properties?: {
+                [x: string]: object;
+            } | undefined;
+            required?: string[] | undefined;
+        } | undefined;
+        annotations?: {
             title?: string | undefined;
             readOnlyHint?: boolean | undefined;
             destructiveHint?: boolean | undefined;
             idempotentHint?: boolean | undefined;
             openWorldHint?: boolean | undefined;
         } | undefined;
+        execution?: {
+            taskSupport?: "optional" | "required" | "forbidden" | undefined;
+        } | undefined;
+        _meta?: {
+            [x: string]: unknown;
+        } | undefined;
+        icons?: {
+            src: string;
+            mimeType?: string | undefined;
+            sizes?: string[] | undefined;
+        }[] | undefined;
+        title?: string | undefined;
     };
-    handler: (client: Finch, args: Record<string, unknown> | undefined) => import("@tryfinch/finch-api/core").APIPromise<Finch.Jobs.Automated.AutomatedAsyncJob>;
+    handler: (client: Finch, args: Record<string, unknown> | undefined) => Promise<import("@tryfinch/finch-api-mcp/tools/types").ToolCallResult>;
 };
 export default _default;
 //# sourceMappingURL=retrieve-jobs-automated.d.mts.map

package/tools/jobs/automated/retrieve-jobs-automated.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"retrieve-jobs-automated.d.mts","sourceRoot":"","sources":["../../../src/tools/jobs/automated/retrieve-jobs-automated.ts"],"names":[],"mappings":"OAEO,EAAE,IAAI,EAAE,MAAM,oCAAoC;OAClD,KAAK,EAAE,QAAQ,EAAE;OACjB,KAAK,MAAM,qBAAqB;AAEvC,eAAO,MAAM,QAAQ,EAAE,QAItB,CAAC;AAEF,eAAO,MAAM,IAAI,EAAE,IAWlB,CAAC;AAEF,eAAO,MAAM,OAAO,GAAI,QAAQ,KAAK,EAAE,MAAM,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,0FAG/E,CAAC;;;;;;;;;;;;;;;;;;;;;;;sBAH8B,KAAK,QAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS;;AAKhF,wBAA2C"}
+{"version":3,"file":"retrieve-jobs-automated.d.mts","sourceRoot":"","sources":["../../../src/tools/jobs/automated/retrieve-jobs-automated.ts"],"names":[],"mappings":"OAGO,EAAE,QAAQ,EAAsC,MAAM,qCAAqC;OAE3F,EAAE,IAAI,EAAE,MAAM,oCAAoC;OAClD,KAAK,MAAM,qBAAqB;AAEvC,eAAO,MAAM,QAAQ,EAAE,QAOtB,CAAC;AAEF,eAAO,MAAM,IAAI,EAAE,IAsBlB,CAAC;AAEF,eAAO,MAAM,OAAO,GAAU,QAAQ,KAAK,EAAE,MAAM,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,0EAUrF,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;sBAVoC,KAAK,QAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS;;AAYtF,wBAA2C"}

package/tools/jobs/automated/retrieve-jobs-automated.d.ts

@@ -1,32 +1,51 @@
+import { Metadata } from '@tryfinch/finch-api-mcp/tools/types';
 import { Tool } from '@modelcontextprotocol/sdk/types.js';
-import type { Metadata } from "../..//index.js";
 import Finch from '@tryfinch/finch-api';
 export declare const metadata: Metadata;
 export declare const tool: Tool;
-export declare const handler: (client: Finch, args: Record<string, unknown> | undefined) => import("@tryfinch/finch-api/core").APIPromise<Finch.Jobs.Automated.AutomatedAsyncJob>;
+export declare const handler: (client: Finch, args: Record<string, unknown> | undefined) => Promise<import("@tryfinch/finch-api-mcp/tools/types").ToolCallResult>;
 declare const _default: {
     metadata: Metadata;
     tool: {
-        [x: string]: unknown;
-        name: string;
         inputSchema: {
             [x: string]: unknown;
             type: "object";
             properties?: {
-                [x: string]: unknown;
+                [x: string]: object;
             } | undefined;
+            required?: string[] | undefined;
         };
+        name: string;
         description?: string | undefined;
-        annotations?: {
+        outputSchema?: {
             [x: string]: unknown;
+            type: "object";
+            properties?: {
+                [x: string]: object;
+            } | undefined;
+            required?: string[] | undefined;
+        } | undefined;
+        annotations?: {
             title?: string | undefined;
             readOnlyHint?: boolean | undefined;
             destructiveHint?: boolean | undefined;
             idempotentHint?: boolean | undefined;
             openWorldHint?: boolean | undefined;
         } | undefined;
+        execution?: {
+            taskSupport?: "optional" | "required" | "forbidden" | undefined;
+        } | undefined;
+        _meta?: {
+            [x: string]: unknown;
+        } | undefined;
+        icons?: {
+            src: string;
+            mimeType?: string | undefined;
+            sizes?: string[] | undefined;
+        }[] | undefined;
+        title?: string | undefined;
     };
-    handler: (client: Finch, args: Record<string, unknown> | undefined) => import("@tryfinch/finch-api/core").APIPromise<Finch.Jobs.Automated.AutomatedAsyncJob>;
+    handler: (client: Finch, args: Record<string, unknown> | undefined) => Promise<import("@tryfinch/finch-api-mcp/tools/types").ToolCallResult>;
 };
 export default _default;
 //# sourceMappingURL=retrieve-jobs-automated.d.ts.map

package/tools/jobs/automated/retrieve-jobs-automated.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"retrieve-jobs-automated.d.ts","sourceRoot":"","sources":["../../../src/tools/jobs/automated/retrieve-jobs-automated.ts"],"names":[],"mappings":"OAEO,EAAE,IAAI,EAAE,MAAM,oCAAoC;OAClD,KAAK,EAAE,QAAQ,EAAE;OACjB,KAAK,MAAM,qBAAqB;AAEvC,eAAO,MAAM,QAAQ,EAAE,QAItB,CAAC;AAEF,eAAO,MAAM,IAAI,EAAE,IAWlB,CAAC;AAEF,eAAO,MAAM,OAAO,GAAI,QAAQ,KAAK,EAAE,MAAM,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,0FAG/E,CAAC;;;;;;;;;;;;;;;;;;;;;;;sBAH8B,KAAK,QAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS;;AAKhF,wBAA2C"}
+{"version":3,"file":"retrieve-jobs-automated.d.ts","sourceRoot":"","sources":["../../../src/tools/jobs/automated/retrieve-jobs-automated.ts"],"names":[],"mappings":"OAGO,EAAE,QAAQ,EAAsC,MAAM,qCAAqC;OAE3F,EAAE,IAAI,EAAE,MAAM,oCAAoC;OAClD,KAAK,MAAM,qBAAqB;AAEvC,eAAO,MAAM,QAAQ,EAAE,QAOtB,CAAC;AAEF,eAAO,MAAM,IAAI,EAAE,IAsBlB,CAAC;AAEF,eAAO,MAAM,OAAO,GAAU,QAAQ,KAAK,EAAE,MAAM,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,0EAUrF,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;sBAVoC,KAAK,QAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS;;AAYtF,wBAA2C"}

package/tools/jobs/automated/retrieve-jobs-automated.js

@@ -1,27 +1,53 @@
 "use strict";
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.handler = exports.tool = exports.metadata = void 0;
+const filtering_1 = require("@tryfinch/finch-api-mcp/filtering");
+const types_1 = require("@tryfinch/finch-api-mcp/tools/types");
+const finch_api_1 = __importDefault(require("@tryfinch/finch-api"));
 exports.metadata = {
     resource: 'jobs.automated',
     operation: 'read',
     tags: [],
+    httpMethod: 'get',
+    httpPath: '/jobs/automated/{job_id}',
+    operationId: 'get-jobs-job_id',
 };
 exports.tool = {
     name: 'retrieve_jobs_automated',
-    description: 'Get an automated job by `job_id`.',
+    description: "When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance.\n\nOnly omit if you're sure you don't need the data.\n\nGet an automated job by `job_id`.\n\n# Response Schema\n```json\n{\n  $ref: '#/$defs/automated_async_job',\n  $defs: {\n    automated_async_job: {\n      type: 'object',\n      title: 'AutomatedAsyncJob',\n      properties: {\n        completed_at: {\n          type: 'string',\n          description: 'The datetime the job completed.',\n          format: 'date-time'\n        },\n        created_at: {\n          type: 'string',\n          description: 'The datetime when the job was created. for scheduled jobs, this will be the initial connection time. For ad-hoc jobs, this will be the time the creation request was received.',\n          format: 'date-time'\n        },\n        job_id: {\n          type: 'string',\n          description: 'The id of the job that has been created.'\n        },\n        job_url: {\n          type: 'string',\n          description: 'The url that can be used to retrieve the job status'\n        },\n        params: {\n          type: 'object',\n          description: 'The input parameters for the job.',\n          properties: {\n            individual_id: {\n              type: 'string',\n              description: 'The ID of the individual that the job was completed for.'\n            }\n          }\n        },\n        scheduled_at: {\n          type: 'string',\n          description: 'The datetime a job is scheduled to be run. For scheduled jobs, this datetime can be in the future if the job has not yet been enqueued. For ad-hoc jobs, this field will be null.',\n          format: 'date-time'\n        },\n        started_at: {\n          type: 'string',\n          description: 'The datetime a job entered into the job queue.',\n          format: 'date-time'\n        },\n        status: {\n          type: 'string',\n          enum: [            'pending',\n            'in_progress',\n            'complete',\n            'error',\n            'reauth_error',\n            'permissions_error'\n          ]\n        },\n        type: {\n          type: 'string',\n          description: 'The type of automated job',\n          enum: [            'data_sync_all',\n            'w4_form_employee_sync'\n          ]\n        }\n      },\n      required: [        'completed_at',\n        'created_at',\n        'job_id',\n        'job_url',\n        'params',\n        'scheduled_at',\n        'started_at',\n        'status',\n        'type'\n      ]\n    }\n  }\n}\n```",
     inputSchema: {
         type: 'object',
         properties: {
             job_id: {
                 type: 'string',
             },
+            jq_filter: {
+                type: 'string',
+                title: 'jq Filter',
+                description: 'A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide ".results[].name".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/).',
+            },
         },
+        required: ['job_id'],
+    },
+    annotations: {
+        readOnlyHint: true,
     },
 };
-const handler = (client, args) => {
-    const { job_id, ...body } = args;
-    return client.jobs.automated.retrieve(job_id);
+const handler = async (client, args) => {
+    const { job_id, jq_filter, ...body } = args;
+    try {
+        return (0, types_1.asTextContentResult)(await (0, filtering_1.maybeFilter)(jq_filter, await client.jobs.automated.retrieve(job_id)));
+    }
+    catch (error) {
+        if (error instanceof finch_api_1.default.APIError || (0, filtering_1.isJqError)(error)) {
+            return (0, types_1.asErrorResult)(error.message);
+        }
+        throw error;
+    }
 };
 exports.handler = handler;
 exports.default = { metadata: exports.metadata, tool: exports.tool, handler: exports.handler };

package/tools/jobs/automated/retrieve-jobs-automated.js.map

@@ -1 +1 @@
-{"version":3,"file":"retrieve-jobs-automated.js","sourceRoot":"","sources":["../../../src/tools/jobs/automated/retrieve-jobs-automated.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAMzE,QAAA,QAAQ,GAAa;IAChC,QAAQ,EAAE,gBAAgB;IAC1B,SAAS,EAAE,MAAM;IACjB,IAAI,EAAE,EAAE;CACT,CAAC;AAEW,QAAA,IAAI,GAAS;IACxB,IAAI,EAAE,yBAAyB;IAC/B,WAAW,EAAE,mCAAmC;IAChD,WAAW,EAAE;QACX,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE;YACV,MAAM,EAAE;gBACN,IAAI,EAAE,QAAQ;aACf;SACF;KACF;CACF,CAAC;AAEK,MAAM,OAAO,GAAG,CAAC,MAAa,EAAE,IAAyC,EAAE,EAAE;IAClF,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,IAAW,CAAC;IACxC,OAAO,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AAChD,CAAC,CAAC;AAHW,QAAA,OAAO,WAGlB;AAEF,kBAAe,EAAE,QAAQ,EAAR,gBAAQ,EAAE,IAAI,EAAJ,YAAI,EAAE,OAAO,EAAP,eAAO,EAAE,CAAC"}
+{"version":3,"file":"retrieve-jobs-automated.js","sourceRoot":"","sources":["../../../src/tools/jobs/automated/retrieve-jobs-automated.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;AAEtF,iEAA2E;AAC3E,+DAAmG;AAGnG,oEAAwC;AAE3B,QAAA,QAAQ,GAAa;IAChC,QAAQ,EAAE,gBAAgB;IAC1B,SAAS,EAAE,MAAM;IACjB,IAAI,EAAE,EAAE;IACR,UAAU,EAAE,KAAK;IACjB,QAAQ,EAAE,0BAA0B;IACpC,WAAW,EAAE,iBAAiB;CAC/B,CAAC;AAEW,QAAA,IAAI,GAAS;IACxB,IAAI,EAAE,yBAAyB;IAC/B,WAAW,EACT,giFAAgiF;IACliF,WAAW,EAAE;QACX,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE;YACV,MAAM,EAAE;gBACN,IAAI,EAAE,QAAQ;aACf;YACD,SAAS,EAAE;gBACT,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,WAAW;gBAClB,WAAW,EACT,kWAAkW;aACrW;SACF;QACD,QAAQ,EAAE,CAAC,QAAQ,CAAC;KACrB;IACD,WAAW,EAAE;QACX,YAAY,EAAE,IAAI;KACnB;CACF,CAAC;AAEK,MAAM,OAAO,GAAG,KAAK,EAAE,MAAa,EAAE,IAAyC,EAAE,EAAE;IACxF,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,IAAW,CAAC;IACnD,IAAI,CAAC;QACH,OAAO,IAAA,2BAAmB,EAAC,MAAM,IAAA,uBAAW,EAAC,SAAS,EAAE,MAAM,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IACzG,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,mBAAK,CAAC,QAAQ,IAAI,IAAA,qBAAS,EAAC,KAAK,CAAC,EAAE,CAAC;YACxD,OAAO,IAAA,qBAAa,EAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,CAAC;QACD,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC,CAAC;AAVW,QAAA,OAAO,WAUlB;AAEF,kBAAe,EAAE,QAAQ,EAAR,gBAAQ,EAAE,IAAI,EAAJ,YAAI,EAAE,OAAO,EAAP,eAAO,EAAE,CAAC"}

package/tools/jobs/automated/retrieve-jobs-automated.mjs

@@ -1,24 +1,47 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { isJqError, maybeFilter } from '@tryfinch/finch-api-mcp/filtering';
+import { asErrorResult, asTextContentResult } from '@tryfinch/finch-api-mcp/tools/types';
+import Finch from '@tryfinch/finch-api';
 export const metadata = {
     resource: 'jobs.automated',
     operation: 'read',
     tags: [],
+    httpMethod: 'get',
+    httpPath: '/jobs/automated/{job_id}',
+    operationId: 'get-jobs-job_id',
 };
 export const tool = {
     name: 'retrieve_jobs_automated',
-    description: 'Get an automated job by `job_id`.',
+    description: "When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance.\n\nOnly omit if you're sure you don't need the data.\n\nGet an automated job by `job_id`.\n\n# Response Schema\n```json\n{\n  $ref: '#/$defs/automated_async_job',\n  $defs: {\n    automated_async_job: {\n      type: 'object',\n      title: 'AutomatedAsyncJob',\n      properties: {\n        completed_at: {\n          type: 'string',\n          description: 'The datetime the job completed.',\n          format: 'date-time'\n        },\n        created_at: {\n          type: 'string',\n          description: 'The datetime when the job was created. for scheduled jobs, this will be the initial connection time. For ad-hoc jobs, this will be the time the creation request was received.',\n          format: 'date-time'\n        },\n        job_id: {\n          type: 'string',\n          description: 'The id of the job that has been created.'\n        },\n        job_url: {\n          type: 'string',\n          description: 'The url that can be used to retrieve the job status'\n        },\n        params: {\n          type: 'object',\n          description: 'The input parameters for the job.',\n          properties: {\n            individual_id: {\n              type: 'string',\n              description: 'The ID of the individual that the job was completed for.'\n            }\n          }\n        },\n        scheduled_at: {\n          type: 'string',\n          description: 'The datetime a job is scheduled to be run. For scheduled jobs, this datetime can be in the future if the job has not yet been enqueued. For ad-hoc jobs, this field will be null.',\n          format: 'date-time'\n        },\n        started_at: {\n          type: 'string',\n          description: 'The datetime a job entered into the job queue.',\n          format: 'date-time'\n        },\n        status: {\n          type: 'string',\n          enum: [            'pending',\n            'in_progress',\n            'complete',\n            'error',\n            'reauth_error',\n            'permissions_error'\n          ]\n        },\n        type: {\n          type: 'string',\n          description: 'The type of automated job',\n          enum: [            'data_sync_all',\n            'w4_form_employee_sync'\n          ]\n        }\n      },\n      required: [        'completed_at',\n        'created_at',\n        'job_id',\n        'job_url',\n        'params',\n        'scheduled_at',\n        'started_at',\n        'status',\n        'type'\n      ]\n    }\n  }\n}\n```",
     inputSchema: {
         type: 'object',
         properties: {
             job_id: {
                 type: 'string',
             },
+            jq_filter: {
+                type: 'string',
+                title: 'jq Filter',
+                description: 'A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide ".results[].name".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/).',
+            },
         },
+        required: ['job_id'],
+    },
+    annotations: {
+        readOnlyHint: true,
     },
 };
-export const handler = (client, args) => {
-    const { job_id, ...body } = args;
-    return client.jobs.automated.retrieve(job_id);
+export const handler = async (client, args) => {
+    const { job_id, jq_filter, ...body } = args;
+    try {
+        return asTextContentResult(await maybeFilter(jq_filter, await client.jobs.automated.retrieve(job_id)));
+    }
+    catch (error) {
+        if (error instanceof Finch.APIError || isJqError(error)) {
+            return asErrorResult(error.message);
+        }
+        throw error;
+    }
 };
 export default { metadata, tool, handler };
 //# sourceMappingURL=retrieve-jobs-automated.mjs.map

package/tools/jobs/automated/retrieve-jobs-automated.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"retrieve-jobs-automated.mjs","sourceRoot":"","sources":["../../../src/tools/jobs/automated/retrieve-jobs-automated.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAMtF,MAAM,CAAC,MAAM,QAAQ,GAAa;IAChC,QAAQ,EAAE,gBAAgB;IAC1B,SAAS,EAAE,MAAM;IACjB,IAAI,EAAE,EAAE;CACT,CAAC;AAEF,MAAM,CAAC,MAAM,IAAI,GAAS;IACxB,IAAI,EAAE,yBAAyB;IAC/B,WAAW,EAAE,mCAAmC;IAChD,WAAW,EAAE;QACX,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE;YACV,MAAM,EAAE;gBACN,IAAI,EAAE,QAAQ;aACf;SACF;KACF;CACF,CAAC;AAEF,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,MAAa,EAAE,IAAyC,EAAE,EAAE;IAClF,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,IAAW,CAAC;IACxC,OAAO,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AAChD,CAAC,CAAC;AAEF,eAAe,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC"}
+{"version":3,"file":"retrieve-jobs-automated.mjs","sourceRoot":"","sources":["../../../src/tools/jobs/automated/retrieve-jobs-automated.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,mCAAmC;OACnE,EAAY,aAAa,EAAE,mBAAmB,EAAE,MAAM,qCAAqC;OAG3F,KAAK,MAAM,qBAAqB;AAEvC,MAAM,CAAC,MAAM,QAAQ,GAAa;IAChC,QAAQ,EAAE,gBAAgB;IAC1B,SAAS,EAAE,MAAM;IACjB,IAAI,EAAE,EAAE;IACR,UAAU,EAAE,KAAK;IACjB,QAAQ,EAAE,0BAA0B;IACpC,WAAW,EAAE,iBAAiB;CAC/B,CAAC;AAEF,MAAM,CAAC,MAAM,IAAI,GAAS;IACxB,IAAI,EAAE,yBAAyB;IAC/B,WAAW,EACT,giFAAgiF;IACliF,WAAW,EAAE;QACX,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE;YACV,MAAM,EAAE;gBACN,IAAI,EAAE,QAAQ;aACf;YACD,SAAS,EAAE;gBACT,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,WAAW;gBAClB,WAAW,EACT,kWAAkW;aACrW;SACF;QACD,QAAQ,EAAE,CAAC,QAAQ,CAAC;KACrB;IACD,WAAW,EAAE;QACX,YAAY,EAAE,IAAI;KACnB;CACF,CAAC;AAEF,MAAM,CAAC,MAAM,OAAO,GAAG,KAAK,EAAE,MAAa,EAAE,IAAyC,EAAE,EAAE;IACxF,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,IAAW,CAAC;IACnD,IAAI,CAAC;QACH,OAAO,mBAAmB,CAAC,MAAM,WAAW,CAAC,SAAS,EAAE,MAAM,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IACzG,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,KAAK,CAAC,QAAQ,IAAI,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;YACxD,OAAO,aAAa,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,CAAC;QACD,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC,CAAC;AAEF,eAAe,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC"}