TypeScript/JavaScript SDK patterns and best practices for Linear. Use when learning SDK idioms, implementing common patterns, or optimizing Linear API usage. Trigger with phrases like "linear SDK...
Keep SDK mechanics inside a bounded adapter and expose domain-shaped results rather than generated model objects throughout the application.
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.
createIssue, updateUser, and archiveProject.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.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.
LinearError and GraphQL partial errors into retryable, terminal, and reconciliation-required outcomes.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.
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.
| Condition | Response |
|---|---|
| Method missing | Compare code with the installed generated SDK and the verb-first mutation contract. |
| Connection truncated | Follow pageInfo or SDK page helpers until the required boundary is reached. |
| Model leaks across layers | Map it to a stable application-owned type at the adapter boundary. |
| Raw query drifts | Validate against current introspection/generated schema and add a contract test. |
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