---
name: tinybird-typescript-sdk-guidelines
description: Tinybird TypeScript SDK for defining datasources, pipes, and queries with full type inference. Use when working with @tinybirdco/sdk, TypeScript Tinybird…
---

# tinybird-typescript-sdk-guidelines

Tinybird TypeScript SDK for defining datasources, pipes, and queries with full type inference. Use when working with @tinybirdco/sdk, TypeScript Tinybird…

# tinybird-typescript-sdk-guidelinesby tinybirdco
Tinybird TypeScript SDK for defining datasources, pipes, and queries with full type inference. Use when working with @tinybirdco/sdk, TypeScript Tinybird…

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

## 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

## More skills from tinybirdco
tinybirdby tinybirdcoTinybird configuration rules, SQL patterns, and optimization guidance for datasources, pipes, endpoints, and materialized views. Covers 13 rule categories including project structure, datasource and pipe design, endpoint schemas, materialized views, copy pipes, connections, SQL best practices, and deduplication patterns Emphasizes local files as source of truth, MergeTree as default table engine, and SELECT-only SQL with strict parameter handling Provides optimization strategies: filter...tinybird-cli-guidelinesby tinybirdcoTinybird CLI commands, workflows, and operations. Use when running tb commands, managing local development, deploying, or working with data operations.tinybird-python-sdk-guidelinesby tinybirdcoTinybird Python SDK for defining datasources, pipes, and queries in Python. Use when working with tinybird-sdk, Python Tinybird projects, or data ingestion and…

---

**Source**: https://github.com/tinybirdco/tinybird-agent-skills/tree/HEAD/skills/tinybird-typescript-sdk-guidelines
**Author**: tinybirdco
**Discovered via**: mcpservers.org