Framework Registry

Complete guide to the Augments MCP Server Framework Registry system, configuration schema, and management features.

Registry Overview

The Framework Registry is the core system that manages all framework configurations and metadata

92 Frameworks

Across 9 categories

Hot-Reloading

Live configuration updates

Schema Validation

Strict configuration validation

File Monitoring

Automatic config detection

Key Features

Hot-reload framework configurations without server restart

Automatic file system monitoring with watchdog

Comprehensive schema validation for all configurations

Smart search with relevance scoring and field matching

Priority-based framework ranking system

Multi-source documentation support (GitHub + Website)

Structured metadata with features and patterns

Category-based organization and filtering

Framework Configuration Schema

Complete reference for framework configuration JSON files

Core Framework Fields

Field	Type	Required	Description
name	string	Required	Unique framework identifier (alphanumeric, hyphens, underscores)nextjs
display_name	string	Required	Human-readable framework nameNext.js
category	string	Required	Framework category (web, backend, mobile, ai-ml, design, tools, database)web
type	string	Required	Framework type classificationjavascript-framework
version	string	Optional	Framework versionlatest
priority	integer	Optional	Framework importance (1-100, higher = more important)85

Sources Configuration

The sources object defines where to retrieve framework documentation and examples.

Sources Structure

{
  "sources": {
    "documentation": {
      "github": {
        "repo": "owner/repository",
        "docs_path": "docs",
        "branch": "main"
      },
      "website": "https://framework.dev/docs"
    },
    "examples": {
      "github": {
        "repo": "owner/examples-repo",
        "docs_path": "examples",
        "branch": "main"
      }
    }
  }
}

Metadata Fields

Field	Type	Required	Description
context_files	string[]	Required	Important documentation files to prioritize["README.md", "GUIDE.md"]
key_features	string[]	Required	Primary framework features and capabilities["component-based", "virtual-dom", "hooks"]
common_patterns	string[]	Required	Common usage patterns and practices["functional-components", "state-lifting"]
sections	object	Optional	Mapping of section names to URL paths{"tutorial": "learn/tutorial", "api": "reference/api"}

Complete Configuration Example

react.json

{
  "name": "react",
  "display_name": "React",
  "category": "web",
  "type": "javascript-library",
  "version": "latest",
  "sources": {
    "documentation": {
      "github": {
        "repo": "facebook/react",
        "docs_path": "docs",
        "branch": "main"
      },
      "website": "https://react.dev"
    },
    "examples": {
      "github": {
        "repo": "facebook/react",
        "docs_path": "fixtures",
        "branch": "main"
      }
    }
  },
  "sections": {
    "learn": "learn",
    "hooks": "reference/react/hooks",
    "api": "reference/react",
    "tutorial": "learn/tutorial-tic-tac-toe"
  },
  "context_files": [
    "docs/Learn/installation.md",
    "docs/Learn/thinking-in-react.md",
    "docs/Reference/react/hooks.md"
  ],
  "key_features": [
    "component-based",
    "virtual-dom",
    "jsx-syntax",
    "hooks",
    "state-management"
  ],
  "common_patterns": [
    "functional-components",
    "hook-patterns",
    "component-composition",
    "context-api"
  ],
  "priority": 95
}

Framework Categories

Supported framework categories and their purposes

web

Web Development

Frontend frameworks, CSS frameworks, JavaScript libraries for web development

Examples: React, Vue.js, Tailwind CSS, Bootstrap

backend

Backend

Server-side frameworks, APIs, microservices platforms

Examples: FastAPI, Django, Express.js, Spring Boot

mobile

Mobile

Mobile app development frameworks and cross-platform tools

Examples: React Native, Flutter, Ionic, Xamarin

ai-ml

AI/ML

Machine learning frameworks, AI libraries, data science tools

Examples: TensorFlow, PyTorch, scikit-learn, pandas

design

Design

UI/UX design systems, component libraries, design tokens

Examples: shadcn/ui, Chakra UI, Material-UI, Ant Design

