What is Augments?
Whether you need a quick reference, a step-by-step how-to, or balanced overview, Augments automatically detects the query intent and formats the results accordingly. It covers every npm package, with enhanced support for 24 popular frameworks like React, Next.js, Vue, Express, Zustand, and more. This eliminates Claude's reliance on outdated training data and guesswork.
Features
- Intent-aware formatting: Automatically detects query intent (how-to, reference, or balanced) and formats output for clarity.
- Any npm package: Resolves and provides docs, types, and examples for any package on the npm registry, not just a curated list.
- Type signatures and prose docs: Returns accurate TypeScript type signatures and natural language documentation.
- Code examples: Includes working code examples to illustrate usage.
- Framework-specific enhancements: Provides enriched documentation for 24 frameworks including React, Next.js, Vue, Svelte, Express, Prisma, Zustand, and more.
- MCP integration: Works with Claude via the Model Context Protocol, allowing easy setup with a single npx command.
Use Cases
- Learn how to use a new npm package with accurate API documentation.
- Get instant type signatures and examples while coding with Claude.
- Verify the correct usage of a function or library without leaving the chat.
- Explore different ways to use a package by asking questions like "how does Zustand's persist middleware work?"
- Obtain up-to-date information that avoids outdated training data.
FAQs
-
What is Augments?
Augments is an MCP server that gives Claude access to live API documentation, type signatures, and code examples from npm packages. It ensures Claude provides accurate, up-to-date information instead of relying on outdated training data. -
How do I set up Augments with Claude?
Run the command: 'claude mcp add -s user augments -- npx -y @augmnt-sh/augments-mcp-server'. This installs the MCP server and connects it to Claude. -
Does Augments work with any npm package?
Yes, Augments works with any package on the npm registry. It auto-discovers documentation from npm registry metadata and resolves TypeScript types from DefinitelyTyped or bundled declarations. -
Which frameworks get enhanced results?
Augments provides curated doc sources for 24 frameworks, including React, React DOM, Next.js, Vue, Svelte, Angular, Solid, Express, Fastify, Hono, Prisma, Drizzle, Zod, tRPC, TanStack Query, SWR, Zustand, Jotai, Redux, React Hook Form, Framer Motion, Supabase, Vitest, and Playwright. -
How does intent-aware formatting work?
When you ask a question, Augments automatically detects whether the intent is 'how-to', 'reference', or 'balanced' and formats the output—type signatures, prose docs, and code examples—to best match that intent.