tinybird-typescript-sdk-guidelines
by tinybirdcotinybird-typescript-sdk-guidelines helps backend developers install, configure, and use @tinybirdco/sdk for type-safe Tinybird datasources, pipes, endpoints, connections, and typed clients in TypeScript projects. Includes migration from legacy .datasource and .pipe files plus dev, build, and deploy workflow guidance.
This skill scores 82/100, which makes it a solid directory listing for users who work with Tinybird TypeScript projects. The repository shows a real, triggerable workflow for defining datasources, pipes, typed clients, connections, and deployment commands, so users can judge install fit with useful confidence even though it is documentation-led rather than tool-backed.
- Clear trigger scope for @tinybirdco/sdk, TypeScript Tinybird projects, typed clients, and migration from legacy .datasource/.pipe files.
- Operational guidance is concrete: init, dev, build, deploy, preview, migrate, and config patterns are documented.
- Good workflow coverage across datasources, endpoints, connections, materialized views, copy/sink pipes, and token handling.
- No install command in SKILL.md and no scripts/resources files, so users must rely on docs alone to execute correctly.
- The repo is guidance-heavy with limited practical examples beyond snippets, which may leave some implementation edge cases to the agent.
Overview of tinybird-typescript-sdk-guidelines skill
What this skill is for
The tinybird-typescript-sdk-guidelines skill helps you work with @tinybirdco/sdk in TypeScript projects where Tinybird resources are defined as code. It is best for backend developers who need type-safe datasources, pipes, endpoints, connections, and typed clients without guessing at Tinybird syntax or deployment flow.
What users usually need
Most people install the tinybird-typescript-sdk-guidelines skill to move faster on one of three jobs: define new Tinybird resources correctly, migrate legacy .datasource and .pipe files into TypeScript, or avoid breaking changes while using tinybird dev, tinybird build, and tinybird deploy.
Why this skill is different
This skill is not just a repo skim. It concentrates the practical rules that matter for adoption: supported config formats, CLI workflow, server-side-only constraints, branch-safe development, and the specific resource patterns Tinybird expects in TypeScript.
How to Use tinybird-typescript-sdk-guidelines skill
Install and confirm fit
Install the tinybird-typescript-sdk-guidelines skill with npx skills add tinybirdco/tinybird-agent-skills --skill tinybird-typescript-sdk-guidelines. Before you use it, make sure your project is actually a Tinybird TypeScript workflow: Node.js 20+, TypeScript 4.9+, and server-side execution only. This is the right skill when your prompt involves @tinybirdco/sdk, not a generic SQL or API client task.
Start from the right files
Read SKILL.md first, then use the rule files that match your task:
rules/getting-started.mdfor setup and project shaperules/configuration.mdfortinybird.config.*rules/defining-datasources.mdandrules/defining-endpoints.mdfor resource authoringrules/typed-client.mdfor generated client usagerules/cli-commands.mdfortinybird init,dev,build,deploy, andmigrate
If your task touches external data, also check rules/connections.md, rules/materialized-views.md, rules/copy-sink-pipes.md, and rules/tokens.md.
Turn a rough goal into a useful prompt
Give the skill a concrete target, repository context, and deployment constraint. Strong inputs mention the resource type, where the file should live, and whether you are migrating or starting fresh.
Example: “Create a TypeScript Tinybird datasource for event ingestion in src/tinybird/datasources.ts, use mergeTree, add nullable country, and keep it compatible with branch dev mode.”
Weak input: “Set up Tinybird.”
Follow the workflow that matters
Use tinybird init for new projects, tinybird migrate for legacy file conversion, tinybird dev for iterative sync, tinybird build for validation, and tinybird deploy only when you are ready for production. The tinybird-typescript-sdk-guidelines guide is especially useful when you need to keep dev and deploy targets separate through devMode.
tinybird-typescript-sdk-guidelines skill FAQ
Is this skill only for backend development?
Yes. The tinybird-typescript-sdk-guidelines for Backend Development use case is the intended fit. It should not be used for browser code, since tokens must stay server-side.
Do I need the skill if I already know Tinybird?
If you know Tinybird but need reliable TypeScript definitions, typed output, or safe migration from legacy files, the skill still adds value. It reduces time spent checking the exact config shape, CLI command, and resource definition pattern.
How does it differ from a normal prompt?
A normal prompt may produce plausible Tinybird advice. This skill gives you the repo-backed rules for installation, config, resource definitions, and command flow, which lowers the risk of generating code that looks right but fails in real projects.
When should I not use it?
Do not use the tinybird-typescript-sdk-guidelines skill if your task is unrelated to Tinybird, if you only need a general SQL explanation, or if you are building a frontend-only feature that cannot safely hold tokens.
How to Improve tinybird-typescript-sdk-guidelines skill
Provide the exact resource shape
The best outputs come from naming the resource and its constraints up front: datasource, endpoint, connection, materialized view, copy pipe, or sink pipe. Include schema fields, sort keys, params, schedule, and whether the target is branch, local, or production.
Include repository and migration context
If the skill is working against an existing codebase, tell it where the files live and what already exists. For example: “Migrate tinybird/**/*.datasource and tinybird/**/*.pipe into src/tinybird/*.ts, preserve current names, and keep mixed-format compatibility during rollout.” That is much better than asking for a generic migration plan.
Watch for the common failure modes
The most common mistakes are exposing tokens in client code, skipping tinybird.config.*, mixing up devMode behavior, or omitting the type details that drive inference. If the first output is too broad, ask for a narrower artifact: one datasource file, one endpoint, or one CLI-ready migration step.
Iterate with validation in mind
After the first draft, ask for the next concrete checkpoint: a corrected config, a stronger schema, a safer query, or a deployment checklist. For the tinybird-typescript-sdk-guidelines guide, the fastest improvement loop is: define one resource, validate with tinybird build, then refine based on the exact error or missing type inference.