tinybird-typescript-sdk-guidelines

backendtinybirdco

Tinybird TypeScript SDK for defining datasources, pipes, and queries with full type inference. Use when working with @tinybirdco/sdk, TypeScript Tinybird projects, or type-safe data ingestion and queries.

Install

npx skills add https://github.com/tinybirdco/tinybird-agent-skills --skill tinybird-typescript-sdk-guidelines

SKILL.md

---name: tinybird-typescript-sdk-guidelinesdescription: Tinybird TypeScript SDK for defining datasources, pipes, and queries with full type inference. Use when working with @tinybirdco/sdk, TypeScript Tinybird projects, or type-safe data ingestion and queries.---

Tinybird TypeScript SDK Guidelines

Guidance for using the @tinybirdco/sdk package to define Tinybird resources in TypeScript with complete type inference.

When to Apply

Installing or configuring @tinybirdco/sdk
Defining datasources or pipes in TypeScript
Creating typed Tinybird clients
Using type-safe ingestion or queries
Running tinybird dev/build/deploy commands for TypeScript projects
Migrating from legacy .datasource/.pipe files to TypeScript
Defining connections (Kafka, S3, GCS)
Creating materialized views, copy pipes, or sink pipes

Rule Files

rules/getting-started.md
rules/configuration.md
rules/defining-datasources.md
rules/defining-endpoints.md
rules/typed-client.md
rules/low-level-api.md
rules/cli-commands.md
rules/connections.md
rules/materialized-views.md
rules/copy-sink-pipes.md
rules/tokens.md

Quick Reference

Install: npm install @tinybirdco/sdk
Initialize: npx tinybird init
Dev mode: tinybird dev (uses configured devMode, typically branch)
Build: tinybird build (builds against configured dev target)
Deploy: tinybird deploy (deploys to main/production)
Preview in CI: tinybird preview
Server-side only; never expose tokens in browsers

Related skills

entra-app-registrationmicrosoft606KGuides Microsoft Entra ID app registration, OAuth 2.0 authentication, and MSAL integration. USE FOR: create app registration, register Azure AD app, configure OAuth, set up authentication, add API permissions, generate service principal, MSAL example, console app auth, Entra ID setup, Azure AD authentication. DO NOT USE FOR: Key Vault secrets (use azure-keyvault-expiration-audit), general Azure resource security guidance.azure-messagingmicrosoft595KTroubleshoot and resolve issues with Azure Messaging SDKs for Event Hubs and Service Bus. Covers connection failures, authentication errors, message processing issues, and SDK configuration problems. WHEN: event hub SDK error, service bus SDK issue, messaging connection failure, AMQP error, event processor host issue, message lock lost, message lock expired, lock renewal, lock renewal batch, send timeout, receiver disconnected, SDK troubleshooting, azure messaging SDK, event hub consumer, servic entra-agent-idmicrosoft328KProvision Microsoft Entra Agent Identity Blueprints, BlueprintPrincipals, and per-instance Agent Identities via Microsoft Graph, and configure OAuth 2.0 token exchange (fmi_path, OBO, cross-tenant) including the Microsoft Entra SDK for AgentID sidecar. USE FOR: Agent Identity Blueprint, BlueprintPrincipal, agent OAuth, fmi_path token exchange, agent OBO, Workload Identity Federation for agents, polyglot agent auth, Microsoft.Identity.Web.AgentIdentities. DO NOT USE FOR: standard Entra app regist supabasesupabase298KUse when doing ANY task involving Supabase. Triggers: Supabase products (Database, Auth, Edge Functions, Realtime, Storage, Vectors, Cron, Queues); client libraries and SSR integrations (supabase-js, @supabase/ssr) in Next.js, React, SvelteKit, Astro, Remix; auth issues (login, logout, sessions, JWT, cookies, getSession, getUser, getClaims, RLS); Supabase CLI or MCP server; schema changes, migrations, declarative schemas, security audits, Postgres extensions (pg_graphql, pg_cron, pg_vector); deb