@tryfinch/finch-api 6.31.0 → 8.0.0

package/CHANGELOG.md

@@ -1,5 +1,335 @@
 # Changelog
 
+## 8.0.0 (2025-12-18)
+
+Full Changelog: [v7.0.0...v8.0.0](https://github.com/Finch-API/finch-api-node/compare/v7.0.0...v8.0.0)
+
+### ⚠ BREAKING CHANGES
+
+* **mcp:** remove deprecated tool schemes
+* **mcp:** **Migration:** To migrate, simply modify the command used to invoke the MCP server. Currently, the only supported tool scheme is code mode. Now, starting the server with just `node /path/to/mcp/server` or `npx package-name` will invoke code tools: changing your command to one of these is likely all you will need to do.
+
+### Bug Fixes
+
+* **mcp:** pass base url to code tool ([631bb5c](https://github.com/Finch-API/finch-api-node/commit/631bb5c63a966a3227a94488d92b135457075dad))
+
+
+### Chores
+
+* **mcp:** remove deprecated tool schemes ([9b1ff85](https://github.com/Finch-API/finch-api-node/commit/9b1ff85ec8bfb1195a63f8d16174800735c6997a))
+
+## 7.0.0 (2025-12-17)
+
+Full Changelog: [v6.38.0...v7.0.0](https://github.com/Finch-API/finch-api-node/compare/v6.38.0...v7.0.0)
+
+### Features
+
+* **api:** api update ([b2d5fcc](https://github.com/Finch-API/finch-api-node/commit/b2d5fcca38564c4b562263813bc945bae0a06b39))
+* **api:** api update ([b1be6b0](https://github.com/Finch-API/finch-api-node/commit/b1be6b0108c5ae0896e7379d5342fc9629ec8c30))
+* **api:** api update ([3fb650b](https://github.com/Finch-API/finch-api-node/commit/3fb650b9ac0084d7a6e4d9c026c0355b2b74af0b))
+* **api:** manual updates ([adf8013](https://github.com/Finch-API/finch-api-node/commit/adf8013674c0b3c7fb532ad8b98ec23863f7200b))
+* **api:** move node to typescript generator ([baa0237](https://github.com/Finch-API/finch-api-node/commit/baa02378d7b36940a4ac806462b6180d77e3ceac))
+* **api:** update automated code reviewer selection ([8639c2e](https://github.com/Finch-API/finch-api-node/commit/8639c2e81ba805d4e7df858302d0efbe725c2feb))
+* **mcp:** add detail field to docs search tool ([7eb8b44](https://github.com/Finch-API/finch-api-node/commit/7eb8b44caeeea6202f06c192759554a3883df345))
+* **mcp:** add typescript check to code execution tool ([b2b1ac1](https://github.com/Finch-API/finch-api-node/commit/b2b1ac16388edf736837f722fb700c3079bda946))
+* **mcp:** enable optional code execution tool on http mcp servers ([ace64da](https://github.com/Finch-API/finch-api-node/commit/ace64daf797895abdf52bada50f0cfff2b44c146))
+* **mcp:** handle code mode calls in the Stainless API ([e3777b8](https://github.com/Finch-API/finch-api-node/commit/e3777b8a92ed7971bf7fcbb2f4754638457a6494))
+* **mcp:** return logs on code tool errors ([7b37d8f](https://github.com/Finch-API/finch-api-node/commit/7b37d8f9cbca8d13dc09f894da08d6cb76487e74))
+
+
+### Bug Fixes
+
+* **api:** migrate custom code to TypeScript ([ec5d7fd](https://github.com/Finch-API/finch-api-node/commit/ec5d7fd9792c1a95be18f099764996796c949bb9))
+* **api:** resolve build issues ([f6be917](https://github.com/Finch-API/finch-api-node/commit/f6be917b1e7116cf84b575166d59e332390eb904))
+* **java:** Resolve name collisions ([7866332](https://github.com/Finch-API/finch-api-node/commit/7866332384999fb7dd718cf04e1e767946b400db))
+* **mcp:** add client instantiation options to code tool ([9cdaea8](https://github.com/Finch-API/finch-api-node/commit/9cdaea8d601afff676330e8eddc8fb4abb02cee3))
+* **mcp:** correct code tool API endpoint ([6d91f55](https://github.com/Finch-API/finch-api-node/commit/6d91f5522082891016109942b7501946d01153fd))
+* **mcp:** return correct lines on typescript errors ([41e296a](https://github.com/Finch-API/finch-api-node/commit/41e296a4d57b19346d88236a530b908f9c6f4f02))
+* **mcp:** return tool execution error on api error ([6059d9c](https://github.com/Finch-API/finch-api-node/commit/6059d9c53093f4da1c8bede00dffd4e27209c691))
+* **mcp:** return tool execution error on jq failure ([738e75d](https://github.com/Finch-API/finch-api-node/commit/738e75d5e4be2a4a2f4819941fc3af918094e9e5))
+* **tests:** fix tests ([eee03b0](https://github.com/Finch-API/finch-api-node/commit/eee03b0f219aead8d6c7ab4e743ed3cf66f8e9e5))
+
+
+### Chores
+
+* **client:** fix logger property type ([c3f828d](https://github.com/Finch-API/finch-api-node/commit/c3f828db47683dac2852c85f710c145f0efc95cf))
+* **internal:** codegen related update ([a361eb9](https://github.com/Finch-API/finch-api-node/commit/a361eb9698f2f3f76f2f02c76d8d44b132a1787e))
+* **internal:** codegen related update ([0f70da6](https://github.com/Finch-API/finch-api-node/commit/0f70da66ed3b1d7b2be256c25298a788baed4847))
+* **internal:** codegen related update ([a39b040](https://github.com/Finch-API/finch-api-node/commit/a39b0402570ec2e64a4950efb55726c33cbf6ce3))
+* **internal:** codegen related update ([60aa66a](https://github.com/Finch-API/finch-api-node/commit/60aa66a135d99299976fb2c59ac8d83f98d6841c))
+* **internal:** upgrade eslint ([1707b51](https://github.com/Finch-API/finch-api-node/commit/1707b51aab5ad912d7210f6dc3b142eea1b2d749))
+* mcp code tool explicit error message when missing a run function ([c43cbb2](https://github.com/Finch-API/finch-api-node/commit/c43cbb234a5044f21866998cacf9f658cc55de49))
+* **mcp:** add friendlier MCP code tool errors on incorrect method invocations ([6b20464](https://github.com/Finch-API/finch-api-node/commit/6b20464cdcf9d407bb22ac7a65a0a40732130321))
+* **mcp:** add line numbers to code tool errors ([3289a2b](https://github.com/Finch-API/finch-api-node/commit/3289a2b9e29e2d7298f096fcbae9237e28bce198))
+* **mcp:** clarify http auth error ([b028908](https://github.com/Finch-API/finch-api-node/commit/b02890809d93b7496cc2deeb9f0547d5b180cd06))
+* **mcp:** update lockfile ([88a4eac](https://github.com/Finch-API/finch-api-node/commit/88a4eacf9b9276a7b3db8a8dc9f12a0053251829))
+* **mcp:** upgrade jq-web ([8531130](https://github.com/Finch-API/finch-api-node/commit/8531130ea2dfcd42b747357d9c0f13dea4e933c5))
+* sync repo ([f38fc15](https://github.com/Finch-API/finch-api-node/commit/f38fc15fccf7f65422fc9cd62aea41fb143b36ed))
+* use latest @modelcontextprotocol/sdk ([b29ebd1](https://github.com/Finch-API/finch-api-node/commit/b29ebd1cc574733a9443ad9937e8e1b7e0f5d0a1))
+
+
+### Documentation
+
+* **mcp:** add a README button for one-click add to Cursor ([99e438c](https://github.com/Finch-API/finch-api-node/commit/99e438ca85071e011f30e93f7b5f67628bd0695c))
+* **mcp:** add a README link to add server to VS Code or Claude Code ([7a5ecb9](https://github.com/Finch-API/finch-api-node/commit/7a5ecb92bc7575e51fd053e3d6796f0b1b06dc6f))
+
+## 6.38.0 (2025-10-27)
+
+Full Changelog: [v6.37.0...v6.38.0](https://github.com/Finch-API/finch-api-node/compare/v6.37.0...v6.38.0)
+
+### Features
+
+* **api:** api update ([4d57031](https://github.com/Finch-API/finch-api-node/commit/4d5703128cd8a626dec68fe4ffc34980579bcd6f))
+* **api:** api update ([50af0c2](https://github.com/Finch-API/finch-api-node/commit/50af0c2c4756708e0de6bdb3c1eaacce3d24733b))
+* **api:** api update ([9fb854f](https://github.com/Finch-API/finch-api-node/commit/9fb854f6ceaac25e21901b4a035d2207de994901))
+* **api:** api update ([96d3f66](https://github.com/Finch-API/finch-api-node/commit/96d3f666690caea95b650b954dfd681eeb686c8e))
+* **api:** api update ([b331c10](https://github.com/Finch-API/finch-api-node/commit/b331c108e3912c503e4cc8393587bac2a927f4f7))
+* **api:** api update ([99a20c2](https://github.com/Finch-API/finch-api-node/commit/99a20c267f645658d3928f269f5da7a33b287d17))
+* **api:** api update ([f9c7e06](https://github.com/Finch-API/finch-api-node/commit/f9c7e0685ff5ab28614353eacc1fc7887ec6a0ff))
+* **api:** api update ([1c4f073](https://github.com/Finch-API/finch-api-node/commit/1c4f073cc8e8f06e58069dcc2bc5b708e3a8be34))
+* **api:** api update ([843b525](https://github.com/Finch-API/finch-api-node/commit/843b525f6a3f07edda04ca213a35dd3d2d37fdb3))
+* **api:** api update ([9bc9a38](https://github.com/Finch-API/finch-api-node/commit/9bc9a38df44189e734248cf7ad06259f93e25b82))
+* **api:** api update ([09d2e93](https://github.com/Finch-API/finch-api-node/commit/09d2e939a8c42d495d9207ad2d73841f6e9e8732))
+* **api:** make client id, client secret optional again ([d67f867](https://github.com/Finch-API/finch-api-node/commit/d67f867f1b3c9e4886d21da21a1cccab5760aa9d))
+* **mcp:** add docs search tool ([a9e8666](https://github.com/Finch-API/finch-api-node/commit/a9e866662d47e0f39a1988339101d46ba149fb9d))
+* **mcp:** add mcp bundles to build script ([45794fe](https://github.com/Finch-API/finch-api-node/commit/45794fe7a8d09dd0160ac3d2a64941fff12837d5))
+* **mcp:** add option for including docs tools ([fef1f5b](https://github.com/Finch-API/finch-api-node/commit/fef1f5b0cc05c737db89097378c88a38e8973089))
+* **mcp:** allow setting logging level ([4634f9a](https://github.com/Finch-API/finch-api-node/commit/4634f9a04f0fd3a7daa781876a1d93e170f1941d))
+* **mcp:** change remote server query option parsing logic ([13ef1bd](https://github.com/Finch-API/finch-api-node/commit/13ef1bd4400e1ae2b2197a35f33e79703af34e08))
+* **mcp:** enable experimental docs search tool ([8ec38f6](https://github.com/Finch-API/finch-api-node/commit/8ec38f6536ca6a6e7324dd827db0dc9ee9234f61))
+* **mcp:** expose client options in `streamableHTTPApp` ([39cdb76](https://github.com/Finch-API/finch-api-node/commit/39cdb7601c55b6d723132edeb320c3898e697fa2))
+
+
+### Bug Fixes
+
+* **ci:** set permissions for DXT publish action ([6a6dd0a](https://github.com/Finch-API/finch-api-node/commit/6a6dd0af7e290990c7773447615e3e5d99ff217b))
+* **client:** incorrect offset pagination check ([2600077](https://github.com/Finch-API/finch-api-node/commit/26000775b7ab71e9e3994196806a847383905853))
+* coerce nullable values to undefined ([aa135f5](https://github.com/Finch-API/finch-api-node/commit/aa135f5fdfe89359b6ad8c49b1908e7faee4ebaa))
+* **mcp:** avoid importing unsupported libraries on non-node environments ([8c380a8](https://github.com/Finch-API/finch-api-node/commit/8c380a8499435e8a92155664943e6fc631f7ba1a))
+* **mcp:** fix cli argument parsing logic ([277ba31](https://github.com/Finch-API/finch-api-node/commit/277ba31b242825bd569a6566a8f2a136ec0b595d))
+* **mcp:** fix query options parsing ([9087760](https://github.com/Finch-API/finch-api-node/commit/90877607933fa892f5d05c8931fa2de9d139e769))
+* **mcp:** fix uploading dxt release assets ([70f9a36](https://github.com/Finch-API/finch-api-node/commit/70f9a36f47190f4b78de043e63d65e21df6ce116))
+* **mcp:** resolve a linting issue in server code ([90b7ae2](https://github.com/Finch-API/finch-api-node/commit/90b7ae260d427cebb7bcd7f2d3e854a0efaccd19))
+
+
+### Performance Improvements
+
+* faster formatting ([163982a](https://github.com/Finch-API/finch-api-node/commit/163982a884bcf10684b5b3e242b0d52d547fc62b))
+
+
+### Chores
+
+* ci build action ([f0c3633](https://github.com/Finch-API/finch-api-node/commit/f0c3633571f7eea46803cb75ba244c41cac5a7b4))
+* **codegen:** internal codegen update ([27ec1f5](https://github.com/Finch-API/finch-api-node/commit/27ec1f5a8d71f31a327021745f7dab0aeebc4b7b))
+* do not install brew dependencies in ./scripts/bootstrap by default ([1758c0d](https://github.com/Finch-API/finch-api-node/commit/1758c0de64e97975332bb8a0c6b55a23ed82a036))
+* extract some types in mcp docs ([55c3799](https://github.com/Finch-API/finch-api-node/commit/55c37998bdb39779bfb9ae62ee5310a2a423248d))
+* **internal:** codegen related update ([d020050](https://github.com/Finch-API/finch-api-node/commit/d0200501b52ae4ac9e7c8de91d2f883e27db34c5))
+* **internal:** codegen related update ([697d211](https://github.com/Finch-API/finch-api-node/commit/697d211b9600d388aa101879ac6c400e4eb4ac53))
+* **internal:** codegen related update ([ac835bf](https://github.com/Finch-API/finch-api-node/commit/ac835bf6af93d53e551d73001d048baa95e1c334))
+* **internal:** fix incremental formatting in some cases ([40ecf6a](https://github.com/Finch-API/finch-api-node/commit/40ecf6a887ea44d156672f155abf70ab2d146921))
+* **internal:** gitignore .mcpb files ([73c778e](https://github.com/Finch-API/finch-api-node/commit/73c778e3b9d157f8296c43131cd0db764d5086bc))
+* **internal:** ignore .eslintcache ([4d90156](https://github.com/Finch-API/finch-api-node/commit/4d901569e987fa9c93c12ae77844972b4655fa8f))
+* **internal:** remove .eslintcache ([64d2197](https://github.com/Finch-API/finch-api-node/commit/64d21976509a6d6b6d0095bf1867ad9bdd153e03))
+* **internal:** remove deprecated `compilerOptions.baseUrl` from tsconfig.json ([5955e29](https://github.com/Finch-API/finch-api-node/commit/5955e291311d6d8192a3e8c3eb87f4eac9bdbdbc))
+* **internal:** use npm pack for build uploads ([7df5a28](https://github.com/Finch-API/finch-api-node/commit/7df5a28a1be002645785fa2d59cd94da5df28889))
+* **mcp:** allow pointing `docs_search` tool at other URLs ([bb7f182](https://github.com/Finch-API/finch-api-node/commit/bb7f182ef3959a99a7728cdab685d972e4110756))
+* **mcp:** rename dxt to mcpb ([68a9c07](https://github.com/Finch-API/finch-api-node/commit/68a9c079dfb35ab661f58780405036399fbaf31e))
+* **mcp:** upload dxt as release asset ([256c717](https://github.com/Finch-API/finch-api-node/commit/256c717c7eb0bd947322b14d85fc15cd7f919724))
+* update CI script ([47843c8](https://github.com/Finch-API/finch-api-node/commit/47843c85864215c19edd9826952bd625e79ca78c))
+* update lockfile ([0601d2a](https://github.com/Finch-API/finch-api-node/commit/0601d2aca7eeb80b8967d3bc89dea5b5ab527565))
+
+## 6.37.0 (2025-08-21)
+
+Full Changelog: [v6.36.0...v6.37.0](https://github.com/Finch-API/finch-api-node/compare/v6.36.0...v6.37.0)
+
+### Features
+
+* **api:** api update ([fc318d6](https://github.com/Finch-API/finch-api-node/commit/fc318d6591c306228fdd216498f8b704eeb4aa67))
+* **mcp:** add option to infer mcp client ([3581de0](https://github.com/Finch-API/finch-api-node/commit/3581de04c7957c0ea00041bed835b1210210baa8))
+
+
+### Chores
+
+* **internal:** make mcp-server publishing public by defaut ([5f917cb](https://github.com/Finch-API/finch-api-node/commit/5f917cb85ed363831a49a7dbee70db4d57bdfac8))
+* **mcp:** update package.json ([976bd47](https://github.com/Finch-API/finch-api-node/commit/976bd47a6097636ea128cd5c250b6a67d0d10ca1))
+* **mcp:** update types ([3aeae4c](https://github.com/Finch-API/finch-api-node/commit/3aeae4c9f57cb8f19f7458f5b42f33027d9f9a8e))
+
+## 6.36.0 (2025-08-19)
+
+Full Changelog: [v6.35.1...v6.36.0](https://github.com/Finch-API/finch-api-node/compare/v6.35.1...v6.36.0)
+
+### Features
+
+* **mcp:** add code execution tool ([a7dba4d](https://github.com/Finch-API/finch-api-node/commit/a7dba4d6ccd7c40f819ba1c5c8fd9542dc2b3f7a))
+
+## 6.35.1 (2025-08-19)
+
+Full Changelog: [v6.35.0...v6.35.1](https://github.com/Finch-API/finch-api-node/compare/v6.35.0...v6.35.1)
+
+### Chores
+
+* **mcp:** add cors to oauth metadata route ([75a424b](https://github.com/Finch-API/finch-api-node/commit/75a424b26ea9c2e7c191bc94c962d0c9aaf2f6aa))
+
+## 6.35.0 (2025-08-18)
+
+Full Changelog: [v6.34.0...v6.35.0](https://github.com/Finch-API/finch-api-node/compare/v6.34.0...v6.35.0)
+
+### Features
+
+* **api:** api update ([6b47451](https://github.com/Finch-API/finch-api-node/commit/6b4745198032d8b2928001f1a1cf0fa21f0b5bae))
+* **api:** api update ([0e1db82](https://github.com/Finch-API/finch-api-node/commit/0e1db82162b8729c64910f06872f12ced2a23b25))
+* **mcp:** parse query string as mcp client options in mcp server ([ee1762e](https://github.com/Finch-API/finch-api-node/commit/ee1762e2698c866ce3eeb4867116dcc54b4b890e))
+
+
+### Bug Fixes
+
+* **mcp:** fix jq type bug ([eedf679](https://github.com/Finch-API/finch-api-node/commit/eedf6799e9b70c2925376c6361da6a4b5a74b605))
+* **mcp:** generate additionalProperties=true for map schemas to avoid validation issues ([0ed8d86](https://github.com/Finch-API/finch-api-node/commit/0ed8d86ae898be9ac41ed0011b65e97374c92e64))
+
+
+### Chores
+
+* **deps:** update dependency node-fetch to v2.6.13 ([3cded58](https://github.com/Finch-API/finch-api-node/commit/3cded5866267fb80d06cd1904b0cd4d7a2973f6b))
+* **internal:** formatting change ([55cdd5f](https://github.com/Finch-API/finch-api-node/commit/55cdd5f591e02cce1cf297f59a1baca82452cca3))
+* **internal:** refactor array check ([1ca2890](https://github.com/Finch-API/finch-api-node/commit/1ca2890574edeac7b78492f4ed2fdc7d9b3f8441))
+* **internal:** update comment in script ([468ca33](https://github.com/Finch-API/finch-api-node/commit/468ca33d139f121d484b8e0b71eefc694e4ffb2f))
+* **mcp:** bump JQ version ([c472eac](https://github.com/Finch-API/finch-api-node/commit/c472eaca3c50e765294a9b71d754d368911fe3c4))
+* **mcp:** document remote server in README.md ([01b0197](https://github.com/Finch-API/finch-api-node/commit/01b01972327ed68e8b35d34c0a448e80e5aea5cf))
+* **mcp:** minor cleanup of types and package.json ([176af80](https://github.com/Finch-API/finch-api-node/commit/176af80204ad16024fa339014905bf818e683245))
+* **mcp:** update README ([47c2bcc](https://github.com/Finch-API/finch-api-node/commit/47c2bcc8dfaba660acdf326e835e2c345ba84166))
+* update @stainless-api/prism-cli to v5.15.0 ([a05f59c](https://github.com/Finch-API/finch-api-node/commit/a05f59c97d046a57b64f82dccc697137d892ccfc))
+
+## 6.34.0 (2025-08-06)
+
+Full Changelog: [v6.33.0...v6.34.0](https://github.com/Finch-API/finch-api-node/compare/v6.33.0...v6.34.0)
+
+### Features
+
+* **mcp:** add logging when environment variable is set ([0d90a8c](https://github.com/Finch-API/finch-api-node/commit/0d90a8c366ab7dfff6f6fba61e4157ed91597417))
+* **mcp:** add unix socket option for remote MCP ([0bd4baf](https://github.com/Finch-API/finch-api-node/commit/0bd4baf79a26faa908fedc6682c99b290e5dc247))
+* **mcp:** remote server with passthru auth ([fd0274b](https://github.com/Finch-API/finch-api-node/commit/fd0274b025d19940b425fe6e5cda89b0a4a7736b))
+
+
+### Bug Fixes
+
+* **mcp:** avoid sending `jq_filter` to base API ([685a555](https://github.com/Finch-API/finch-api-node/commit/685a555e335413712c6b569910f4e421aa8cefb2))
+* **mcp:** fix bug in header handling ([d43cbe4](https://github.com/Finch-API/finch-api-node/commit/d43cbe4f291963392fb8bb73c2b924a0c4c9117c))
+* **mcp:** fix tool description of jq_filter ([f3687ac](https://github.com/Finch-API/finch-api-node/commit/f3687ac778ceb5d1609f20f4ac51da9eb7fc8bdd))
+* **mcp:** reverse validJson capability option and limit scope ([8b71749](https://github.com/Finch-API/finch-api-node/commit/8b71749012e2910f803a867e5ca7709fd1476560))
+
+
+### Chores
+
+* **internal:** codegen related update ([f9e09f1](https://github.com/Finch-API/finch-api-node/commit/f9e09f139130ab844a18d1cc2430a2d0ee80bc09))
+* **internal:** move publish config ([d79a421](https://github.com/Finch-API/finch-api-node/commit/d79a42138da01ee3bdec3688ffcba2250292581e))
+* **internal:** remove redundant imports config ([9abbf0b](https://github.com/Finch-API/finch-api-node/commit/9abbf0bdacfdca38cd5ee775bc6f981c4689fc69))
+* **mcp:** refactor streamable http transport ([2e519b6](https://github.com/Finch-API/finch-api-node/commit/2e519b6d69a29a53148aef12f6333538ad239181))
+
+## 6.33.0 (2025-07-23)
+
+Full Changelog: [v6.32.3...v6.33.0](https://github.com/Finch-API/finch-api-node/compare/v6.32.3...v6.33.0)
+
+### Features
+
+* **api:** api update ([44a2607](https://github.com/Finch-API/finch-api-node/commit/44a26078e84c965bee4fe6dfa0691031ccc65a42))
+* **api:** api update ([c52f01b](https://github.com/Finch-API/finch-api-node/commit/c52f01b0de3340c07294bac7934959da5d399e98))
+
+
+### Bug Fixes
+
+* **mcp:** include required section for top-level properties and support naming transformations ([81932c7](https://github.com/Finch-API/finch-api-node/commit/81932c754864cea1defc5939355a8d7ed8efca54))
+* **mcp:** support jq filtering on cloudflare workers ([f678d75](https://github.com/Finch-API/finch-api-node/commit/f678d75f966bc152fdcc7d19dab40c20f0e4446c))
+
+
+### Chores
+
+* **internal:** codegen related update ([3687e69](https://github.com/Finch-API/finch-api-node/commit/3687e69a3c9f381d958545c25f4e38de33c87ea6))
+* **mcp:** formatting ([040c60f](https://github.com/Finch-API/finch-api-node/commit/040c60fb2766d9a65b7ed56da90a3fc6a06c9de3))
+* **mcp:** rework imports in tools ([58349e8](https://github.com/Finch-API/finch-api-node/commit/58349e876bcf5c8d3b35f306455238fa17c31fe7))
+
+## 6.32.3 (2025-07-10)
+
+Full Changelog: [v6.32.2...v6.32.3](https://github.com/Finch-API/finch-api-node/compare/v6.32.2...v6.32.3)
+
+### Chores
+
+* **internal:** codegen related update ([f8bf46e](https://github.com/Finch-API/finch-api-node/commit/f8bf46e0dc32f11e9920a59c8ff0c8e44536a9fe))
+* make some internal functions async ([1656660](https://github.com/Finch-API/finch-api-node/commit/16566608f8bc0206caf44fd33ad7a44d678f2c1b))
+
+## 6.32.2 (2025-07-03)
+
+Full Changelog: [v6.32.1...v6.32.2](https://github.com/Finch-API/finch-api-node/compare/v6.32.1...v6.32.2)
+
+### Bug Fixes
+
+* **build:** bump node version in CI build to 20 to be compatible with MCP package ([a42f5a6](https://github.com/Finch-API/finch-api-node/commit/a42f5a6d80c069df0b250d0557b0b9490f0293cb))
+* **client:** don't send `Content-Type` for bodyless methods ([605ebe0](https://github.com/Finch-API/finch-api-node/commit/605ebe0809f965063cee49b21903e4dba3073ce0))
+
+
+### Chores
+
+* mention unit type in timeout docs ([46e6e6f](https://github.com/Finch-API/finch-api-node/commit/46e6e6fc73bd4b5dcf6ac0bb2d9cc268314fbc39))
+
+## 6.32.1 (2025-06-27)
+
+Full Changelog: [v6.32.0...v6.32.1](https://github.com/Finch-API/finch-api-node/compare/v6.32.0...v6.32.1)
+
+### Bug Fixes
+
+* **ci:** release-doctor — report correct token name ([85086a9](https://github.com/Finch-API/finch-api-node/commit/85086a95f3c5efe51167c40dc0652e05c2425fcd))
+
+
+### Chores
+
+* **ci:** only run for pushes and fork pull requests ([f679ab4](https://github.com/Finch-API/finch-api-node/commit/f679ab46d68f21a9ed7ca7c362054c48883f817c))
+
+## 6.32.0 (2025-06-23)
+
+Full Changelog: [v6.31.0...v6.32.0](https://github.com/Finch-API/finch-api-node/compare/v6.31.0...v6.32.0)
+
+### Features
+
+* **api:** api update ([7182d88](https://github.com/Finch-API/finch-api-node/commit/7182d889a7de38d03c7994caf4747fcd2a82a846))
+* **api:** api update ([4663014](https://github.com/Finch-API/finch-api-node/commit/46630149ddd55b184ec7ddcdb9d70df15477f72c))
+* **api:** api update ([c167734](https://github.com/Finch-API/finch-api-node/commit/c167734a8071e5733f5a56f9b2c750c300952164))
+* **api:** api update ([2978396](https://github.com/Finch-API/finch-api-node/commit/29783964a38bc08f24752be9565282222e316568))
+* **client:** add support for endpoint-specific base URLs ([f85edd8](https://github.com/Finch-API/finch-api-node/commit/f85edd832b9b2ecc3a16e5e4e0260797b7bbd472))
+* **mcp:** implement support for binary responses ([6cc04d6](https://github.com/Finch-API/finch-api-node/commit/6cc04d6f6cebe1487b366d067f9de34c8f857b38))
+* **mcp:** include http information in tools ([d583a5a](https://github.com/Finch-API/finch-api-node/commit/d583a5a224672caa80f9010e005be60d1efc9b69))
+* **mcp:** set X-Stainless-MCP header ([a744e70](https://github.com/Finch-API/finch-api-node/commit/a744e7079b7bef164c0e0eaef0608e62dfa5ea45))
+
+
+### Bug Fixes
+
+* **client:** fix PayStatementResponse body ([5855476](https://github.com/Finch-API/finch-api-node/commit/585547621b48de30db9cb69f07e93f983ab51ac5))
+* **client:** manual fix ([c7cc53b](https://github.com/Finch-API/finch-api-node/commit/c7cc53b674ed870e42132b46e78f81b9d03e9ed8))
+* **mcp:** fix cursor schema transformation issue with recursive references ([1bed3f2](https://github.com/Finch-API/finch-api-node/commit/1bed3f2480b88dceb722cc25ad4deb31b41f6fc8))
+* **mcp:** include description in dynamic tool search ([886e2d8](https://github.com/Finch-API/finch-api-node/commit/886e2d8e61925f572c978de5c86bbecae255705f))
+* publish script — handle NPM errors correctly ([87bd68d](https://github.com/Finch-API/finch-api-node/commit/87bd68ddb4b348084f6c82e59f0453e97ea881c3))
+
+
+### Chores
+
+* **ci:** enable for pull requests ([81c3d57](https://github.com/Finch-API/finch-api-node/commit/81c3d5761ac996f17dfdfd2581e2251cf1a545a2))
+* **docs:** grammar improvements ([3a9ab50](https://github.com/Finch-API/finch-api-node/commit/3a9ab5071bc3e021d4dc15d91b4ac1cd86bfadd3))
+* **docs:** use top-level-await in example snippets ([adaa4ce](https://github.com/Finch-API/finch-api-node/commit/adaa4cea5dbeb9f35b393f3816da8eb9f0c75372))
+* improve docs for MCP servers ([deff850](https://github.com/Finch-API/finch-api-node/commit/deff850e6b9a989d50d9ecad8af0b7f1744983ba))
+* improve publish-npm script --latest tag logic ([a40bcfe](https://github.com/Finch-API/finch-api-node/commit/a40bcfed602c2ec66fe5fbccc42df558ad257262))
+* **internal:** make base APIResource abstract ([558f47f](https://github.com/Finch-API/finch-api-node/commit/558f47fca967f63f8eeb4f650595b53cc38a752c))
+* **mcp:** provides high-level initMcpServer function and exports known clients ([edc7876](https://github.com/Finch-API/finch-api-node/commit/edc7876600c6962bc22311372af65fbaf156d011))
+* **mcp:** remove duplicate assignment ([6e38b68](https://github.com/Finch-API/finch-api-node/commit/6e38b68b83e91416e49b2285c72932041d1b8524))
+* **tests:** skip endpoints with basic auth ([483735c](https://github.com/Finch-API/finch-api-node/commit/483735cde0fca3925b0d8471e3dd342e59232481))
+
+
+### Documentation
+
+* **pagination:** improve naming ([90d96a3](https://github.com/Finch-API/finch-api-node/commit/90d96a323eff4579dc9462691f9a0176b7d7a5aa))
+
+
+### Refactors
+
+* **types:** replace Record with mapped types ([f28d3d3](https://github.com/Finch-API/finch-api-node/commit/f28d3d394e978aeb7e8081342f72476fd22bf9ef))
+
 ## 6.31.0 (2025-05-16)
 
 Full Changelog: [v6.30.0...v6.31.0](https://github.com/Finch-API/finch-api-node/compare/v6.30.0...v6.31.0)

package/README.md

@@ -1,6 +1,6 @@
-# Finch Node API Library
+# Finch TypeScript API Library
 
-[![NPM version](https://img.shields.io/npm/v/@tryfinch/finch-api.svg)](https://npmjs.org/package/@tryfinch/finch-api) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/@tryfinch/finch-api)
+[![NPM version](<https://img.shields.io/npm/v/@tryfinch/finch-api.svg?label=npm%20(stable)>)](https://npmjs.org/package/@tryfinch/finch-api) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/@tryfinch/finch-api)
 
 This library provides convenient access to the Finch REST API from server-side TypeScript or JavaScript.
 
@@ -26,14 +26,10 @@ const client = new Finch({
   accessToken: 'My Access Token',
 });
 
-async function main() {
-  const page = await client.hris.directory.list();
-  const individualInDirectory = page.individuals[0];
-
-  console.log(individualInDirectory.id);
-}
+const page = await client.hris.directory.list();
+const individualInDirectory = page.individuals[0];
 
-main();
+console.log(individualInDirectory.id);
 ```
 
 ### Request & Response types
@@ -48,11 +44,7 @@ const client = new Finch({
   accessToken: 'My Access Token',
 });
 
-async function main() {
-  const [individualInDirectory]: [Finch.HRIS.IndividualInDirectory] = await client.hris.directory.list();
-}
-
-main();
+const [individualInDirectory]: [Finch.HRIS.IndividualInDirectory] = await client.hris.directory.list();
 ```
 
 Documentation for each method, request param, and response field are available in docstrings and will appear on hover in most modern editors.
@@ -65,19 +57,15 @@ a subclass of `APIError` will be thrown:
 
 <!-- prettier-ignore -->
 ```ts
-async function main() {
-  const company = await client.hris.company.retrieve().catch(async (err) => {
-    if (err instanceof Finch.APIError) {
-      console.log(err.status); // 400
-      console.log(err.name); // BadRequestError
-      console.log(err.headers); // {server: 'nginx', ...}
-    } else {
-      throw err;
-    }
-  });
-}
-
-main();
+const company = await client.hris.company.retrieve().catch(async (err) => {
+  if (err instanceof Finch.APIError) {
+    console.log(err.status); // 400
+    console.log(err.name); // BadRequestError
+    console.log(err.headers); // {server: 'nginx', ...}
+  } else {
+    throw err;
+  }
+});
 ```
 
 Error codes are as follows:
@@ -141,13 +129,13 @@ List methods in the Finch API are paginated.
 You can use the `for await … of` syntax to iterate through items across all pages:
 
 ```ts
-async function fetchAllHRISDirectories(params) {
-  const allHRISDirectories = [];
+async function fetchAllIndividualInDirectories(params) {
+  const allIndividualInDirectories = [];
   // Automatically fetches more pages as needed.
   for await (const individualInDirectory of client.hris.directory.list()) {
-    allHRISDirectories.push(individualInDirectory);
+    allIndividualInDirectories.push(individualInDirectory);
   }
-  return allHRISDirectories;
+  return allIndividualInDirectories;
 }
 ```
 
@@ -217,8 +205,10 @@ export default async function POST(req) {
 ### Accessing raw Response data (e.g., headers)
 
 The "raw" `Response` returned by `fetch()` can be accessed through the `.asResponse()` method on the `APIPromise` type that all methods return.
+This method returns as soon as the headers for a successful response are received and does not consume the response body, so you are free to write custom parsing or streaming logic.
 
 You can also use the `.withResponse()` method to get the raw `Response` along with the parsed data.
+Unlike `.asResponse()` this method consumes the body, returning once it is parsed.
 
 <!-- prettier-ignore -->
 ```ts
@@ -235,6 +225,59 @@ for await (const individualInDirectory of page) {
 }
 ```
 
+### Logging
+
+> [!IMPORTANT]
+> All log messages are intended for debugging only. The format and content of log messages
+> may change between releases.
+
+#### Log levels
+
+The log level can be configured in two ways:
+
+1. Via the `FINCH_LOG` environment variable
+2. Using the `logLevel` client option (overrides the environment variable if set)
+
+```ts
+import Finch from '@tryfinch/finch-api';
+
+const client = new Finch({
+  logLevel: 'debug', // Show all log messages
+});
+```
+
+Available log levels, from most to least verbose:
+
+- `'debug'` - Show debug messages, info, warnings, and errors
+- `'info'` - Show info messages, warnings, and errors
+- `'warn'` - Show warnings and errors (default)
+- `'error'` - Show only errors
+- `'off'` - Disable all logging
+
+At the `'debug'` level, all HTTP requests and responses are logged, including headers and bodies.
+Some authentication-related headers are redacted, but sensitive data in request and response bodies
+may still be visible.
+
+#### Custom logger
+
+By default, this library logs to `globalThis.console`. You can also provide a custom logger.
+Most logging libraries are supported, including [pino](https://www.npmjs.com/package/pino), [winston](https://www.npmjs.com/package/winston), [bunyan](https://www.npmjs.com/package/bunyan), [consola](https://www.npmjs.com/package/consola), [signale](https://www.npmjs.com/package/signale), and [@std/log](https://jsr.io/@std/log). If your logger doesn't work, please open an issue.
+
+When providing a custom logger, the `logLevel` option still controls which messages are emitted, messages
+below the configured level will not be sent to your logger.
+
+```ts
+import Finch from '@tryfinch/finch-api';
+import pino from 'pino';
+
+const logger = pino();
+
+const client = new Finch({
+  logger: logger.child({ name: 'Finch' }),
+  logLevel: 'debug', // Send all messages to pino, allowing it to filter
+});
+```
+
 ### Making custom/undocumented requests
 
 This library is typed for convenient access to the documented API. If you need to access undocumented
@@ -259,9 +302,8 @@ parameter. This library doesn't validate at runtime that the request matches the
 send will be sent as-is.
 
 ```ts
-client.foo.create({
-  foo: 'my_param',
-  bar: 12,
+client.hris.directory.list({
+  // ...
   // @ts-expect-error baz is not yet public
   baz: 'undocumented option',
 });
@@ -281,66 +323,85 @@ validate or strip extra properties from the response from the API.
 
 ### Customizing the fetch client
 
-By default, this library uses `node-fetch` in Node, and expects a global `fetch` function in other environments.
+By default, this library expects a global `fetch` function is defined.
 
-If you would prefer to use a global, web-standards-compliant `fetch` function even in a Node environment,
-(for example, if you are running Node with `--experimental-fetch` or using NextJS which polyfills with `undici`),
-add the following import before your first import `from "Finch"`:
+If you want to use a different `fetch` function, you can either polyfill the global:
 
 ```ts
-// Tell TypeScript and the package to use the global web fetch instead of node-fetch.
-// Note, despite the name, this does not add any polyfills, but expects them to be provided if needed.
-import '@tryfinch/finch-api/shims/web';
-import Finch from '@tryfinch/finch-api';
+import fetch from 'my-fetch';
+
+globalThis.fetch = fetch;
 ```
 
-To do the inverse, add `import "@tryfinch/finch-api/shims/node"` (which does import polyfills).
-This can also be useful if you are getting the wrong TypeScript types for `Response` ([more details](https://github.com/Finch-API/finch-api-node/tree/main/src/_shims#readme)).
+Or pass it to the client:
+
+```ts
+import Finch from '@tryfinch/finch-api';
+import fetch from 'my-fetch';
+
+const client = new Finch({ fetch });
+```
 
-### Logging and middleware
+### Fetch options
 
-You may also provide a custom `fetch` function when instantiating the client,
-which can be used to inspect or alter the `Request` or `Response` before/after each request:
+If you want to set custom `fetch` options without overriding the `fetch` function, you can provide a `fetchOptions` object when instantiating the client or making a request. (Request-specific options override client options.)
 
 ```ts
-import { fetch } from 'undici'; // as one example
 import Finch from '@tryfinch/finch-api';
 
 const client = new Finch({
-  fetch: async (url: RequestInfo, init?: RequestInit): Promise<Response> => {
-    console.log('About to make a request', url, init);
-    const response = await fetch(url, init);
-    console.log('Got response', response);
-    return response;
+  fetchOptions: {
+    // `RequestInit` options
   },
 });
 ```
 
-Note that if given a `DEBUG=true` environment variable, this library will log all requests and responses automatically.
-This is intended for debugging purposes only and may change in the future without notice.
+#### Configuring proxies
 
-### Configuring an HTTP(S) Agent (e.g., for proxies)
+To modify proxy behavior, you can provide custom `fetchOptions` that add runtime-specific proxy
+options to requests:
 
-By default, this library uses a stable agent for all http/https requests to reuse TCP connections, eliminating many TCP & TLS handshakes and shaving around 100ms off most requests.
+<img src="https://raw.githubusercontent.com/stainless-api/sdk-assets/refs/heads/main/node.svg" align="top" width="18" height="21"> **Node** <sup>[[docs](https://github.com/nodejs/undici/blob/main/docs/docs/api/ProxyAgent.md#example---proxyagent-with-fetch)]</sup>
 
-If you would like to disable or customize this behavior, for example to use the API behind a proxy, you can pass an `httpAgent` which is used for all requests (be they http or https), for example:
+```ts
+import Finch from '@tryfinch/finch-api';
+import * as undici from 'undici';
+
+const proxyAgent = new undici.ProxyAgent('http://localhost:8888');
+const client = new Finch({
+  fetchOptions: {
+    dispatcher: proxyAgent,
+  },
+});
+```
+
+<img src="https://raw.githubusercontent.com/stainless-api/sdk-assets/refs/heads/main/bun.svg" align="top" width="18" height="21"> **Bun** <sup>[[docs](https://bun.sh/guides/http/proxy)]</sup>
 
-<!-- prettier-ignore -->
 ```ts
-import http from 'http';
-import { HttpsProxyAgent } from 'https-proxy-agent';
+import Finch from '@tryfinch/finch-api';
 
-// Configure the default for all requests:
 const client = new Finch({
-  httpAgent: new HttpsProxyAgent(process.env.PROXY_URL),
+  fetchOptions: {
+    proxy: 'http://localhost:8888',
+  },
 });
+```
 
-// Override per-request:
-await client.hris.directory.list({
-  httpAgent: new http.Agent({ keepAlive: false }),
+<img src="https://raw.githubusercontent.com/stainless-api/sdk-assets/refs/heads/main/deno.svg" align="top" width="18" height="21"> **Deno** <sup>[[docs](https://docs.deno.com/api/deno/~/Deno.createHttpClient)]</sup>
+
+```ts
+import Finch from 'npm:@tryfinch/finch-api';
+
+const httpClient = Deno.createHttpClient({ proxy: { url: 'http://localhost:8888' } });
+const client = new Finch({
+  fetchOptions: {
+    client: httpClient,
+  },
 });
 ```
 
+## Frequently Asked Questions
+
 ## Semantic versioning
 
 This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:
@@ -355,11 +416,11 @@ We are keen for your feedback; please open an [issue](https://www.github.com/Fin
 
 ## Requirements
 
-TypeScript >= 4.5 is supported.
+TypeScript >= 4.9 is supported.
 
 The following runtimes are supported:
 
-- Node.js 18 LTS or later ([non-EOL](https://endoflife.date/nodejs)) versions.
+- Node.js 20 LTS or later ([non-EOL](https://endoflife.date/nodejs)) versions.
 - Deno v1.28.0 or higher.
 - Bun 1.0 or later.
 - Cloudflare Workers.

package/api-promise.d.mts

@@ -0,0 +1,2 @@
+export * from "./core/api-promise.mjs";
+//# sourceMappingURL=api-promise.d.mts.map

package/api-promise.d.mts.map

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