Augments MCP Server

What augmnt/augments-mcp-server MCP server does

The augmnt/augments-mcp-server MCP server gives an MCP-connected coding agent access to npm package documentation and related project metadata. It is designed for framework and library questions that need more than a package name or TypeScript signature: responses can include parameters, return types, explanatory prose, and implementation examples.

The server supports npm packages broadly rather than limiting lookups to a fixed catalog. It can use package metadata, bundled declaration files, DefinitelyTyped types, GitHub repositories, documentation directories, and README content. The README also lists richer curated sources for frameworks and libraries including React, Next.js, Vue, Prisma, Zod, Supabase, TanStack Query, Zustand, Drizzle, Vitest, Playwright, Fastify, Svelte, Angular, and Redux.

How it works

Natural-language queries are parsed for package, framework, concept, and intent. Documentation is indexed with BM25 search and split into heading-based chunks; API names receive additional search weight, and synonym groups expand concepts such as state management, routing, validation, testing, and pagination. The response format changes based on whether the request asks for a how-to example, a reference signature, a migration, or a balanced result.

For API context, the server can race or consult npm metadata, CDNs, type sources, and documentation sources before combining the results. Version analysis uses npm registry data, declaration-file differences, changelogs, and GitHub releases. Error diagnosis combines curated error patterns with GitHub issue and documentation searches. Caches use an LRU strategy, while network handling includes retry backoff, CDN circuit breaking, and GitHub rate-limit tracking.

Setup and configuration

Install the augmnt/augments-mcp-server MCP server locally with npx:

npx -y @augmnt-sh/augments-mcp-server

Claude Code can register that command as a user-scoped MCP server, and Cursor can use it as the command with -y and @augmnt-sh/augments-mcp-server in its MCP configuration. The documented package entry point uses stdio, so the client starts the process locally.

GITHUB_TOKEN is optional. Supplying it increases GitHub API rate limits when the server retrieves examples and documentation; the material does not identify any other required environment variable or credential.

Tools and capabilities

The augmnt/augments-mcp-server MCP server exposes these capabilities:

• get_api_context retrieves signatures, parameters, return types, prose, and examples for natural-language or API-specific npm queries.
• search_apis searches across frameworks using keyword and concept matching.
• get_version_info reports available versions and changelog-backed breaking changes or new features.
• get_migration_guide compares package versions and includes changes, deprecations, type differences, and official migration documentation when available.
• diagnose_error analyzes error messages and stack traces against known patterns, GitHub issues, and documentation.
• compare_packages compares two to five npm packages using downloads, bundle size, dependencies, GitHub stars, and exported APIs.
• scan_project_deps reads package.json to identify outdated, deprecated, and security-affected dependencies.
• diagnostics reports server version, uptime, memory, cache statistics, and Node.js version.

Limitations and notes

Results depend on the availability of public npm, CDN, GitHub, repository, changelog, and README data. GitHub access is subject to API rate limits; a token raises the available limit but is not documented as mandatory. The dependency scanner reads package.json, so the provided material does not establish support for other manifest formats. The README describes the package as working with npm packages, not arbitrary non-npm ecosystems.