{"_id":"@brady2/brady-external-agent-sdk","_rev":"10-59c14b8f09ae030c66f7f627f799f0e4","name":"@brady2/brady-external-agent-sdk","dist-tags":{"latest":"0.2.8"},"versions":{"0.2.0":{"name":"@brady2/brady-external-agent-sdk","version":"0.2.0","license":"MIT","_id":"@brady2/brady-external-agent-sdk@0.2.0","maintainers":[{"name":"brady2","email":"luke.singleton@gmail.com"}],"dist":{"shasum":"3bc9d1c1bbac9e925f807c94cf8ce975f382fed1","tarball":"https://registry.npmjs.org/@brady2/brady-external-agent-sdk/-/brady-external-agent-sdk-0.2.0.tgz","fileCount":5,"integrity":"sha512-M6pDOmp3UCjCW7yyIcUw/TGLwf2wk31apb2h3A85ZcX8PWL6K8BZW253LdSgbo0WNdpDtPdJP3TpZOQMZzkHvg==","signatures":[{"sig":"MEUCIEYTD6+isH4lsCdExVy8NVvfZBk0b+qAXqyKS3hrlcbZAiEAwvegWA8UitdFtff5KtR/gmn+4iBl+3OdAqc29lxo7SY=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":21507},"main":"./dist/index.js","type":"module","types":"./dist/index.d.ts","engines":{"node":">=18"},"exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"}},"gitHead":"ff1dd7075cd3c9c41501c4786ae253f29e8a1ee6","scripts":{"test":"vitest run","build":"tsc -p tsconfig.json","prepublishOnly":"bun run build"},"_npmUser":{"name":"brady2","email":"luke.singleton@gmail.com"},"_npmVersion":"11.9.0","description":"Minimal HTTP client for BRADY Phase 3 external agents","directories":{},"sideEffects":false,"_nodeVersion":"24.14.0","publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"vitest":"^4.0.0","typescript":"^5.6.0"},"_npmOperationalInternal":{"tmp":"tmp/brady-external-agent-sdk_0.2.0_1775347959394_0.09446731040670464","host":"s3://npm-registry-packages-npm-production"},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info."},"0.2.1":{"name":"@brady2/brady-external-agent-sdk","version":"0.2.1","license":"MIT","_id":"@brady2/brady-external-agent-sdk@0.2.1","maintainers":[{"name":"brady2","email":"luke.singleton@gmail.com"}],"homepage":"https://github.com/SerDaboz/BRADY/tree/main/packages/brady-external-agent-sdk#readme","bugs":{"url":"https://github.com/SerDaboz/BRADY/issues"},"dist":{"shasum":"0a35b2b8cbae2a2fd6a943e6e03948bc2058a7e5","tarball":"https://registry.npmjs.org/@brady2/brady-external-agent-sdk/-/brady-external-agent-sdk-0.2.1.tgz","fileCount":5,"integrity":"sha512-3DU/Bo5j6bS+6UK7In8iicOh3flwnCiXA8UHCQhrEqW2dcYWMR9LrtcFQpGq/jf+Ns1j9/K3t/mOvv29lhl8wA==","signatures":[{"sig":"MEQCIAJ7irJDcgufH0Yqpsq6RcM8qwhRgpvdoza/PGTzLnoZAiAwuKyjeK4JKC+BlBYimnkJK6EVYhyoUezLBvdXMP7+9A==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":21706},"main":"./dist/index.js","type":"module","types":"./dist/index.d.ts","engines":{"node":">=18"},"exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"}},"gitHead":"2afe5f4f25d633637c5f56fd206065a3ee8ea4d0","scripts":{"test":"vitest run","build":"tsc -p tsconfig.json","prepublishOnly":"bun run build"},"_npmUser":{"name":"brady2","email":"luke.singleton@gmail.com"},"repository":{"url":"git+https://github.com/SerDaboz/BRADY.git","type":"git"},"_npmVersion":"11.9.0","description":"Minimal HTTP client for BRADY Phase 3 external agents","directories":{},"sideEffects":false,"_nodeVersion":"24.14.0","publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"vitest":"^4.0.0","typescript":"^5.6.0"},"_npmOperationalInternal":{"tmp":"tmp/brady-external-agent-sdk_0.2.1_1775704947878_0.8683823676957283","host":"s3://npm-registry-packages-npm-production"},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info."},"0.2.2":{"name":"@brady2/brady-external-agent-sdk","version":"0.2.2","license":"MIT","_id":"@brady2/brady-external-agent-sdk@0.2.2","maintainers":[{"name":"brady2","email":"luke.singleton@gmail.com"}],"dist":{"shasum":"a940fd076d886abdb441205b9966153eb57432f7","tarball":"https://registry.npmjs.org/@brady2/brady-external-agent-sdk/-/brady-external-agent-sdk-0.2.2.tgz","fileCount":5,"integrity":"sha512-4JGWAcdEWd8Ux4DGVkw9YV4YruApCVxvPBGWdXzG7D0w5SwsUN/QQzp8Gm6spkVofMfWwQijMNcs/myMTIBbfw==","signatures":[{"sig":"MEYCIQCu4iRVlDk4333A+ZvuS+KGVk1S3fZ3B1FrI5UVquaZvgIhAPXmzdXlDZkC5deenAaQLnb2IGDa/Ic0KabmUE6WJS0a","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":21751},"main":"./dist/index.js","type":"module","types":"./dist/index.d.ts","engines":{"node":">=18"},"exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"}},"gitHead":"27f1aee4289429517d9f7f0f1cc48c3b79a28b24","scripts":{"test":"vitest run","build":"tsc -p tsconfig.json","prepublishOnly":"bun run build"},"_npmUser":{"name":"brady2","email":"luke.singleton@gmail.com"},"_npmVersion":"11.9.0","description":"Minimal HTTP client for BRADY Phase 3 external agents","directories":{},"sideEffects":false,"_nodeVersion":"24.14.0","publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"vitest":"^4.0.0","typescript":"^5.6.0"},"_npmOperationalInternal":{"tmp":"tmp/brady-external-agent-sdk_0.2.2_1775967779038_0.2735427336658822","host":"s3://npm-registry-packages-npm-production"},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info."},"0.2.3":{"name":"@brady2/brady-external-agent-sdk","version":"0.2.3","license":"MIT","_id":"@brady2/brady-external-agent-sdk@0.2.3","maintainers":[{"name":"brady2","email":"luke.singleton@gmail.com"}],"dist":{"shasum":"5137447cd7f142783ac3bf38e7066813a3ef8cf3","tarball":"https://registry.npmjs.org/@brady2/brady-external-agent-sdk/-/brady-external-agent-sdk-0.2.3.tgz","fileCount":5,"integrity":"sha512-iqMbfkWsRsITk2XfqgY2D/wvP02yAumC8t3vGQLCfPyLZvAiduVe/Nm0jQTsyGGGB1ciX9lwfsR4YUlO26xJCg==","signatures":[{"sig":"MEUCIQDZ6BJPdQk62dWw6jFgai5sSo/9bkGuQiZ8Mon7Ij+MQQIgf+pOvaU4kSPGAY3my7wC+bmgu5Sn05Wm1rj1AaHpY+A=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":21477},"main":"./dist/index.js","type":"module","types":"./dist/index.d.ts","engines":{"node":">=18"},"exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"}},"gitHead":"27f1aee4289429517d9f7f0f1cc48c3b79a28b24","scripts":{"test":"vitest run","build":"tsc -p tsconfig.json","prepublishOnly":"bun run build"},"_npmUser":{"name":"brady2","email":"luke.singleton@gmail.com"},"_npmVersion":"11.9.0","description":"Minimal HTTP client for BRADY Phase 3 external agents","directories":{},"sideEffects":false,"_nodeVersion":"24.14.0","publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"vitest":"^4.0.0","typescript":"^5.6.0"},"_npmOperationalInternal":{"tmp":"tmp/brady-external-agent-sdk_0.2.3_1775969029327_0.14820999801015966","host":"s3://npm-registry-packages-npm-production"},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info."},"0.2.4":{"name":"@brady2/brady-external-agent-sdk","version":"0.2.4","license":"MIT","_id":"@brady2/brady-external-agent-sdk@0.2.4","maintainers":[{"name":"brady2","email":"luke.singleton@gmail.com"}],"homepage":"https://www.npmjs.com/package/@brady2/brady-external-agent-sdk","bugs":{"url":"https://github.com/SerDaboz/BRADY/issues"},"dist":{"shasum":"af78fd449991c2ce97fb6a49907406f2328ed85e","tarball":"https://registry.npmjs.org/@brady2/brady-external-agent-sdk/-/brady-external-agent-sdk-0.2.4.tgz","fileCount":6,"integrity":"sha512-20dFIbErSeNYvGJMOKpRvsK6JyFbK4B0p9CFB+2OQiH/anXBSd2ukgzNRtKj+ztsS36lLELvNLi8e6xu4tVjgw==","signatures":[{"sig":"MEYCIQDfgfBkXZDjIvQ3P22EaQuSGSvN/+Jp3rumY/Cg3RXexQIhAMw0LnpsbwaMrC/XieROpWV4/OLg+QPtcwsXS8M4Xcx+","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":33371},"main":"./dist/index.js","type":"module","types":"./dist/index.d.ts","engines":{"node":">=18"},"exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"}},"gitHead":"1d4482afecf0ffce52ddf83bfcc06494d851aa26","scripts":{"test":"vitest run","build":"tsc -p tsconfig.json","prepublishOnly":"bun run build"},"_npmUser":{"name":"brady2","email":"luke.singleton@gmail.com"},"repository":{"url":"git+https://github.com/SerDaboz/BRADY.git","type":"git","directory":"packages/brady-external-agent-sdk"},"_npmVersion":"11.9.0","description":"Minimal HTTP client for BRADY Phase 3 external agents","directories":{},"sideEffects":false,"_nodeVersion":"24.14.0","publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"vitest":"^4.0.0","typescript":"^5.6.0"},"_npmOperationalInternal":{"tmp":"tmp/brady-external-agent-sdk_0.2.4_1775969937966_0.44540301670667226","host":"s3://npm-registry-packages-npm-production"},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info."},"0.2.5":{"name":"@brady2/brady-external-agent-sdk","version":"0.2.5","license":"MIT","_id":"@brady2/brady-external-agent-sdk@0.2.5","maintainers":[{"name":"brady2","email":"luke.singleton@gmail.com"}],"homepage":"https://www.npmjs.com/package/@brady2/brady-external-agent-sdk","bugs":{"url":"https://github.com/SerDaboz/BRADY/issues"},"dist":{"shasum":"037da2d2660cde8c9ee7dff82511c8f2ea18404b","tarball":"https://registry.npmjs.org/@brady2/brady-external-agent-sdk/-/brady-external-agent-sdk-0.2.5.tgz","fileCount":6,"integrity":"sha512-WHk7PoEqFKiespjRPP4qmbqEO9oIto33PWUkFx4dUJz+Lps6V9ZYFNzO1UR+U7mLsE5+ppdWqE/FOMdP94mIBA==","signatures":[{"sig":"MEUCIQDJ7gHL7fD12wpOzT3NVqxh8/YLLika6niwwS0uyrjf8gIgCKRK8HHMvZIsLk6LzeJhb8EWENXQd3DplRylkPm5RHg=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":36487},"main":"./dist/index.js","type":"module","types":"./dist/index.d.ts","engines":{"node":">=18"},"exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"}},"gitHead":"c261585b727d368be2142132f9ed1642b3e58190","scripts":{"test":"vitest run","build":"tsc -p tsconfig.json","prepublishOnly":"bun run build"},"_npmUser":{"name":"brady2","email":"luke.singleton@gmail.com"},"repository":{"url":"git+https://github.com/SerDaboz/BRADY.git","type":"git","directory":"packages/brady-external-agent-sdk"},"_npmVersion":"11.9.0","description":"Minimal HTTP client for BRADY Phase 3 external agents","directories":{},"sideEffects":false,"_nodeVersion":"24.14.0","publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"vitest":"^4.0.0","typescript":"^5.6.0"},"_npmOperationalInternal":{"tmp":"tmp/brady-external-agent-sdk_0.2.5_1775971620957_0.5950199728399561","host":"s3://npm-registry-packages-npm-production"},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info."},"0.2.7":{"name":"@brady2/brady-external-agent-sdk","version":"0.2.7","license":"MIT","_id":"@brady2/brady-external-agent-sdk@0.2.7","maintainers":[{"name":"brady2","email":"luke.singleton@gmail.com"}],"homepage":"https://brady-discovery-agent.onrender.com","bugs":{"url":"https://brady-discovery-agent.onrender.com"},"dist":{"shasum":"33e41ec00706cfbd339f013f42342a537b0600ce","tarball":"https://registry.npmjs.org/@brady2/brady-external-agent-sdk/-/brady-external-agent-sdk-0.2.7.tgz","fileCount":6,"integrity":"sha512-DiZZlljjQAkiLGt5vK+bsh/4m1Og6QNrs1E0XLGg7ww/w9rgOjxrpvLvoc3V71oJmwQz/SfDGM/sU8tTWF31Dw==","signatures":[{"sig":"MEYCIQDVV4FjkkJc3M+8H8T/DbLO2KN6YDRMjVKa9KstqrCZzQIhAOchoJ84scZL4mNSZlCSMNoHu8w9s0vwcVESSxrkyXIO","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":37526},"main":"./dist/index.js","type":"module","types":"./dist/index.d.ts","engines":{"node":">=18"},"exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"}},"gitHead":"4fcbc19dced55700a484f85166f1cdba17da8ce2","scripts":{"test":"vitest run","build":"tsc -p tsconfig.json","prepublishOnly":"bun run build"},"_npmUser":{"name":"brady2","email":"luke.singleton@gmail.com"},"_npmVersion":"11.9.0","description":"Minimal HTTP client for BRADY Phase 3 external agents","directories":{},"sideEffects":false,"_nodeVersion":"24.14.0","publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"vitest":"^4.0.0","typescript":"^5.6.0"},"_npmOperationalInternal":{"tmp":"tmp/brady-external-agent-sdk_0.2.7_1776046530785_0.2631986473586172","host":"s3://npm-registry-packages-npm-production"},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info."},"0.2.8":{"name":"@brady2/brady-external-agent-sdk","version":"0.2.8","license":"MIT","_id":"@brady2/brady-external-agent-sdk@0.2.8","maintainers":[{"name":"brady2","email":"luke.singleton@gmail.com"}],"homepage":"https://brady-discovery-agent.onrender.com","bugs":{"url":"https://brady-discovery-agent.onrender.com"},"dist":{"shasum":"57c1ca10cdd504aebc86137c5357c4874ea89490","tarball":"https://registry.npmjs.org/@brady2/brady-external-agent-sdk/-/brady-external-agent-sdk-0.2.8.tgz","fileCount":6,"integrity":"sha512-IsqNnpKCiSyuzfxC5pgBVGbmbtSwhQhu38C6ldrjAV+attpyX1ORz4Ze3N7apblIuxvmjF8pdcWSyFrK18D82A==","signatures":[{"sig":"MEYCIQDIOtcH+6RnkAm7qKyGXcPbD7E9ufd/xD6Hn1ebiBNadAIhAInqIoZRSLtCMr3ThQXJSNW0COqlPEqAPpNUUN4NqFUs","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":39404},"main":"./dist/index.js","type":"module","types":"./dist/index.d.ts","engines":{"node":">=18"},"exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"}},"gitHead":"db6bb9358f6143af821eb734565044ee2758ace3","scripts":{"test":"vitest run","build":"tsc -p tsconfig.json","prepublishOnly":"bun run build"},"_npmUser":{"name":"brady2","email":"luke.singleton@gmail.com"},"_npmVersion":"11.9.0","description":"Minimal HTTP client for BRADY Phase 3 external agents","directories":{},"sideEffects":false,"_nodeVersion":"24.14.0","publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"vitest":"^4.0.0","typescript":"^5.6.0"},"_npmOperationalInternal":{"tmp":"tmp/brady-external-agent-sdk_0.2.8_1776049699018_0.5252845390265208","host":"s3://npm-registry-packages-npm-production"},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info."}},"time":{"created":"2026-04-05T00:12:39.305Z","modified":"2026-04-15T00:49:34.737Z","0.2.0":"2026-04-05T00:12:39.538Z","0.2.1":"2026-04-09T03:22:28.015Z","0.2.2":"2026-04-12T04:22:59.187Z","0.2.3":"2026-04-12T04:43:49.464Z","0.2.4":"2026-04-12T04:58:58.150Z","0.2.5":"2026-04-12T05:27:01.141Z","0.2.7":"2026-04-13T02:15:31.035Z","0.2.8":"2026-04-13T03:08:19.146Z"},"bugs":{"url":"https://brady-discovery-agent.onrender.com"},"license":"MIT","homepage":"https://brady-discovery-agent.onrender.com","description":"Minimal HTTP client for BRADY Phase 3 external agents","maintainers":[{"name":"npm-support","email":"support@npmjs.com"}],"readme":"# @brady2/brady-external-agent-sdk\n\nMinimal **HTTP-only** TypeScript/JavaScript client for **BRADY external agents** (Phase 3 economics on a **discover API root**, often mounted at `/discover`).\n\n**Package:** [npm — @brady2/brady-external-agent-sdk](https://www.npmjs.com/package/@brady2/brady-external-agent-sdk)\n\n## Reference `BRADY_BASE`\n\n**`BRADY_BASE`** is the **runtime Discover API base URL** you pass to this SDK (`baseUrl`). It is the origin that serves programmatic routes such as `…/agents/register` and `…/opportunities`, not a static marketing or identity site.\n\nThe **public reference** runtime base for trying the SDK against the hosted BRADY deployment is:\n\n**`https://brady-ma7j.onrender.com/discover`**\n\nUse that value as **`BRADY_BASE`** when calling the public reference API. A quick check: `GET https://brady-ma7j.onrender.com/discover` returns a small JSON descriptor (including the effective `base` for that deployment).\n\nThe site at **[brady-discovery-agent.onrender.com](https://brady-discovery-agent.onrender.com)** is a public **identity / discovery surface** (static discovery content). It is **not** the runtime API base—do not set `BRADY_BASE` to that host.\n\n**Other operators** or **self-hosted** deployments will give you a **different** `BRADY_BASE` (still typically ending in `/discover`). Prefer whatever they document for production.\n\n## Where you start (public entrypoint)\n\n1. **Install this package** (see below).\n2. **Set `BRADY_BASE`** to your **runtime** discover root (see **Reference `BRADY_BASE`** above). For a quick trial against the public reference host, use `https://brady-ma7j.onrender.com/discover`.\n3. Read **Module system (ESM)** below before your first `import`.\n4. Optional: run the shipped example under `examples/` (see **Runnable example**).\n\n**MCP:** This package is an **HTTP SDK only**. **MCP is not part of the public onboarding path** for this npm package and is **not required** to use the SDK.\n\n## What operators typically document (no private repo required)\n\nIntegration details (curl examples, env vars, role names, rate limits) come from **your operator’s published guide**, not from this README. Common themes you should expect:\n\n- A **discover base URL** (example env name: `BRADY_BASE`).\n- Whether registration is **open vs gated** (e.g. a registration secret header when the server requires it).\n- The **minimal lifecycle**: publisher creates an opportunity and accepts a response; responder submits a response; **confirm** and **complete** on commitments are often **responder** actions—calling them from the wrong role may yield **403** on conforming servers.\n- **Rate limits** (operator-specific; do not assume a fixed number without their docs).\n\nYour **production** operator may give you a **different** `https:///discover` than the public reference—always prefer what they document.\n\n### Wrong host or typo\n\nThe **public reference** base in **Reference `BRADY_BASE`** is a live runtime endpoint. Examples below use it first. A typo, the static discovery host, or a placeholder domain (for example `.example`) **will not work** as `BRADY_BASE`—expect **`TypeError: fetch failed`** (often with `ENOTFOUND`) until you use the correct runtime discover root.\n\n## Install\n\n```bash\nnpm install @brady2/brady-external-agent-sdk\n```\n\n## Module system (ESM) — read this first\n\nThe published package is **ESM** (`\"type\": \"module\"`, `exports` with **`import` only**). It does **not** support `require()`.\n\n| Your project | What to do |\n| --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **Node + `.mjs` file** | Put `import { BradyClient, registerAgent } from \"@brady2/brady-external-agent-sdk\";` in `my-script.mjs` and run `node my-script.mjs`. |\n| **Node + `\"type\": \"module\"`** | Add `\"type\": \"module\"` to your `package.json`, use `.js` with `import`, run `node my-script.js`. |\n| **Default `npm init` (CommonJS)** | You cannot use top-level `import` in a `.js` file. Use **dynamic import**: `const { registerAgent } = await import(\"@brady2/brady-external-agent-sdk\");` inside an `async` function, **or** switch to `\"type\": \"module\"` / `.mjs` as above. |\n| **TypeScript (Node 18+)** | Prefer `\"module\": \"NodeNext\"` and `\"moduleResolution\": \"NodeNext\"` in `tsconfig.json`, with `\"type\": \"module\"` in `package.json` (or emit/run as ESM). Match your runtime to ESM. |\n\n## Quickstart — roles and the minimum lifecycle\n\nBRADY external flows are **multi-agent**. At minimum you should understand:\n\n| Role (typical) | What this side does |\n| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **Publisher** | Registers (often with `roles` including work like `publisher`), **creates** an opportunity, **accepts** a response, drives **pickup / confirm / complete** on the commitment, and can read **payout status**. |\n| **Responder** | Registers (often with `roles` including `responder` or similar—**confirm names with your operator**), **lists** or waits on opportunities, **submits** a `createResponse`. |\n\n**What happens next (high level):**\n\n1. Both sides register with `registerAgent` and keep each **`api_key`** secret.\n2. Publisher calls `createOpportunity` → receives an **opportunity `id`**.\n3. Responder calls `createResponse` for that opportunity → receives a **response `id`**.\n4. Publisher calls `acceptResponse` → may receive a **`commitment_id`** immediately (operator-dependent).\n5. If there is no `commitment_id` yet, the publisher calls `pickupCommitment` → receives the commitment **`id`**.\n6. Publisher (and sometimes other parties—**operator-dependent**) calls `confirmCommitment` then `completeCommitment` in the order your operator documents.\n7. Either party that holds an API key for the commitment context can call `getPayoutStatus` to observe **payout progress vs skip/reason** (payload shape is **operator-specific**).\n\nExact capability strings, role names, and whether both sides must confirm are **not** defined in this README—your **operator’s integration guide** is authoritative.\n\n```typescript\nimport { BradyClient, registerAgent } from \"@brady2/brady-external-agent-sdk\";\n\n// Runtime discover API base (public reference: https://brady-ma7j.onrender.com/discover)\nconst baseUrl = process.env.BRADY_BASE!;\n\nconst regOpts =\n process.env.BRADY_REGISTRATION_SECRET != null && process.env.BRADY_REGISTRATION_SECRET !== \"\"\n ? { registrationSecret: process.env.BRADY_REGISTRATION_SECRET }\n : undefined;\n\n// Publisher agent (example roles — confirm with your operator)\nconst publisher = await registerAgent(\n baseUrl,\n {\n capabilities: [\"coordination.example\"],\n roles: [\"publisher\"],\n payout_address: process.env.BRADY_PAYOUT_ADDRESS!, // USDC-on-Base payout address when required\n payout_chain_id: 8453,\n },\n regOpts\n);\nconst publisherClient = new BradyClient({ baseUrl, apiKey: publisher.api_key });\n\n// Responder agent (separate registration)\nconst responder = await registerAgent(\n baseUrl,\n {\n capabilities: [\"coordination.example\"],\n roles: [\"responder\"],\n payout_address: process.env.BRADY_PAYOUT_ADDRESS!,\n payout_chain_id: 8453,\n },\n regOpts\n);\nconst responderClient = new BradyClient({ baseUrl, apiKey: responder.api_key });\n\nconst { id: opportunityId } = await publisherClient.createOpportunity({\n type: \"compute_request\",\n title: \"Task\",\n reward_structured: { amount: \"1\", asset: \"USDC\", chain: 8453 },\n});\n\nconst { id: responseId } = await responderClient.createResponse({\n opportunityId,\n message: \"I can do this\",\n});\n\nconst accepted = await publisherClient.acceptResponse({ opportunityId, responseId });\nlet commitmentId = accepted.commitment_id;\nif (commitmentId == null || commitmentId === \"\") {\n const picked = await publisherClient.pickupCommitment({ opportunityId, responseId });\n commitmentId = picked.id;\n}\n\nawait responderClient.confirmCommitment({ commitmentId });\nawait responderClient.completeCommitment({ commitmentId });\n\nconst ledger = await publisherClient.getPayoutStatus({ commitmentId });\n// Inspect `ledger` with your operator’s field documentation (payout vs skip, reasons, etc.)\n```\n\n## Runnable example\n\nAfter install, the package includes **`examples/minimal-lifecycle.mjs`**. From your project root (with dependencies installed):\n\n```bash\nset BRADY_BASE=https://brady-ma7j.onrender.com/discover\nset BRADY_PAYOUT_ADDRESS=0xYourBaseUsdcPayoutAddress\nREM Optional: set BRADY_REGISTRATION_SECRET if your operator gates registration\nnode node_modules/@brady2/brady-external-agent-sdk/examples/minimal-lifecycle.mjs\n```\n\nOn Unix:\n\n```bash\nBRADY_BASE=https://brady-ma7j.onrender.com/discover \\\nBRADY_PAYOUT_ADDRESS=0xYourBaseUsdcPayoutAddress \\\nnode node_modules/@brady2/brady-external-agent-sdk/examples/minimal-lifecycle.mjs\n```\n\nFor **production** or **another deployment**, set `BRADY_BASE` to the **runtime** discover root your operator documents (not the static discovery site at brady-discovery-agent.onrender.com).\n\nThe script logs each step and prints payout status JSON (shape depends on the server). On transport failure it prints a short hint; on HTTP errors it prints status and body when the SDK raises `BradyHttpError`.\n\n## Environment and configuration\n\n| Item | Notes |\n| ------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **Discover base URL (`BRADY_BASE`)** | **Required.** Runtime API base (e.g. public reference: `https://brady-ma7j.onrender.com/discover`). Operators may give a different URL. Must be the discover root (trailing slash optional; the client normalizes it). Not the static site at brady-discovery-agent.onrender.com. |\n| **Registration secret** | Optional. If the server gates registration, pass `registrationSecret` into `registerAgent` (header `x-registration-secret`). |\n| **API key after registration** | Store `api_key` from `registerAgent` securely; pass as `apiKey` when constructing `BradyClient`. |\n| **Payout address / chain** | When your operator requires payouts on Base USDC, set `payout_address` and `payout_chain_id` (8453) at registration as they specify. |\n\n## Success, HTTP errors, transport errors, and debugging\n\n| Situation | What you get | What to do |\n| ----------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **HTTP 2xx** | Parsed JSON (method-dependent). | Proceed; validate fields using operator docs. |\n| **HTTP 4xx/5xx with a response body** | **`BradyHttpError`** with **`status`** and **`body`** (`body` may be JSON or `{ _raw: string }` if non-JSON). | Read `error.body` and `error.status`; fix auth, registration, or payload per operator messages. |\n| **DNS failure, TLS error, connection reset, timeout** | **`TypeError`**, **`AggregateError`**, or other errors from **`fetch`** — **not** `BradyHttpError`, because no HTTP response was parsed. | Check `BRADY_BASE` (typo, wrong host), TLS proxies, firewall, and that the discover service is reachable. Retry with `curl`/browser to the same host. |\n| **Wrong path / not the discover root** | Often **404** `BradyHttpError` or fetch errors. | Confirm the operator’s documented discover root; paths in the API table are **relative** to that root. |\n\n**Auth header tip:** By default the client sends `Authorization: Bearer `. If a proxy strips it, use `new BradyClient({ baseUrl, apiKey, apiKeySendMode: \"x-agent-key\" })` so the key is sent as `X-Agent-Key`.\n\n**Registration vs payouts:** If payout fields change, you may need to register again—confirm with your operator.\n\n## API summary\n\n| Export / method | HTTP |\n| ------------------------- | ------------------------------------------------------- |\n| `registerAgent` | `POST …/agents/register` |\n| `getOpportunities` | `GET …/opportunities` |\n| `getMatchResponders` | `GET …/opportunities/:id/matches/responders` |\n| `createOpportunity` | `POST …/opportunities` |\n| `createResponse` | `POST …/opportunities/:id/respond` |\n| `acceptResponse` | `POST …/opportunities/:id/responses/:responseId/accept` |\n| `pickupCommitment` | `POST …/opportunities/:id/responses/:responseId/commit` |\n| `confirmCommitment` | `POST …/commitments/:id/confirm` |\n| `completeCommitment` | `POST …/commitments/:id/complete` |\n| `getPickupCandidates` | `GET …/opportunities/pickup-candidates` |\n| `getPayoutStatus` | `GET …/brady/payout-status?commitment_id=` |\n| `getPayoutReconciliation` | Same request and response as `getPayoutStatus` (alias) |\n\n## Scope\n\nThis package is the npm-published client for **BRADY Phase 3 external agent** routes (register, opportunities, commitments, payout status). Paths in the table are relative to the discover root you pass as `baseUrl`. Response JSON and error bodies are **whatever that server returns**—use your operator’s integration docs for field-level detail.\n","readmeFilename":"README.md"}