README.md
MCP server for the AegisX platform providing UI components and API tools.
@aegisx/mcp
MCP (Model Context Protocol) server for the AegisX platform. Provides AI assistants with access to AegisX UI components, CRUD generator commands, development patterns, and API contract discovery.
Features
- UI Components Reference - Browse and search 78+ AegisX UI components with full API documentation
- CRUD Generator Commands - Build and execute CRUD generation commands with 23 supported options (100% CLI alignment)
- Development Patterns - Access best practices, code templates, and architecture patterns
- API Contract Discovery - List, search, and validate API contracts across your codebase
- API Testing & Authentication - Login, test protected endpoints, decode JWT tokens, and track request history
- Design Tokens - Reference design tokens for colors, spacing, typography
- Development Standards - Access coding standards and guidelines
Data Synchronization
The component, command, and pattern data files are auto-generated from source libraries:
src/data/components.ts- Generated from aegisx-ui componentssrc/data/crud-commands.ts- Generated from aegisx-cli commandssrc/data/patterns.ts- Validated from existing patterns
⚠️ DO NOT EDIT MANUALLY - Changes will be overwritten on next sync.
Installation
NPM (Global)
npm install -g @aegisx/mcp
Claude Desktop Configuration
Add to your Claude Desktop config (~/Library/Application Support/Claude/claude_desktop_config.json):
{
"mcpServers": {
"aegisx": {
"command": "npx",
"args": ["-y", "@aegisx/mcp"]
}
}
}
Or if installed globally:
{
"mcpServers": {
"aegisx": {
"command": "aegisx-mcp"
}
}
}
Available Tools
UI Components
| Tool | Description |
|---|---|
aegisx_components_list |
List all UI components, optionally filtered by category |
aegisx_components_get |
Get detailed info about a specific component |
aegisx_components_search |
Search components by name or description |
Example:
Use aegisx_components_get with name="Card" to see the Card component API.
CRUD Generator
| Tool | Description |
|---|---|
aegisx_crud_build_command |
Build a CRUD generation command with options |
aegisx_crud_packages |
View available packages (standard, enterprise, full) |
aegisx_crud_files |
See what files will be generated |
aegisx_crud_troubleshoot |
Get help with common issues |
aegisx_crud_workflow |
Get complete workflow for a feature |
Example:
Use aegisx_crud_build_command with tableName="products" and withImport=true to get the command.
Development Patterns
| Tool | Description |
|---|---|
aegisx_patterns_list |
List all patterns by category |
aegisx_patterns_get |
Get a specific pattern with code |
aegisx_patterns_search |
Search patterns |
aegisx_patterns_suggest |
Get pattern suggestions for a task |
Example:
Use aegisx_patterns_suggest with task="create API endpoint" to get relevant patterns.
API Contract Tools
| Tool | Description |
|---|---|
aegisx_api_list |
List all API endpoints, optionally filtered by feature |
aegisx_api_search |
Search endpoints by keyword across paths and methods |
aegisx_api_get |
Get detailed contract for a specific endpoint |
aegisx_api_validate |
Validate implementation matches documented contracts |
Examples:
# List all endpoints
Use aegisx_api_list to see all documented APIs.
# Search for budget-related APIs
Use aegisx_api_search with query="budget" to find budget endpoints.
# Get contract details
Use aegisx_api_get with path="/api/profile" to see the full contract.
# Validate a feature
Use aegisx_api_validate with feature="user-profile" to check for mismatches.
API Testing & Authentication Tools
| Tool | Description | | ------------
Tools (16)
aegisx_components_listList all UI components, optionally filtered by categoryaegisx_components_getGet detailed info about a specific componentaegisx_components_searchSearch components by name or descriptionaegisx_crud_build_commandBuild a CRUD generation command with optionsaegisx_crud_packagesView available packages (standard, enterprise, full)aegisx_crud_filesSee what files will be generatedaegisx_crud_troubleshootGet help with common issuesaegisx_crud_workflowGet complete workflow for a featureaegisx_patterns_listList all patterns by categoryaegisx_patterns_getGet a specific pattern with codeaegisx_patterns_searchSearch patternsaegisx_patterns_suggestGet pattern suggestions for a taskaegisx_api_listList all API endpoints, optionally filtered by featureaegisx_api_searchSearch endpoints by keyword across paths and methodsaegisx_api_getGet detailed contract for a specific endpointaegisx_api_validateValidate implementation matches documented contractsConfiguration
claude_desktop_config.json
{"mcpServers": {"aegisx": {"command": "npx", "args": ["-y", "@aegisx/mcp"]}}}Try it
→List all available UI components for the AegisX platform.
→Build a CRUD generation command for a new 'products' table.
→Suggest a development pattern for creating a new API endpoint.
→Search for all budget-related API endpoints.
→Validate the current implementation of the user-profile feature against its contract.