AdonisJS MCP服务器

一个安全的模型上下文协议(MCP)服务器,用于执行AdonisJS Ace命令,为AI助手提供与AdonisJS项目交互的安全接口。

  • by mkrlabs
  • JavaScript
  • 本地部署
  • 2 星标
  • 更新于
在 GitHub 查看 mkrlbs/mcp-adonisjs

使用说明

AdonisJS MCP服务器

安全 模型上下文协议(MCP) 服务器 用于执行AdonisJS Ace命令。该服务器允许AI助手 通过受控的安全界面与AdonisJS项目进行交互。

特性

  • 🔒 缺省安全:将危险命令列入黑名单并阻止shell 注射
  • 🛠️ 25个专用工具:所有常见AdonisJS的预配置工具 运营
  • 📚 内置文档访问:直接获取AdonisJS v7文档 标记语言
  • ⏱️ 超时保护:30s超时防止交互式无限挂起 提示
  • ✅ 验证:使用Zod模式进行严格的参数验证
  • 📦 TypeScript:完全使用TypeScript实现更好的DX

快速开始

这是一个MCP服务器,它作为AI启动的外部进程运行 客户。在MCP客户端设置中配置它:

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

请参阅 文档 用于客户特定指令(VS 代码、克劳德桌面、克劳德代码、反重力、Codex、Gemini CLI等)。

可用工具

脚手架

工具 命令 额外参数
make_controller node ace make:controller resource (布尔值)
make_service node ace make:service —
make_migration node ace make:migration withModel (布尔值, -m 旗帜)
make_model node ace make:model —
make_validator node ace make:validator —
make_seeder node ace make:seeder —
make_exception node ace make:exception —
make_middleware node ace make:middleware —
make_test node ace make:test suite (单元/功能/浏览器)
make_factory node ace make:factory —
make_policy node ace make:policy —
make_event node ace make:event —
make_listener node ace make:listener —
make_mailer node ace make:mailer —
make_command node ace make:command —
make_repository (文件生成) —

数据库和路由

工具 命令 额外参数
migration_run node ace migration:run force (布尔值)
migration_rollback node ace migration:rollback batch (编号)
migration_status node ace migration:status —
db_seed node ace db:seed files (字符串)
list_routes node ace list:routes —

文档

工具 描述 Args
check_docs 获取某个主题的AdonisJS v7文档作为markdown topic (字符串)
list_docs 列出可用的文档主题,可按类别筛选 category (字符串,可选)

14个类别可供选择: 开始、基础、前端、数据库、身份验证、安全, 概念,深入挖掘,ace,测试,教程超媒体,教程反应, 参考,资源。

效用

工具 描述 Args
set_project_cwd 设置Ace命令的工作目录 path (字符串)
run_ace_command 捕获所有Ace命令 command (字符串), args (字符串[])

所有脚手架工具均接受 name (string,必填)参数。

例子

{ "name": "UserController", "resource": true }
{ "name": "create_projects_table", "withModel": true }
{ "name": "users/list", "suite": "functional" }
{ "command": "make:provider", "args": ["AppProvider"] }
{ "topic": "routing" }
{ "category": "auth" }

安全

列入黑名单的命令

出于安全原因,以下命令被列入黑名单:

  • migration:fresh

尝试运行这些命令将导致错误。

外壳注射保护

所有命令参数都经过验证,以防止shell注入攻击。这 不允许使用以下字符:

  • ; (分号)
  • & (与)
  • | (管道)
  • ` (后退)
  • $ (美元符号)
  • <> (尖括号)
  • \ (反斜杠)

超时

所有命令都有30秒的超时时间,以防止交互式系统无限挂起 提示。

发展

建筑

npm run build

测试

npm run test

观看模式

npm run watch

需求

  • Node.js 24+
  • AdonisJS项目(自动检测或通过设置 set_project_cwd 工具)

许可证

麻省理工学院