[{"data":1,"prerenderedAt":1703},["ShallowReactive",2],{"navigation_docs":3,"-libraries-agents":612,"-libraries-agents-surround":1698},[4,35,85,138,318,453,489,548,587],{"title":5,"path":6,"stem":7,"children":8,"page":34},"Start","\u002Fstart","1.start",[9,14,19,24,29],{"title":10,"path":11,"stem":12,"icon":13},"Introduction","\u002Fstart\u002Fintroduction","1.start\u002F1.introduction","i-lucide-info",{"title":15,"path":16,"stem":17,"icon":18},"Why start with evlog","\u002Fstart\u002Fwhy-evlog","1.start\u002F2.why-evlog","i-lucide-rocket",{"title":20,"path":21,"stem":22,"icon":23},"Installation","\u002Fstart\u002Finstallation","1.start\u002F3.installation","i-lucide-download",{"title":25,"path":26,"stem":27,"icon":28},"Quick Start","\u002Fstart\u002Fquick-start","1.start\u002F4.quick-start","i-lucide-zap",{"title":30,"path":31,"stem":32,"icon":33},"Choose your logger","\u002Fstart\u002Ftypescript-logging-library","1.start\u002F5.typescript-logging-library","i-lucide-file-code",false,{"title":36,"path":37,"stem":38,"children":39,"page":34},"Learn","\u002Flearn","2.learn",[40,45,50,55,60,65,70,75,80],{"title":41,"path":42,"stem":43,"icon":44},"Overview","\u002Flearn\u002Foverview","2.learn\u002F0.overview","i-lucide-list",{"title":46,"path":47,"stem":48,"icon":49},"Simple Logging","\u002Flearn\u002Fsimple-logging","2.learn\u002F1.simple-logging","i-lucide-terminal",{"title":51,"path":52,"stem":53,"icon":54},"Wide Events","\u002Flearn\u002Fwide-events","2.learn\u002F2.wide-events","i-lucide-layers",{"title":56,"path":57,"stem":58,"icon":59},"Structured Errors","\u002Flearn\u002Fstructured-errors","2.learn\u002F3.structured-errors","i-lucide-shield-alert",{"title":61,"path":62,"stem":63,"icon":64},"Lifecycle","\u002Flearn\u002Flifecycle","2.learn\u002F4.lifecycle","i-lucide-arrow-right-left",{"title":66,"path":67,"stem":68,"icon":69},"Sampling","\u002Flearn\u002Fsampling","2.learn\u002F5.sampling","i-lucide-filter",{"title":71,"path":72,"stem":73,"icon":74},"Auto-Redaction","\u002Flearn\u002Fredaction","2.learn\u002F6.redaction","i-lucide-eye-off",{"title":76,"path":77,"stem":78,"icon":79},"Typed Fields","\u002Flearn\u002Ftyped-fields","2.learn\u002F7.typed-fields","i-simple-icons-typescript",{"title":81,"path":82,"stem":83,"icon":84},"Catalogs","\u002Flearn\u002Fcatalogs","2.learn\u002F8.catalogs","i-lucide-book-open",{"title":86,"path":87,"stem":88,"children":89,"page":34},"CLI","\u002Fcli","3.cli",[90,93,98,103,108,113,118,123,128,133],{"title":41,"path":91,"stem":92,"icon":49},"\u002Fcli\u002Foverview","3.cli\u002F0.overview",{"title":94,"path":95,"stem":96,"icon":97},"init","\u002Fcli\u002Finit","3.cli\u002F1.init","i-lucide-wand-sparkles",{"title":99,"path":100,"stem":101,"icon":102},"map","\u002Fcli\u002Fmap","3.cli\u002F2.map","i-lucide-radar",{"title":104,"path":105,"stem":106,"icon":107},"Rules","\u002Fcli\u002Frules","3.cli\u002F3.rules","i-lucide-list-checks",{"title":109,"path":110,"stem":111,"icon":112},"Scoring","\u002Fcli\u002Fscoring","3.cli\u002F4.scoring","i-lucide-gauge",{"title":114,"path":115,"stem":116,"icon":117},"CI","\u002Fcli\u002Fci","3.cli\u002F5.ci","i-lucide-git-pull-request",{"title":119,"path":120,"stem":121,"icon":122},"doctor","\u002Fcli\u002Fdoctor","3.cli\u002F6.doctor","i-lucide-stethoscope",{"title":124,"path":125,"stem":126,"icon":127},"telemetry","\u002Fcli\u002Ftelemetry","3.cli\u002F7.telemetry","i-lucide-bar-chart-3",{"title":129,"path":130,"stem":131,"icon":132},"agents","\u002Fcli\u002Fagents","3.cli\u002F8.agents","i-lucide-bot",{"title":134,"path":135,"stem":136,"icon":137},"Observability Score","\u002Fcli\u002Fobservability-score","3.cli\u002F9.observability-score","i-lucide-activity",{"title":139,"path":140,"stem":141,"children":142,"page":34},"Integrate","\u002Fintegrate","4.integrate",[143,147,230],{"title":41,"path":144,"stem":145,"icon":146},"\u002Fintegrate\u002Foverview","4.integrate\u002F0.overview","i-lucide-plug",{"title":148,"path":149,"stem":150,"children":151,"page":34},"Adapters","\u002Fintegrate\u002Fadapters","4.integrate\u002Fadapters",[152,155,185,210],{"title":41,"path":153,"stem":154,"icon":44},"\u002Fintegrate\u002Fadapters\u002Foverview","4.integrate\u002Fadapters\u002F01.overview",{"title":156,"path":157,"stem":158,"children":159,"page":34},"Cloud","\u002Fintegrate\u002Fadapters\u002Fcloud","4.integrate\u002Fadapters\u002Fcloud",[160,165,170,175,180],{"title":161,"path":162,"stem":163,"icon":164},"Axiom","\u002Fintegrate\u002Fadapters\u002Fcloud\u002Faxiom","4.integrate\u002Fadapters\u002Fcloud\u002F01.axiom","i-custom-axiom",{"title":166,"path":167,"stem":168,"icon":169},"PostHog","\u002Fintegrate\u002Fadapters\u002Fcloud\u002Fposthog","4.integrate\u002Fadapters\u002Fcloud\u002F02.posthog","i-simple-icons-posthog",{"title":171,"path":172,"stem":173,"icon":174},"Sentry","\u002Fintegrate\u002Fadapters\u002Fcloud\u002Fsentry","4.integrate\u002Fadapters\u002Fcloud\u002F03.sentry","i-simple-icons-sentry",{"title":176,"path":177,"stem":178,"icon":179},"Better Stack","\u002Fintegrate\u002Fadapters\u002Fcloud\u002Fbetter-stack","4.integrate\u002Fadapters\u002Fcloud\u002F04.better-stack","i-simple-icons-betterstack",{"title":181,"path":182,"stem":183,"icon":184},"Datadog","\u002Fintegrate\u002Fadapters\u002Fcloud\u002Fdatadog","4.integrate\u002Fadapters\u002Fcloud\u002F05.datadog","i-simple-icons-datadog",{"title":186,"path":187,"stem":188,"children":189,"page":34},"Cloud or Self-Hosted","\u002Fintegrate\u002Fadapters\u002Fhybrid","4.integrate\u002Fadapters\u002Fhybrid",[190,195,200,205],{"title":191,"path":192,"stem":193,"icon":194},"Grafana Loki","\u002Fintegrate\u002Fadapters\u002Fhybrid\u002Floki","4.integrate\u002Fadapters\u002Fhybrid\u002F01.loki","i-simple-icons-grafana",{"title":196,"path":197,"stem":198,"icon":199},"ClickHouse","\u002Fintegrate\u002Fadapters\u002Fhybrid\u002Fclickhouse","4.integrate\u002Fadapters\u002Fhybrid\u002F02.clickhouse","i-simple-icons-clickhouse",{"title":201,"path":202,"stem":203,"icon":204},"OTLP","\u002Fintegrate\u002Fadapters\u002Fhybrid\u002Fotlp","4.integrate\u002Fadapters\u002Fhybrid\u002F03.otlp","i-simple-icons-opentelemetry",{"title":206,"path":207,"stem":208,"icon":209},"HyperDX","\u002Fintegrate\u002Fadapters\u002Fhybrid\u002Fhyperdx","4.integrate\u002Fadapters\u002Fhybrid\u002F04.hyperdx","i-custom-hyperdx",{"title":211,"path":212,"stem":213,"children":214,"page":34},"Self-Hosted","\u002Fintegrate\u002Fadapters\u002Fself-hosted","4.integrate\u002Fadapters\u002Fself-hosted",[215,220,225],{"title":216,"path":217,"stem":218,"icon":219},"File System","\u002Fintegrate\u002Fadapters\u002Fself-hosted\u002Ffs","4.integrate\u002Fadapters\u002Fself-hosted\u002F01.fs","i-lucide-hard-drive",{"title":221,"path":222,"stem":223,"icon":224},"NuxtHub","\u002Fintegrate\u002Fadapters\u002Fself-hosted\u002Fnuxthub","4.integrate\u002Fadapters\u002Fself-hosted\u002F02.nuxthub","i-simple-icons-nuxt",{"title":226,"path":227,"stem":228,"icon":229},"Memory","\u002Fintegrate\u002Fadapters\u002Fself-hosted\u002Fmemory","4.integrate\u002Fadapters\u002Fself-hosted\u002F03.memory","i-lucide-cpu",{"title":231,"path":232,"stem":233,"children":234,"page":34},"Frameworks","\u002Fintegrate\u002Fframeworks","4.integrate\u002Fframeworks",[235,239,244,249,254,259,264,269,274,279,284,289,294,299,303,308,313],{"title":41,"path":236,"stem":237,"icon":238},"\u002Fintegrate\u002Fframeworks\u002Foverview","4.integrate\u002Fframeworks\u002F00.overview","i-lucide-layout-grid",{"title":240,"path":241,"stem":242,"icon":243},"Nuxt","\u002Fintegrate\u002Fframeworks\u002Fnuxt","4.integrate\u002Fframeworks\u002F01.nuxt","i-simple-icons-nuxtdotjs",{"title":245,"path":246,"stem":247,"icon":248},"Next.js","\u002Fintegrate\u002Fframeworks\u002Fnextjs","4.integrate\u002Fframeworks\u002F02.nextjs","i-simple-icons-nextdotjs",{"title":250,"path":251,"stem":252,"icon":253},"SvelteKit","\u002Fintegrate\u002Fframeworks\u002Fsveltekit","4.integrate\u002Fframeworks\u002F03.sveltekit","i-simple-icons-svelte",{"title":255,"path":256,"stem":257,"icon":258},"Nitro","\u002Fintegrate\u002Fframeworks\u002Fnitro","4.integrate\u002Fframeworks\u002F04.nitro","i-custom-nitro",{"title":260,"path":261,"stem":262,"icon":263},"TanStack Start","\u002Fintegrate\u002Fframeworks\u002Ftanstack-start","4.integrate\u002Fframeworks\u002F05.tanstack-start","i-custom-tanstack",{"title":265,"path":266,"stem":267,"icon":268},"NestJS","\u002Fintegrate\u002Fframeworks\u002Fnestjs","4.integrate\u002Fframeworks\u002F06.nestjs","i-simple-icons-nestjs",{"title":270,"path":271,"stem":272,"icon":273},"Express","\u002Fintegrate\u002Fframeworks\u002Fexpress","4.integrate\u002Fframeworks\u002F07.express","i-simple-icons-express",{"title":275,"path":276,"stem":277,"icon":278},"Hono","\u002Fintegrate\u002Fframeworks\u002Fhono","4.integrate\u002Fframeworks\u002F08.hono","i-simple-icons-hono",{"title":280,"path":281,"stem":282,"icon":283},"Fastify","\u002Fintegrate\u002Fframeworks\u002Ffastify","4.integrate\u002Fframeworks\u002F09.fastify","i-simple-icons-fastify",{"title":285,"path":286,"stem":287,"icon":288},"Elysia","\u002Fintegrate\u002Fframeworks\u002Felysia","4.integrate\u002Fframeworks\u002F10.elysia","i-custom-elysia",{"title":290,"path":291,"stem":292,"icon":293},"React Router","\u002Fintegrate\u002Fframeworks\u002Freact-router","4.integrate\u002Fframeworks\u002F11.react-router","i-custom-reactrouter",{"title":295,"path":296,"stem":297,"icon":298},"Cloudflare Workers","\u002Fintegrate\u002Fframeworks\u002Fcloudflare-workers","4.integrate\u002Fframeworks\u002F12.cloudflare-workers","i-simple-icons-cloudflare",{"title":300,"path":301,"stem":302,"icon":79},"Standalone","\u002Fintegrate\u002Fframeworks\u002Fstandalone","4.integrate\u002Fframeworks\u002F13.standalone",{"title":304,"path":305,"stem":306,"icon":307},"Astro","\u002Fintegrate\u002Fframeworks\u002Fastro","4.integrate\u002Fframeworks\u002F14.astro","i-simple-icons-astro",{"title":309,"path":310,"stem":311,"icon":312},"oRPC","\u002Fintegrate\u002Fframeworks\u002Forpc","4.integrate\u002Fframeworks\u002F15.orpc","i-lucide-network",{"title":314,"path":315,"stem":316,"icon":317},"AWS Lambda","\u002Fintegrate\u002Fframeworks\u002Faws-lambda","4.integrate\u002Fframeworks\u002F16.aws-lambda","i-custom-lambda",{"title":319,"path":320,"stem":321,"children":322,"page":34},"Use Cases","\u002Fuse-cases","5.use-cases",[323,326,331,359,386,418,439,444,449],{"title":41,"path":324,"stem":325,"icon":107},"\u002Fuse-cases\u002Foverview","5.use-cases\u002F0.overview",{"title":327,"path":328,"stem":329,"icon":330},"Client Logging","\u002Fuse-cases\u002Fclient-logging","5.use-cases\u002F1.client-logging","i-lucide-monitor",{"title":332,"icon":333,"path":334,"stem":335,"children":336,"page":34},"AI SDK","i-simple-icons-vercel","\u002Fuse-cases\u002Fai-sdk","5.use-cases\u002F2.ai-sdk",[337,340,345,350,355],{"title":41,"path":338,"stem":339,"icon":44},"\u002Fuse-cases\u002Fai-sdk\u002Foverview","5.use-cases\u002F2.ai-sdk\u002F01.overview",{"title":341,"path":342,"stem":343,"icon":344},"Usage","\u002Fuse-cases\u002Fai-sdk\u002Fusage","5.use-cases\u002F2.ai-sdk\u002F02.usage","i-lucide-code",{"title":346,"path":347,"stem":348,"icon":349},"Options","\u002Fuse-cases\u002Fai-sdk\u002Foptions","5.use-cases\u002F2.ai-sdk\u002F03.options","i-lucide-sliders",{"title":351,"path":352,"stem":353,"icon":354},"Metadata","\u002Fuse-cases\u002Fai-sdk\u002Fmetadata","5.use-cases\u002F2.ai-sdk\u002F04.metadata","i-lucide-database",{"title":356,"path":357,"stem":358,"icon":137},"Telemetry","\u002Fuse-cases\u002Fai-sdk\u002Ftelemetry","5.use-cases\u002F2.ai-sdk\u002F05.telemetry",{"title":360,"icon":361,"path":362,"stem":363,"children":364,"page":34},"Better Auth","i-simple-icons-betterauth","\u002Fuse-cases\u002Fbetter-auth","5.use-cases\u002F3.better-auth",[365,368,373,378,382],{"title":41,"path":366,"stem":367,"icon":44},"\u002Fuse-cases\u002Fbetter-auth\u002Foverview","5.use-cases\u002F3.better-auth\u002F01.overview",{"title":369,"path":370,"stem":371,"icon":372},"Identify User","\u002Fuse-cases\u002Fbetter-auth\u002Fidentify-user","5.use-cases\u002F3.better-auth\u002F02.identify-user","i-lucide-user-check",{"title":374,"path":375,"stem":376,"icon":377},"Middleware","\u002Fuse-cases\u002Fbetter-auth\u002Fmiddleware","5.use-cases\u002F3.better-auth\u002F03.middleware","i-lucide-shield",{"title":379,"path":380,"stem":381,"icon":330},"Client Sync","\u002Fuse-cases\u002Fbetter-auth\u002Fclient-sync","5.use-cases\u002F3.better-auth\u002F04.client-sync",{"title":383,"path":384,"stem":385,"icon":112},"Performance","\u002Fuse-cases\u002Fbetter-auth\u002Fperformance","5.use-cases\u002F3.better-auth\u002F05.performance",{"title":387,"icon":388,"path":389,"stem":390,"children":391,"page":34},"Audit Logs","i-lucide-shield-check","\u002Fuse-cases\u002Faudit","5.use-cases\u002F4.audit",[392,395,400,405,410,414],{"title":41,"path":393,"stem":394,"icon":44},"\u002Fuse-cases\u002Faudit\u002Foverview","5.use-cases\u002F4.audit\u002F01.overview",{"title":396,"path":397,"stem":398,"icon":399},"Schema","\u002Fuse-cases\u002Faudit\u002Fschema","5.use-cases\u002F4.audit\u002F02.schema","i-lucide-file-text",{"title":401,"path":402,"stem":403,"icon":404},"Recording","\u002Fuse-cases\u002Faudit\u002Frecording","5.use-cases\u002F4.audit\u002F03.recording","i-lucide-pen-line",{"title":406,"path":407,"stem":408,"icon":409},"Drains","\u002Fuse-cases\u002Faudit\u002Fpipeline","5.use-cases\u002F4.audit\u002F04.pipeline","i-lucide-link",{"title":411,"path":412,"stem":413,"icon":388},"Compliance","\u002Fuse-cases\u002Faudit\u002Fcompliance","5.use-cases\u002F4.audit\u002F05.compliance",{"title":415,"path":416,"stem":417,"icon":84},"Recipes","\u002Fuse-cases\u002Faudit\u002Frecipes","5.use-cases\u002F4.audit\u002F06.recipes",{"title":356,"icon":112,"path":419,"stem":420,"children":421,"page":34},"\u002Fuse-cases\u002Ftelemetry","5.use-cases\u002F4.telemetry",[422,425,430,435],{"title":41,"path":423,"stem":424,"icon":44},"\u002Fuse-cases\u002Ftelemetry\u002Foverview","5.use-cases\u002F4.telemetry\u002F01.overview",{"title":426,"path":427,"stem":428,"icon":429},"Setup","\u002Fuse-cases\u002Ftelemetry\u002Fsetup","5.use-cases\u002F4.telemetry\u002F02.setup","i-lucide-wrench",{"title":431,"path":432,"stem":433,"icon":434},"Ingest","\u002Fuse-cases\u002Ftelemetry\u002Fingest","5.use-cases\u002F4.telemetry\u002F03.ingest","i-lucide-server",{"title":436,"path":437,"stem":438,"icon":84},"Reference","\u002Fuse-cases\u002Ftelemetry\u002Freference","5.use-cases\u002F4.telemetry\u002F04.reference",{"title":440,"path":441,"stem":442,"icon":443},"Enrichers","\u002Fuse-cases\u002Fenrichers","5.use-cases\u002F5.enrichers","i-lucide-sparkles",{"title":445,"path":446,"stem":447,"icon":448},"eve","\u002Fuse-cases\u002Feve","5.use-cases\u002F5.eve","i-custom-eve",{"title":450,"path":451,"stem":452,"icon":434},"Node.js request logging","\u002Fuse-cases\u002Fstructured-logging-nodejs","5.use-cases\u002F6.structured-logging-nodejs",{"title":454,"path":455,"stem":456,"children":457,"page":34},"Libraries","\u002Flibraries","6.libraries",[458,462,467,470,474,479,484],{"title":41,"path":459,"stem":460,"icon":461},"\u002Flibraries\u002Foverview","6.libraries\u002F0.overview","i-lucide-package",{"title":463,"path":464,"stem":465,"icon":466},"Emitting Events","\u002Flibraries\u002Femitting","6.libraries\u002F1.emitting","i-lucide-radio",{"title":56,"path":468,"stem":469,"icon":59},"\u002Flibraries\u002Ferrors","6.libraries\u002F2.errors",{"title":471,"path":472,"stem":473,"icon":132},"Errors Agents Can Act On","\u002Flibraries\u002Fagents","6.libraries\u002F3.agents",{"title":475,"path":476,"stem":477,"icon":478},"Exporting the Catalog","\u002Flibraries\u002Fexporting","6.libraries\u002F4.exporting","i-lucide-file-output",{"title":480,"path":481,"stem":482,"icon":483},"Migrating","\u002Flibraries\u002Fmigrating","6.libraries\u002F5.migrating","i-lucide-route",{"title":485,"path":486,"stem":487,"icon":488},"Testing","\u002Flibraries\u002Ftesting","6.libraries\u002F6.testing","i-lucide-flask-conical",{"title":490,"path":491,"stem":492,"children":493,"page":34},"Extend","\u002Fextend","7.extend",[494,498,503,508,512,517,521,525,529,533,538,543],{"title":41,"path":495,"stem":496,"icon":497},"\u002Fextend\u002Foverview","7.extend\u002F0.overview","i-lucide-blocks",{"title":499,"path":500,"stem":501,"icon":502},"Stream","\u002Fextend\u002Fstream","7.extend\u002F1.stream","i-lucide-radio-tower",{"title":504,"path":505,"stem":506,"icon":507},"Custom framework","\u002Fextend\u002Fcustom-framework","7.extend\u002F10.custom-framework","i-lucide-puzzle",{"title":509,"path":510,"stem":511,"icon":502},"Diagnostics channel","\u002Fextend\u002Fdiagnostics-channel","7.extend\u002F11.diagnostics-channel",{"title":513,"path":514,"stem":515,"icon":516},"FS reader","\u002Fextend\u002Ffs-reader","7.extend\u002F2.fs-reader","i-lucide-folder-search",{"title":415,"path":518,"stem":519,"icon":520},"\u002Fextend\u002Fconsumer-recipes","7.extend\u002F3.consumer-recipes","i-lucide-chef-hat",{"title":522,"path":523,"stem":524,"icon":497},"Plugins","\u002Fextend\u002Fplugins","7.extend\u002F4.plugins",{"title":526,"path":527,"stem":528,"icon":443},"Custom enrichers","\u002Fextend\u002Fcustom-enrichers","7.extend\u002F5.custom-enrichers",{"title":530,"path":531,"stem":532,"icon":69},"Tail sampling","\u002Fextend\u002Ftail-sampling","7.extend\u002F6.tail-sampling",{"title":534,"path":535,"stem":536,"icon":537},"Identity headers","\u002Fextend\u002Fidentity-headers","7.extend\u002F7.identity-headers","i-lucide-fingerprint",{"title":539,"path":540,"stem":541,"icon":542},"Custom drains","\u002Fextend\u002Fcustom-drains","7.extend\u002F8.custom-drains","i-lucide-share-2",{"title":544,"path":545,"stem":546,"icon":547},"Drain pipeline","\u002Fextend\u002Fdrain-pipeline","7.extend\u002F9.drain-pipeline","i-lucide-workflow",{"title":436,"path":549,"stem":550,"children":551,"page":34},"\u002Freference","8.reference",[552,556,561,564,569,573,578,582],{"title":41,"path":553,"stem":554,"icon":555},"\u002Freference\u002Foverview","8.reference\u002F0.overview","i-lucide-book-marked",{"title":557,"path":558,"stem":559,"icon":560},"Configuration","\u002Freference\u002Fconfiguration","8.reference\u002F1.configuration","i-lucide-settings",{"title":383,"path":562,"stem":563,"icon":112},"\u002Freference\u002Fperformance","8.reference\u002F2.performance",{"title":565,"path":566,"stem":567,"icon":568},"Vite Plugin","\u002Freference\u002Fvite-plugin","8.reference\u002F3.vite-plugin","i-custom-vite",{"title":570,"path":571,"stem":572,"icon":388},"Best Practices","\u002Freference\u002Fbest-practices","8.reference\u002F4.best-practices",{"title":574,"path":575,"stem":576,"icon":577},"vs Other Loggers","\u002Freference\u002Fvs-other-loggers","8.reference\u002F5.vs-other-loggers","i-lucide-scale",{"title":579,"path":580,"stem":581,"icon":443},"Agent Skills","\u002Freference\u002Fagent-skills","8.reference\u002F6.agent-skills",{"title":583,"path":584,"stem":585,"icon":586},"Cost","\u002Freference\u002Fcost","8.reference\u002F7.cost","i-lucide-receipt",{"title":588,"path":589,"stem":590,"children":591,"page":34},"Compare","\u002Fcompare","9.compare",[592,596,600,604,608],{"title":593,"path":594,"stem":595,"icon":577},"evlog vs Pino","\u002Fcompare\u002Fpino","9.compare\u002F1.pino",{"title":597,"path":598,"stem":599,"icon":204},"evlog vs OpenTelemetry","\u002Fcompare\u002Fopentelemetry","9.compare\u002F2.opentelemetry",{"title":601,"path":602,"stem":603,"icon":577},"evlog vs LogTape","\u002Fcompare\u002Flogtape","9.compare\u002F3.logtape",{"title":605,"path":606,"stem":607,"icon":577},"evlog vs Winston: formats and request events","\u002Fcompare\u002Fwinston","9.compare\u002F4.winston",{"title":609,"path":610,"stem":611,"icon":577},"evlog vs Consola: reporters and request context","\u002Fcompare\u002Fconsola","9.compare\u002F5.consola",{"id":613,"title":471,"body":614,"description":1691,"extension":1692,"links":1693,"meta":1694,"navigation":1695,"path":472,"seo":1696,"stem":473,"__hash__":1697},"docs\u002F6.libraries\u002F3.agents.md",{"type":615,"value":616,"toc":1685},"minimark",[617,634,644,649,745,752,1034,1045,1049,1052,1061,1087,1108,1122,1134,1138,1141,1608,1627,1660,1664,1681],[618,619,620,621,625,626,629,630,633],"p",{},"An agent calls a tool built on your package. The call fails. What the model sees next decides whether it recovers in one step or in six: a bare ",[622,623,624],"code",{},"Not authorized"," reads as \"the repository is private\" to a model, which then reports a wrong cause with confidence, or opens your documentation and spends a few thousand tokens reading pages that may not name the case at all. A catalog entry with a good ",[622,627,628],{},"why"," and ",[622,631,632],{},"fix"," is the page it would have needed, delivered inside the error.",[618,635,636,637,640,641,643],{},"This is the same catalog as ",[638,639,56],"a",{"href":468},". The difference is who reads the fields. A human skims ",[622,642,632],{}," and fills in the gaps; a model executes it literally, so the sentences have to survive being taken at their word.",[645,646,648],"h2",{"id":647},"what-a-model-does-with-each-field","What a model does with each field",[650,651,652,668],"table",{},[653,654,655],"thead",{},[656,657,658,662,665],"tr",{},[659,660,661],"th",{},"Field",[659,663,664],{},"What the model does with it",[659,666,667],{},"What that means for how you write it",[669,670,671,690,703,715,727],"tbody",{},[656,672,673,678,684],{},[674,675,676],"td",{},[622,677,622],{},[674,679,680,681],{},"Matches it against what it has seen before, in this session or in your ",[622,682,683],{},"llms.txt",[674,685,686,687],{},"Stable, namespaced, in the form a prompt can quote: ",[622,688,689],{},"github_tools.NOT_FOUND",[656,691,692,697,700],{},[674,693,694],{},[622,695,696],{},"message",[674,698,699],{},"Reports it to the user, or reasons from it alone when a framework strips the rest",[674,701,702],{},"Self-sufficient: the upstream detail embedded, the next move implied",[656,704,705,709,712],{},[674,706,707],{},[622,708,628],{},[674,710,711],{},"Decides whether to retry, change input, or stop",[674,713,714],{},"Names the real cause, including the one that looks like something else",[656,716,717,721,724],{},[674,718,719],{},[622,720,632],{},[674,722,723],{},"Executes it",[674,725,726],{},"An imperative with the exact command, env var, or parameter. No \"check your configuration\"",[656,728,729,734,742],{},[674,730,731],{},[622,732,733],{},"link",[674,735,736,737,629,739,741],{},"Fetches it when ",[622,738,628],{},[622,740,632],{}," are not enough",[674,743,744],{},"A stable anchor to the section that covers this case, not the docs home",[618,746,747,748,751],{},"The two ",[622,749,750],{},"github_tools"," entries below are the ones models got wrong most often before the catalog existed, and they show what \"names the real cause\" means in practice:",[753,754,760],"pre",{"className":755,"code":756,"filename":757,"language":758,"meta":759,"style":759},"language-typescript shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","NOT_FOUND: {\n  status: 404,\n  message: ({ detail }: { detail: string }) => `GitHub resource not found (404): ${detail}`,\n  why: 'Either the resource does not exist, or the token cannot see it. GitHub deliberately returns 404 instead of 403 for private resources the token has no access to.',\n  fix: 'Check the owner\u002Frepo\u002Fnumber input first. If it is correct, the token lacks access: grant the repository to the PAT or App installation, or use a Connect subject that has access.',\n  link: 'https:\u002F\u002Fdocs.github.com\u002Fen\u002Frest\u002Fusing-the-rest-api\u002Ftroubleshooting-the-rest-api#404-not-found-for-an-existing-resource',\n},\nOIDC_TOKEN_EXPIRED: {\n  status: 401,\n  message: ({ expiredAt }: { expiredAt: string }) =>\n    `VERCEL_OIDC_TOKEN expired at ${expiredAt}; Vercel Connect would reject it, so no GitHub request was made.`,\n  why: 'The SDK pins the VERCEL_OIDC_TOKEN environment token when it is set, so an expired env token is never refreshed automatically.',\n  fix: 'Locally: run `vercel env pull` to refresh .env.local. On Vercel: deployments inject a fresh token; check nothing overrides VERCEL_OIDC_TOKEN with a stale value.',\n  link: 'https:\u002F\u002Fgithub-tools.com\u002Fguide\u002Fvercel-connect#eve-agent',\n},\n","src\u002Fcore\u002Ferrors.ts","typescript","",[622,761,762,778,793,848,867,884,901,907,917,929,956,981,997,1013,1029],{"__ignoreMap":759},[763,764,767,771,775],"span",{"class":765,"line":766},"line",1,[763,768,770],{"class":769},"sBMFI","NOT_FOUND",[763,772,774],{"class":773},"sMK4o",":",[763,776,777],{"class":773}," {\n",[763,779,781,784,786,790],{"class":765,"line":780},2,[763,782,783],{"class":769},"  status",[763,785,774],{"class":773},[763,787,789],{"class":788},"sbssI"," 404",[763,791,792],{"class":773},",\n",[763,794,796,799,801,804,808,811,814,817,819,822,825,829,832,836,839,843,846],{"class":765,"line":795},3,[763,797,798],{"class":769},"  message",[763,800,774],{"class":773},[763,802,803],{"class":773}," ({",[763,805,807],{"class":806},"sHdIc"," detail",[763,809,810],{"class":773}," }:",[763,812,813],{"class":773}," {",[763,815,807],{"class":816},"swJcz",[763,818,774],{"class":773},[763,820,821],{"class":769}," string",[763,823,824],{"class":773}," })",[763,826,828],{"class":827},"spNyl"," =>",[763,830,831],{"class":773}," `",[763,833,835],{"class":834},"sfazB","GitHub resource not found (404): ",[763,837,838],{"class":773},"${",[763,840,842],{"class":841},"sTEyZ","detail",[763,844,845],{"class":773},"}`",[763,847,792],{"class":773},[763,849,851,854,856,859,862,865],{"class":765,"line":850},4,[763,852,853],{"class":769},"  why",[763,855,774],{"class":773},[763,857,858],{"class":773}," '",[763,860,861],{"class":834},"Either the resource does not exist, or the token cannot see it. GitHub deliberately returns 404 instead of 403 for private resources the token has no access to.",[763,863,864],{"class":773},"'",[763,866,792],{"class":773},[763,868,870,873,875,877,880,882],{"class":765,"line":869},5,[763,871,872],{"class":769},"  fix",[763,874,774],{"class":773},[763,876,858],{"class":773},[763,878,879],{"class":834},"Check the owner\u002Frepo\u002Fnumber input first. If it is correct, the token lacks access: grant the repository to the PAT or App installation, or use a Connect subject that has access.",[763,881,864],{"class":773},[763,883,792],{"class":773},[763,885,887,890,892,894,897,899],{"class":765,"line":886},6,[763,888,889],{"class":769},"  link",[763,891,774],{"class":773},[763,893,858],{"class":773},[763,895,896],{"class":834},"https:\u002F\u002Fdocs.github.com\u002Fen\u002Frest\u002Fusing-the-rest-api\u002Ftroubleshooting-the-rest-api#404-not-found-for-an-existing-resource",[763,898,864],{"class":773},[763,900,792],{"class":773},[763,902,904],{"class":765,"line":903},7,[763,905,906],{"class":773},"},\n",[763,908,910,913,915],{"class":765,"line":909},8,[763,911,912],{"class":769},"OIDC_TOKEN_EXPIRED",[763,914,774],{"class":773},[763,916,777],{"class":773},[763,918,920,922,924,927],{"class":765,"line":919},9,[763,921,783],{"class":769},[763,923,774],{"class":773},[763,925,926],{"class":788}," 401",[763,928,792],{"class":773},[763,930,932,934,936,938,941,943,945,947,949,951,953],{"class":765,"line":931},10,[763,933,798],{"class":769},[763,935,774],{"class":773},[763,937,803],{"class":773},[763,939,940],{"class":806}," expiredAt",[763,942,810],{"class":773},[763,944,813],{"class":773},[763,946,940],{"class":816},[763,948,774],{"class":773},[763,950,821],{"class":769},[763,952,824],{"class":773},[763,954,955],{"class":827}," =>\n",[763,957,959,962,965,967,970,973,976,979],{"class":765,"line":958},11,[763,960,961],{"class":773},"    `",[763,963,964],{"class":834},"VERCEL_OIDC_TOKEN expired at ",[763,966,838],{"class":773},[763,968,969],{"class":841},"expiredAt",[763,971,972],{"class":773},"}",[763,974,975],{"class":834},"; Vercel Connect would reject it, so no GitHub request was made.",[763,977,978],{"class":773},"`",[763,980,792],{"class":773},[763,982,984,986,988,990,993,995],{"class":765,"line":983},12,[763,985,853],{"class":769},[763,987,774],{"class":773},[763,989,858],{"class":773},[763,991,992],{"class":834},"The SDK pins the VERCEL_OIDC_TOKEN environment token when it is set, so an expired env token is never refreshed automatically.",[763,994,864],{"class":773},[763,996,792],{"class":773},[763,998,1000,1002,1004,1006,1009,1011],{"class":765,"line":999},13,[763,1001,872],{"class":769},[763,1003,774],{"class":773},[763,1005,858],{"class":773},[763,1007,1008],{"class":834},"Locally: run `vercel env pull` to refresh .env.local. On Vercel: deployments inject a fresh token; check nothing overrides VERCEL_OIDC_TOKEN with a stale value.",[763,1010,864],{"class":773},[763,1012,792],{"class":773},[763,1014,1016,1018,1020,1022,1025,1027],{"class":765,"line":1015},14,[763,1017,889],{"class":769},[763,1019,774],{"class":773},[763,1021,858],{"class":773},[763,1023,1024],{"class":834},"https:\u002F\u002Fgithub-tools.com\u002Fguide\u002Fvercel-connect#eve-agent",[763,1026,864],{"class":773},[763,1028,792],{"class":773},[763,1030,1032],{"class":765,"line":1031},15,[763,1033,906],{"class":773},[618,1035,1036,1038,1039,1041,1042,1044],{},[622,1037,770],{}," tells the model the thing a GitHub 404 hides: the resource may exist and the token cannot see it. Without that sentence, a model concludes the repository is gone and stops. ",[622,1040,912],{}," is thrown before any request is made, with the expiry timestamp, so the model never sees the opaque Connect 403 that used to arrive instead. Both ",[622,1043,632],{}," strings name the command to run.",[645,1046,1048],{"id":1047},"write-the-four-sentences","Write the four sentences",[618,1050,1051],{},"The test for each field is whether a model, holding only the error, can act correctly on the first try.",[618,1053,1054,1060],{},[1055,1056,1057,1059],"strong",{},[622,1058,628],{}," names the cause the symptom hides."," State what happened at the layer that knows: the token is invalid, the OIDC token expired, the input was well-formed and the provider refused it. Where the symptom misleads (a 404 that is really a 403, a 403 that is really a rate limit), say so in the second sentence. That sentence is the one that saves the loop.",[618,1062,1063,1068,1069,1072,1073,1072,1076,1079,1080,1082,1083,1086],{},[1055,1064,1065,1067],{},[622,1066,632],{}," is one imperative the model can run."," Start with the verb. Name the exact parameter, environment variable, or command: ",[622,1070,1071],{},"set GITHUB_TOKEN",", ",[622,1074,1075],{},"run vercel env pull",[622,1077,1078],{},"retry after the reset timestamp in the message",". If the fix depends on where the code runs, split it by environment the way ",[622,1081,912],{}," does. If the right move is to stop, say stop: ",[622,1084,1085],{},"Stop calling this tool and retry after the reset timestamp"," prevents a model from burning its quota on retries.",[618,1088,1089,1094,1095,1098,1099,1102,1103,629,1105,1107],{},[1055,1090,1091,1093],{},[622,1092,696],{}," stands alone."," Some frameworks forward only ",[622,1096,1097],{},"error.message"," to the model. Embed the upstream detail with a typed template (",[622,1100,1101],{},"({ detail }) => ...",") so the message carries the provider's own words, and write it so the next move is implied even when ",[622,1104,628],{},[622,1106,632],{}," are stripped.",[618,1109,1110,1115,1116,1118,1119,1121],{},[1055,1111,1112,1114],{},[622,1113,733],{}," goes to the section, not the site."," A model that fetches the link reads the page it lands on. ",[622,1117,1024],{}," costs one fetch; a docs home page costs a search. External docs are fine when they are the authority, and GitHub's own troubleshooting anchor is the right ",[622,1120,733],{}," for a GitHub 422.",[618,1123,1124,1125,1127,1128,1130,1131,1133],{},"What this costs: the four sentences go stale when the upstream API changes, and a wrong ",[622,1126,632],{}," misleads a model faster than no ",[622,1129,632],{}," at all, because the model trusts it. Review the catalog when you bump the upstream SDK, and keep ",[638,1132,475],{"href":476}," in the build so the docs regenerate from the same source.",[645,1135,1137],{"id":1136},"return-the-structure-to-the-model","Return the structure to the model",[618,1139,1140],{},"The catalog does nothing for an agent if the tool layer flattens the error to a string before the model sees it. Where your package owns the tool boundary, return the projection instead of throwing:",[753,1142,1145],{"className":755,"code":1143,"filename":1144,"language":758,"meta":759,"style":759},"import { EvlogError } from 'evlog'\n\nfunction toModelErrorPayload(error: EvlogError): Record\u003Cstring, string> {\n  return {\n    ...(error.code ? { code: error.code } : {}),\n    message: error.message,\n    ...(error.why ? { why: error.why } : {}),\n    ...(error.fix ? { fix: error.fix } : {}),\n    ...(error.link ? { link: error.link } : {}),\n  }\n}\n\nexport async function runTool(name: string, input: Record\u003Cstring, unknown>) {\n  try {\n    return await execute(name, input)\n  } catch (error) {\n    if (EvlogError.isEvlogError(error)) {\n      return { error: toModelErrorPayload(error) }\n    }\n    return { error: error instanceof Error ? error.message : String(error) }\n  }\n}\n","src\u002Feve\u002Fsteps.ts",[622,1146,1147,1172,1178,1219,1226,1270,1285,1322,1359,1396,1401,1406,1410,1456,1463,1485,1505,1530,1552,1558,1598,1603],{"__ignoreMap":759},[763,1148,1149,1153,1155,1158,1161,1164,1166,1169],{"class":765,"line":766},[763,1150,1152],{"class":1151},"s7zQu","import",[763,1154,813],{"class":773},[763,1156,1157],{"class":841}," EvlogError",[763,1159,1160],{"class":773}," }",[763,1162,1163],{"class":1151}," from",[763,1165,858],{"class":773},[763,1167,1168],{"class":834},"evlog",[763,1170,1171],{"class":773},"'\n",[763,1173,1174],{"class":765,"line":780},[763,1175,1177],{"emptyLinePlaceholder":1176},true,"\n",[763,1179,1180,1183,1187,1190,1193,1195,1197,1200,1203,1206,1209,1212,1214,1217],{"class":765,"line":795},[763,1181,1182],{"class":827},"function",[763,1184,1186],{"class":1185},"s2Zo4"," toModelErrorPayload",[763,1188,1189],{"class":773},"(",[763,1191,1192],{"class":806},"error",[763,1194,774],{"class":773},[763,1196,1157],{"class":769},[763,1198,1199],{"class":773},"):",[763,1201,1202],{"class":769}," Record",[763,1204,1205],{"class":773},"\u003C",[763,1207,1208],{"class":769},"string",[763,1210,1211],{"class":773},",",[763,1213,821],{"class":769},[763,1215,1216],{"class":773},">",[763,1218,777],{"class":773},[763,1220,1221,1224],{"class":765,"line":850},[763,1222,1223],{"class":1151},"  return",[763,1225,777],{"class":773},[763,1227,1228,1231,1233,1235,1238,1240,1243,1245,1248,1250,1253,1255,1257,1259,1262,1265,1268],{"class":765,"line":869},[763,1229,1230],{"class":773},"    ...",[763,1232,1189],{"class":816},[763,1234,1192],{"class":841},[763,1236,1237],{"class":773},".",[763,1239,622],{"class":841},[763,1241,1242],{"class":773}," ?",[763,1244,813],{"class":773},[763,1246,1247],{"class":816}," code",[763,1249,774],{"class":773},[763,1251,1252],{"class":841}," error",[763,1254,1237],{"class":773},[763,1256,622],{"class":841},[763,1258,1160],{"class":773},[763,1260,1261],{"class":773}," :",[763,1263,1264],{"class":773}," {}",[763,1266,1267],{"class":816},")",[763,1269,792],{"class":773},[763,1271,1272,1275,1277,1279,1281,1283],{"class":765,"line":886},[763,1273,1274],{"class":816},"    message",[763,1276,774],{"class":773},[763,1278,1252],{"class":841},[763,1280,1237],{"class":773},[763,1282,696],{"class":841},[763,1284,792],{"class":773},[763,1286,1287,1289,1291,1293,1295,1297,1299,1301,1304,1306,1308,1310,1312,1314,1316,1318,1320],{"class":765,"line":903},[763,1288,1230],{"class":773},[763,1290,1189],{"class":816},[763,1292,1192],{"class":841},[763,1294,1237],{"class":773},[763,1296,628],{"class":841},[763,1298,1242],{"class":773},[763,1300,813],{"class":773},[763,1302,1303],{"class":816}," why",[763,1305,774],{"class":773},[763,1307,1252],{"class":841},[763,1309,1237],{"class":773},[763,1311,628],{"class":841},[763,1313,1160],{"class":773},[763,1315,1261],{"class":773},[763,1317,1264],{"class":773},[763,1319,1267],{"class":816},[763,1321,792],{"class":773},[763,1323,1324,1326,1328,1330,1332,1334,1336,1338,1341,1343,1345,1347,1349,1351,1353,1355,1357],{"class":765,"line":909},[763,1325,1230],{"class":773},[763,1327,1189],{"class":816},[763,1329,1192],{"class":841},[763,1331,1237],{"class":773},[763,1333,632],{"class":841},[763,1335,1242],{"class":773},[763,1337,813],{"class":773},[763,1339,1340],{"class":816}," fix",[763,1342,774],{"class":773},[763,1344,1252],{"class":841},[763,1346,1237],{"class":773},[763,1348,632],{"class":841},[763,1350,1160],{"class":773},[763,1352,1261],{"class":773},[763,1354,1264],{"class":773},[763,1356,1267],{"class":816},[763,1358,792],{"class":773},[763,1360,1361,1363,1365,1367,1369,1371,1373,1375,1378,1380,1382,1384,1386,1388,1390,1392,1394],{"class":765,"line":919},[763,1362,1230],{"class":773},[763,1364,1189],{"class":816},[763,1366,1192],{"class":841},[763,1368,1237],{"class":773},[763,1370,733],{"class":841},[763,1372,1242],{"class":773},[763,1374,813],{"class":773},[763,1376,1377],{"class":816}," link",[763,1379,774],{"class":773},[763,1381,1252],{"class":841},[763,1383,1237],{"class":773},[763,1385,733],{"class":841},[763,1387,1160],{"class":773},[763,1389,1261],{"class":773},[763,1391,1264],{"class":773},[763,1393,1267],{"class":816},[763,1395,792],{"class":773},[763,1397,1398],{"class":765,"line":931},[763,1399,1400],{"class":773},"  }\n",[763,1402,1403],{"class":765,"line":958},[763,1404,1405],{"class":773},"}\n",[763,1407,1408],{"class":765,"line":983},[763,1409,1177],{"emptyLinePlaceholder":1176},[763,1411,1412,1415,1418,1421,1424,1426,1429,1431,1433,1435,1438,1440,1442,1444,1446,1448,1451,1454],{"class":765,"line":999},[763,1413,1414],{"class":1151},"export",[763,1416,1417],{"class":827}," async",[763,1419,1420],{"class":827}," function",[763,1422,1423],{"class":1185}," runTool",[763,1425,1189],{"class":773},[763,1427,1428],{"class":806},"name",[763,1430,774],{"class":773},[763,1432,821],{"class":769},[763,1434,1211],{"class":773},[763,1436,1437],{"class":806}," input",[763,1439,774],{"class":773},[763,1441,1202],{"class":769},[763,1443,1205],{"class":773},[763,1445,1208],{"class":769},[763,1447,1211],{"class":773},[763,1449,1450],{"class":769}," unknown",[763,1452,1453],{"class":773},">)",[763,1455,777],{"class":773},[763,1457,1458,1461],{"class":765,"line":1015},[763,1459,1460],{"class":1151},"  try",[763,1462,777],{"class":773},[763,1464,1465,1468,1471,1474,1476,1478,1480,1482],{"class":765,"line":1031},[763,1466,1467],{"class":1151},"    return",[763,1469,1470],{"class":1151}," await",[763,1472,1473],{"class":1185}," execute",[763,1475,1189],{"class":816},[763,1477,1428],{"class":841},[763,1479,1211],{"class":773},[763,1481,1437],{"class":841},[763,1483,1484],{"class":816},")\n",[763,1486,1488,1491,1494,1497,1499,1502],{"class":765,"line":1487},16,[763,1489,1490],{"class":773},"  }",[763,1492,1493],{"class":1151}," catch",[763,1495,1496],{"class":816}," (",[763,1498,1192],{"class":841},[763,1500,1501],{"class":816},") ",[763,1503,1504],{"class":773},"{\n",[763,1506,1508,1511,1513,1516,1518,1521,1523,1525,1528],{"class":765,"line":1507},17,[763,1509,1510],{"class":1151},"    if",[763,1512,1496],{"class":816},[763,1514,1515],{"class":841},"EvlogError",[763,1517,1237],{"class":773},[763,1519,1520],{"class":1185},"isEvlogError",[763,1522,1189],{"class":816},[763,1524,1192],{"class":841},[763,1526,1527],{"class":816},")) ",[763,1529,1504],{"class":773},[763,1531,1533,1536,1538,1540,1542,1544,1546,1548,1550],{"class":765,"line":1532},18,[763,1534,1535],{"class":1151},"      return",[763,1537,813],{"class":773},[763,1539,1252],{"class":816},[763,1541,774],{"class":773},[763,1543,1186],{"class":1185},[763,1545,1189],{"class":816},[763,1547,1192],{"class":841},[763,1549,1501],{"class":816},[763,1551,1405],{"class":773},[763,1553,1555],{"class":765,"line":1554},19,[763,1556,1557],{"class":773},"    }\n",[763,1559,1561,1563,1565,1567,1569,1571,1574,1577,1579,1581,1583,1585,1587,1590,1592,1594,1596],{"class":765,"line":1560},20,[763,1562,1467],{"class":1151},[763,1564,813],{"class":773},[763,1566,1252],{"class":816},[763,1568,774],{"class":773},[763,1570,1252],{"class":841},[763,1572,1573],{"class":773}," instanceof",[763,1575,1576],{"class":769}," Error",[763,1578,1242],{"class":773},[763,1580,1252],{"class":841},[763,1582,1237],{"class":773},[763,1584,696],{"class":841},[763,1586,1261],{"class":773},[763,1588,1589],{"class":1185}," String",[763,1591,1189],{"class":816},[763,1593,1192],{"class":841},[763,1595,1501],{"class":816},[763,1597,1405],{"class":773},[763,1599,1601],{"class":765,"line":1600},21,[763,1602,1400],{"class":773},[763,1604,1606],{"class":765,"line":1605},22,[763,1607,1405],{"class":773},[618,1609,1610,629,1613,1616,1617,1620,1621,1623,1624,1626],{},[622,1611,1612],{},"internal",[622,1614,1615],{},"status"," stay out of the payload: the request URL is for the host's logs, and the HTTP status means nothing to a model deciding what to do next. This is what ",[622,1618,1619],{},"@github-tools\u002Fsdk"," returns from its ",[638,1622,445],{"href":446}," tools, and it is the shape that lets the model read ",[622,1625,632],{}," and act on it in the same turn.",[618,1628,1629,1630,1072,1632,629,1635,1638,1639,1641,1642,1645,1646,1649,1650,1072,1652,1072,1654,1656,1657,1659],{},"Where the host owns the boundary, tell it what to do in your README. With the ",[638,1631,332],{"href":338},[622,1633,1634],{},"generateText",[622,1636,1637],{},"streamText"," forward ",[622,1640,1097],{}," from a throwing tool, which is why the message has to stand alone; a host that wants the full structure in an error boundary or an ",[622,1643,1644],{},"onError"," handler calls ",[622,1647,1648],{},"parseError(error)"," and gets ",[622,1651,622],{},[622,1653,628],{},[622,1655,632],{},", and ",[622,1658,733],{}," as flat fields.",[645,1661,1663],{"id":1662},"where-the-catalog-reaches-the-model-before-the-error-does","Where the catalog reaches the model before the error does",[618,1665,1666,1667,1669,1670,1673,1674,1676,1677,1680],{},"An error carries its entry to the model at failure time. The exported catalog reaches it earlier: in your ",[622,1668,683],{},", in an agent skill, or in a JSON file the agent loads at the start of a session. An agent that has read ",[622,1671,1672],{},"github_tools.RATE_LIMITED"," before its first call writes the backoff before it needs it. ",[638,1675,475],{"href":476}," generates those artifacts from the same ",[622,1678,1679],{},"defineErrorCatalog"," call, so the version the agent read matches the version your package throws.",[1682,1683,1684],"style",{},"html pre.shiki code .sBMFI, html code.shiki .sBMFI{--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B}html pre.shiki code .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}html pre.shiki code .sbssI, html code.shiki .sbssI{--shiki-light:#F76D47;--shiki-default:#F78C6C;--shiki-dark:#F78C6C}html pre.shiki code .sHdIc, html code.shiki .sHdIc{--shiki-light:#90A4AE;--shiki-light-font-style:italic;--shiki-default:#EEFFFF;--shiki-default-font-style:italic;--shiki-dark:#BABED8;--shiki-dark-font-style:italic}html pre.shiki code .swJcz, html code.shiki .swJcz{--shiki-light:#E53935;--shiki-default:#F07178;--shiki-dark:#F07178}html pre.shiki code .spNyl, html code.shiki .spNyl{--shiki-light:#9C3EDA;--shiki-default:#C792EA;--shiki-dark:#C792EA}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html pre.shiki code .sTEyZ, html code.shiki .sTEyZ{--shiki-light:#90A4AE;--shiki-default:#EEFFFF;--shiki-dark:#BABED8}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .s7zQu, html code.shiki .s7zQu{--shiki-light:#39ADB5;--shiki-light-font-style:italic;--shiki-default:#89DDFF;--shiki-default-font-style:italic;--shiki-dark:#89DDFF;--shiki-dark-font-style:italic}html pre.shiki code .s2Zo4, html code.shiki .s2Zo4{--shiki-light:#6182B8;--shiki-default:#82AAFF;--shiki-dark:#82AAFF}",{"title":759,"searchDepth":780,"depth":780,"links":1686},[1687,1688,1689,1690],{"id":647,"depth":780,"text":648},{"id":1047,"depth":780,"text":1048},{"id":1136,"depth":780,"text":1137},{"id":1662,"depth":780,"text":1663},"Write why, fix, and link so a model calling your package recovers from the error itself, without a docs round-trip and the tokens it costs.","md",null,{},{"title":471,"icon":132},{"title":471,"description":1691},"0WAaJJ2OLLpLmWQ8yVb4zM6OZ1rkL5_EguXQexWRcp4",[1699,1701],{"title":56,"path":468,"stem":469,"description":1700,"icon":59,"children":-1},"Replace bare errors with a catalog your package owns: what the host receives, how upstream failures map into it, and why codes are wire format.",{"title":475,"path":476,"stem":477,"description":1702,"icon":478,"children":-1},"Generate your package's error reference from the catalog: a Markdown page for humans, a JSON file for tooling, and an llms.txt section for agents.",1789294039584]