@tryfinch/finch-api-mcp 7.0.0 → 8.1.0

package/src/tools/hris/directory/list-hris-directory.ts

@@ -1,67 +0,0 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-import { isJqError, maybeFilter } from '@tryfinch/finch-api-mcp/filtering';
-import { Metadata, asErrorResult, asTextContentResult } from '@tryfinch/finch-api-mcp/tools/types';
-
-import { Tool } from '@modelcontextprotocol/sdk/types.js';
-import Finch from '@tryfinch/finch-api';
-
-export const metadata: Metadata = {
-  resource: 'hris.directory',
-  operation: 'read',
-  tags: [],
-  httpMethod: 'get',
-  httpPath: '/employer/directory',
-  operationId: 'get-directory',
-};
-
-export const tool: Tool = {
-  name: 'list_hris_directory',
-  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\nRead company directory and organization structure\n\n# Response Schema\n```json\n{\n  type: 'object',\n  properties: {\n    individuals: {\n      type: 'array',\n      description: 'The array of employees.',\n      items: {\n        $ref: '#/$defs/individual_in_directory'\n      }\n    },\n    paging: {\n      $ref: '#/$defs/paging'\n    }\n  },\n  required: [    'individuals',\n    'paging'\n  ],\n  $defs: {\n    individual_in_directory: {\n      type: 'object',\n      properties: {\n        id: {\n          type: 'string',\n          description: 'A stable Finch `id` (UUID v4) for an individual in the company.'\n        },\n        department: {\n          type: 'object',\n          description: 'The department object.',\n          properties: {\n            name: {\n              type: 'string',\n              description: 'The name of the department.'\n            }\n          }\n        },\n        first_name: {\n          type: 'string',\n          description: 'The legal first name of the individual.'\n        },\n        is_active: {\n          type: 'boolean',\n          description: '`true` if the individual is an active employee or contractor at the company.'\n        },\n        last_name: {\n          type: 'string',\n          description: 'The legal last name of the individual.'\n        },\n        manager: {\n          type: 'object',\n          description: 'The manager object.',\n          properties: {\n            id: {\n              type: 'string',\n              description: 'A stable Finch `id` (UUID v4) for an individual in the company.'\n            }\n          },\n          required: [            'id'\n          ]\n        },\n        middle_name: {\n          type: 'string',\n          description: 'The legal middle name of the individual.'\n        }\n      },\n      required: [        'id',\n        'department',\n        'first_name',\n        'is_active',\n        'last_name',\n        'manager',\n        'middle_name'\n      ]\n    },\n    paging: {\n      type: 'object',\n      title: 'Paging',\n      properties: {\n        offset: {\n          type: 'integer',\n          description: 'The current start index of the returned list of elements'\n        },\n        count: {\n          type: 'integer',\n          description: 'The total number of elements for the entire query (not just the given page)'\n        }\n      },\n      required: [        'offset'\n      ]\n    }\n  }\n}\n```",
-  inputSchema: {
-    type: 'object',
-    properties: {
-      entity_ids: {
-        type: 'array',
-        description: "The entity IDs to specify which entities' data to access.",
-        items: {
-          type: 'string',
-        },
-      },
-      limit: {
-        type: 'integer',
-        description: 'Number of employees to return (defaults to all)',
-      },
-      offset: {
-        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 = async (client: Finch, args: Record<string, unknown> | undefined) => {
-  const { jq_filter, ...body } = args as any;
-  const response = await client.hris.directory.list(body).asResponse();
-  try {
-    return asTextContentResult(await maybeFilter(jq_filter, await response.json()));
-  } catch (error) {
-    if (error instanceof Finch.APIError || isJqError(error)) {
-      return asErrorResult(error.message);
-    }
-    throw error;
-  }
-};
-
-export default { metadata, tool, handler };

package/src/tools/hris/documents/list-hris-documents.ts

@@ -1,82 +0,0 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-import { isJqError, maybeFilter } from '@tryfinch/finch-api-mcp/filtering';
-import { Metadata, asErrorResult, asTextContentResult } from '@tryfinch/finch-api-mcp/tools/types';
-
-import { Tool } from '@modelcontextprotocol/sdk/types.js';
-import Finch from '@tryfinch/finch-api';
-
-export const metadata: Metadata = {
-  resource: 'hris.documents',
-  operation: 'read',
-  tags: [],
-  httpMethod: 'get',
-  httpPath: '/employer/documents',
-  operationId: 'list-documents',
-};
-
-export const tool: Tool = {
-  name: 'list_hris_documents',
-  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\n**Beta:** This endpoint is in beta and may change.\nRetrieve a list of company-wide documents.\n\n\n# Response Schema\n```json\n{\n  $ref: '#/$defs/document_list_response',\n  $defs: {\n    document_list_response: {\n      type: 'object',\n      properties: {\n        documents: {\n          type: 'array',\n          items: {\n            $ref: '#/$defs/document_response'\n          }\n        },\n        paging: {\n          $ref: '#/$defs/paging'\n        }\n      },\n      required: [        'documents',\n        'paging'\n      ]\n    },\n    document_response: {\n      type: 'object',\n      properties: {\n        id: {\n          type: 'string',\n          description: 'A stable Finch id for the document.'\n        },\n        individual_id: {\n          type: 'string',\n          description: 'The ID of the individual associated with the document. This will be null for employer-level documents.'\n        },\n        type: {\n          type: 'string',\n          description: 'The type of document.',\n          enum: [            'w4_2020',\n            'w4_2005'\n          ]\n        },\n        url: {\n          type: 'string',\n          description: 'A URL to access the document. Format: `https://api.tryfinch.com/employer/documents/:document_id`.'\n        },\n        year: {\n          type: 'number',\n          description: 'The year the document applies to, if available.'\n        }\n      },\n      required: [        'id',\n        'individual_id',\n        'type',\n        'url',\n        'year'\n      ]\n    },\n    paging: {\n      type: 'object',\n      title: 'Paging',\n      properties: {\n        offset: {\n          type: 'integer',\n          description: 'The current start index of the returned list of elements'\n        },\n        count: {\n          type: 'integer',\n          description: 'The total number of elements for the entire query (not just the given page)'\n        }\n      },\n      required: [        'offset'\n      ]\n    }\n  }\n}\n```",
-  inputSchema: {
-    type: 'object',
-    properties: {
-      entity_ids: {
-        type: 'array',
-        description: "The entity IDs to specify which entities' data to access.",
-        items: {
-          type: 'string',
-        },
-      },
-      individual_ids: {
-        type: 'array',
-        description:
-          'Comma-delimited list of stable Finch uuids for each individual. If empty, defaults to all individuals',
-        items: {
-          type: 'string',
-        },
-      },
-      limit: {
-        type: 'integer',
-        description: 'Number of documents to return (defaults to all)',
-      },
-      offset: {
-        type: 'integer',
-        description: 'Index to start from (defaults to 0)',
-      },
-      types: {
-        type: 'array',
-        description: 'Comma-delimited list of document types to filter on. If empty, defaults to all types',
-        items: {
-          type: 'string',
-          enum: ['w4_2020', 'w4_2005'],
-        },
-      },
-      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 = async (client: Finch, args: Record<string, unknown> | undefined) => {
-  const { jq_filter, ...body } = args as any;
-  try {
-    return asTextContentResult(await maybeFilter(jq_filter, await client.hris.documents.list(body)));
-  } catch (error) {
-    if (error instanceof Finch.APIError || isJqError(error)) {
-      return asErrorResult(error.message);
-    }
-    throw error;
-  }
-};
-
-export default { metadata, tool, handler };

package/src/tools/hris/documents/retreive-hris-documents.ts

@@ -1,63 +0,0 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-import { isJqError, maybeFilter } from '@tryfinch/finch-api-mcp/filtering';
-import { Metadata, asErrorResult, asTextContentResult } from '@tryfinch/finch-api-mcp/tools/types';
-
-import { Tool } from '@modelcontextprotocol/sdk/types.js';
-import Finch from '@tryfinch/finch-api';
-
-export const metadata: Metadata = {
-  resource: 'hris.documents',
-  operation: 'read',
-  tags: [],
-  httpMethod: 'get',
-  httpPath: '/employer/documents/{document_id}',
-  operationId: 'get-document',
-};
-
-export const tool: Tool = {
-  name: 'retreive_hris_documents',
-  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\n**Beta:** This endpoint is in beta and may change.\nRetrieve details of a specific document by its ID.\n\n\n# Response Schema\n```json\n{\n  $ref: '#/$defs/document_retreive_response',\n  $defs: {\n    document_retreive_response: {\n      anyOf: [        {\n          $ref: '#/$defs/w42020'\n        },\n        {\n          $ref: '#/$defs/w42005'\n        }\n      ],\n      description: 'A 2020 version of the W-4 tax form containing information on an individual\\'s filing status, dependents, and withholding details.'\n    },\n    w42020: {\n      type: 'object',\n      description: 'A 2020 version of the W-4 tax form containing information on an individual\\'s filing status, dependents, and withholding details.',\n      properties: {\n        data: {\n          type: 'object',\n          description: 'Detailed information specific to the 2020 W4 form.',\n          properties: {\n            amount_for_other_dependents: {\n              type: 'integer',\n              description: 'Amount claimed for dependents other than qualifying children under 17 (in cents).'\n            },\n            amount_for_qualifying_children_under_17: {\n              type: 'integer',\n              description: 'Amount claimed for dependents under 17 years old (in cents).'\n            },\n            deductions: {\n              type: 'integer',\n              description: 'Deductible expenses (in cents).'\n            },\n            extra_withholding: {\n              type: 'integer',\n              description: 'Additional withholding amount (in cents).'\n            },\n            filing_status: {\n              type: 'string',\n              description: 'The individual\\'s filing status for tax purposes.',\n              enum: [                'head_of_household',\n                'married_filing_jointly_or_qualifying_surviving_spouse',\n                'single_or_married_filing_separately'\n              ]\n            },\n            individual_id: {\n              type: 'string',\n              description: 'The unique identifier for the individual associated with this document.'\n            },\n            other_income: {\n              type: 'integer',\n              description: 'Additional income from sources outside of primary employment (in cents).'\n            },\n            total_claim_dependent_and_other_credits: {\n              type: 'integer',\n              description: 'Total amount claimed for dependents and other credits (in cents).'\n            }\n          },\n          required: [            'amount_for_other_dependents',\n            'amount_for_qualifying_children_under_17',\n            'deductions',\n            'extra_withholding',\n            'filing_status',\n            'individual_id',\n            'other_income',\n            'total_claim_dependent_and_other_credits'\n          ]\n        },\n        type: {\n          type: 'string',\n          description: 'Specifies the form type, indicating that this document is a 2020 W4 form.',\n          enum: [            'w4_2020'\n          ]\n        },\n        year: {\n          type: 'number',\n          description: 'The tax year this W4 document applies to.'\n        }\n      },\n      required: [        'data',\n        'type',\n        'year'\n      ]\n    },\n    w42005: {\n      type: 'object',\n      description: 'A 2005 version of the W-4 tax form containing information on an individual\\'s filing status, dependents, and withholding details.',\n      properties: {\n        data: {\n          type: 'object',\n          description: 'Detailed information specific to the 2005 W4 form.',\n          properties: {\n            additional_withholding: {\n              type: 'integer',\n              description: 'Additional withholding amount (in cents).'\n            },\n            exemption: {\n              type: 'string',\n              description: 'Indicates exemption status from federal tax withholding.',\n              enum: [                'exempt',\n                'non_exempt'\n              ]\n            },\n            filing_status: {\n              type: 'string',\n              description: 'The individual\\'s filing status for tax purposes.',\n              enum: [                'married',\n                'married_but_withhold_at_higher_single_rate',\n                'single'\n              ]\n            },\n            individual_id: {\n              type: 'string',\n              description: 'The unique identifier for the individual associated with this 2005 W4 form.'\n            },\n            total_number_of_allowances: {\n              type: 'integer',\n              description: 'Total number of allowances claimed (in cents).'\n            }\n          },\n          required: [            'additional_withholding',\n            'exemption',\n            'filing_status',\n            'individual_id',\n            'total_number_of_allowances'\n          ]\n        },\n        type: {\n          type: 'string',\n          description: 'Specifies the form type, indicating that this document is a 2005 W4 form.',\n          enum: [            'w4_2005'\n          ]\n        },\n        year: {\n          type: 'number',\n          description: 'The tax year this W4 document applies to.'\n        }\n      },\n      required: [        'data',\n        'type',\n        'year'\n      ]\n    }\n  }\n}\n```",
-  inputSchema: {
-    type: 'object',
-    properties: {
-      document_id: {
-        type: 'string',
-      },
-      entity_ids: {
-        type: 'array',
-        description: "The entity IDs to specify which entities' data to access.",
-        items: {
-          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: ['document_id'],
-  },
-  annotations: {
-    readOnlyHint: true,
-  },
-};
-
-export const handler = async (client: Finch, args: Record<string, unknown> | undefined) => {
-  const { document_id, jq_filter, ...body } = args as any;
-  try {
-    return asTextContentResult(
-      await maybeFilter(jq_filter, await client.hris.documents.retreive(document_id, body)),
-    );
-  } catch (error) {
-    if (error instanceof Finch.APIError || isJqError(error)) {
-      return asErrorResult(error.message);
-    }
-    throw error;
-  }
-};
-
-export default { metadata, tool, handler };

package/src/tools/hris/employments/retrieve-many-hris-employments.ts

@@ -1,64 +0,0 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-import { Metadata, asErrorResult, asTextContentResult } from '@tryfinch/finch-api-mcp/tools/types';
-
-import { Tool } from '@modelcontextprotocol/sdk/types.js';
-import Finch from '@tryfinch/finch-api';
-
-export const metadata: Metadata = {
-  resource: 'hris.employments',
-  operation: 'write',
-  tags: [],
-  httpMethod: 'post',
-  httpPath: '/employer/employment',
-  operationId: 'get-employment',
-};
-
-export const tool: Tool = {
-  name: 'retrieve_many_hris_employments',
-  description: 'Read individual employment and income data',
-  inputSchema: {
-    type: 'object',
-    properties: {
-      requests: {
-        type: 'array',
-        description: 'The array of batch requests.',
-        items: {
-          type: 'object',
-          properties: {
-            individual_id: {
-              type: 'string',
-              description:
-                'A stable Finch `id` (UUID v4) for an individual in the company. There is no limit to the number of `individual_id` to send per request. It is preferantial to send all ids in a single request for Finch to optimize provider rate-limits.',
-            },
-          },
-          required: ['individual_id'],
-        },
-      },
-      entity_ids: {
-        type: 'array',
-        description: "The entity IDs to specify which entities' data to access.",
-        items: {
-          type: 'string',
-        },
-      },
-    },
-    required: ['requests'],
-  },
-  annotations: {},
-};
-
-export const handler = async (client: Finch, args: Record<string, unknown> | undefined) => {
-  const body = args as any;
-  const response = await client.hris.employments.retrieveMany(body).asResponse();
-  try {
-    return asTextContentResult(await response.json());
-  } catch (error) {
-    if (error instanceof Finch.APIError) {
-      return asErrorResult(error.message);
-    }
-    throw error;
-  }
-};
-
-export default { metadata, tool, handler };

package/src/tools/hris/individuals/retrieve-many-hris-individuals.ts

@@ -1,79 +0,0 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-import { isJqError, maybeFilter } from '@tryfinch/finch-api-mcp/filtering';
-import { Metadata, asErrorResult, asTextContentResult } from '@tryfinch/finch-api-mcp/tools/types';
-
-import { Tool } from '@modelcontextprotocol/sdk/types.js';
-import Finch from '@tryfinch/finch-api';
-
-export const metadata: Metadata = {
-  resource: 'hris.individuals',
-  operation: 'write',
-  tags: [],
-  httpMethod: 'post',
-  httpPath: '/employer/individual',
-  operationId: 'get-individual',
-};
-
-export const tool: Tool = {
-  name: 'retrieve_many_hris_individuals',
-  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\nRead individual data, excluding income and employment data\n\n# Response Schema\n```json\n{\n  type: 'object',\n  properties: {\n    responses: {\n      type: 'array',\n      items: {\n        $ref: '#/$defs/individual_response'\n      }\n    }\n  },\n  required: [    'responses'\n  ],\n  $defs: {\n    individual_response: {\n      type: 'object',\n      properties: {\n        body: {\n          $ref: '#/$defs/individual'\n        },\n        code: {\n          type: 'integer'\n        },\n        individual_id: {\n          type: 'string'\n        }\n      },\n      required: [        'body',\n        'code',\n        'individual_id'\n      ]\n    },\n    individual: {\n      anyOf: [        {\n          type: 'object',\n          properties: {\n            id: {\n              type: 'string',\n              description: 'A stable Finch `id` (UUID v4) for an individual in the company.'\n            },\n            dob: {\n              type: 'string',\n              title: 'Date'\n            },\n            ethnicity: {\n              type: 'string',\n              description: 'The EEOC-defined ethnicity of the individual.',\n              enum: [                'asian',\n                'white',\n                'black_or_african_american',\n                'native_hawaiian_or_pacific_islander',\n                'american_indian_or_alaska_native',\n                'hispanic_or_latino',\n                'two_or_more_races',\n                'decline_to_specify'\n              ]\n            },\n            first_name: {\n              type: 'string',\n              description: 'The legal first name of the individual.'\n            },\n            gender: {\n              type: 'string',\n              description: 'The gender of the individual.',\n              enum: [                'female',\n                'male',\n                'other',\n                'decline_to_specify'\n              ]\n            },\n            last_name: {\n              type: 'string',\n              description: 'The legal last name of the individual.'\n            },\n            middle_name: {\n              type: 'string',\n              description: 'The legal middle name of the individual.'\n            },\n            phone_numbers: {\n              type: 'array',\n              items: {\n                type: 'object',\n                properties: {\n                  data: {\n                    type: 'string'\n                  },\n                  type: {\n                    type: 'string',\n                    enum: [                      'work',\n                      'personal'\n                    ]\n                  }\n                },\n                required: [                  'data',\n                  'type'\n                ]\n              }\n            },\n            preferred_name: {\n              type: 'string',\n              description: 'The preferred name of the individual.'\n            },\n            residence: {\n              $ref: '#/$defs/location'\n            },\n            emails: {\n              type: 'array',\n              items: {\n                type: 'object',\n                properties: {\n                  data: {\n                    type: 'string'\n                  },\n                  type: {\n                    type: 'string',\n                    enum: [                      'work',\n                      'personal'\n                    ]\n                  }\n                },\n                required: [                  'data',\n                  'type'\n                ]\n              }\n            },\n            encrypted_ssn: {\n              type: 'string',\n              description: 'Social Security Number of the individual in **encrypted** format. This field is only available with the `ssn` scope enabled and the `options: { include: [\\'ssn\\'] }` param set in the body.'\n            },\n            ssn: {\n              type: 'string',\n              description: 'Social Security Number of the individual. This field is only available with the `ssn` scope enabled and the `options: { include: [\\'ssn\\'] }` param set in the body. [Click here to learn more about enabling the SSN field](/developer-resources/Enable-SSN-Field).'\n            }\n          },\n          required: [            'id',\n            'dob',\n            'ethnicity',\n            'first_name',\n            'gender',\n            'last_name',\n            'middle_name',\n            'phone_numbers',\n            'preferred_name',\n            'residence'\n          ]\n        },\n        {\n          type: 'object',\n          properties: {\n            code: {\n              type: 'number'\n            },\n            message: {\n              type: 'string'\n            },\n            name: {\n              type: 'string'\n            },\n            finch_code: {\n              type: 'string'\n            }\n          },\n          required: [            'code',\n            'message',\n            'name'\n          ]\n        }\n      ]\n    },\n    location: {\n      type: 'object',\n      title: 'Location',\n      properties: {\n        city: {\n          type: 'string',\n          description: 'City, district, suburb, town, or village.'\n        },\n        country: {\n          type: 'string',\n          description: 'The 2-letter ISO 3166 country code.'\n        },\n        line1: {\n          type: 'string',\n          description: 'Street address or PO box.'\n        },\n        line2: {\n          type: 'string',\n          description: 'Apartment, suite, unit, or building.'\n        },\n        postal_code: {\n          type: 'string',\n          description: 'The postal code or zip code.'\n        },\n        state: {\n          type: 'string',\n          description: 'The state code.'\n        },\n        name: {\n          type: 'string'\n        },\n        source_id: {\n          type: 'string'\n        }\n      },\n      required: [        'city',\n        'country',\n        'line1',\n        'line2',\n        'postal_code',\n        'state'\n      ]\n    }\n  }\n}\n```",
-  inputSchema: {
-    type: 'object',
-    properties: {
-      entity_ids: {
-        type: 'array',
-        description: "The entity IDs to specify which entities' data to access.",
-        items: {
-          type: 'string',
-        },
-      },
-      options: {
-        type: 'object',
-        properties: {
-          include: {
-            type: 'array',
-            items: {
-              type: 'string',
-            },
-          },
-        },
-      },
-      requests: {
-        type: 'array',
-        items: {
-          type: 'object',
-          properties: {
-            individual_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: [],
-  },
-  annotations: {},
-};
-
-export const handler = async (client: Finch, args: Record<string, unknown> | undefined) => {
-  const { jq_filter, ...body } = args as any;
-  const response = await client.hris.individuals.retrieveMany(body).asResponse();
-  try {
-    return asTextContentResult(await maybeFilter(jq_filter, await response.json()));
-  } catch (error) {
-    if (error instanceof Finch.APIError || isJqError(error)) {
-      return asErrorResult(error.message);
-    }
-    throw error;
-  }
-};
-
-export default { metadata, tool, handler };

package/src/tools/hris/pay-statements/retrieve-many-hris-pay-statements.ts

@@ -1,72 +0,0 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-import { Metadata, asErrorResult, asTextContentResult } from '@tryfinch/finch-api-mcp/tools/types';
-
-import { Tool } from '@modelcontextprotocol/sdk/types.js';
-import Finch from '@tryfinch/finch-api';
-
-export const metadata: Metadata = {
-  resource: 'hris.pay_statements',
-  operation: 'write',
-  tags: [],
-  httpMethod: 'post',
-  httpPath: '/employer/pay-statement',
-  operationId: 'get-pay-statement',
-};
-
-export const tool: Tool = {
-  name: 'retrieve_many_hris_pay_statements',
-  description:
-    'Read detailed pay statements for each individual.\n\nDeduction and contribution types are supported by the payroll systems that supports Benefits.',
-  inputSchema: {
-    type: 'object',
-    properties: {
-      requests: {
-        type: 'array',
-        description: 'The array of batch requests.',
-        items: {
-          type: 'object',
-          properties: {
-            payment_id: {
-              type: 'string',
-              description: 'A stable Finch `id` (UUID v4) for a payment.',
-            },
-            limit: {
-              type: 'integer',
-              description: 'Number of pay statements to return (defaults to all).',
-            },
-            offset: {
-              type: 'integer',
-              description: 'Index to start from.',
-            },
-          },
-          required: ['payment_id'],
-        },
-      },
-      entity_ids: {
-        type: 'array',
-        description: "The entity IDs to specify which entities' data to access.",
-        items: {
-          type: 'string',
-        },
-      },
-    },
-    required: ['requests'],
-  },
-  annotations: {},
-};
-
-export const handler = async (client: Finch, args: Record<string, unknown> | undefined) => {
-  const body = args as any;
-  const response = await client.hris.payStatements.retrieveMany(body).asResponse();
-  try {
-    return asTextContentResult(await response.json());
-  } catch (error) {
-    if (error instanceof Finch.APIError) {
-      return asErrorResult(error.message);
-    }
-    throw error;
-  }
-};
-
-export default { metadata, tool, handler };

package/src/tools/hris/payments/list-hris-payments.ts

@@ -1,69 +0,0 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-import { isJqError, maybeFilter } from '@tryfinch/finch-api-mcp/filtering';
-import { Metadata, asErrorResult, asTextContentResult } from '@tryfinch/finch-api-mcp/tools/types';
-
-import { Tool } from '@modelcontextprotocol/sdk/types.js';
-import Finch from '@tryfinch/finch-api';
-
-export const metadata: Metadata = {
-  resource: 'hris.payments',
-  operation: 'read',
-  tags: [],
-  httpMethod: 'get',
-  httpPath: '/employer/payment',
-  operationId: 'get-payment',
-};
-
-export const tool: Tool = {
-  name: 'list_hris_payments',
-  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\nRead payroll and contractor related payments by the company.\n\n# Response Schema\n```json\n{\n  type: 'array',\n  items: {\n    $ref: '#/$defs/payment'\n  },\n  $defs: {\n    payment: {\n      type: 'object',\n      properties: {\n        id: {\n          type: 'string',\n          description: 'The unique id for the payment.'\n        },\n        company_debit: {\n          $ref: '#/$defs/money'\n        },\n        debit_date: {\n          type: 'string',\n          title: 'Date'\n        },\n        employee_taxes: {\n          $ref: '#/$defs/money'\n        },\n        employer_taxes: {\n          $ref: '#/$defs/money'\n        },\n        gross_pay: {\n          $ref: '#/$defs/money'\n        },\n        individual_ids: {\n          type: 'array',\n          description: 'Array of every individual on this payment.',\n          items: {\n            type: 'string'\n          }\n        },\n        net_pay: {\n          $ref: '#/$defs/money'\n        },\n        pay_date: {\n          type: 'string',\n          title: 'Date'\n        },\n        pay_frequencies: {\n          type: 'array',\n          description: 'List of pay frequencies associated with this payment.',\n          items: {\n            type: 'string',\n            enum: [              'annually',\n              'bi_weekly',\n              'daily',\n              'monthly',\n              'other',\n              'quarterly',\n              'semi_annually',\n              'semi_monthly',\n              'weekly'\n            ]\n          }\n        },\n        pay_group_ids: {\n          type: 'array',\n          description: 'Array of the Finch id (uuidv4) of every pay group associated with this payment.',\n          items: {\n            type: 'string'\n          }\n        },\n        pay_period: {\n          type: 'object',\n          description: 'The pay period object.',\n          properties: {\n            end_date: {\n              type: 'string',\n              title: 'Date'\n            },\n            start_date: {\n              type: 'string',\n              title: 'Date'\n            }\n          },\n          required: [            'end_date',\n            'start_date'\n          ]\n        }\n      },\n      required: [        'id',\n        'company_debit',\n        'debit_date',\n        'employee_taxes',\n        'employer_taxes',\n        'gross_pay',\n        'individual_ids',\n        'net_pay',\n        'pay_date',\n        'pay_frequencies',\n        'pay_group_ids',\n        'pay_period'\n      ]\n    },\n    money: {\n      type: 'object',\n      title: 'Money',\n      properties: {\n        amount: {\n          type: 'integer',\n          description: 'Amount for money object (in cents)'\n        },\n        currency: {\n          type: 'string'\n        }\n      },\n      required: [        'amount',\n        'currency'\n      ]\n    }\n  }\n}\n```",
-  inputSchema: {
-    type: 'object',
-    properties: {
-      end_date: {
-        type: 'string',
-        description: 'The end date to retrieve payments by a company (inclusive) in `YYYY-MM-DD` format.',
-        format: 'date',
-      },
-      start_date: {
-        type: 'string',
-        description: 'The start date to retrieve payments by a company (inclusive) in `YYYY-MM-DD` format.',
-        format: 'date',
-      },
-      entity_ids: {
-        type: 'array',
-        description: "The entity IDs to specify which entities' data to access.",
-        items: {
-          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: ['end_date', 'start_date'],
-  },
-  annotations: {
-    readOnlyHint: true,
-  },
-};
-
-export const handler = async (client: Finch, args: Record<string, unknown> | undefined) => {
-  const { jq_filter, ...body } = args as any;
-  const response = await client.hris.payments.list(body).asResponse();
-  try {
-    return asTextContentResult(await maybeFilter(jq_filter, await response.json()));
-  } catch (error) {
-    if (error instanceof Finch.APIError || isJqError(error)) {
-      return asErrorResult(error.message);
-    }
-    throw error;
-  }
-};
-
-export default { metadata, tool, handler };