tools

Tools

Development tools, build systems, testing frameworks

Examples: Webpack, Vite, ESLint, Prettier, Jest

database

Database

Database ORMs, query builders, database management tools

Examples: Prisma, TypeORM, Mongoose, SQLAlchemy

Registry Management

How the registry system manages configurations and handles updates

Hot-Reloading System

The registry monitors framework configuration files and automatically reloads changes without server restart.

File System Monitoring

• Watches all .json files in frameworks/ directory
• Recursive monitoring of all subdirectories
• Detects file modifications, additions, and deletions
• Uses Python watchdog library for efficient monitoring

Automatic Reloading

• Validates configuration on each file change
• Updates registry in-memory without service disruption
• Logs all configuration changes with structured logging
• Gracefully handles validation errors

✅ Development Workflow

You can edit framework configurations in frameworks/ and see changes immediately without restarting the MCP server. This enables rapid iteration during development.

Smart Search System

Advanced search capabilities with relevance scoring across multiple framework fields.

Score Weights

Exact name match

100 points

Partial name match

50 points

Display name match

30 points

Category match

25 points

Feature Weights

Type match

20 points

Key feature match

15 points

Pattern match

10 points

Configuration Validation

Comprehensive validation ensures all framework configurations meet quality standards.

Required Field Validation

• All required fields must be present
• String fields cannot be empty or whitespace-only
• Arrays must contain valid string items
• Sources must have either GitHub or website configuration

Format Validation

• Framework names: alphanumeric, hyphens, underscores only
• GitHub repos: must follow owner/repository format
• URLs: must start with http:// or https://
• Categories: must be from allowed list

Adding New Frameworks

Step-by-step guide to adding new framework configurations

📁 Directory Structure

Framework configurations are organized by category in the frameworks/ directory.

frameworks/
├── web/
│   ├── react.json
│   ├── vue.json
│   └── tailwindcss.json
├── backend/
│   ├── fastapi.json
│   └── django.json
├── mobile/
│   ├── react-native.json
│   └── flutter.json
└── ai-ml/
    ├── tensorflow.json
    └── pytorch.json

Step-by-Step Process

Choose the Correct Category

Determine which category your framework belongs to: web, backend, mobile, ai-ml, design, tools, or database.

Create Configuration File

Create a new .json file in the appropriate category directory. Use the framework name as the filename.

# Example: Adding Svelte to web frameworks
touch frameworks/web/svelte.json

Fill Required Fields

Complete all required fields following the schema. Start with this template:

svelte.json

{
  "name": "svelte",
  "display_name": "Svelte",
  "category": "web",
  "type": "javascript-framework",
  "version": "latest",
  "sources": {
    "documentation": {
      "github": {
        "repo": "sveltejs/svelte",
        "docs_path": "site/content/docs",
        "branch": "master"
      },
      "website": "https://svelte.dev/docs"
    }
  },
  "context_files": [
    "site/content/docs/01-getting-started.md",
    "site/content/docs/02-template-syntax.md"
  ],
  "key_features": [
    "compile-time",
    "reactive",
    "component-based",
    "small-bundle-size"
  ],
  "common_patterns": [
    "reactive-statements",
    "component-composition",
    "stores",
    "transitions"
  ],
  "priority": 75
}

Validate Configuration

The registry will automatically validate your configuration when you save the file. Check the server logs for any validation errors.

✓

Test the Framework

Use the MCP tools to test your new framework configuration:

• list_available_frameworks to see it in the list
• get_framework_info to verify all fields
• get_framework_docs to test documentation retrieval

⚠️ Best Practices

• Use descriptive, searchable key features and patterns
• Set appropriate priority based on framework popularity and importance
• Verify that GitHub repositories and URLs are accessible
• Include the most important documentation files in context_files
• Test the configuration thoroughly before deployment

Registry Statistics

Current framework distribution and registry metrics

Web

Backend

AI/ML

Tools

Mobile

Testing

Database

DevOps

50+

Total Frameworks Supported