Adonis MCP

Adonis MCP

Adonis MCP 是一个为 AdonisJS 框架设计的软件包，提供对 Model Context Protocol（MCP）的支持。借助此软件包，你可以使用 Server-Sent Events（SSE）轻松构建远程 MCP 服务。

安装

运行以下命令安装软件包：

node ace add @7nohe/adonis-mcp

配置

安装后会生成 config/mcp.ts 文件。编辑此文件以自定义 MCP 服务设置。

示例：

import { defineConfig } from '@7nohe/adonis-mcp'

export default defineConfig({
  ssePath: '/sse',
  messagesPath: '/messages',
  serverOptions: {
    name: 'mymcp',
    version: '0.0.1',
  },
})

使用

注册路由

你可以在 start/routes.ts 中使用 registerRoutes 方法定义工具和提示词。以下是一个示例：

import mcp from '@7nohe/adonis-mcp/services/main'
import { ResourceTemplate } from '@modelcontextprotocol/sdk/server/mcp.js'
import { z } from 'zod'

await mcp.registerRoutes((server) => {
  server.resource(
    'echo',
    new ResourceTemplate('echo://{message}', { list: undefined }),
    async (uri, { message }) => ({
      contents: [
        {
          uri: uri.href,
          text: `Resource echo: ${message}`,
        },
      ],
    })
  )

  server.tool('echo', { message: z.string() }, async ({ message }) => ({
    content: [{ type: 'text', text: `Tool echo: ${message}` }],
  }))

  server.prompt('echo', { message: z.string() }, ({ message }) => ({
    messages: [
      {
        role: 'user',
        content: {
          type: 'text',
          text: `Please process this message: ${message}`,
        },
      },
    ],
  }))
})

启动服务

定义路由后，运行以下命令启动 MCP 服务：

npm run dev

调试

使用配置文件

要进行调试，请按如下方式编辑 MCP 服务配置文件（例如 Claude Desktop 或 Cursor 的配置文件）：

{
  "mcpServers": {
    "mymcp": {
      "url": "http://localhost:3333/sse"
    }
  }
}

使用 Inspector

另一种调试方法是使用 Inspector。运行以下命令启动它：

npx @modelcontextprotocol/inspector

1. 将 Transport Type 设为 SSE。
2. 输入 URL http://localhost:3333/sse。
3. 点击 Connect 按钮。
4. 确认状态变为 Connected。

如需了解详情，请参阅 Inspector 文档。

许可证

本项目采用 MIT 许可证。