[duplicate] feat(ai): add AGENTS.md to npm package#11774
Closed
kairosci wants to merge 3 commits intovercel:mainfrom
Closed
[duplicate] feat(ai): add AGENTS.md to npm package#11774kairosci wants to merge 3 commits intovercel:mainfrom
kairosci wants to merge 3 commits intovercel:mainfrom
Conversation
vercel-ai-sdk
bot
added
the
maintenance
![vercel[bot]](https://avatars.githubusercontent.com/in/8329?s=60&v=4){kind=small}
This commit updates the AGENTS.md file to focus on how to use the AI SDK, not how to develop it. This is based on the feedback from the community and the tracking issue for common AI agent mistakes. Fixes vercel#11759 Fixes vercel#11723
kairosci
force-pushed
the
feature/add-agents-md-to-npm-package
branch
from
dd274b4 to
f9d4856
Compare
kairosci
force-pushed
the
feature/add-agents-md-to-npm-package
branch
2 times, most recently
from
8670915 to
aed9b69
Compare
Moves AGENTS.md to packages/ai/ so it is included in the published npm package. Closes vercel#11759 Related to vercel#11723
kairosci
force-pushed
the
feature/add-agents-md-to-npm-package
branch
from
210c8ba to
296823d
Compare
Collaborator
|
there's already a PR in flight for this (#11760) - so marking this as closed! |
kairosci
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Background
LLM agents and AI coding assistants frequently hallucinate when using the AI SDK by attempting to use deprecated or removed APIs (like
maxTokens,maxSteps, orgenerateObject). Providing a dedicatedAGENTS.mdfile within the published package helps these agents understand the correct modern API usage patterns.Summary
AGENTS.mdfrom the repository root topackages/ai/AGENTS.mdto ensure inclusion in the npm package.AGENTS.mdwith a comprehensive list of common mistakes and their corrections for both AI SDK Core and UI.aipackage.Manual Verification
packages/ai/package.jsonincludesAGENTS.mdin thefilesarray.pnpm prettier --check packages/ai/AGENTS.mdto confirm correct formatting.Checklist
pnpm changesetin the project root)Related Issues
Fixes #11759
Related to #11723