add-provider-package

Name: add-provider-package
Author: vercel

937installs4.8kforks

How to install add-provider-package?

vercel/ai/add-provider-package

$npx -y skills add vercel/ai --skill add-provider-package

Installs into the current project.

Summary

Guide for adding new AI provider packages to the AI SDK. Use when creating a new @ai-sdk/<provider> package to integrate an AI service into the SDK.

Files · 1

View on GitHub

SKILL.md

1	## Adding a New Provider Package
2
3	This guide covers the process of creating a new `@ai-sdk/<provider>` package to integrate an AI service into the AI SDK.
4
5	## First-Party vs Third-Party Providers
6
7	- Third-party packages: Any provider can create a third-party package. We're happy to link to it from our documentation.
8	- First-party `@ai-sdk/<provider>` packages: If you prefer a first-party package, please create an issue first to discuss.
9
10	## Reference Example
11
12	See https://github.com/vercel/ai/pull/8136/files for a complete example of adding a new provider.
13
14	## Provider Architecture
15
16	The AI SDK uses a layered provider architecture following the adapter pattern:
17
18	1. Specifications (`@ai-sdk/provider`): Defines interfaces like `LanguageModelV4`, `EmbeddingModelV4`, etc.
19	2. Utilities (`@ai-sdk/provider-utils`): Shared code for implementing providers
20	3. Providers (`@ai-sdk/<provider>`): Concrete implementations for each AI service
21	4. Core (`ai`): High-level functions like `generateText`, `streamText`, `generateObject`
22
23	## Step-by-Step Guide
24
25	### 1. Create Package Structure
26
27	Create a new folder `packages/<provider>` with the following structure:
28
29	```
30	packages/<provider>/
31	├── src/
32	│ ├── index.ts # Main exports
33	│ ├── version.ts # Package version
34	│ ├── <provider>-provider.ts # Provider implementation
35	│ ├── <provider>-provider.test.ts
36	│ ├── <provider>-*-options.ts # Model-specific options
37	│ └── <provider>-*-model.ts # Model implementations (e.g., language, embedding, image)
38	├── package.json
39	├── tsconfig.json
40	├── tsconfig.build.json
41	├── tsup.config.ts
42	├── turbo.json
43	├── vitest.node.config.js
44	├── vitest.edge.config.js
45	└── README.md
46	```
47
48	Do not create a `CHANGELOG.md` file. It will be auto-generated.
49
50	### 2. Configure package.json
51
52	Set up your `package.json` with:
53
54	- `"name": "@ai-sdk/<provider>"`
55	- `"version": "0.0.0"` (initial version, will be updated by changeset)
56	- `"type": "module"`
57	- `"license": "Apache-2.0"`
58	- `"sideEffects": false`
59	- Dependencies on `@ai-sdk/provider` and `@ai-sdk/provider-utils` (use `workspace:*`)
60	- Dev dependencies: `@ai-sdk/test-server`, `@types/node`, `@vercel/ai-tsconfig`, `tsup`, `typescript`, `zod`
61	- `"engines": { "node": ">=22" }`
62	- Peer dependency on `zod` (both v3 and v4): `"zod": "^3.25.76 \|\| ^4.1.8"`
63
64	Example package entry point configuration:
65
66	```json
67	{
68	"type": "module",
69	"main": "./dist/index.js",
70	"types": "./dist/index.d.ts",
71	"exports": {
72	"./package.json": "./package.json",
73	".": {
74	"types": "./dist/index.d.ts",
75	"import": "./dist/index.js",
76	"default": "./dist/index.js"
77	}
78	}
79	}
80	```
81
82	### 3. Create TypeScript Configurations
83
84	tsconfig.json:
85
86	```json
87	{
88	"extends": "@vercel/ai-tsconfig/base.json",
89	"include": ["src/*/.ts"],
90	"exclude": ["node_modules", "dist"]
91	}
92	```
93
94	tsconfig.build.json:
95
96	```json
97	{
98	"extends": "./tsconfig.json",
99	"exclude": [
100	"*/.test.ts",
101	"*/.test-d.ts",
102	"**/__snapshots__",
103	"**/__fixtures__"
104	]
105	}
106	```
107
108	### 4. Configure Build Tool (tsup)
109
110	Create `tsup.config.ts`:
111
112	```typescript
113	import { defineConfig } from 'tsup';
114
115	export default defineConfig({
116	entry: ['src/index.ts'],
117	format: ['cjs', 'esm'],
118	dts: true,
119	sourcemap: true,
120	clean: true,
121	});
122	```
123
124	### 5. Configure Test Runners
125
126	Create both `vitest.node.config.js` and `vitest.edge.config.js` (copy from existing provider like `anthropic`).
127
128	### 6. Implement Provider
129
130	Provider implementation pattern:
131
132	```typescript
133	// <provider>-provider.ts
134	import { NoSuchModelError } from '@ai-sdk/provider';
135	import { loadApiKey } from '@ai-sdk/provider-utils';
136
137	export interface ProviderSettings {
138	apiKey?: string;
139	baseURL?: string;
140	// provider-specific settings
141	}
142
143	export class ProviderInstance {
144	readonly apiKey?: string;
145	readonly baseURL?: string;
146
147	constructor(options: ProviderSettings = {}) {
148	this.apiKey = options.apiKey;
149	this.baseURL = options.baseURL;
150	}
151
152	private get baseConfig() {
153	return {
154	apiKey: () =>
155	loadApiKey({
156	apiKey: this.apiKey,
157	environmentVariableName: 'PROVIDER_API_KEY',
158	description: 'Provider API key',
159	}),
160	baseURL: this.baseURL ?? 'https://api.provider.com',
161	};
162	}
163
164	languageModel(modelId: string) {
165	return new ProviderLanguageModel(modelId, this.baseConfig);
166	}
167
168	// Shorter alias
169	chat(modelId: string) {
170	return this.languageModel(modelId);
171	}
172	}
173
174	// Export default instance
175	export const providerName = new ProviderInstance();
176	```
177
178	### 7. Implement Model Classes
179
180	Each model type (language, embedding, image, etc.) should implement the appropriate interface from `@ai-sdk/provider`:
181
182	- `LanguageModelV4` for text generation models
183	- `EmbeddingModelV4` for embe

