Skip to content

chore(ai): add AGENTS.md and CLAUDE.md to npm package#11760

Closed
lgrammel wants to merge 6 commits intomainfrom
lg/rikqiq1f
Closed

chore(ai): add AGENTS.md and CLAUDE.md to npm package#11760
lgrammel wants to merge 6 commits intomainfrom
lg/rikqiq1f

Conversation

@lgrammel
Copy link
Copy Markdown
Collaborator

@lgrammel lgrammel commented Jan 13, 2026

Background

AI agents can benefit from an AGENTS.md in the npm package that shows how to use the library.

Summary

Add USER-AGENTS.ms with basic patterns for testing the approach.

It is shipped as AGENTS.md (for Cursor) and CLAUDE.md for Claude code.

Manual Verification

Future Work

  • evaluate if this approach helps with maxOutputTokens when generating examples with AI agents
  • add more patterns to AGENTS.md

Related Issues

Resolves #11759

- 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.
@vercel-ai-sdk vercel-ai-sdk bot added the ai/core core functions like generateText, streamText, etc. Provider utils, and provider spec. label Jan 13, 2026
@lgrammel lgrammel changed the title Lg/rikqiq1f chore(ai): add AGENTS.md to npm package Jan 13, 2026
@lgrammel lgrammel marked this pull request as ready for review January 13, 2026 10:39
@lgrammel lgrammel changed the title chore(ai): add AGENTS.md to npm package chore(ai): add AGENTS.md and CLAUDE.md to npm package Jan 13, 2026
@gr2m
Copy link
Copy Markdown
Collaborator

gr2m commented Jan 13, 2026

@lgrammel I assume you still work on this one? The actual changes do not match the title / gitignore updates etc

@gr2m gr2m marked this pull request as draft January 13, 2026 17:34
@lgrammel lgrammel closed this Jan 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ai/core core functions like generateText, streamText, etc. Provider utils, and provider spec.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add AGENTS.md to ai npm package

3 participants