![](\"https://res.cloudinary.com/dycvts6vp/image/upload/v1723671980/ampersand-logo-black.svg","directories":{},"sideEffects":false,"_nodeVersion":"16.20.2","dependencies":{},"_hasShrinkwrap":false,"devDependencies":{"bun":"^1.2.2","zod":"^3.23.4","eslint":"^9.19.0","express":"^4.21.2","globals":"^15.14.0","bun-types":"^1.2.2","@eslint/js":"^9.19.0","typescript":"^5.4.5","@stricli/core":"^1.1.1","@types/express":"^4.17.21","typescript-eslint":"^8.22.0","@modelcontextprotocol/sdk":"^1.5.0"},"peerDependencies":{"zod":"){kind=logo}
= 3","@modelcontextprotocol/sdk":"^1.5.0"},"peerDependenciesMeta":{"@modelcontextprotocol/sdk":{"optional":true}},"_npmOperationalInternal":{"tmp":"tmp/sdk-node-write_0.2.0_1744384149877_0.580760613911389","host":"s3://npm-registry-packages-npm-production"}},"0.2.1":{"name":"@amp-labs/sdk-node-write","version":"0.2.1","author":{"name":"Speakeasy"},"_id":"@amp-labs/sdk-node-write@0.2.1","maintainers":[{"name":"laurenzlong","email":"laurenzlong@gmail.com"},{"name":"ampersand-ops","email":"devops@withampersand.com"}],"homepage":"https://github.com/amp-labs/sdk-node-write#readme","bugs":{"url":"https://github.com/amp-labs/sdk-node-write/issues"},"bin":{"mcp":"bin/mcp-server.js"},"dist":{"shasum":"6ec58c4e405ec1e473ab3acd462ad34ed175c9b9","tarball":"https://registry.npmjs.org/@amp-labs/sdk-node-write/-/sdk-node-write-0.2.1.tgz","fileCount":295,"integrity":"sha512-JpE/BndtkBoUGBVh/BOeJ8Ta3d79AhHHncawXIZXUs0HnSQAEQZITQmKkVLv0d6Y5ntV8uBt9w8f8v9OS++3HQ==","signatures":[{"sig":"MEUCIQCWvbEHhiJ5USwLsqDccdqe2HsdzUEqEwH0KLh52Ks4MQIgYV1Uvucc3n0KjoR1OegXQ/ktrLcusiINv7aJLzekGoI=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":4012915},"main":"./index.js","types":"./index.d.ts","gitHead":"0a3712ec5717c6ccbd84a83bc5af67169c767a32","scripts":{"lint":"eslint --cache --max-warnings=0 src","build":"npm run build:mcp && tsc","build:mcp":"bun src/mcp-server/build.mts","prepublishOnly":"npm run build"},"_npmUser":{"name":"ampersand-ops","email":"devops@withampersand.com"},"repository":{"url":"git+https://github.com/amp-labs/sdk-node-write.git","type":"git"},"_npmVersion":"8.19.4","description":"= 3","@modelcontextprotocol/sdk":"^1.5.0"},"peerDependenciesMeta":{"@modelcontextprotocol/sdk":{"optional":true}},"_npmOperationalInternal":{"tmp":"tmp/sdk-node-write_0.2.1_1744838318348_0.4761781608170954","host":"s3://npm-registry-packages-npm-production"}},"0.2.3":{"name":"@amp-labs/sdk-node-write","version":"0.2.3","author":{"name":"Speakeasy"},"_id":"@amp-labs/sdk-node-write@0.2.3","maintainers":[{"name":"laurenzlong","email":"laurenzlong@gmail.com"},{"name":"ampersand-ops","email":"devops@withampersand.com"}],"homepage":"https://github.com/amp-labs/sdk-node-write#readme","bugs":{"url":"https://github.com/amp-labs/sdk-node-write/issues"},"bin":{"mcp":"bin/mcp-server.js"},"dist":{"shasum":"9ca46d5fd43db60cea32c9890a2264eabdb81504","tarball":"https://registry.npmjs.org/@amp-labs/sdk-node-write/-/sdk-node-write-0.2.3.tgz","fileCount":295,"integrity":"sha512-47vycGtWS1W5PpJUhdvkUPua9/+rApiL85HJ+zzAJauDiKqH4wqbDwwPJrerGzCn4aDqYQVdggQwkoOzNOnVMA==","signatures":[{"sig":"MEYCIQDAQ2lKQJz5acZv9s6YmuDYgfJEuHpMAbtcLHkeGmQqngIhANotJd02ho8fDE7haC4nC3K0kOgIXhFZkCeRtNB2hUNX","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":4012915},"main":"./index.js","types":"./index.d.ts","gitHead":"7a7f79da2a3e8f6adc4d11e080ba59d50d936c8d","scripts":{"lint":"eslint --cache --max-warnings=0 src","build":"npm run build:mcp && tsc","build:mcp":"bun src/mcp-server/build.mts","prepublishOnly":"npm run build"},"_npmUser":{"name":"ampersand-ops","email":"devops@withampersand.com"},"repository":{"url":"git+https://github.com/amp-labs/sdk-node-write.git","type":"git"},"_npmVersion":"8.19.4","description":"= 3","@modelcontextprotocol/sdk":"^1.5.0"},"peerDependenciesMeta":{"@modelcontextprotocol/sdk":{"optional":true}},"_npmOperationalInternal":{"tmp":"tmp/sdk-node-write_0.2.3_1744838583776_0.369037272403703","host":"s3://npm-registry-packages-npm-production"}},"0.2.4":{"name":"@amp-labs/sdk-node-write","version":"0.2.4","author":{"name":"Speakeasy"},"bin":{"mcp":"bin/mcp-server.js"},"main":"./index.js","sideEffects":false,"repository":{"type":"git","url":"git+https://github.com/amp-labs/sdk-node-write.git"},"scripts":{"lint":"eslint --cache --max-warnings=0 src","build:mcp":"bun src/mcp-server/build.mts","build":"npm run build:mcp && tsc","prepublishOnly":"npm run build"},"peerDependencies":{"@modelcontextprotocol/sdk":">=1.5.0 <1.10.0","zod":">= 3"},"peerDependenciesMeta":{"@modelcontextprotocol/sdk":{"optional":true}},"devDependencies":{"@eslint/js":"^9.19.0","@modelcontextprotocol/sdk":">=1.5.0 <1.10.0","@stricli/core":"^1.1.1","@types/express":"^4.17.21","bun":"^1.2.2","bun-types":"^1.2.2","eslint":"^9.19.0","express":"^4.21.2","globals":"^15.14.0","typescript":"^5.4.5","typescript-eslint":"^8.22.0","zod":"^3.23.4"},"dependencies":{},"types":"./index.d.ts","gitHead":"b0166a76a2a1c2cc09567271199c95a9ef475f3f","description":"![](\"https://res.cloudinary.com/dycvts6vp/image/upload/v1723671980/ampersand-logo-black.svg","bugs":{"url":"https://github.com/amp-labs/sdk-node-write/issues"},"homepage":"https://github.com/amp-labs/sdk-node-write#readme","_id":"@amp-labs/sdk-node-write@0.2.4","_nodeVersion":"16.20.2","_npmVersion":"8.19.4","dist":{"integrity":"sha512-JU2nnhGs0tcLIxJ+Jv9qrgo+aGtWq8Pzlt9A4W+0FhXxfjpjAOYnVEMjw94JG71RI1n1tRe3/YQSalVxJko2WA==","shasum":"8210492b95ab4b83b45c2dc81e252ad2490f775d","tarball":"https://registry.npmjs.org/@amp-labs/sdk-node-write/-/sdk-node-write-0.2.4.tgz","fileCount":295,"unpackedSize":4012382,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQDIsUiEhTm6zUbWqXvwImp+OZFegx/hYQgzdmx5cSBx9gIhAPz8Wt4tQy5dMsA65NFadT9/WO9LdpWvHJX//4QrO+0d"}]},"_npmUser":{"name":"ampersand-ops","email":"devops@withampersand.com"},"directories":{},"maintainers":[{"name":"laurenzlong","email":"laurenzlong@gmail.com"},{"name":"ampersand-ops","email":"devops@withampersand.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/sdk-node-write_0.2.4_1746120800994_0.9690659973482727"},"_hasShrinkwrap":false}},"time":{"created":"2025-04-11T14:47:18.472Z","modified":"2025-05-01T17:33:21.547Z","0.1.3":"2025-04-11T14:47:18.711Z","0.2.0":"2025-04-11T15:09:10.127Z","0.2.1":"2025-04-16T21:18:38.646Z","0.2.3":"2025-04-16T21:23:04.050Z","0.2.4":"2025-05-01T17:33:21.302Z"},"bugs":{"url":"https://github.com/amp-labs/sdk-node-write/issues"},"author":{"name":"Speakeasy"},"homepage":"https://github.com/amp-labs/sdk-node-write#readme","repository":{"type":"git","url":"git+https://github.com/amp-labs/sdk-node-write.git"},"description":"<br/){kind=logo}
![](\"https://res.cloudinary.com/dycvts6vp/image/upload/v1723671980/ampersand-logo-black.svg","maintainers":[{"name":"laurenzlong","email":"laurenzlong@gmail.com"},{"name":"ampersand-ops","email":"devops@withampersand.com"}],"readme":"#){kind=logo}
\n\n \n ![\"Ampersand](\"https://res.cloudinary.com/dycvts6vp/image/upload/v1723671980/ampersand-logo-black.svg\")
\n \n
\n
\n\n
\n\n# Overview\n\n[Ampersand](https://withampersand.com?trk=readme-github) is a declarative platform for SaaS builders who are creating product integrations. It allows you to:\n\n* Read data from your customer’s SaaS\n* Write data to your customer’s SaaS\n* Subscribe to events (creates, deletes, and field changes) in your customer’s SaaS\n\n\n## Summary\n\n\n\n\n\n## Table of Contents\n\n* [Ampersand write SDK](#ampersand-write-sdk)\n* [Overview](#overview)\n * [SDK Installation](#sdk-installation)\n * [Requirements](#requirements)\n * [SDK Example Usage](#sdk-example-usage)\n * [Authentication](#authentication)\n * [Available Resources and Operations](#available-resources-and-operations)\n * [Standalone functions](#standalone-functions)\n * [Retries](#retries)\n * [Error Handling](#error-handling)\n * [Server Selection](#server-selection)\n * [Custom HTTP Client](#custom-http-client)\n * [Debugging](#debugging)\n* [Development](#development)\n * [Maturity](#maturity)\n * [Contributions](#contributions)\n\n\n\n\n## SDK Installation\n\nThe SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [bun](https://bun.sh/) or [yarn](https://classic.yarnpkg.com/en/) package managers.\n\n### NPM\n\n```bash\nnpm add @amp-labs/sdk-node-write\n```\n\n### PNPM\n\n```bash\npnpm add @amp-labs/sdk-node-write\n```\n\n### Bun\n\n```bash\nbun add @amp-labs/sdk-node-write\n```\n\n### Yarn\n\n```bash\nyarn add @amp-labs/sdk-node-write zod\n\n# Note that Yarn does not install peer dependencies automatically. You will need\n# to install zod as shown above.\n```\n\n\n\n### Model Context Protocol (MCP) Server\n\nThis SDK is also an installable MCP server where the various SDK methods are\nexposed as tools that can be invoked by AI applications.\n\n> Node.js v20 or greater is required to run the MCP server from npm.\n\n\n \n\n
\n\n
\n\n[](https://github.com/amp-labs/sdk-node-write) [](https://discord.gg/BWP4BpKHvf) [](https://docs.withampersand.com)  ![\"License\"](\"https://img.shields.io/static/v1?label=license&message=MIT&color=white\")
\n
\n\n\n\n
\n\nClaude installation steps
\n\nAdd the following server definition to your `claude_desktop_config.json` file:\n\n```json\n{\n \"mcpServers\": {\n \"Ampersand\": {\n \"command\": \"npx\",\n \"args\": [\n \"-y\", \"--package\", \"@amp-labs/sdk-node-write\",\n \"--\",\n \"mcp\", \"start\",\n \"--api-key-header\", \"...\"\n ]\n }\n }\n}\n```\n\n\n
\n\nYou can also run MCP servers as a standalone binary with no additional dependencies. You must pull these binaries from available Github releases:\n\n```bash\ncurl -L -o mcp-server \\\n https://github.com/{org}/{repo}/releases/download/{tag}/mcp-server-bun-darwin-arm64 && \\\nchmod +x mcp-server\n```\n\nIf the repo is a private repo you must add your Github PAT to download a release `-H \"Authorization: Bearer {GITHUB_PAT}\"`.\n\n\n```json\n{\n \"mcpServers\": {\n \"Todos\": {\n \"command\": \"./DOWNLOAD/PATH/mcp-server\",\n \"args\": [\n \"start\"\n ]\n }\n }\n}\n```\n\nFor a full list of server arguments, run:\n\n```sh\nnpx -y --package @amp-labs/sdk-node-write -- mcp start --help\n```\n\n\n\n## Requirements\n\nFor supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).\n\n\n\n## SDK Example Usage\n\n### Example\n\n```typescript\nimport { Ampersand } from \"@amp-labs/sdk-node-write\";\n\nconst ampersand = new Ampersand({\n apiKeyHeader: process.env[\"SDKNODEWRITE_API_KEY_HEADER\"] ?? \"\",\n});\n\nasync function run() {\n const result = await ampersand.write.records({\n projectIdOrName: \"Cursor installation steps
\n\nCreate a `.cursor/mcp.json` file in your project root with the following content:\n\n```json\n{\n \"mcpServers\": {\n \"Ampersand\": {\n \"command\": \"npx\",\n \"args\": [\n \"-y\", \"--package\", \"@amp-labs/sdk-node-write\",\n \"--\",\n \"mcp\", \"start\",\n \"--api-key-header\", \"...\"\n ]\n }\n }\n}\n```\n\n\n
\n\n\n\n## Standalone functions\n\nAll the methods listed above are available as standalone functions. These\nfunctions are ideal for use in applications running in the browser, serverless\nruntimes or other environments where application bundle size is a primary\nconcern. When using a bundler to build your application, all unused\nfunctionality will be either excluded from the final bundle or tree-shaken away.\n\nTo read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).\n\nAvailable methods
\n\n\n### [write](docs/sdks/write/README.md)\n\n* [records](docs/sdks/write/README.md#records) - Write records\n\n\n\n
\n\n\n\n## Retries\n\nSome of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.\n\nTo change the default retry strategy for a single API call, simply provide a retryConfig object to the call:\n```typescript\nimport { Ampersand } from \"@amp-labs/sdk-node-write\";\n\nconst ampersand = new Ampersand({\n apiKeyHeader: process.env[\"SDKNODEWRITE_API_KEY_HEADER\"] ?? \"\",\n});\n\nasync function run() {\n const result = await ampersand.write.records({\n projectIdOrName: \"