MCP Tools API Reference

Complete reference documentation for all 11 MCP tools available in the Augments MCP Server.

Overview
The Augments MCP Server provides 11 comprehensive tools organized into 4 main categories
Framework Discovery
3 tools
Documentation Access
3 tools
Context Enhancement
2 tools
Cache & Registry Management
3 tools
Framework Discovery Tools
Tools for discovering and exploring available frameworks

list_available_frameworks

Framework Discovery

List all available frameworks, optionally filtered by category.

Parameters

ParameterTypeRequiredDescription
category
string
Optional
Filter by category (web, backend, mobile, ai-ml, design, tools)

Returns

List[Dict[str, Any]]
- List of framework information including name, category, and description

Example Usage

JSON Request
{
  "category": "web"
}

search_frameworks

Framework Discovery

Search for frameworks by name, keyword, or feature.

Parameters

ParameterTypeRequiredDescription
query
string
Required
Search term to match against framework names and features

Returns

List[Dict[str, Any]]
- Ranked list of matching frameworks with relevance scores

Example Usage

JSON Request
{
  "query": "react component"
}

get_framework_info

Framework Discovery

Get detailed information about a specific framework.

Parameters

ParameterTypeRequiredDescription
framework
string
Required
Framework name

Returns

Dict[str, Any]
- Detailed framework information or error message

Example Usage

JSON Request
{
  "framework": "tailwindcss"
}
Documentation Access Tools
Tools for retrieving and searching framework documentation

get_framework_docs

Documentation Access

Retrieve comprehensive documentation for a specific framework.

Parameters

ParameterTypeRequiredDescription
framework
string
Required
Framework name (e.g., 'react', 'tailwind', 'laravel')
section
string
Optional
Specific documentation section (e.g., 'installation', 'configuration')
use_cache
boolean
Optional
Whether to use cached contentDefault: true

Returns

string
- Formatted documentation content with examples and best practices

Example Usage

JSON Request
{
  "framework": "nextjs",
  "section": "app-router",
  "use_cache": true
}

get_framework_examples

Documentation Access

Get code examples for specific patterns within a framework.

Parameters

ParameterTypeRequiredDescription
framework
string
Required
Framework name
pattern
string
Optional
Specific pattern (e.g., 'components', 'routing', 'authentication')

Returns

string
- Code examples with explanations and best practices

Example Usage

JSON Request
{
  "framework": "react",
  "pattern": "hooks"
}

search_documentation

Documentation Access

Search within a framework's cached documentation.

Parameters

ParameterTypeRequiredDescription
framework
string
Required
Framework name to search within
query
string
Required
Search query
limit
integer
Optional
Maximum number of results (1-50)Default: 10

Returns

List[Dict[str, Any]]
- List of search results with context

Example Usage

JSON Request
{
  "framework": "tailwindcss",
  "query": "responsive design",
  "limit": 5
}
Context Enhancement Tools
Advanced tools for multi-framework context and code analysis

get_framework_context

Context Enhancement

Get relevant context for multiple frameworks based on the development task.

Parameters

ParameterTypeRequiredDescription
frameworks
List[string]
Required
List of framework names being used
task_description
string
Required
Description of what you're trying to build

Returns

string
- Curated context combining relevant documentation, patterns, and best practices

Example Usage

JSON Request
{
  "frameworks": ["nextjs", "tailwindcss", "shadcn-ui"],
  "task_description": "Building a responsive dashboard with dark mode"
}

analyze_code_compatibility

Context Enhancement

Analyze code for framework compatibility and suggest improvements.

Parameters

ParameterTypeRequiredDescription
code
string
Required
Code snippet to analyze
frameworks
List[string]
Required
List of frameworks the code should work with

Returns

Dict[str, Any]
- Analysis results with compatibility issues and improvement suggestions

Example Usage

JSON Request
{
  "code": "const App = () => { return <div className='p-4'>Hello</div> }",
  "frameworks": ["react", "tailwindcss"]
}
Cache & Registry Management Tools
Tools for managing cache, updates, and registry statistics

check_framework_updates

Cache Management

Check if framework documentation has been updated since last cache.

Parameters

ParameterTypeRequiredDescription
framework
string
Required
Framework name to check

Returns

Dict[str, Any]
- Update status with last modified dates and change summary

Example Usage

JSON Request
{
  "framework": "nextjs"
}

refresh_framework_cache

Cache Management

Refresh cached documentation for frameworks.

Parameters

ParameterTypeRequiredDescription
framework
string
Optional
Specific framework to refresh, or None for all
force
boolean
Optional
Force refresh even if cache is still validDefault: false

Returns

string
- Status message with refresh results

Example Usage

JSON Request
{
  "framework": "react",
  "force": false
}

get_cache_stats

Cache Management

Get detailed cache statistics and performance metrics.

Parameters

This tool takes no parameters.

Returns

Dict[str, Any]
- Comprehensive cache statistics

Example Response

JSON Response
{
  "total_cached_frameworks": 15,
  "cache_size_mb": 45.2,
  "cache_hit_rate": 0.87,
  "average_cache_age_hours": 12.5,
  "frameworks_by_category": {
    "web": 8,
    "backend": 3,
    "mobile": 2,
    "ai-ml": 2
  },
  "recent_cache_activity": [
    {
      "framework": "react",
      "action": "updated",
      "timestamp": "2024-01-16T09:15:00Z"
    }
  ]
}

get_registry_stats

Registry Management

Get statistics about the framework registry.

Parameters

This tool takes no parameters.

Returns

Dict[str, Any]
- Registry statistics including framework count and categories

Example Response

JSON Response
{
  "total_frameworks": 50,
  "categories": {
    "web": 18,
    "backend": 12,
    "mobile": 6,
    "ai-ml": 8,
    "design": 3,
    "tools": 3
  },
  "framework_types": {
    "framework": 32,
    "library": 15,
    "tool": 3
  },
  "registry_loaded": true,
  "last_updated": "2024-01-16T08:00:00Z"
}
Error Handling
Common error patterns and response formats

Error Response Format

All tools use consistent error handling with structured error messages.

Error Response Example
{
  "error": "ToolError",
  "message": "Framework 'unknown-framework' not found",
  "details": {
    "tool": "get_framework_info", 
    "parameter": "framework",
    "provided_value": "unknown-framework"
  }
}

Common Error Types

Framework Not Found
Invalid framework name provided
404
Missing Required Parameter
Required parameter not provided
400
Registry Not Initialized
Server initialization issue
500
Cache Access Error
Cache system unavailable
503
Best Practices
Recommendations for optimal tool usage

Performance

  • • Use caching (use_cache=true) for repeated requests
  • • Limit search results with the limit parameter
  • • Check for updates before refreshing cache
  • • Use specific section parameters for focused docs

Reliability

  • • Always validate framework names first
  • • Handle errors gracefully in your application
  • • Use get_registry_stats to check server status
  • • Implement retry logic for transient failures