MCP Tools API Reference
Complete reference documentation for all 11 MCP tools available in the Augments MCP Server.
list_available_frameworks
List all available frameworks, optionally filtered by category.
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
category | string | Optional | Filter by category (web, backend, mobile, ai-ml, design, tools) |
Returns
Example Usage
{
"category": "web"
}
search_frameworks
Search for frameworks by name, keyword, or feature.
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
query | string | Required | Search term to match against framework names and features |
Returns
Example Usage
{
"query": "react component"
}
get_framework_info
Get detailed information about a specific framework.
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
framework | string | Required | Framework name |
Returns
Example Usage
{
"framework": "tailwindcss"
}
get_framework_docs
Retrieve comprehensive documentation for a specific framework.
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
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
Example Usage
{
"framework": "nextjs",
"section": "app-router",
"use_cache": true
}
get_framework_examples
Get code examples for specific patterns within a framework.
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
framework | string | Required | Framework name |
pattern | string | Optional | Specific pattern (e.g., 'components', 'routing', 'authentication') |
Returns
Example Usage
{
"framework": "react",
"pattern": "hooks"
}
search_documentation
Search within a framework's cached documentation.
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
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
Example Usage
{
"framework": "tailwindcss",
"query": "responsive design",
"limit": 5
}
get_framework_context
Get relevant context for multiple frameworks based on the development task.
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
frameworks | List[string] | Required | List of framework names being used |
task_description | string | Required | Description of what you're trying to build |
Returns
Example Usage
{
"frameworks": ["nextjs", "tailwindcss", "shadcn-ui"],
"task_description": "Building a responsive dashboard with dark mode"
}
analyze_code_compatibility
Analyze code for framework compatibility and suggest improvements.
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
code | string | Required | Code snippet to analyze |
frameworks | List[string] | Required | List of frameworks the code should work with |
Returns
Example Usage
{
"code": "const App = () => { return <div className='p-4'>Hello</div> }",
"frameworks": ["react", "tailwindcss"]
}
check_framework_updates
Check if framework documentation has been updated since last cache.
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
framework | string | Required | Framework name to check |
Returns
Example Usage
{
"framework": "nextjs"
}
refresh_framework_cache
Refresh cached documentation for frameworks.
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
framework | string | Optional | Specific framework to refresh, or None for all |
force | boolean | Optional | Force refresh even if cache is still validDefault: false |
Returns
Example Usage
{
"framework": "react",
"force": false
}
get_cache_stats
Get detailed cache statistics and performance metrics.
Parameters
This tool takes no parameters.
Returns
Example 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
Get statistics about the framework registry.
Parameters
This tool takes no parameters.
Returns
Example 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 Response Format
All tools use consistent error handling with structured error messages.
{
"error": "ToolError",
"message": "Framework 'unknown-framework' not found",
"details": {
"tool": "get_framework_info",
"parameter": "framework",
"provided_value": "unknown-framework"
}
}
Common Error Types
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