People who liked this also viewed

6 picks

Type

hyperframes-cliUse the HyperFrames CLI development loop: init, add, catalog, capture, lint, check, snapshot, compare, grade-compare, preview, play, present, beats, keyframes, single or batch render, publish, cloud, SkillsJul 2026262k37k
request-refactor-planSkills for Real Engineers. Straight from my .agents directory.SkillsJul 2026165k181k
analyze-projectRigor Analyze / Rigor Audit read-only skill for deep learning research repositories. Use when the user wants to read and understand a repository, inspect model structure and training or inference entrSkillsMay 2026161k507
explore-codeRigor Improve implementation leaf skill for auditable candidate implementation in deep learning research repositories. Use when the researcher explicitly authorizes exploratory work on an isolated braSkillsMay 2026161k507
ubiquitous-languageSkills for Real Engineers. Straight from my .agents directory.SkillsJul 2026160k181k
scaffold-exercisesSkills for Real Engineers. Straight from my .agents directory.SkillsJul 2026149k181k

add-provider-package

937installs4.8kforks

View on GitHub

How to install add-provider-package?

vercel/ai/add-provider-package

$npx -y skills add vercel/ai --skill add-provider-package

Installs into the current project.

Summary

Guide for adding new AI provider packages to the AI SDK. Use when creating a new @ai-sdk/<provider> package to integrate an AI service into the SDK.

Files · 1

View on GitHub

SKILL.md

