Installation

Connect to Augments instantly via our hosted MCP server at https://mcp.augments.dev/mcp, or install locally for development.

Option 1: Hosted MCP Server (Recommended)

No Installation Required

Connect directly to our hosted MCP server - no installation, always up-to-date, completely frictionless

Claude Code CLI (Easiest):

# Add the hosted MCP server
claude mcp add --transport http augments https://mcp.augments.dev/mcp

# Verify it was added
claude mcp list

Cursor Configuration:

Add to your Cursor MCP configuration:

Cursor MCP Config

{
  "mcpServers": {
    "augments": {
      "transport": "http",
      "url": "https://mcp.augments.dev/mcp"
    }
  }
}

Claude Desktop Configuration:

Add to your Claude Desktop config file:

Claude Desktop Config

{
  "mcpServers": {
    "augments": {
      "transport": {
        "type": "streamable-http",
        "url": "https://mcp.augments.dev/mcp"
      }
    }
  }
}

✅ Hosted Service Benefits

• No installation, setup, or maintenance required

• Always up-to-date with the latest framework documentation

• High availability with smart caching and rate limiting

• No authentication or API keys needed

• Works immediately across all your projects

• MCP Protocol Compliant - Uses official MCP Python SDK

• Multi-Client Support - Works with Claude Code, Cursor, and more

• Secure HTTPS with proper streamable-http transport

Option 2: Local Installation

Install locally for development, customization, or offline use

Prerequisites:

Python 3.11+ and uv package manager

Install uv (if not installed)

curl -LsSf https://astral.sh/uv/install.sh | sh

Clone and install:

git clone https://github.com/augmnt/augments-mcp-server.git
cd augments-mcp-server
uv sync

💡 Why uv?

uv is a fast Python package installer and resolver, written in Rust. It provides faster dependency resolution and installation compared to pip.

Step 1: Test Local Server (Local Installation Only)

Verify the server runs correctly before configuring (skip this for hosted option)

Start the server:

# From the augments-mcp-server directory
uv run augments-mcp-server

✅ Success Indicators

• Server starts without errors

• Framework registry loads successfully

• Cache system initializes

🔧 Development Mode

For development with auto-reload:

uv run fastmcp dev src/augments_mcp/server.py

Step 2: Configure MCP Server (Local Installation Only)

Choose your method to configure local installation (hosted option is already configured)

Add with Claude Code CLI (Recommended):

The easiest way to configure the MCP server with Claude Code

# Add the MCP server (from augments-mcp-server directory)
claude mcp add augments \
  -e AUGMENTS_CACHE_DIR="~/.cache/augments-mcp-server" \
  -e GITHUB_TOKEN="your_github_token" \
  -- uv run augments-mcp-server

# Verify it was added
claude mcp list

✅ Benefits of Claude Code CLI

• Automatic configuration with proper paths

• Easy to manage and update

• Built-in verification commands

• No manual file editing required

💡 Configuration Notes

• Replace /path/to/augments-mcp-server with the actual path where you cloned the repository

• The GITHUB_TOKEN is optional but recommended for higher API rate limits

• For Claude Code CLI: run commands from within the augments-mcp-server directory

• Configuration scopes: CLI (local), .mcp.json (project), Claude Desktop (global)

Step 3: Verify Installation

Test that Augments is working correctly with Claude Code

1. Restart Claude Desktop

Close and reopen Claude Desktop to load the MCP server configuration.

2. Test with Claude Code

Try this example prompt in Claude Code:

Show me React components with TypeScript and Tailwind CSS

You should notice more accurate, framework-aware code generation with current patterns.

3. Check Available Tools

Claude Code now has access to these Augments tools:

get_framework_docs

search_documentation

get_framework_examples

analyze_code_compatibility

🎉 Installation Complete!

Augments is now enhancing your Claude Code experience with real-time framework context. Your AI assistant now has access to the latest documentation for 92 frameworks.

Next steps: