Skip to content

docs(ai-anthropic): add package README - #1443

Merged
AlemTuzlak merged 1 commit into
TanStack:mainfrom
changbaebang:docs-ai-anthropic-readme
Sep 22, 2026
Merged

AlemTuzlak merged 1 commit into
TanStack:mainfrom
changbaebang:docs-ai-anthropic-readme

Conversation

@changbaebang

@changbaebang changbaebang commented Sep 21, 2026

Copy link
Copy Markdown
Contributor

🎯 Changes

@tanstack/ai-anthropic ships without a README.md, so its npm page is empty. This adds one in the shape of the other adapter READMEs (ai-groq, ai-mistral): setup, chat, explicit API key, tools, adaptive thinking (with a pointer to the per-model rules rather than restating them), prompt caching, summarization, the eight provider tools with the webSearchTool example, Claude on Vertex via @tanstack/ai-anthropic/vertex, a feature list, and links.

Every snippet is lifted from docs/adapters/anthropic.md; the factories and the eight tools are checked against src/index.ts and src/tools/index.ts. Same series as #1417 / #1434 / #1436 / #1437 / #1442.

Patch changeset included so the README reaches npm.

✅ Checklist

  • I have followed the steps in the Contributing guide.
  • I have tested code changes locally with pnpm run test:pr, or these tests do not apply to this pull request.
  • I fully understand the code in this pull request, including any code generated with AI assistance.
  • Docs: I updated docs/ for this change, or this change is not user-facing.
  • Changeset: I added a changeset (pnpm changeset), or this PR does not change a published package.

🚀 Release Impact

  • This change affects published code, and I have generated a changeset.
  • This change is docs/CI/dev-only (no release).

Summary by CodeRabbit

  • Documentation
    • Added comprehensive documentation for the Anthropic AI package.
    • Documented installation, environment setup, Claude chat usage, tool calling, thinking modes, prompt caching, summarization, and Vertex AI support.
    • Added examples and references for supported provider tools and configuration options.
    • Added links to related documentation.

The package had no README, so its npm page was empty. Same shape as the
other adapter READMEs; every snippet comes from docs/adapters/anthropic.md.
@coderabbitai

coderabbitai Bot commented Sep 21, 2026

Copy link
Copy Markdown
Contributor

Review Change StackReview Change Stack

Understand this PR’s impact

Explore downstream dependencies and potential security impact with Blast Radius.

View blast radius →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository: TanStack/ai/.coderabbit.yaml

Review profile: CHILL

Plan: Advanced

Run ID: b310f927-d0fc-45a2-b79d-3a5bde9ce1af

📥 Commits

Reviewing files that changed from the base of the PR and between 645757a and 15d25b0.

📒 Files selected for processing (2)
  • .changeset/ai-anthropic-readme.md
  • packages/ai-anthropic/README.md

Included review availability: Your plan provides up to 8 included reviews per hour; 6 remain after this review.


📝 Walkthrough

Walkthrough

The pull request adds a README for @tanstack/ai-anthropic and a patch changeset. The README documents setup, chat, tools, thinking, prompt caching, summarization, provider tools, Vertex AI, and related links.

Changes

Anthropic package documentation

Layer / File(s) Summary
README content and release metadata
packages/ai-anthropic/README.md, .changeset/ai-anthropic-readme.md
The README documents installation, API-key setup, adapter usage, tool calling, thinking options, prompt caching, summarization, provider tools, and Claude on Vertex AI. The changeset records a patch release for the package.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely identifies the main change: adding the package README for @tanstack/ai-anthropic.
Description check ✅ Passed The description follows the required template, explains the README content and rationale, records testing and checklist status, and documents the changeset and release impact.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions

Copy link
Copy Markdown
Contributor

Thanks for the PR, @changbaebang! 🙌 @tombeckenham will take a look.

Automated pre-review checks

  • ✅ CI passing
  • ✅ No merge conflicts
  • ✅ Changeset present
  • ✅ E2E test changes included

Automated triage — a human review follows.

@github-actions github-actions Bot added the waiting-on: maintainer The ball is in the maintainers’ court label Sep 22, 2026
@AlemTuzlak
AlemTuzlak merged commit 77c4607 into TanStack:main Sep 22, 2026
3 checks passed
@github-actions github-actions Bot mentioned this pull request Sep 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

waiting-on: maintainer The ball is in the maintainers’ court

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants