Augments

by augmnt

295 downloads
Not rated
GitHub Website

About

Comprehensive framework documentation and code examples for popular development tools and libraries.

Details

Author
augmnt
Downloads
295
Categories
Developer Tools, Knowledge Base

- 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:

  1. Download and install Highlight from highlightai.com/download
  2. Navigate to the plugins tab and select "Add Custom Plugin"
  3. Configure the plugin with the settings below
    Plugin Name Augments
    Command (node, npx, python, etc.)

    Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.

  4. Enable "Start Automatically" if you want the plugin to start when Highlight launches

From the repository

Clone the repository, install with uv sync or pip install -e ., optionally configure environment variables in a .env file, then start the server with uv run augments-mcp-server. Integrate with Claude Code using the claude mcp add augments command or by editing the Claude Desktop MCP configuration file.

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"
        }
    }
}

Augments MCP Server

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 pip

Installation Steps

```bash

No reviews yet β€” be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.