@tryfinch/finch-api-mcp 6.22.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 Finch
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,247 @@
+# Finch Node MCP Server
+
+It is generated with [Stainless](https://www.stainless.com/).
+
+## Installation
+
+### Direct invocation
+
+You can run the MCP Server directly via `npx`:
+
+```sh
+export FINCH_ACCESS_TOKEN="My Access Token"
+export FINCH_CLIENT_ID="4ab15e51-11ad-49f4-acae-f343b7794375"
+export FINCH_CLIENT_SECRET="My Client Secret"
+export FINCH_WEBHOOK_SECRET="My Webhook Secret"
+npx -y @tryfinch/finch-api-mcp
+```
+
+### Via MCP Client
+
+There is a partial list of existing clients at [modelcontextprotocol.io](https://modelcontextprotocol.io/clients). If you already
+have a client, consult their documentation to install the MCP server.
+
+For clients with a configuration JSON, it might look something like this:
+
+```json
+{
+  "mcpServers": {
+    "tryfinch_finch_api_api": {
+      "command": "npx",
+      "args": ["-y", "@tryfinch/finch-api-mcp"],
+      "env": {
+        "FINCH_ACCESS_TOKEN": "My Access Token",
+        "FINCH_CLIENT_ID": "4ab15e51-11ad-49f4-acae-f343b7794375",
+        "FINCH_CLIENT_SECRET": "My Client Secret",
+        "FINCH_WEBHOOK_SECRET": "My Webhook Secret"
+      }
+    }
+  }
+}
+```
+
+## Filtering tools
+
+You can run the package on the command line to discover and filter the set of tools that are exposed by the
+MCP Server. This can be helpful for large APIs where including all endpoints at once is too much for your AI's
+context window.
+
+You can filter by multiple aspects:
+
+- `--tool` includes a specific tool by name
+- `--resource` includes all tools under a specific resource, and can have wildcards, e.g. `my.resource*`
+- `--operation` includes just read (get/list) or just write operations
+
+See more information with `--help`.
+
+All of these command-line options can be repeated, combined together, and have corresponding exclusion versions (e.g. `--no-tool`).
+
+Use `--list` to see the list of available tools, or see below.
+
+## Importing the tools and server individually
+
+```js
+// Import the server, generated endpoints, or the init function
+import { server, endpoints, init } from "@tryfinch/finch-api-mcp/server";
+
+// import a specific tool
+import createAccessTokens from "@tryfinch/finch-api-mcp/tools/access-tokens/create-access-tokens";
+
+// initialize the server and all endpoints
+init({ server, endpoints });
+
+// manually start server
+const transport = new StdioServerTransport();
+await server.connect(transport);
+
+// or initialize your own server with specific tools
+const myServer = new McpServer(...);
+
+// define your own endpoint
+const myCustomEndpoint = {
+  tool: {
+    name: 'my_custom_tool',
+    description: 'My custom tool',
+    inputSchema: zodToJsonSchema(z.object({ a_property: z.string() })),
+  },
+  handler: async (client: client, args: any) => {
+    return { myResponse: 'Hello world!' };
+  })
+};
+
+// initialize the server with your custom endpoints
+init({ server: myServer, endpoints: [createAccessTokens, myCustomEndpoint] });
+```
+
+## Available Tools
+
+The following tools are available in this MCP server.
+
+### Resource `access_tokens`:
+
+- `create_access_tokens` (`write`): Exchange the authorization code for an access token
+
+### Resource `hris.company`:
+
+- `retrieve_hris_company` (`read`): Read basic company data
+
+### Resource `hris.company.pay_statement_item`:
+
+- `list_company_hris_pay_statement_item` (`read`): **Beta:** this endpoint currently serves employers onboarded after March 4th and historical support will be added soon
+  Retrieve a list of detailed pay statement items for the access token's connection account.
+
+### Resource `hris.company.pay_statement_item.rules`:
+
+- `create_pay_statement_item_company_hris_rules` (`write`): **Beta:** this endpoint currently serves employers onboarded after March 4th and historical support will be added soon
+  Custom rules can be created to associate specific attributes to pay statement items depending on the use case. For example, pay statement items that meet certain conditions can be labeled as a pre-tax 401k. This metadata can be retrieved where pay statement item information is available.
+- `update_pay_statement_item_company_hris_rules` (`write`): **Beta:** this endpoint currently serves employers onboarded after March 4th and historical support will be added soon
+  Update a rule for a pay statement item.
+- `list_pay_statement_item_company_hris_rules` (`read`): **Beta:** this endpoint currently serves employers onboarded after March 4th and historical support will be added soon
+  List all rules of a connection account.
+- `delete_pay_statement_item_company_hris_rules` (`write`): **Beta:** this endpoint currently serves employers onboarded after March 4th and historical support will be added soon
+  Delete a rule for a pay statement item.
+
+### Resource `hris.directory`:
+
+- `list_hris_directory` (`read`): Read company directory and organization structure
+- `list_individuals_hris_directory` (`read`): Read company directory and organization structure
+
+### Resource `hris.individuals`:
+
+- `retrieve_many_hris_individuals` (`write`): Read individual data, excluding income and employment data
+
+### Resource `hris.employments`:
+
+- `retrieve_many_hris_employments` (`write`): Read individual employment and income data
+
+### Resource `hris.payments`:
+
+- `list_hris_payments` (`read`): Read payroll and contractor related payments by the company.
+
+### Resource `hris.pay_statements`:
+
+- `retrieve_many_hris_pay_statements` (`write`): Read detailed pay statements for each individual.
+
+Deduction and contribution types are supported by the payroll systems that supports Benefits.
+
+### Resource `hris.documents`:
+
+- `list_hris_documents` (`read`): **Beta:** This endpoint is in beta and may change.
+  Retrieve a list of company-wide documents.
+- `retreive_hris_documents` (`read`): **Beta:** This endpoint is in beta and may change.
+  Retrieve details of a specific document by its ID.
+
+### Resource `hris.benefits`:
+
+- `create_hris_benefits` (`write`): Creates a new company-wide deduction or contribution. Please use the `/providers` endpoint to view available types for each provider.
+- `retrieve_hris_benefits` (`read`): Lists deductions and contributions information for a given item
+- `update_hris_benefits` (`write`): Updates an existing company-wide deduction or contribution
+- `list_hris_benefits` (`read`): List all company-wide deductions and contributions.
+- `list_supported_benefits_hris_benefits` (`read`): Get deductions metadata
+
+### Resource `hris.benefits.individuals`:
+
+- `enroll_many_benefits_hris_individuals` (`write`): Enroll an individual into a deduction or contribution. This is an overwrite operation. If the employee is already enrolled, the enrollment amounts will be adjusted. Making the same request multiple times will not create new enrollments, but will continue to set the state of the existing enrollment.
+- `enrolled_ids_benefits_hris_individuals` (`read`): Lists individuals currently enrolled in a given deduction.
+- `retrieve_many_benefits_benefits_hris_individuals` (`read`): Get enrollment information for the given individuals.
+- `unenroll_many_benefits_hris_individuals` (`write`): Unenroll individuals from a deduction or contribution
+
+### Resource `providers`:
+
+- `list_providers` (`read`): Return details on all available payroll and HR systems.
+
+### Resource `account`:
+
+- `disconnect_account` (`write`): Disconnect one or more `access_token`s from your application.
+- `introspect_account` (`read`): Read account information associated with an `access_token`
+
+### Resource `request_forwarding`:
+
+- `forward_request_forwarding` (`write`): The Forward API allows you to make direct requests to an employment system. If Finch’s unified API
+  doesn’t have a data model that cleanly fits your needs, then Forward allows you to push or pull
+  data models directly against an integration’s API.
+
+### Resource `jobs.automated`:
+
+- `create_jobs_automated` (`write`): Enqueue an automated job.
+
+`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.
+
+`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.
+
+This endpoint is available for _Scale_ tier customers as an add-on. To request access to this endpoint, please contact your Finch account manager.
+
+- `retrieve_jobs_automated` (`read`): Get an automated job by `job_id`.
+- `list_jobs_automated` (`read`): 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.
+
+### Resource `jobs.manual`:
+
+- `retrieve_jobs_manual` (`read`): Get a manual job by `job_id`. Manual jobs are completed by a human and include Assisted Benefits jobs.
+
+### Resource `sandbox.connections`:
+
+- `create_sandbox_connections` (`write`): Create a new connection (new company/provider pair) with a new account
+
+### Resource `sandbox.connections.accounts`:
+
+- `create_connections_sandbox_accounts` (`write`): Create a new account for an existing connection (company/provider pair)
+- `update_connections_sandbox_accounts` (`write`): Update an existing sandbox account. Change the connection status to understand how the Finch API responds.
+
+### Resource `sandbox.company`:
+
+- `update_sandbox_company` (`write`): Update a sandbox company's data
+
+### Resource `sandbox.directory`:
+
+- `create_sandbox_directory` (`write`): Add new individuals to a sandbox company
+
+### Resource `sandbox.individual`:
+
+- `update_sandbox_individual` (`write`): Update sandbox individual
+
+### Resource `sandbox.employment`:
+
+- `update_sandbox_employment` (`write`): Update sandbox employment
+
+### Resource `sandbox.payment`:
+
+- `create_sandbox_payment` (`write`): Add a new sandbox payment
+
+### Resource `sandbox.jobs`:
+
+- `create_sandbox_jobs` (`write`): Enqueue a new sandbox job
+
+### Resource `sandbox.jobs.configuration`:
+
+- `retrieve_jobs_sandbox_configuration` (`read`): Get configurations for sandbox jobs
+- `update_jobs_sandbox_configuration` (`write`): Update configurations for sandbox jobs
+
+### Resource `payroll.pay_groups`:
+
+- `retrieve_payroll_pay_groups` (`read`): Read information from a single pay group
+- `list_payroll_pay_groups` (`read`): Read company pay groups and frequencies
+
+### Resource `connect.sessions`:
+
+- `new_connect_sessions` (`write`): Create a new connect session for an employer
+- `reauthenticate_connect_sessions` (`write`): Create a new Connect session for reauthenticating an existing connection

package/index.d.mts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.d.mts.map

package/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":""}

package/index.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.d.ts.map

package/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":""}

package/index.js

@@ -0,0 +1,162 @@
+#!/usr/bin/env node
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const stdio_js_1 = require("@modelcontextprotocol/sdk/server/stdio.js");
+const yargs_1 = __importDefault(require("yargs"));
+const helpers_1 = require("yargs/helpers");
+const server_1 = require("./server.js");
+const tools_1 = require("./tools.js");
+async function main() {
+    const opts = (0, yargs_1.default)((0, helpers_1.hideBin)(process.argv))
+        .option('tool', {
+        type: 'string',
+        array: true,
+        description: 'Include tools matching the specified names',
+    })
+        .option('resource', {
+        type: 'string',
+        array: true,
+        description: 'Include tools matching the specified resources',
+    })
+        .option('operation', {
+        type: 'string',
+        array: true,
+        choices: ['read', 'write'],
+        description: 'Include tools matching the specified operations',
+    })
+        .option('tag', {
+        type: 'string',
+        array: true,
+        description: 'Include tools with the specified tags',
+    })
+        .option('no-tool', {
+        type: 'string',
+        array: true,
+        description: 'Exclude tools matching the specified names',
+    })
+        .option('no-resource', {
+        type: 'string',
+        array: true,
+        description: 'Exclude tools matching the specified resources',
+    })
+        .option('no-operation', {
+        type: 'string',
+        array: true,
+        description: 'Exclude tools matching the specified operations',
+    })
+        .option('no-tag', {
+        type: 'string',
+        array: true,
+        description: 'Exclude tools with the specified tags',
+    })
+        .option('list', {
+        type: 'boolean',
+        description: 'List all tools and exit',
+    })
+        .help();
+    for (const [command, desc] of examples()) {
+        opts.example(command, desc);
+    }
+    const argv = opts.parseSync();
+    if (argv.list) {
+        listAllTools();
+        return;
+    }
+    const filters = [];
+    for (const tag of argv.tag || []) {
+        filters.push({ type: 'tag', op: 'include', value: tag });
+    }
+    for (const tag of argv.noTag || []) {
+        filters.push({ type: 'tag', op: 'exclude', value: tag });
+    }
+    for (const resource of argv.resource || []) {
+        filters.push({ type: 'resource', op: 'include', value: resource });
+    }
+    for (const resource of argv.noResource || []) {
+        filters.push({ type: 'resource', op: 'exclude', value: resource });
+    }
+    for (const tool of argv.tool || []) {
+        filters.push({ type: 'tool', op: 'include', value: tool });
+    }
+    for (const tool of argv.noTool || []) {
+        filters.push({ type: 'tool', op: 'exclude', value: tool });
+    }
+    for (const operation of argv.operation || []) {
+        filters.push({ type: 'operation', op: 'include', value: operation });
+    }
+    for (const operation of argv.noOperation || []) {
+        filters.push({ type: 'operation', op: 'exclude', value: operation });
+    }
+    const filteredEndpoints = (0, tools_1.query)(filters, tools_1.endpoints);
+    if (filteredEndpoints.length === 0) {
+        console.error('No tools match the provided filters.');
+        process.exit(1);
+    }
+    console.error(`MCP Server starting with ${filteredEndpoints.length} tools:`, filteredEndpoints.map((e) => e.tool.name));
+    (0, server_1.init)({ server: server_1.server, endpoints: filteredEndpoints });
+    const transport = new stdio_js_1.StdioServerTransport();
+    await server_1.server.connect(transport);
+    console.error('MCP Server running on stdio');
+}
+if (require.main === module) {
+    main().catch((error) => {
+        console.error('Fatal error in main():', error);
+        process.exit(1);
+    });
+}
+function listAllTools() {
+    if (tools_1.endpoints.length === 0) {
+        console.error('No tools available.');
+        return;
+    }
+    console.error('Available tools:\n');
+    // Group endpoints by resource
+    const resourceGroups = new Map();
+    for (const endpoint of tools_1.endpoints) {
+        const resource = endpoint.metadata.resource;
+        if (!resourceGroups.has(resource)) {
+            resourceGroups.set(resource, []);
+        }
+        resourceGroups.get(resource).push(endpoint);
+    }
+    // Sort resources alphabetically
+    const sortedResources = Array.from(resourceGroups.keys()).sort();
+    // Display hierarchically by resource
+    for (const resource of sortedResources) {
+        console.error(`Resource: ${resource}`);
+        const resourceEndpoints = resourceGroups.get(resource);
+        // Sort endpoints by tool name
+        resourceEndpoints.sort((a, b) => a.tool.name.localeCompare(b.tool.name));
+        for (const endpoint of resourceEndpoints) {
+            const { tool, metadata: { operation, tags }, } = endpoint;
+            console.error(`  - ${tool.name} (${operation}) ${tags.length > 0 ? `tags: ${tags.join(', ')}` : ''}`);
+            console.error(`    Description: ${tool.description}`);
+        }
+        console.error('');
+    }
+}
+function examples() {
+    const firstEndpoint = tools_1.endpoints[0];
+    const secondEndpoint = tools_1.endpoints.find((e) => e.metadata.resource !== firstEndpoint.metadata.resource) || tools_1.endpoints[1];
+    const tag = tools_1.endpoints.find((e) => e.metadata.tags.length > 0)?.metadata.tags[0];
+    const otherEndpoint = secondEndpoint || firstEndpoint;
+    return [
+        [
+            `--tool="${firstEndpoint.tool.name}" ${secondEndpoint ? `--tool="${secondEndpoint.tool.name}"` : ''}`,
+            'Include tools by name',
+        ],
+        [
+            `--resource="${firstEndpoint.metadata.resource}" --operation="read"`,
+            'Filter by resource and operation',
+        ],
+        [
+            `--resource="${otherEndpoint.metadata.resource}*" --no-tool="${otherEndpoint.tool.name}"`,
+            'Use resource wildcards and exclusions',
+        ],
+        ...(tag ? [[`--tag="${tag}"`, 'Filter based on tags']] : []),
+    ];
+}
+//# sourceMappingURL=index.js.map

package/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":";;;;;AAAA,wEAAiF;AACjF,kDAA0B;AAC1B,2CAAwC;AACxC,wCAAwC;AACxC,sCAAmD;AAEnD,KAAK,UAAU,IAAI;IACjB,MAAM,IAAI,GAAG,IAAA,eAAK,EAAC,IAAA,iBAAO,EAAC,OAAO,CAAC,IAAI,CAAC,CAAC;SACtC,MAAM,CAAC,MAAM,EAAE;QACd,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,IAAI;QACX,WAAW,EAAE,4CAA4C;KAC1D,CAAC;SACD,MAAM,CAAC,UAAU,EAAE;QAClB,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,IAAI;QACX,WAAW,EAAE,gDAAgD;KAC9D,CAAC;SACD,MAAM,CAAC,WAAW,EAAE;QACnB,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,IAAI;QACX,OAAO,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC;QAC1B,WAAW,EAAE,iDAAiD;KAC/D,CAAC;SACD,MAAM,CAAC,KAAK,EAAE;QACb,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,IAAI;QACX,WAAW,EAAE,uCAAuC;KACrD,CAAC;SACD,MAAM,CAAC,SAAS,EAAE;QACjB,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,IAAI;QACX,WAAW,EAAE,4CAA4C;KAC1D,CAAC;SACD,MAAM,CAAC,aAAa,EAAE;QACrB,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,IAAI;QACX,WAAW,EAAE,gDAAgD;KAC9D,CAAC;SACD,MAAM,CAAC,cAAc,EAAE;QACtB,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,IAAI;QACX,WAAW,EAAE,iDAAiD;KAC/D,CAAC;SACD,MAAM,CAAC,QAAQ,EAAE;QAChB,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,IAAI;QACX,WAAW,EAAE,uCAAuC;KACrD,CAAC;SACD,MAAM,CAAC,MAAM,EAAE;QACd,IAAI,EAAE,SAAS;QACf,WAAW,EAAE,yBAAyB;KACvC,CAAC;SACD,IAAI,EAAE,CAAC;IAEV,KAAK,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,QAAQ,EAAE,EAAE;QACxC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;KAC7B;IAED,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;IAE9B,IAAI,IAAI,CAAC,IAAI,EAAE;QACb,YAAY,EAAE,CAAC;QACf,OAAO;KACR;IACD,MAAM,OAAO,GAAa,EAAE,CAAC;IAE7B,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,GAAG,IAAI,EAAE,EAAE;QAChC,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC;KAC1D;IAED,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,KAAK,IAAI,EAAE,EAAE;QAClC,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC;KAC1D;IAED,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,QAAQ,IAAI,EAAE,EAAE;QAC1C,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC;KACpE;IAED,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,UAAU,IAAI,EAAE,EAAE;QAC5C,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC;KACpE;IAED,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,IAAI,IAAI,EAAE,EAAE;QAClC,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;KAC5D;IAED,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,MAAM,IAAI,EAAE,EAAE;QACpC,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;KAC5D;IAED,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,SAAS,IAAI,EAAE,EAAE;QAC5C,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;KACtE;IAED,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,WAAW,IAAI,EAAE,EAAE;QAC9C,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;KACtE;IAED,MAAM,iBAAiB,GAAG,IAAA,aAAK,EAAC,OAAO,EAAE,iBAAS,CAAC,CAAC;IAEpD,IAAI,iBAAiB,CAAC,MAAM,KAAK,CAAC,EAAE;QAClC,OAAO,CAAC,KAAK,CAAC,sCAAsC,CAAC,CAAC;QACtD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACjB;IAED,OAAO,CAAC,KAAK,CACX,4BAA4B,iBAAiB,CAAC,MAAM,SAAS,EAC7D,iBAAiB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAC1C,CAAC;IAEF,IAAA,aAAI,EAAC,EAAE,MAAM,EAAN,eAAM,EAAE,SAAS,EAAE,iBAAiB,EAAE,CAAC,CAAC;IAE/C,MAAM,SAAS,GAAG,IAAI,+BAAoB,EAAE,CAAC;IAC7C,MAAM,eAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IAChC,OAAO,CAAC,KAAK,CAAC,6BAA6B,CAAC,CAAC;AAC/C,CAAC;AAED,IAAI,OAAO,CAAC,IAAI,KAAK,MAAM,EAAE;IAC3B,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;QACrB,OAAO,CAAC,KAAK,CAAC,wBAAwB,EAAE,KAAK,CAAC,CAAC;QAC/C,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC,CAAC,CAAC;CACJ;AAED,SAAS,YAAY;IACnB,IAAI,iBAAS,CAAC,MAAM,KAAK,CAAC,EAAE;QAC1B,OAAO,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC;QACrC,OAAO;KACR;IACD,OAAO,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC;IAEpC,8BAA8B;IAC9B,MAAM,cAAc,GAAG,IAAI,GAAG,EAA4B,CAAC;IAE3D,KAAK,MAAM,QAAQ,IAAI,iBAAS,EAAE;QAChC,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC;QAC5C,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE;YACjC,cAAc,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;SAClC;QACD,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;KAC9C;IAED,gCAAgC;IAChC,MAAM,eAAe,GAAG,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;IAEjE,qCAAqC;IACrC,KAAK,MAAM,QAAQ,IAAI,eAAe,EAAE;QACtC,OAAO,CAAC,KAAK,CAAC,aAAa,QAAQ,EAAE,CAAC,CAAC;QAEvC,MAAM,iBAAiB,GAAG,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAE,CAAC;QACxD,8BAA8B;QAC9B,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAEzE,KAAK,MAAM,QAAQ,IAAI,iBAAiB,EAAE;YACxC,MAAM,EACJ,IAAI,EACJ,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,GAC9B,GAAG,QAAQ,CAAC;YAEb,OAAO,CAAC,KAAK,CAAC,OAAO,IAAI,CAAC,IAAI,KAAK,SAAS,KAAK,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YACtG,OAAO,CAAC,KAAK,CAAC,oBAAoB,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;SACvD;QACD,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;KACnB;AACH,CAAC;AAED,SAAS,QAAQ;IACf,MAAM,aAAa,GAAG,iBAAS,CAAC,CAAC,CAAE,CAAC;IACpC,MAAM,cAAc,GAClB,iBAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,KAAK,aAAa,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,iBAAS,CAAC,CAAC,CAAC,CAAC;IACjG,MAAM,GAAG,GAAG,iBAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAChF,MAAM,aAAa,GAAG,cAAc,IAAI,aAAa,CAAC;IAEtD,OAAO;QACL;YACE,WAAW,aAAa,CAAC,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,CAAC,CAAC,WAAW,cAAc,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;YACrG,uBAAuB;SACxB;QACD;YACE,eAAe,aAAa,CAAC,QAAQ,CAAC,QAAQ,sBAAsB;YACpE,kCAAkC;SACnC;QACD;YACE,eAAe,aAAa,CAAC,QAAQ,CAAC,QAAQ,iBAAiB,aAAa,CAAC,IAAI,CAAC,IAAI,GAAG;YACzF,uCAAuC;SACxC;QACD,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU,GAAG,GAAG,EAAE,sBAAsB,CAAqB,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;KACjF,CAAC;AACJ,CAAC"}