1	## Adding a New Provider Package
2
3	This guide covers the process of creating a new `@ai-sdk/<provider>` package to integrate an AI service into the AI SDK.
4
5	## First-Party vs Third-Party Providers
6
7	- Third-party packages: Any provider can create a third-party package. We're happy to link to it from our documentation.
8	- First-party `@ai-sdk/<provider>` packages: If you prefer a first-party package, please create an issue first to discuss.
9
10	## Reference Example
11
12	See https://github.com/vercel/ai/pull/8136/files for a complete example of adding a new provider.
13
14	## Provider Architecture
15
16	The AI SDK uses a layered provider architecture following the adapter pattern:
17
18	1. Specifications (`@ai-sdk/provider`): Defines interfaces like `LanguageModelV4`, `EmbeddingModelV4`, etc.
19	2. Utilities (`@ai-sdk/provider-utils`): Shared code for implementing providers
20	3. Providers (`@ai-sdk/<provider>`): Concrete implementations for each AI service
21	4. Core (`ai`): High-level functions like `generateText`, `streamText`, `generateObject`
22
23	## Step-by-Step Guide
24
25	### 1. Create Package Structure
26
27	Create a new folder `packages/<provider>` with the following structure:
28
29	```
30	packages/<provider>/
31	├── src/
32	│ ├── index.ts # Main exports
33	│ ├── version.ts # Package version
34	│ ├── <provider>-provider.ts # Provider implementation
35	│ ├── <provider>-provider.test.ts
36	│ ├── <provider>-*-options.ts # Model-specific options
37	│ └── <provider>-*-model.ts # Model implementations (e.g., language, embedding, image)
38	├── package.json
39	├── tsconfig.json
40	├── tsconfig.build.json
41	├── tsup.config.ts
42	├── turbo.json
43	├── vitest.node.config.js
44	├── vitest.edge.config.js
45	└── README.md
46	```
47
48	Do not create a `CHANGELOG.md` file. It will be auto-generated.
49
50	### 2. Configure package.json
51
52	Set up your `package.json` with:
53
54	- `"name": "@ai-sdk/<provider>"`
55	- `"version": "0.0.0"` (initial version, will be updated by changeset)
56	- `"type": "module"`
57	- `"license": "Apache-2.0"`
58	- `"sideEffects": false`
59	- Dependencies on `@ai-sdk/provider` and `@ai-sdk/provider-utils` (use `workspace:*`)
60	- Dev dependencies: `@ai-sdk/test-server`, `@types/node`, `@vercel/ai-tsconfig`, `tsup`, `typescript`, `zod`
61	- `"engines": { "node": ">=22" }`
62	- Peer dependency on `zod` (both v3 and v4): `"zod": "^3.25.76 \|\| ^4.1.8"`
63
64	Example package entry point configuration:
65
66	```json
67	{
68	"type": "module",
69	"main": "./dist/index.js",
70	"types": "./dist/index.d.ts",
71	"exports": {
72	"./package.json": "./package.json",
73	".": {
74	"types": "./dist/index.d.ts",
75	"import": "./dist/index.js",
76	"default": "./dist/index.js"
77	}
78	}
79	}
80	```
81
82	### 3. Create TypeScript Configurations
83
84	tsconfig.json:
85
86	```json
87	{
88	"extends": "@vercel/ai-tsconfig/base.json",
89	"include": ["src/*/.ts"],
90	"exclude": ["node_modules", "dist"]
91	}
92	```
93
94	tsconfig.build.json:
95
96	```json
97	{
98	"extends": "./tsconfig.json",
99	"exclude": [
100	"*/.test.ts",
101	"*/.test-d.ts",
102	"**/__snapshots__",
103	"**/__fixtures__"
104	]
105	}
106	```
107
108	### 4. Configure Build Tool (tsup)
109
110	Create `tsup.config.ts`:
111
112	```typescript
113	import { defineConfig } from 'tsup';
114
115	export default defineConfig({
116	entry: ['src/index.ts'],
117	format: ['cjs', 'esm'],
118	dts: true,
119	sourcemap: true,
120	clean: true,
121	});
122	```
123
124	### 5. Configure Test Runners
125
126	Create both `vitest.node.config.js` and `vitest.edge.config.js` (copy from existing provider like `anthropic`).
127
128	### 6. Implement Provider
129
130	Provider implementation pattern:
131
132	```typescript
133	// <provider>-provider.ts
134	import { NoSuchModelError } from '@ai-sdk/provider';
135	import { loadApiKey } from '@ai-sdk/provider-utils';
136
137	export interface ProviderSettings {
138	apiKey?: string;
139	baseURL?: string;
140	// provider-specific settings
141	}
142
143	export class ProviderInstance {
144	readonly apiKey?: string;
145	readonly baseURL?: string;
146
147	constructor(options: ProviderSettings = {}) {
148	this.apiKey = options.apiKey;
149	this.baseURL = options.baseURL;
150	}
151
152	private get baseConfig() {
153	return {
154	apiKey: () =>
155	loadApiKey({
156	apiKey: this.apiKey,
157	environmentVariableName: 'PROVIDER_API_KEY',
158	description: 'Provider API key',
159	}),
160	baseURL: this.baseURL ?? 'https://api.provider.com',
161	};
162	}
163
164	languageModel(modelId: string) {
165	return new ProviderLanguageModel(modelId, this.baseConfig);
166	}
167
168	// Shorter alias
169	chat(modelId: string) {
170	return this.languageModel(modelId);
171	}
172	}
173
174	// Export default instance
175	export const providerName = new ProviderInstance();
176	```
177
178	### 7. Implement Model Classes
179
180	Each model type (language, embedding, image, etc.) should implement the appropriate interface from `@ai-sdk/provider`:
181
182	- `LanguageModelV4` for text generation models
183	- `EmbeddingModelV4` for embe

People who liked this also viewed

6 picks

Type