模型上下文协议服务

MCP(模型上下文协议)服务器为AegisX平台提供AI助手访问UI组件、CRUD生成命令、开发模式和API合同发现等功能。

  • by aegisx-platform
  • TypeScript
  • 本地部署
  • 更新于
在 GitHub 查看 aegisx-platform/aegisx-mcp

使用说明

@aegisx/mcp

用于AegisX平台的MCP(模型上下文协议)服务器。为人工智能助手提供对Aegis X UI组件、CRUD生成器命令、开发模式和API合同发现的访问。

特性

  • UI组件参考 -浏览和搜索78多个Aegis X UI组件以及完整的API文档
  • CRUD生成器命令 -使用23个受支持的选项构建和执行CRUD生成命令(100%CLI对齐)
  • 发展模式 -访问最佳实践、代码模板和架构模式
  • API合同发现 -在代码库中列出、搜索和验证API契约
  • API测试与认证 -登录、测试受保护的端点、解码JWT令牌和跟踪请求历史
  • 设计标记 -颜色、间距、排版的参考设计符号
  • 开发标准 -访问编码标准和指南

数据同步

组件、命令和模式数据文件是 自动生成 来自源库:

  • src/data/components.ts -由aegisx用户界面组件生成
  • src/data/crud-commands.ts -由aegisx-cli命令生成
  • src/data/patterns.ts -根据现有模式进行验证

⚠️ 不要手动编辑 -更改将在下次同步时被覆盖。

安装

NPM(全球)

npm install -g @aegisx/mcp

Claude桌面配置

添加到您的Claude桌面配置(~/Library/Application Support/Claude/claude_desktop_config.json):

{
  "mcpServers": {
    "aegisx": {
      "command": "npx",
      "args": ["-y", "@aegisx/mcp"]
    }
  }
}

或者,如果全局安装:

{
  "mcpServers": {
    "aegisx": {
      "command": "aegisx-mcp"
    }
  }
}

可用工具

UI组件

工具 说明
aegisx_components_list 列出所有UI组件,可选择按类别筛选
aegisx_components_get 获取特定组件的详细信息
aegisx_components_search 按名称或描述搜索组件

例子:

Use aegisx_components_get with name="Card" to see the Card component API.

CRUD生成器

工具 说明
aegisx_crud_build_command 使用选项构建CRUD生成命令
aegisx_crud_packages 查看可用包(标准、企业、完整)
aegisx_crud_files 查看将生成哪些文件
aegisx_crud_troubleshoot 获取常见问题的帮助
aegisx_crud_workflow 获取功能的完整工作流程

例子:

Use aegisx_crud_build_command with tableName="products" and withImport=true to get the command.

发展模式

工具 说明
aegisx_patterns_list 按类别列出所有图案
aegisx_patterns_get 用代码获取特定模式
aegisx_patterns_search 搜索模式
aegisx_patterns_suggest 获取任务的模式建议

例子:

Use aegisx_patterns_suggest with task="create API endpoint" to get relevant patterns.

API合同工具

工具 说明
aegisx_api_list 列出所有API端点,可选择按功能筛选
aegisx_api_search 跨路径和方法按关键字搜索端点
aegisx_api_get 获取特定端点的详细合同
aegisx_api_validate 验证实施是否与记录的合同相匹配

示例:

# 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测试和验证工具

工具 说明
aegisx_auth_login 登录API并存储访问令牌(默认值:localhost:3000)
aegisx_auth_status 检查身份验证状态和令牌信息
aegisx_auth_decode_jwt 解码JWT令牌以查看标头、有效载荷和到期详细信息
aegisx_auth_logout 注销并清除身份验证会话
aegisx_api_request 发出经过身份验证的HTTP请求(GET/POST/PUT/PATCH/DELETE)
aegisx_api_history 通过筛选查看请求/响应历史记录
aegisx_api_clear_history 清除请求历史记录

示例:

# Login to API
Use aegisx_auth_login with email and password to authenticate and store token.

# Check authentication status
Use aegisx_auth_status to see current user info and token expiry.

# Decode JWT token
Use aegisx_auth_decode_jwt to inspect token claims and expiration.

# Test protected endpoint
Use aegisx_api_request with method="GET" and path="/api/profile" to call authenticated endpoints.

# View request history
Use aegisx_api_history to see recent API calls with status codes and response times.

特征:

  • ✅ 自动令牌管理和存储
  • ✅ 请求/响应历史记录(最近50个请求)
  • ✅ JWT令牌解码和验证
  • ✅ 支持自定义标头和查询参数
  • ✅ 可配置的基本URL(默认值:http://localhost:3000)
  • ✅ 环境变量支持(AEGISX_API_URL)

可用资源

资源 描述
aegisx://design-tokens 设计符号(颜色、间距、排版)
aegisx://development-standards 编码标准和指南
aegisx://api-reference 后端API约定
aegisx://project-structure Monorepo结构指南
aegisx://quick-start 入门指南

组件类别

  • 数据显示 -徽章、卡片、头像、KPI卡、统计卡、列表、时间线、进度
  • 表格 -日期选择器、输入OTP、旋钮、弹出式编辑、调度器、时间槽
  • 反馈 -警报、加载栏、内部加载、启动画面、骨架
  • 导航 -面包屑、命令面板、导航栏、启动器
  • 布局 -经典布局、紧凑布局、企业布局、空布局
  • 认证 -登录表单、注册表单、重置密码表单、社交登录
  • 先进的 -日历、Gridster、文件上传、主题生成器、主题切换器
  • 覆盖层 -抽屉

CRUD包

包装 功能
标准 基本CRUD、分页、搜索、软删除
企业 标准+Excel/CSV导入
满的 企业+WebSocket事件

发展

从源同步数据

同步工具会自动更新源库中的数据文件。这在每次构建之前通过 prebuild 钩子。

cd libs/aegisx-mcp
pnpm run sync           # Update data files
pnpm run sync:dry-run   # Preview changes without writing
pnpm run sync:verbose   # See detailed progress

注: 同步过程从中提取组件元数据 libs/aegisx-ui,命令定义来自 libs/aegisx-cli,并验证现有模式。对生成的数据文件的手动编辑将在下次同步时被覆盖。

构建

cd libs/aegisx-mcp
pnpm install
pnpm run build

构建过程自动运行 pnpm run sync 在编译之前,确保数据文件是最新的。

本地测试

node dist/index.js

调试

集 DEBUG=mcp:* 详细日志记录的环境变量。

许可证

麻省理工学院