项目简介

@jrmc/adonis-mcp 是一个专为 AdonisJS 框架设计的 Model Context Protocol (MCP) 服务器实现。它允许AI代理通过标准化的MCP协议与AdonisJS应用程序进行交互。

主要功能

  • MCP 工具支持:注册和执行外部功能,支持JSON Schema和Zod验证
  • MCP 资源支持:提供数据访问能力,支持URI模板和动态参数
  • MCP 提示支持:定义和渲染可定制的LLM交互模板
  • 多传输协议:支持HTTP、Stdio和模拟传输
  • 高级分页支持:处理大量工具和资源的列表请求
  • 元数据支持:为响应内容添加自定义元信息
  • 注释系统:为工具和资源提供丰富的元数据描述
  • 认证和授权集成:与AdonisJS的auth和bouncer系统无缝集成
  • 完成功能:为提示和资源提供参数建议
  • 检查器工具:提供图形界面调试和测试MCP服务器

安装步骤

  1. 在AdonisJS项目中安装包:
node ace add @jrmc/adonis-mcp
  • 配置文件:安装后会在 'config/mcp.ts' 中生成配置

服务器配置

MCP客户端需要配置以下信息来连接服务器:

  • 服务器类型:AdonisJS应用服务器
  • 启动命令:'node'
  • 启动参数:'ace','mcp:start'
  • 传输协议:支持Stdio和HTTP两种方式

Stdio 传输配置

{
  "command": "node",
  "args": ["ace", "mcp:start"]
- **可访问路径**:HTTP传输时默认为 '/mcp'

## 基本使用方法
1. 使用 Ace 命令创建 MCP 组件:
   - 创建工具:'node ace make:mcp-tool 工具名"
- **资源路径**:默认在 'app/mcp/' 目录下
2. 工具、资源和提示都支持完整的生命周期管理
3. 支持丰富的响应类型:文本、图像、音频、结构化数据、资源链接等
4. 支持资源模板和动态参数提取
5. 内置完整的测试套件和类型定义

## 核心特性
- 完整的MCP协议实现,支持初始化、工具调用、资源读取等核心方法
6. 提供完整的类型安全和开发体验

信息

分类

开发者工具