Configuration Reference

Complete configuration reference for the Augments MCP Server including environment variables, framework definitions, and cache settings.

Configuration Overview

The Augments MCP Server supports multiple configuration methods for different aspects of the system

Environment Variables

Cache, GitHub API, logging

Framework Definitions

JSON configuration files

Claude Desktop Integration

MCP server configuration

Cache Management

TTL and storage settings

Environment Variables

Configure the MCP server behavior using environment variables

Cache Configuration

Variable	Type	Default	Required	Description
AUGMENTS_CACHE_DIR	string	~/.cache/augments-mcp-server	Optional	Directory for storing cached framework documentation and metadata
AUGMENTS_CACHE_TTL	integer	3600	Optional	Basic cache time-to-live in seconds (overridden by per-framework TTL strategies)

GitHub API Configuration

Variable	Type	Default	Required	Description
GITHUB_TOKEN	string	None	Optional	GitHub Personal Access Token for authenticated API access (increases rate limit from 60 to 5000 requests/hour)

Example Configuration

.env

# Cache Configuration
AUGMENTS_CACHE_DIR=~/.cache/augments-mcp-server
AUGMENTS_CACHE_TTL=3600

# GitHub API (optional but recommended)
GITHUB_TOKEN=your_github_personal_access_token_here

Claude Desktop Integration

Configure the Augments MCP Server in Claude Desktop

Configuration File

Add the following configuration to your Claude Desktop configuration file:

Configuration File Location

~/Library/Application Support/Claude/claude_desktop_config.json

Configuration Content

claude_desktop_config.json

{
  "mcpServers": {
    "augments": {
      "command": "uv",
      "args": ["run", "augments-mcp-server"],
      "cwd": "/path/to/augments-mcp-server",
      "env": {
        "AUGMENTS_CACHE_DIR": "~/.cache/augments-mcp-server",
        "AUGMENTS_CACHE_TTL": "3600",
        "GITHUB_TOKEN": "your_token_here"
      }
    }
  }
}

Framework Configuration

Define custom frameworks using JSON configuration files

Schema Overview

Each framework is defined by a JSON file in the frameworks/ directory with the following structure:

Variable	Type	Default	Required	Description
name	string	Required	Required	Unique identifier for the framework (lowercase, alphanumeric with hyphens)
display_name	string	Required	Required	Human-readable name for the framework
category	string	Required	Required	Framework category: web, backend, mobile, ai-ml, design, tools, database, devops, state-management, testing
type	string	Required	Required	Framework type description (e.g., 'JavaScript library', 'CSS framework')
version	string	latest	Optional	Framework version
sources	object	Required	Required	Documentation and example sources configuration
context_files	array	Required	Required	Important files to include in context
key_features	array	Required	Required	Main features and capabilities
common_patterns	array	Required	Required	Common usage patterns
priority	number	50	Optional	Framework priority (1-100, higher = more important)

Complete Example

frameworks/my-framework.json

{
  "name": "my-framework",
  "display_name": "My Framework",
  "category": "web",
  "type": "JavaScript framework",
  "version": "latest",
  "sources": {
    "documentation": {
      "github": {
        "repo": "owner/my-framework",
        "docs_path": "docs",
        "branch": "main"
      },
      "website": "https://my-framework.dev/docs"
    },
    "examples": {
      "github": {
        "repo": "owner/my-framework-examples",
        "docs_path": "examples",
        "branch": "main"
      }
    }
  },
  "sections": {
    "getting-started": "/getting-started",
    "api-reference": "/api",
    "guides": "/guides"
  },
  "context_files": [
    "README.md",
    "CHANGELOG.md",
    "docs/getting-started.md",
    "docs/api-reference.md"
  ],
  "key_features": [
    "component-based",
    "reactive",
    "type-safe",
    "server-side-rendering"
  ],
  "common_patterns": [
    "component-composition",
    "state-management",
    "routing",
    "data-fetching"
  ],
  "priority": 75
}

Sources Configuration

The sources object defines where to fetch documentation and examples:

GitHub-only configuration

{
  "sources": {
    "documentation": {
      "github": {
        "repo": "facebook/react",
        "docs_path": "docs",
        "branch": "main"
      }
    }
  }
}

Cache Management

Understanding cache behavior and TTL strategies

TTL Strategies

The server uses different cache TTL (Time To Live) values based on the framework version type:

Variable	Type	Default	Required	Description
stable	duration	24 hours	Optional	Stable releases are cached for a full day
beta	duration	6 hours	Optional	Beta versions are cached for 6 hours
dev	duration	1 hour	Optional	Development branches are cached for 1 hour
default	duration	3 hours	Optional	Default TTL for unspecified version types

Auto-Cached Frameworks

Popular frameworks are automatically cached on server startup:

Next.js

React

Tailwind CSS

TypeScript

shadcn/ui

Cache Directory Structure

Cache directory layout

~/.cache/augments-mcp-server/
├── frameworks/
│   ├── react.json                 # Framework metadata
│   ├── nextjs.json               # Framework metadata
│   └── ...
├── documentation/
│   ├── react/
│   │   ├── getting-started.md    # Cached documentation
│   │   ├── api-reference.md
│   │   └── ...
│   └── nextjs/
│       ├── installation.md
│       └── ...
└── github_cache/
    ├── facebook_react.json       # GitHub API responses
    └── ...

HTTP Client Configuration

Built-in HTTP client settings and rate limiting

GitHub Client

Variable	Type	Default	Required	Description
Base URL	string	https://api.github.com	Optional	GitHub API base URL
User Agent	string	Augments-MCP-Server/1.0	Optional	HTTP User-Agent header
Timeout	duration	30 seconds	Optional	Request timeout
Rate Limit	duration	100ms	Optional	Minimum delay between requests

Website Client

Variable	Type	Default	Required	Description
User Agent	string	Augments-MCP-Server/1.0 (Documentation Fetcher)	Optional	HTTP User-Agent header
Timeout	duration	30 seconds	Optional	Request timeout
Redirects	boolean	true	Optional	Follow HTTP redirects

Validation and Best Practices

Configuration validation rules and recommendations

Validation Rules

Required Fields

• Framework name must be unique
• Display name is required
• Category must be valid
• At least one documentation source

Format Rules

• Name: lowercase, alphanumeric, hyphens
• GitHub repo: owner/repository format
• URLs must be valid HTTP/HTTPS
• Priority: 1-100 range

Best Practices

Performance

• Set appropriate cache directories on fast storage
• Use GitHub token for better rate limits
• Monitor cache size and cleanup old entries
• Set realistic priorities for frameworks

Reliability

• Validate JSON syntax before deployment
• Test GitHub repository access
• Include comprehensive context files
• Use stable branches for documentation