augments

Augments is an MCP server that provides API documentation, code examples, and prose for any npm package by leveraging TypeScript typings, auto-discovered docs, and README fallbacks. You can query it to get API signatures, context-aware prose, and runnable examples formatted for how-to, reference, or migration intents. The primary tools exposed are get_api_context (to fetch signatures plus prose and examples), search_apis (to locate APIs by concept or keyword with synonym expansion), and get_version_info (to compare versions and surface breaking changes). Typical usage involves asking for a package like zustand or react-related utilities, and receiving a structured response that starts with examples, followed by explanations and then concise type signatures. You can also perform concept-based searches to explore related APIs via synonyms such as “state management” or “authentication” and get relevant results across frameworks.

To use the server in practice, connect through the MCP API (the hosted http transport is supported) and issue commands like get_api_context query="how to use zustand" or search_apis query="state management". If you’re integrating into your own tooling, you can run the server locally and point your MCP client at it, or use the provided hosted endpoint if you prefer a managed setup. The server is designed to auto-discover documentation from the npm ecosystem, pulling from TypeScript types, GitHub README/doc sources, and README fallbacks when curated docs aren’t available.

Prerequisites:

• Node.js (14.x or newer) and npm installed on your machine
• Git (optional, for cloning the repository)

Option A: Local development from source

1. Clone the repository and install dependencies:

git clone https://github.com/augmnt/augments-mcp-server.git
cd augments-mcp-server
npm install

2. Run the development server:

npm run dev

3. Verify the server is running and reachable at the configured port (default port is typically 3000 or as defined in your environment).

Option B: Quick-start from an installed package (recommended for production usage)

1. Install the MCP server package (as part of your project or globally):

npm install augments-mcp-server

2. Start the server (adjust paths as needed for your setup):

npx augments-mcp-server start

Notes:

• If you’re deploying to a container or cloud environment, ensure the container exposes the configured MCP port and that environment variables (if any) are set accordingly.

Tips and considerations:

• The server auto-discovers documentation for any npm package by combining TypeScript typings, repository metadata, and README content. If documentation is sparse, README fallback will extract relevant prose and code blocks.
• You can customize behavior via environment variables (for example, to toggle auto-discovery, enable verbose logging, or limit concept clusters). See the project's README for a complete list of options.
• For best results with how-to requests, ASCII or fenced code blocks in README sections may be preferred by the Prose Extractor when building examples.
• If you encounter issues with specific packages, ensure that the repository field and any docs/ directories in the package’s GitHub repo are accessible from the environment where the MCP server runs.
• The server supports an http transport for hosted usage, allowing you to register and query the augments MCP server from your Claude integration or other MCP clients.