linear-sdk-patterns

Linear TypeScript SDK Patterns

Overview

Keep SDK mechanics inside a bounded adapter and expose domain-shaped results rather than generated model objects throughout the application.

Prerequisites

• The target repository, Linear workspace, environment, and accountable owner
• Current security, privacy, compliance, capacity, and change-control requirements
• An approved Linear credential only when a bounded live verification is necessary

Tool Discipline

Use Read, Glob, and Grep to inspect code, configuration, and evidence. Use WebFetch only for current first-party Linear documentation and package metadata. Use Write or Edit only for requested implementation with known target files. Never write credentials, customer content, unrestricted environment output, or unredacted GraphQL variables.

Current Contract

• Current SDK mutations use verb-first names such as createIssue, updateUser, and archiveProject.
• Connections expose nodes, pageInfo, fetchNext, and fetchPrevious; optional variables are passed in an object.
• linearClient.client.rawRequest supports purpose-built GraphQL, while LinearError exposes parsed request/response/error evidence.

Authentication

Use a personal API key only for owner-controlled scripts, OAuth with PKCE for user-delegated applications, or an enabled client-credentials grant for approved automation. Personal keys use Authorization: <API_KEY>; OAuth tokens use Authorization: Bearer <ACCESS_TOKEN>. Store credentials server-side in an approved secret manager.

Treat app approval, team access, scope changes, credential creation, rotation, revocation, and production access as owner-approved actions.

Instructions

1. Inspect the installed SDK version, generated types, adapter boundary, call sites, and error policy.
2. Create one client per approved auth context and inject it; never construct clients throughout business code.
3. Wrap SDK models in domain functions that accept stable IDs and return minimum typed projections.
4. Paginate every connection explicitly and expose checkpoints for long-running synchronization.
5. Use raw GraphQL only when it measurably reduces fields or fan-out; keep operation names and variables typed.
6. Normalize LinearError and GraphQL partial errors into retryable, terminal, and reconciliation-required outcomes.

Approval Boundaries

Do not create, reveal, rotate, or revoke credentials; authorize an OAuth app; change scopes or team access; create, mutate, archive, or delete workspace data; configure or re-enable webhooks; import or export data; change roles, SCIM, or audit streaming; transmit diagnostics; change paid entitlements; or perform another production mutation without explicit approval from the accountable owner. Keep diagnosis read-only unless implementation was requested.

Output

Return the workspace and team scope, auth mode without credential value, files and contracts inspected, exact operation names, evidence collected, validation result, sensitive fields redacted, remaining risk, accountable owner, approval state, and rollback or next action.

Error Handling

Examples

Use a compact handoff that makes scope, mutation authority, and verification evidence reviewable.

Input:

adapter=issues; operation=listUpdated; page-size=25; checkpoint=cursor

Expected handoff:

client=injected; projection=minimal; pagination=explicit; errors=normalized

Resources

• Skill-specific official documentation
• Linear developer documentation index
• Linear GraphQL API