tinybird-typescript-sdk-guidelines — Claude Code data skill
Provides guidelines for modeling Tinybird datasources, queries, and pipes via @tinybirdco/sdk with strict type inference. Useful when migrating from legacy configurations.
npx skills add tinybirdco/tinybird-agent-skills --skill tinybird-typescript-sdk-guidelines -a claude-codeWhat tinybird-typescript-sdk-guidelines does
This skill supplies architectural rules for the @tinybirdco/sdk library. It helps agents build typed query clients, define materialized views, and declare copy or sink pipes. It also provides reference patterns for external connections such as Kafka, Amazon S3, and Google Cloud Storage.
The guidelines detail standard CLI workflows. You initialize projects with npx tinybird init, run local branch development using tinybird dev, compile with tinybird build, and ship changes via tinybird deploy. For continuous integration checks, it specifies tinybird preview.
The SDK runs exclusively in server environments. Exposing access tokens inside client-side web bundles creates an immediate security hazard.
What it helps with
- convert legacy
.datasourceand.pipefiles to TypeScript - set up typed data ingestion and query clients
- configure storage connectors for S3, GCS, or Kafka
- define materialized views and copy pipes in code
Example prompts for the agent
- Convert our legacy
analytics.datasourcedefinition into a TypeScript schema - Create a typed client to query the active users endpoint
- Configure a Kafka connection and sink pipe using
@tinybirdco/sdk
How to install tinybird-typescript-sdk-guidelines
1Skills CLI (Vercel)
npx skills add tinybirdco/tinybird-agent-skills --skill tinybird-typescript-sdk-guidelines -a claude-code2Manually: put the files in place
~/.claude/skills/tinybird-typescript-sdk-guidelines/SKILL.mdCopy the whole skill folder; for one project use .claude/skills/tinybird-typescript-sdk-guidelines/
1Skills CLI (Vercel)
npx skills add tinybirdco/tinybird-agent-skills --skill tinybird-typescript-sdk-guidelines -a codex2Manually: put the files in place
.agents/skills/tinybird-typescript-sdk-guidelines/SKILL.mdFor all projects use ~/.agents/skills/
1Skills CLI (Vercel)
npx skills add tinybirdco/tinybird-agent-skills --skill tinybird-typescript-sdk-guidelines -a cursor2Manually: put the files in place
.cursor/skills/tinybird-typescript-sdk-guidelines/SKILL.mdCursor also reads .agents/skills/ and .claude/skills/
1GitHub CLI
gh skill install tinybirdco/tinybird-agent-skills tinybird-typescript-sdk-guidelines2Manually: put the files in place
.github/skills/tinybird-typescript-sdk-guidelines/SKILL.md1Skills CLI (Vercel)
npx skills add tinybirdco/tinybird-agent-skills --skill tinybird-typescript-sdk-guidelines -a gemini-cli2Platform CLI
gemini skills install https://github.com/tinybirdco/tinybird-agent-skills --path skills/tinybird-typescript-sdk-guidelinesManually: put the files in place
.devin/skills/tinybird-typescript-sdk-guidelines/SKILL.mdThe legacy .windsurf/skills/ path still works
Skills CLI (Vercel)
npx skills add tinybirdco/tinybird-agent-skills --skill tinybird-typescript-sdk-guidelines -a opencodeClaude.ai
Zip the folder and upload it in Settings → Capabilities → Skills
Step by step, with commands for each platform: How to install skills in Claude Code: five ways
Questions about tinybird-typescript-sdk-guidelines
How to install tinybird-typescript-sdk-guidelines in Claude Code?
Run npx skills add tinybirdco/tinybird-agent-skills --skill tinybird-typescript-sdk-guidelines -a claude-code. The tool downloads the skill rules into your environment.
What does tinybird-typescript-sdk-guidelines do?
It guides coding agents to write valid TypeScript schemas, endpoints, and deployment configurations for Tinybird with complete type inference.
Can I run queries through this SDK on the frontend?
No, runtime execution must stay on the backend. Tinybird access tokens must never leak into client web browsers.