Augments
About
Comprehensive framework documentation and code examples for popular development tools and libraries.
Details
- Transport
- SSE
Explore
- Categorized framework registry with hot-reloading configuration
- Multi-source documentation aggregation from GitHub and websites
- TTL-based multi-level caching with smart invalidation
- Multi-framework context and code compatibility analysis
- 9 MCP tools for documentation lifecycle management
- Structured JSON responses and error resilience
Setting up with Highlight
This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:
- Download and install Highlight from highlightai.com/download
- Navigate to the plugins tab and select "Add Custom Plugin"
-
Configure the plugin with the settings below
Plugin Name
AugmentsCommand (node, npx, python, etc.)Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.
- Enable "Start Automatically" if you want the plugin to start when Highlight launches
From the repository
- Python 3.11+
- uv (recommended) or pip
{
"name": "framework-name",
"display_name": "Framework Display Name",
"category": "web|backend|mobile|ai-ml|design|tools",
"type": "framework|library|tool|service",
"version": "latest",
"sources": {
"documentation": {
"github": {
"repo": "owner/repository",
"docs_path": "docs",
"branch": "main"
},
"website": "https://docs.framework.com"
},
"examples": {
"github": {
"repo": "owner/examples",
"docs_path": "examples",
"branch": "main"
}
}
},
"context_files": ["README.md", "CHANGELOG.md", "API.md"],
"key_features": ["feature1", "feature2", "feature3"],
"common_patterns": ["pattern1", "pattern2"],
"priority": 50
}
uv sync
pip install -e .
Create a .env file for optional configuration:
claude mcp add augments -e AUGMENTS_CACHE_DIR="~/.cache/augments-mcp-server" -e GITHUB_TOKEN="your_github_token" -- uv run augments-mcp-server
claude mcp list
Add to your Claude Desktop MCP configuration file:
Location:
- macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
- Windows: %APPDATA%\Claude\claude_desktop_config.json
- Linux: ~/.config/Claude/claude_desktop_config.json
json{
"mcpServers": {
"augments": {
"command": "uv",
"args": ["run", "augments-mcp-server"],
"cwd": "/path/to/augments-mcp-server",
"env": {
"AUGMENTS_CACHE_DIR": "~/.cache/augments-mcp-server",
"GITHUB_TOKEN": "your_github_token"
}
}
}
}
For system-wide access without global installation:
bash
claude mcp list
claude mcp remove augments
claude mcp add augments -e GITHUB_TOKEN="your_token" -- uv run augments-mcp-server
Create a JSON file in the appropriate category directory:
bash
{
"name": "my-framework",
"display_name": "My Awesome Framework",
"category": "web",
"type": "framework",
"version": "2.0.0",
"sources": {
"documentation": {
"github": {
"repo": "myorg/my-framework",
"docs_path": "docs",
"branch": "main"
},
"website": "https://myframework.dev/docs"
},
"examples": {
"github": {
"repo": "myorg/my-framework-examples",
"docs_path": "examples",
"branch": "main"
}
}
},
"context_files": ["README.md", "GUIDE.md"],
"key_features": ["fast", "modern", "typescript"],
"common_patterns": ["component-based", "declarative"],
"priority": 60
}
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| name | string | ✅ | Unique framework identifier |
| display_name | string | ✅ | Human-readable name |
| category | string | ✅ | Framework category |
| type | string | ✅ | Framework type |
| version | string | ❌ | Version (default: "latest") |
| sources | object | ✅ | Documentation sources |
| context_files | array | ✅ | Important files to include |
| key_features | array | ✅ | Main features/capabilities |
| common_patterns | array | ✅ | Usage patterns |
| priority | number | ❌ | Importance (1-100, default: 50) |
The server automatically detects new framework configurations and hot-reloads them without restart.
bash
uv sync
uv run pytest
```
- Webpack - Module bundler
- Vite - Fast build tool
- Parcel - Zero configuration build tool
- Rollup - Module bundler for JavaScript
- ESLint - JavaScript linter
- Prettier - Code formatter
- Turbo - High-performance build system
- Nx - Smart, fast and extensible build system
Claude Desktop / Cursor
Paste into your MCP client config file to install this server.
{
"mcpServers": {
"augments": {
"augments": {
"command": "uv",
"args": [
"run",
"augments-mcp-server"
],
"cwd": "/path/to/augments-mcp-server",
"env": {
"AUGMENTS_CACHE_DIR": "~/.cache/augments-mcp-server",
"GITHUB_TOKEN": "your_github_token_here"
}
}
}
}
}
McpServers
{
"augments": {
"command": "uv",
"args": [
"run",
"augments-mcp-server"
],
"cwd": "/path/to/augments-mcp-server",
"env": {
"AUGMENTS_CACHE_DIR": "~/.cache/augments-mcp-server",
"GITHUB_TOKEN": "your_github_token_here"
}
}
}
A comprehensive framework documentation provider for Claude Code via Model Context Protocol (MCP). Provides real-time access to framework documentation, context-aware assistance, and intelligent caching to enhance development workflows.
🚀 Overview
Augments MCP Server is a sophisticated documentation retrieval system that integrates with Claude Code to provide comprehensive, up-to-date framework information. It features advanced caching strategies, multi-source documentation aggregation, and intelligent context enhancement for modern development workflows.
✨ Key Features
🎯 Comprehensive Framework Support
- Categorized Framework Registry: Web, Backend, Mobile, AI/ML, Design, and Tools - Multi-Source Documentation: GitHub repositories, official websites, and examples - Hot-Reloading Configuration: Dynamic framework updates without server restart - Intelligent Prioritization: Framework importance-based ranking⚡ Advanced Caching System
- TTL-Based Strategies: Different cache durations for stable/beta/dev versions - Multi-Level Caching: Memory and disk persistence for optimal performance - Smart Invalidation: Automatic cache refresh based on source updates - Cache Analytics: Detailed statistics and performance monitoring🧠 Context Enhancement
- Multi-Framework Context: Combine documentation from multiple frameworks - Code Compatibility Analysis: Detect framework compatibility issues - Pattern Recognition: Common usage patterns and best practices - Task-Specific Guidance: Context tailored to development tasks🔧 Developer Experience
- 9 Comprehensive MCP Tools: Full documentation lifecycle coverage - Structured Responses: Clean, validated JSON outputs - Error Resilience: Graceful degradation with detailed error messages - Async Performance: Non-blocking operations throughout🏗️ Architecture
Directory Structure
src/augments_mcp/
├── registry/ # Framework registry management
│ ├── manager.py # Hot-reloading registry manager
│ ├── models.py # Pydantic data models
│ └── cache.py # Advanced caching system
├── tools/ # MCP tool implementations
│ ├── framework_discovery.py # Framework search and listing
│ ├── documentation.py # Documentation retrieval
│ ├── context_enhancement.py # Multi-framework context
│ └── updates.py # Cache management and updates
├── providers/ # Documentation source providers
│ ├── github.py # GitHub API integration
│ ├── website.py # Web scraping provider
│ └── base.py # Provider interface
├── utils/ # Shared utilities
│ ├── github_client.py # GitHub API client with rate limiting
│ └── validation.py # Data validation utilities
└── server.py # FastMCP server implementation
frameworks/ # Framework configurations by category
├── web/ # Web frameworks
│ ├── tailwindcss.json
│ ├── react.json
│ └── nextjs.json
├── backend/ # Backend frameworks
│ └── fastapi.json
├── design/ # Design systems
│ └── shadcn-ui.json
└── ai-ml/ # AI/ML frameworks
├── mcp-sdk-python.json
└── anthropic-sdk.json
Framework Configuration Schema
{
"name": "framework-name",
"display_name": "Framework Display Name",
"category": "web|backend|mobile|ai-ml|design|tools",
"type": "framework|library|tool|service",
"version": "latest",
"sources": {
"documentation": {
"github": {
"repo": "owner/repository",
"docs_path": "docs",
"branch": "main"
},
"website": "https://docs.framework.com"
},
"examples": {
"github": {
"repo": "owner/examples",
"docs_path": "examples",
"branch": "main"
}
}
},
"context_files": ["README.md", "CHANGELOG.md", "API.md"],
"key_features": ["feature1", "feature2", "feature3"],
"common_patterns": ["pattern1", "pattern2"],
"priority": 50
}
🛠️ Installation
Prerequisites
- Python 3.11+ - uv (recommended) or pipInstallation Steps
```bash
Sign in to leave a review
Use Google, GitHub, or an email account so ratings stay tied to real people.
No reviews posted yet.



