From a73276a810ef1d01c68935e406d324b93d0d8cef Mon Sep 17 00:00:00 2001 From: Lars Grammel Date: Tue, 13 Jan 2026 11:18:49 +0100 Subject: [PATCH 1/6] 1 --- packages/ai/USAGE-AGENTS.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 packages/ai/USAGE-AGENTS.md diff --git a/packages/ai/USAGE-AGENTS.md b/packages/ai/USAGE-AGENTS.md new file mode 100644 index 000000000000..e06907fffa37 --- /dev/null +++ b/packages/ai/USAGE-AGENTS.md @@ -0,0 +1 @@ +## AI SDK Usage From 51b05ec40ec188eaebf5a56f6b4abb7865a18cb7 Mon Sep 17 00:00:00 2001 From: Lars Grammel Date: Tue, 13 Jan 2026 11:22:35 +0100 Subject: [PATCH 2/6] feat: add AGENTS.md file generation during build process - Implemented a new build step to copy USAGE-AGENTS.md to AGENTS.md for inclusion in the published package. - Updated package.json to include AGENTS.md in the files list. - Added AGENTS.md to .gitignore to prevent it from being tracked in version control. --- .gitignore | 3 +++ packages/ai/package.json | 1 + packages/ai/tsup.config.ts | 5 +++++ 3 files changed, 9 insertions(+) diff --git a/.gitignore b/.gitignore index 872e0184f838..d9966be841a9 100644 --- a/.gitignore +++ b/.gitignore @@ -16,3 +16,6 @@ tsconfig.vitest-temp.json *.log *.local *.tsbuildinfo + +# Generated files +packages/ai/AGENTS.md diff --git a/packages/ai/package.json b/packages/ai/package.json index f1fbc4732439..0c4722ff5870 100644 --- a/packages/ai/package.json +++ b/packages/ai/package.json @@ -9,6 +9,7 @@ "types": "./dist/index.d.ts", "files": [ "dist/**/*", + "AGENTS.md", "CHANGELOG.md", "internal.d.ts", "README.md", diff --git a/packages/ai/tsup.config.ts b/packages/ai/tsup.config.ts index d3c2ec813e04..17f50ae39613 100644 --- a/packages/ai/tsup.config.ts +++ b/packages/ai/tsup.config.ts @@ -1,3 +1,4 @@ +import { copyFileSync } from 'node:fs'; import { defineConfig } from 'tsup'; export default defineConfig([ @@ -16,6 +17,10 @@ export default defineConfig([ .version, ), }, + onSuccess: async () => { + // Copy USAGE-AGENTS.md to AGENTS.md for inclusion in the published package + copyFileSync('USAGE-AGENTS.md', 'AGENTS.md'); + }, }, // Internal APIs { From 35821b6406bf4acd30ea8061c538913902930a57 Mon Sep 17 00:00:00 2001 From: Lars Grammel Date: Tue, 13 Jan 2026 11:32:40 +0100 Subject: [PATCH 3/6] 2 --- packages/ai/USAGE-AGENTS.md | 58 ++++++++++++++++++++++++++++++++++++- 1 file changed, 57 insertions(+), 1 deletion(-) diff --git a/packages/ai/USAGE-AGENTS.md b/packages/ai/USAGE-AGENTS.md index e06907fffa37..75144e8f8cd7 100644 --- a/packages/ai/USAGE-AGENTS.md +++ b/packages/ai/USAGE-AGENTS.md @@ -1 +1,57 @@ -## AI SDK Usage +# AI SDK Usage + +## Use Cases + +### Generating Text + +#### text prompt + +```ts +import { generateText } from 'ai'; + +const result = await generateText({ + model: 'openai/gpt-5', + prompt: 'Invent a new holiday.', // text prompt +}); + +const text = result.text; // access generated text +``` + +#### Specifying the maximum number of tokens to generate + +```ts +import { generateText } from 'ai'; + +const result = await generateText({ + model: 'openai/gpt-5', + prompt: 'Invent a new holiday.', + maxOutputTokens: 100, // maximum number of tokens to generate +}); +``` + +### Streaming Text + +#### text prompt and text stream + +```ts +import { streamText } from 'ai'; + +const result = streamText({ + model: 'openai/gpt-5', + prompt: 'Invent a new holiday.', // text prompt +}); + +const textStream = result.textStream; // access text stream +``` + +#### Specifying the maximum number of tokens to generate + +```ts +import { streamText } from 'ai'; + +const result = await streamText({ + model: 'openai/gpt-5', + prompt: 'Invent a new holiday.', + maxOutputTokens: 100, // maximum number of tokens to generate +}); +``` From eade40887344f5e589d2a47470c8990fce3ca78d Mon Sep 17 00:00:00 2001 From: Lars Grammel Date: Tue, 13 Jan 2026 11:36:20 +0100 Subject: [PATCH 4/6] cs --- .changeset/popular-dingos-doubt.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .changeset/popular-dingos-doubt.md diff --git a/.changeset/popular-dingos-doubt.md b/.changeset/popular-dingos-doubt.md new file mode 100644 index 000000000000..232824ebe341 --- /dev/null +++ b/.changeset/popular-dingos-doubt.md @@ -0,0 +1,5 @@ +--- +'ai': patch +--- + +chore(ai): add AGENTS.md to npm package From f123dca766ffe0afc007f73669703360a8527431 Mon Sep 17 00:00:00 2001 From: Lars Grammel Date: Tue, 13 Jan 2026 13:19:07 +0100 Subject: [PATCH 5/6] c --- .gitignore | 1 + packages/ai/package.json | 1 + packages/ai/tsup.config.ts | 3 ++- 3 files changed, 4 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index d9966be841a9..c0de87a7f505 100644 --- a/.gitignore +++ b/.gitignore @@ -19,3 +19,4 @@ tsconfig.vitest-temp.json # Generated files packages/ai/AGENTS.md +packages/ai/CLAUDE.md \ No newline at end of file diff --git a/packages/ai/package.json b/packages/ai/package.json index 0c4722ff5870..6ffc37435886 100644 --- a/packages/ai/package.json +++ b/packages/ai/package.json @@ -11,6 +11,7 @@ "dist/**/*", "AGENTS.md", "CHANGELOG.md", + "CLAUDE.md", "internal.d.ts", "README.md", "test.d.ts" diff --git a/packages/ai/tsup.config.ts b/packages/ai/tsup.config.ts index 17f50ae39613..4863ae8113d6 100644 --- a/packages/ai/tsup.config.ts +++ b/packages/ai/tsup.config.ts @@ -18,8 +18,9 @@ export default defineConfig([ ), }, onSuccess: async () => { - // Copy USAGE-AGENTS.md to AGENTS.md for inclusion in the published package + // Copy USAGE-AGENTS.md to AGENTS.md and CLAUDE.md for inclusion in the published package copyFileSync('USAGE-AGENTS.md', 'AGENTS.md'); + copyFileSync('USAGE-AGENTS.md', 'CLAUDE.md'); }, }, // Internal APIs From 0219f5681a5f1a9fce0f43e40cb2b2364f1bc290 Mon Sep 17 00:00:00 2001 From: Lars Grammel Date: Tue, 13 Jan 2026 13:19:39 +0100 Subject: [PATCH 6/6] 1 --- .changeset/popular-dingos-doubt.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.changeset/popular-dingos-doubt.md b/.changeset/popular-dingos-doubt.md index 232824ebe341..996809f5f772 100644 --- a/.changeset/popular-dingos-doubt.md +++ b/.changeset/popular-dingos-doubt.md @@ -2,4 +2,4 @@ 'ai': patch --- -chore(ai): add AGENTS.md to npm package +chore(ai): add AGENTS.md and CLAUDE.md to npm package