Skip to directory

About Augments MCP

A local MCP server that searches framework documentation, TypeScript API types, examples, changelogs, and migration guidance for npm packages.

What you can use it for

  • Look up API signatures with prose and examples
  • Search framework APIs by concept
  • Compare package versions and migration changes
  • Diagnose common errors and compare npm packages
  • Scan project dependencies for outdated or insecure packages
Connection and setup
Hosting
Local
Transport
stdio
Endpoint
Local process; no hosted endpoint documented
Authentication
No authentication required for basic use. Optional GITHUB_TOKEN increases GitHub API rate limits when fetching docs and examples; store it in the local MCP environment, not in chat.

Requirements

  • Node.js >=18.0.0
  • npm/npx

Setup steps

  1. Add an MCP server named augments using command npx and args ["-y", "@augmnt-sh/augments-mcp-server"].
  2. For Claude Code, repository documents `claude mcp add -s user augments -- npx -y @augmnt-sh/augments-mcp-server`.
  3. For Cursor, place the same command and args in its MCP configuration.
  4. Optionally set GITHUB_TOKEN in the server environment for higher GitHub API limits.
  5. Verify with a read-only request to get_api_context for a package and a specific API.
Tools 8

The first-party repository remains the source for the eight documented tools and local stdio configuration. This refresh did not install the package or execute it.

  • get_api_context

    Return API signatures, documentation prose, and code examples for an npm package.

    01
  • search_apis

    Search APIs by keyword or concept across supported frameworks.

    02
  • get_version_info

    Read package version metadata and changelog-backed version differences.

    03
  • get_migration_guide

    Generate a migration guide between package versions, including breaking changes and deprecations.

    04
  • diagnose_error

    Diagnose an error using curated patterns, GitHub issues, and troubleshooting documentation.

    05
  • compare_packages

    Compare two to five packages, including downloads, bundle size, dependencies, and exported APIs.

    06
  • scan_project_deps

    Scan package.json dependencies for outdated, deprecated, or insecure packages.

    07
  • diagnostics

    Report server health, uptime, memory, cache statistics, and Node.js version.

    08
Limitations and notes
  • The upstream README says this project is work in progress.
  • GitHub API rate limits can reduce available fetched examples/documentation; an optional GitHub token raises limits.
  • No endpoint or hosted server documented; this implementation runs locally over stdio.
Source discrepancies
  • README labels its release section v7.0.0 while package metadata currently reports 7.1.0; version is recorded from package metadata and tool list from README.
Original sources
  • official repository

    README gives setup, exact eight tool names, descriptions, optional token guidance, and MIT license; repo declares the Augments project.

  • package metadata

    Confirms @augmnt-sh/augments-mcp-server v7.1.0, Node >=18, stdio CLI binary, and MIT.

Documentation checked 2026-10-28T14:10:00.000Z. Connection has not been runtime tested.

Similar tools