[{"_1":2,"_3":-5,"_4":-5},"loaderData",{"_5":6,"_7":8,"_9":10},"actionData","errors","root",{"_112":113},"routes/modules.$creator.$moduleId",{"_14":15,"_16":17,"_18":19,"_20":21},"routes/modules.$creator.$moduleId.endpoints",{"_11":12,"_13":-5},"error","Module not found","tools","module",{"_20":22,"_23":24,"_25":26,"_27":28,"_29":30,"_31":32,"_33":26,"_34":-5,"_35":36,"_37":-5,"_38":-5,"_39":40,"_41":42,"_43":44,"_45":46,"_47":46,"_48":49,"_50":51,"_52":53,"_54":-5,"_55":46,"_56":57,"_58":59,"_60":61,"_62":63,"_64":65,"_66":46,"_67":68,"_69":70,"_71":72,"_73":74,"_75":76,"_77":-5,"_78":-5,"_79":-5,"_80":46,"_81":-5,"_82":83,"_84":85,"_86":87,"_88":89,"_90":91,"_92":93,"_94":95},"apiUrl","https://odel.app/api","creator","outlitai","moduleId","outlit-sdk","@outlitai/outlit-sdk","displayName","Outlit","tagline","Outlit gives agents real-time understanding of customers to automate support and revenue workflows.","iconKey","https://outlit.ai/images/logos/outlit-logo-square.png","category","ai-agents","status","published","metaDescription","metaKeywords","deploymentType","external","workerName","bindingName","mcpConfig","{\"url\":\"https://mcp.outlit.ai/mcp\",\"transport\":\"streamable-http\",\"authType\":\"none\"}","pricingModel","free","creatorUserId","system:external-import","createdAt",1783311690000,"updatedAt","sourceRegistry","official-mcp-registry","sourceUrl","https://registry.modelcontextprotocol.io/v0/servers?search=ai.outlit%2Foutlit","sourceVerified",false,"sourceMissingSince","importedAt","upstreamStars",5,"upstreamUpdatedAt",1782880055000,"detectedTransport","streamable-http","detectedAuthType","oauth","probeStatus","ok","lastProbedAt","githubRepoUrl","https://github.com/OutlitAI/outlit-sdk","githubRepoFullName","OutlitAI/outlit-sdk","releaseId","ext-outlitai-outlit-sdk","version","1.0.0","descriptionMarkdown","# Outlit SDK\n\nOutlit is the real-time understanding of every customer, the infrastructure agents use to automate customer operations.\n\nThis repository contains the public SDK and developer integration packages for Outlit: browser, server, CLI, tool contract, and Pi packages for sending customer signals to Outlit and querying customer context from agent workflows. It is not the hosted remote MCP server implementation; use the canonical Outlit-owned discovery endpoints below for MCP, API, and agent metadata.\n\n## Packages\n\nThis monorepo contains these packages under the `@outlit` scope:\n\n- **[@outlit/core](https://github.com/OutlitAI/outlit-sdk/blob/main/packages/core)** - Core SDK functionality and base client\n- **[@outlit/browser](https://github.com/OutlitAI/outlit-sdk/blob/main/packages/browser)** - Browser-specific SDK with automatic page view tracking\n- **[@outlit/node](https://github.com/OutlitAI/outlit-sdk/blob/main/packages/node)** - Node.js SDK for server-side event tracking\n- **[@outlit/cli](https://github.com/OutlitAI/outlit-sdk/blob/main/packages/cli)** - CLI for Outlit customer intelligence\n- **[@outlit/tools](https://github.com/OutlitAI/outlit-sdk/blob/main/packages/tools)** - Customer intelligence tool contracts and client helpers for API and agent integrations\n- **[@outlit/pi](https://github.com/OutlitAI/outlit-sdk/blob/main/packages/pi)** - Pi package with Outlit customer intelligence tools and skill guidance\n\n## Agent and Crawler Discovery\n\nUse these canonical resources for citations, schema-driven clients, and agent setup instead of copying generated specs or server metadata into this repository:\n\n| Surface | Canonical URL | Purpose |\n|---------|---------------|---------|\n| Developer docs | | SDK, CLI, API, MCP, and customer context documentation |\n| Docs index for agents | | Machine-readable map of documentation pages |\n| Product resource index | | Agent-facing map of SDK packages, docs, API contracts, MCP, CLI, Pi, and skills |\n| OpenAPI spec | | Canonical OpenAPI contract for public API and ingest surfaces |\n| API catalog | | Linkset for API, MCP, OAuth, docs, and support discovery |\n| AI catalog | | Agentic Resource Discovery catalog for Outlit API, MCP, skills, and SDK resources |\n| MCP Registry listing | | Official MCP Registry search surface for `ai.outlit/outlit` |\n| MCP server metadata | | Runtime metadata for the hosted remote MCP server |\n| MCP server card | | Runtime discovery card for the hosted remote MCP server |\n| MCP docs | | Connect remote MCP clients with workspace URLs and OAuth |\n| Agent skills | | Official `outlit` and `outlit-sdk` skill installation guidance |\n\nThe hosted MCP server and OAuth metadata live on `mcp.outlit.ai`; this SDK repo is the public package and developer integration surface.\n\n## Installation\n\nChoose the package that matches the integration surface:\n\n| Package | Install | Use when |\n|---------|---------|----------|\n| `@outlit/browser` | `npm install @outlit/browser` | Browser apps, React, Next.js, Vue, Nuxt, SvelteKit, Angular, Astro, and script-tag tracking |\n| `@outlit/node` | `npm install @outlit/node` | Node.js servers, API routes, jobs, webhooks, CLIs, desktop main processes, and native JavaScript runtimes |\n| `@outlit/core` | `npm install @outlit/core` | Lower-level custom SDK implementations that do not need browser or Node runtime helpers |\n| `@outlit/cli` | `npm install -g @outlit/cli` | Terminal access to Outlit customer intelligence and setup workflows |\n| `@outlit/tools` | `npm install @outlit/tools` | Custom API or agent integrations that need typed Outlit tool gateway contracts and client helpers |\n| `@outlit/pi` | `npm install @outlit/pi` | Pi agents that need Outlit customer intelligence tools and skill guidance |\n| Rust crate | `cargo add outlit` | Rust backends, CLIs, and Tauri backends |\n\nTracking SDK examples:\n\n```bash\n# For browser applications\nnpm install @outlit/browser\n\n# For Node.js applications\nnpm install @outlit/node\n\n# For custom implementations\nnpm install @outlit/core\n```\n\n## Quick Start\n\n### Browser\n\n```typescript\nimport { Outlit } from '@outlit/browser'\n\nconst outlit = new Outlit({\n publicKey: 'pk_xxx',\n trackPageviews: true,\n trackForms: true,\n})\n\n// Identify a user\noutlit.user.identify({\n email: 'user@example.com',\n traits: { name: 'John Doe' },\n customerId: 'cust_123', // Your app's account/workspace/customer ID\n customerTraits: { plan: 'pro' },\n})\n\n// Track events\noutlit.track('button_clicked', {\n button_id: 'signup',\n page: '/homepage',\n})\n\n// Mark billing status on a customer\noutlit.customer.trialing({\n customerId: 'cust_123', // Your app's account/workspace/customer ID\n properties: { plan: 'pro' },\n})\n```\n\n#### Using the singleton API\n\n```typescript\nimport { init, track, user, customer } from '@outlit/browser'\n\n// Initialize once at app startup\ninit({ publicKey: 'pk_xxx' })\n\n// Then use anywhere\ntrack('page_viewed', { page: '/home' })\nuser().identify({\n email: 'user@example.com',\n customerId: 'cust_123', // Your app's account/workspace/customer ID\n})\ncustomer().paid({\n customerId: 'cust_123', // Your app's account/workspace/customer ID\n properties: { plan: 'pro' },\n})\n```\n\n#### Using with React\n\n```tsx\nimport { OutlitProvider, useOutlit } from '@outlit/browser/react'\n\n// Wrap your app\nfunction App() {\n return (\n \n \n \n )\n}\n\n// Use in components\nfunction MyComponent() {\n const { track, user } = useOutlit()\n \n return (\n \n )\n}\n```\n\n### Node.js\n\n```typescript\nimport { Outlit } from '@outlit/node'\n\nconst outlit = new Outlit({\n publicKey: 'pk_xxx',\n})\n\n// Track server-side events (requires identity)\noutlit.track({\n customerId: 'cust_123', // Your app's account/workspace/customer ID\n eventName: 'api_request',\n properties: {\n endpoint: '/api/users',\n method: 'GET',\n status: 200,\n },\n})\n// `customerId`-only track events are valid immediately.\n// When you later call identify() with the same customerId and an email,\n// Outlit can link that account/workspace to the customer resolved from email.\n\n// Identify a user\noutlit.user.identify({\n email: 'user@example.com',\n traits: { plan: 'pro' },\n customerId: 'cust_123', // Your app's account/workspace/customer ID\n customerTraits: { plan: 'pro' },\n})\n\n// Mark customer billing status\noutlit.customer.paid({\n customerId: 'cust_123', // Your app's account/workspace/customer ID\n properties: { plan: 'pro' },\n})\n\n// Flush events before shutdown\nawait outlit.flush()\n```\n\n## Features\n\n- **Modern TypeScript** - Full TypeScript support with type definitions\n- **Tree-shakeable** - Optimized bundle size with dual ESM/CJS exports\n- **Event Queueing** - Automatic batching and flushing of events\n- **Multi-platform** - Separate packages for browser and Node.js\n- **Auto-tracking** - Automatic page view tracking in browser\n- **Middleware Support** - Easy integration with Express and similar frameworks\n- **Persistent Identity** - User and anonymous ID persistence\n- **High Performance** - Minimal overhead and efficient batching\n- **Type Safe** - Full TypeScript support with strict types\n\n## Examples\n\n- **[Pi agents](https://github.com/OutlitAI/outlit-sdk/blob/main/examples/pi-agents)** - Build customer intelligence agents in Pi with `@outlit/pi`\n\n## Development\n\nThis project uses a modern monorepo setup with the following tools:\n\n- **[Bun](https://bun.sh/)** - Fast all-in-one JavaScript runtime and package manager\n- **[Turbo](https://turbo.build/)** - Build system for monorepo orchestration\n- **[TypeScript](https://www.typescriptlang.org/)** - Type-safe JavaScript\n- **[tsup](https://tsup.egoist.dev/)** - Fast TypeScript bundler\n- **[Biome](https://biomejs.dev/)** - Fast linter and formatter\n- **[Playwright](https://playwright.dev/)** - End-to-end testing\n- **[Changesets](https://github.com/changesets/changesets)** - Version management and changelogs\n\n### Setup\n\n```bash\n# Install dependencies\nbun install\n\n# Build all packages\nbun run build\n\n# Run tests\nbun run test\n\n# Lint code\nbun run lint\n\n# Type check\nbun run typecheck\n\n# Format code\nbun run format\n```\n\n### Project Structure\n\n```\noutlit-sdk/\n├── .github/workflows/ # CI/CD workflows\n├── examples/\n│ └── pi-agents/ # Example Pi agents using @outlit/pi\n├── packages/\n│ ├── browser/ # Browser SDK with React bindings\n│ ├── cli/ # Outlit CLI\n│ ├── core/ # Shared types and utilities\n│ ├── node/ # Node.js SDK\n│ ├── pi/ # Pi package for Outlit tools\n│ ├── tools/ # Customer intelligence tool contracts\n│ └── typescript-config/ # Shared TypeScript configs\n├── package.json # Root package with workspace config\n├── bun.lock # Bun lockfile\n├── turbo.json # Turbo build configuration\n└── biome.json # Biome linter/formatter config\n```\n\n### Creating a Changeset\n\nWhen making changes that should be released, create a changeset:\n\n```bash\nbunx changeset\n```\n\nThis will prompt you to:\n1. Select which packages are affected\n2. Choose the version bump type (patch, minor, major)\n3. Write a description of the change\n\nThe changeset file will be committed with your PR and used to generate changelogs on release.\n\n## CI/CD\n\n### Workflows\n\n- **CI** (`ci.yml`) - Runs on PRs: lint, typecheck, build, test\n- **Release** (`release.yml`) - Runs on main: publish canary to npm + CDN, create version PR or publish stable releases\n\n### Required Secrets\n\nFor maintainers setting up the repository:\n\n| Secret | Description |\n|--------|-------------|\n| `NPM_TOKEN` | npm access token with publish permission for `@outlit` scope |\n| `GCP_CREDENTIALS` | Service account JSON key with Storage Object Admin on `cdn.outlit.ai` bucket |\n\n#### Creating NPM_TOKEN\n\n1. Go to [npmjs.com](https://www.npmjs.com/) and sign in\n2. Navigate to Access Tokens → Generate New Token → Granular Access Token\n3. Set permissions: Read and write for `@outlit` packages\n4. Copy the token and add as `NPM_TOKEN` secret in GitHub\n\n#### Creating GCP_CREDENTIALS\n\n1. Go to [Google Cloud Console](https://console.cloud.google.com/)\n2. Navigate to IAM & Admin → Service Accounts\n3. Create a new service account (e.g., `github-actions-deployer`)\n4. Grant \"Storage Object Admin\" role on the `cdn.outlit.ai` bucket\n5. Create a JSON key for the service account\n6. Copy the entire JSON content and add as `GCP_CREDENTIALS` secret in GitHub\n\n### CDN Deployment\n\nThe browser SDK IIFE bundle is deployed to Google Cloud Storage:\n\n| Path | Description |\n|------|-------------|\n| `/canary/outlit.js` | Latest from main branch (5 min cache) |\n| `/stable/outlit.js` | Latest stable release (1 year cache) |\n| `/v{version}/outlit.js` | Immutable versioned release (1 year cache) |\n\n**npm tags:**\n\n| Tag | Description |\n|-----|-------------|\n| `latest` | Stable release (`npm install @outlit/browser`) |\n| `canary` | Latest from main (`npm install @outlit/browser@canary`) |\n\nManual deployment (requires gcloud CLI):\n```bash\ncd packages/browser && bun run deploy:canary # Deploy to canary\ncd packages/browser && bun run deploy:stable # Deploy to stable (requires confirmation)\ncd packages/browser && bun run deploy:version # Deploy versioned release\n```\n\n## Documentation\n\n- [Developer docs](https://docs.outlit.ai)\n- [Browser SDK](https://docs.outlit.ai/tracking/browser/npm)\n- [Node.js SDK](https://docs.outlit.ai/tracking/server/nodejs)\n- [Rust SDK](https://docs.outlit.ai/tracking/server/rust)\n- [API reference](https://docs.outlit.ai/api-reference/introduction)\n- [OpenAPI spec](https://docs.outlit.ai/openapi.json)\n- [MCP integration](https://docs.outlit.ai/ai-integrations/mcp)\n- [Agent skills](https://docs.outlit.ai/ai-integrations/skills)\n\n## Contributing\n\nWe welcome contributions! Please see [CONTRIBUTING.md](https://github.com/OutlitAI/outlit-sdk/blob/main/CONTRIBUTING.md) for guidelines.\n\n## License\n\nApache-2.0 - see [LICENSE](https://github.com/OutlitAI/outlit-sdk/blob/main/LICENSE) for details.\n\n## Support\n\n- Issues: [GitHub Issues](https://github.com/OutlitAI/outlit-sdk/issues)\n- Docs: [Documentation](https://docs.outlit.ai)\n","changelogMarkdown","videoKey","requiredSecretsJson","publishedAt","priceCents","trialDays",0,"categoryDisplayName","AI Agents","upstream",{"_98":99,"_100":101,"_102":103,"_104":105,"_106":107},"requiredSecrets",[],"tags",[],"assets",[],"stats",{"_96":83,"_97":83},"ratingAvg","reviewCount","topics",[30,108,109,110,111],"license","Apache-2.0","language","TypeScript","registryName","ai.outlit/outlit","homepage","https://outlit.ai","customer-intelligence","mcp","model-context-protocol","outlit","ENV",{"_114":115,"_116":117,"_118":119},"ENVIRONMENT","production","TURNSTILE_SITE_KEY","0x4AAAAAAB8-rEI2gNDf_QhU","SENTRY_DSN","https://45fd1229f78089d5c3ee78be128030e1@o4510583261757440.ingest.de.sentry.io/4510584253448272"]