@jrmc/adonis-mcp

AdonisJS MCP - Server MCP for your AdonisJS applications.

Note: This documentation has been generated by AI and has not been fully verified yet. Please report any inaccuracies or issues you encounter.

Links

View documentation

Roadmap

[x] MCP tools support
[x] MCP resources support
[x] MCP prompts support
[x] HTTP transport
[x] Stdio transport
[x] Fake transport (for testing)
[x] Advanced pagination support
[x] Meta support
[x] Annotations
[x] Completion
[x] Inspector
[x] Session
[x] Documentation
[ ] Output tool
[ ] Vine integration
[ ] Bounce integration (WIP)
[ ] Auth helpers (WIP)
[ ] Inject support
[ ] Alternative transports (SSE)
[ ] JSON Schema with Vine ???
[ ] Login flow
[ ] Starter kit
[ ] Demo applications

Installation & Configuration

node ace add @jrmc/adonis-mcp

This will create a configuration file config/mcp.ts:

import { defineConfig } from '@jrmc/adonis-mcp'

export default defineConfig({
  name: 'adonis-mcp-server',
  version: '1.0.0',
})

By default, your MCP tools, resources, and prompts will be stored in app/mcp. If you want to use a different path, you need to configure it in your adonisrc.ts file:

directories: {
  mcp: 'app/custom/mcp', // Optional: custom path for MCP files (defaults to 'app/mcp')
}

Usage

Creating a Tool

To create a new tool, use the Ace command:

node ace make:mcp-tool my_tool

This command will create a file in app/mcp/tools/my_tool.ts with a base template:

import type { ToolContext } from '@jrmc/adonis-mcp/types/context'
import type { BaseSchema } from '@jrmc/adonis-mcp/types/method'

import { Tool } from '@jrmc/adonis-mcp'

type Schema = BaseSchema<{
  text: { type: "string" }
}>

export default class MyToolTool extends Tool<Schema> {
  name = 'tool_name'
  title = 'Tool title'
  description = 'Tool description'

  async handle({ args, response }: ToolContext<Schema>) {
    console.log(args.text)
    return response.text('Hello, world!')
  }

  schema() {
    return {
      type: "object",
      properties: {
        text: {
          type: "string",
          description: "Description text argument"
        },
      },
      required: ["text"]
    } as Schema
  }
}

Schema Definition

The schema defines the input parameters of your tool. It follows the JSON Schema specification:

schema() {
  return {
    type: "object",
    properties: {
      title: {
        type: "string",
        description: "Bookmark title"
      },
      url: {
        type: "string",
        description: "Bookmark URL"
      }
    },
    required: ["title", "url"]
  } as Schema
}

You can also use Zod to define your schema:

import * as z from 'zod'

const zodSchema = z.object({
  page: z.number().optional(),
  perPage: z.number().optional()
})

schema() {
  return z.toJSONSchema(
    zodSchema,
    { io: "input" }
  ) as Schema
}

Handler Implementation

The handle method contains your tool's logic. It receives a typed context with validated arguments:

async handle({ args, response, auth, bouncer }: ToolContext<Schema>) {
  // Your logic here
  const result = await SomeModel.query().where('id', args.id)
  
  return response.text(JSON.stringify({ result }))
}

Setting up Authentication and Bouncer

To use auth and bouncer in your MCP tools, prompts, and resources, add the following TypeScript declaration in your middleware (e.g., in your MCP middleware):

declare module '@jrmc/adonis-mcp/types/context' {
  export interface McpContext {
    auth?: {
      user?: HttpContext['auth']['user']
    }
    bouncer?: Bouncer<
      Exclude<HttpContext['auth']['user'], undefined>,
      typeof abilities,
      typeof policies
    >
  }
}

The MCP context automatically binds auth and bouncer from the HttpContext if they are available, so make sure your middleware initializes them on the HttpContext first.

Registering the MCP Route

In your start/routes.ts file, register the MCP route and apply middleware:

import { middleware } from '#start/kernel'
import router from '@adonisjs/core/services/router'

// Register MCP route (defaults to /mcp, or specify a custom path)
router.mcp().use(middleware.auth())

You can also specify a custom path:

router.mcp('/custom-mcp-path').use(middleware.auth())

⚠️ Important: CSRF Protection

If you have CSRF protection enabled in your application, you must exclude the MCP route from CSRF validation. MCP clients typically don't include CSRF tokens in their requests.

In your config/shield.ts file, add the MCP route to the CSRF exceptions:
export const shieldConfig = defineConfig({
  csrf: {
    enabled: true,
    exceptRoutes: [
      '/mcp', // Or your custom MCP path
    ],
  },
})

Using Authentication

The MCP context automatically includes the auth instance from the HttpContext if available. You can use it to access the authenticated user:

async handle({ args, auth, response }: ToolContext<Schema>) {
  const user = auth?.user
  
  if (!user) {
    throw new Error('User not authenticated')
  }
  
  // Use the authenticated user
  const bookmark = await Bookmark.create({
    title: args.title,
    userId: user.id,
  })
  
  return response.text(JSON.stringify({ bookmark }))
}

Using Bouncer

The MCP context automatically includes the bouncer instance from the HttpContext if available. You can use it to check permissions:

async handle({ args, bouncer, response }: ToolContext<Schema>) {
  // Check a permission
  await bouncer.authorize('viewUsers')
  
  // Or use a policy
  const user = await User.findOrFail(args.userId)
  await bouncer.with(UserPolicy).authorize('view', user)
  
  return response.text(JSON.stringify({ user }))
}

Response Return

The context includes a response instance to format your responses. The available methods depend on the context type:

Tool Responses

For tools, you can use:

response.text(text: string): Return plain text content
response.image(data: string, mimeType: string): Return image content (base64 encoded)
response.audio(data: string, mimeType: string): Return audio content (base64 encoded)
response.structured(object: Record<string, unknown>): Return structured JSON data
response.resourceLink(uri: string): Return a link to a resource
response.error(message: string): Return an error message
response.send(content: Content | Content[]): Send custom content objects

async handle({ args, response }: ToolContext<Schema>) {
  // Return text
  return response.text(JSON.stringify({ success: true }))
  
  // Return structured data
  return response.structured({
    temperature: 22.5,
    conditions: 'Partly cloudy',
    humidity: 65
  })
  
  // Return image
  const imageData = await fs.readFile('path/to/image.png', 'base64')
  return response.image(imageData, 'image/png')
  
  // Return a resource link
  return response.resourceLink('file:///path/to/resource.txt')
  
  // Return error
  return response.error('Something went wrong')
}

Resource Responses

For resources, you can use:

response.text(text: string): Return text content
response.blob(text: string): Return binary content (base64 encoded)

async handle({ response }: ResourceContext) {
  const content = await fs.readFile('path/to/file.txt', 'utf-8')
  return response.text(content)
}

Complete Example

Here is a complete example of a tool that creates a bookmark:

import type { ToolContext } from '@jrmc/adonis-mcp/types/context'
import type { BaseSchema } from '@jrmc/adonis-mcp/types/method'

import { Tool } from '@jrmc/adonis-mcp'
import Bookmark from '#models/bookmark'

type Schema = BaseSchema<{
  title: { type: "string" }
  url: { type: "string" }
}>

export default class AddBookmarkTool extends Tool<Schema> {
  name = 'create_bookmark'
  title = 'Create Bookmark'
  description = 'Create a new bookmark'

  async handle({ args, response, auth }: ToolContext<Schema>) {
    const bookmark = await Bookmark.create({
      title: args.title,
      text: args.url,
      userId: auth?.user?.id,
    })

    return response.text(JSON.stringify({ bookmark }))
  }

  schema() {
    return {
      type: "object",
      properties: {
        title: {
          type: "string",
          description: "Bookmark title"
        },
        url: {
          type: "string",
          description: "Bookmark URL"
        }
      },
      required: ["title", "url"]
    } as Schema
  }
}

Advanced Features

Structured Output

The response.structured() method allows you to return JSON data in a structured format. This is particularly useful when you want to return data that can be easily parsed and used by the MCP client without additional processing:

import type { ToolContext } from '@jrmc/adonis-mcp/types/context'
import { Tool } from '@jrmc/adonis-mcp'

export default class GetWeatherTool extends Tool {
  name = 'get_weather'
  title = 'Get Weather'
  description = 'Get current weather data'

  async handle({ args, response }: ToolContext) {
    const weatherData = {
      temperature: 22.5,
      conditions: 'Partly cloudy',
      humidity: 65,
      windSpeed: 12,
      location: args.location
    }
    
    return response.structured(weatherData)
  }
}

Note: Structured content can only be used in tools, not in prompts or resources.

Resource Links

Resource links allow you to reference other resources in your tool responses. This is useful when you want to point to additional information without embedding the entire resource content:

import type { ToolContext } from '@jrmc/adonis-mcp/types/context'
import { Tool } from '@jrmc/adonis-mcp'

export default class GetDocumentationTool extends Tool {
  name = 'get_documentation'
  title = 'Get Documentation'
  description = 'Get documentation for a specific topic'

  async handle({ args, response }: ToolContext) {
    return [
      response.text('Here is the documentation for your topic:'),
      response.resourceLink(`file:///docs/${args.topic}.md`)
    ]
  }
}

The resource link will include metadata about the resource (name, mimeType, title, description, size) without fetching the actual content. The MCP client can then decide whether to fetch the resource content separately.

Note: Resource links can only be used in tools, not in prompts or resources.

Metadata with `withMeta()`

The withMeta() method is available on all content types and allows you to attach custom metadata to your responses. This metadata can be used by MCP clients for various purposes such as logging, analytics, or custom processing:

async handle({ args, response }: ToolContext<Schema>) {
  const users = await User.all()
  
  return response.text(JSON.stringify(users)).withMeta({
    source: 'database',
    queryTime: Date.now(),
    count: users.length,
    cacheHit: false
  })
}

Metadata is particularly useful when:

You want to provide debugging information
You need to track the source of data
You want to include performance metrics
You need to pass additional context to the client

Annotations

Annotations allow you to provide additional metadata about your tools and resources to help MCP clients better understand their behavior and characteristics.

Tool Annotations

Tools support the following annotations that describe their operational characteristics:

`@isReadOnly()`

Indicates that a tool only reads data and does not modify any state:

import { Tool } from '@jrmc/adonis-mcp'
import { isReadOnly } from '@jrmc/adonis-mcp/tool_annotations'

@isReadOnly()
export default class GetUserTool extends Tool {
  name = 'get_user'
  
  async handle({ args, response }: ToolContext) {
    const user = await User.find(args.id)
    return response.text(JSON.stringify(user))
  }
}

You can also explicitly set it to false:

@isReadOnly(false)
export default class UpdateUserTool extends Tool {
  // ...
}

`@isOpenWorld()`

Indicates that a tool can access information from the internet or external sources:

import { isOpenWorld } from '@jrmc/adonis-mcp/tool_annotations'

@isOpenWorld()
export default class FetchWeatherTool extends Tool {
  name = 'fetch_weather'
  
  async handle({ args, response }: ToolContext) {
    const weather = await externalApi.getWeather(args.city)
    return response.text(JSON.stringify(weather))
  }
}

`@isDestructive()`

Indicates that a tool performs destructive operations like deleting data:

import { isDestructive } from '@jrmc/adonis-mcp/tool_annotations'

@isDestructive()
export default class DeleteUserTool extends Tool {
  name = 'delete_user'
  
  async handle({ args, response }: ToolContext) {
    await User.query().where('id', args.id).delete()
    return response.text('User deleted successfully')
  }
}

`@isIdempotent()`

Indicates that a tool can be safely called multiple times with the same arguments without causing different effects:

import { isIdempotent } from '@jrmc/adonis-mcp/tool_annotations'

@isIdempotent()
export default class SetUserStatusTool extends Tool {
  name = 'set_user_status'
  
  async handle({ args, response }: ToolContext) {
    await User.query().where('id', args.id).update({ status: args.status })
    return response.text('Status updated')
  }
}

Combining Multiple Annotations

You can use multiple annotations on the same tool:

import { isReadOnly, isOpenWorld, isIdempotent } from '@jrmc/adonis-mcp/tool_annotations'

@isReadOnly()
@isOpenWorld()
@isIdempotent()
export default class SearchOnlineTool extends Tool {
  name = 'search_online'
  
  async handle({ args, response }: ToolContext) {
    const results = await searchEngine.search(args.query)
    return response.text(JSON.stringify(results))
  }
}

Resource Annotations

Resources support the following annotations to provide additional context:

`@priority()`

Specifies the importance of a resource as a number between 0.0 and 1.0:

import { Resource } from '@jrmc/adonis-mcp'
import { priority } from '@jrmc/adonis-mcp/annotations'

@priority(0.9)
export default class ImportantDocResource extends Resource {
  name = 'important_doc.txt'
  uri = 'file:///important_doc.txt'
  
  async handle({ response }: ResourceContext) {
    return response.text('Critical documentation content')
  }
}

`@audience()`

Specifies the intended audience for a resource (user, assistant, or both):

import { Resource } from '@jrmc/adonis-mcp'
import { audience } from '@jrmc/adonis-mcp/annotations'
import Role from '@jrmc/adonis-mcp/enums/role'

@audience(Role.USER)
export default class UserManualResource extends Resource {
  name = 'user_manual.txt'
  uri = 'file:///user_manual.txt'
  
  async handle({ response }: ResourceContext) {
    return response.text('User manual content')
  }
}

You can also specify multiple audiences:

@audience([Role.USER, Role.ASSISTANT])
export default class SharedDocResource extends Resource {
  // ...
}

`@lastModified()`

Indicates when a resource was last updated (ISO 8601 timestamp):

import { Resource } from '@jrmc/adonis-mcp'
import { lastModified } from '@jrmc/adonis-mcp/annotations'

@lastModified('2024-12-12T10:00:00Z')
export default class DocumentResource extends Resource {
  name = 'document.txt'
  uri = 'file:///document.txt'
  
  async handle({ response }: ResourceContext) {
    return response.text('Document content')
  }
}

Combining Resource Annotations

You can use multiple annotations on the same resource:

import { Resource } from '@jrmc/adonis-mcp'
import { priority, audience, lastModified } from '@jrmc/adonis-mcp/annotations'
import Role from '@jrmc/adonis-mcp/enums/role'

@priority(0.8)
@audience([Role.USER, Role.ASSISTANT])
@lastModified('2024-12-12T10:00:00Z')
export default class ApiDocResource extends Resource {
  name = 'api_docs.txt'
  uri = 'file:///api_docs.txt'
  
  async handle({ response }: ResourceContext) {
    return response.text('API documentation content')
  }
}

Creating a Resource

To create a new resource, use the Ace command:

node ace make:mcp-resource my_resource

This command will create a file in app/mcp/resources/my_resource.ts with a base template:

import type { ResourceContext } from '@jrmc/adonis-mcp/types/context'

import { Resource } from '@jrmc/adonis-mcp'

export default class MyResourceResource extends Resource {
  name = 'example.txt'
  uri = 'file:///example.txt'
  mimeType = 'text/plain'
  title = 'Resource title'
  description = 'Resource description'
  size = 0

  async handle({ response }: ResourceContext) {
    this.size = 1000
    return response.text('Hello World')
  }
}

Resource Properties

Resources have the following properties:

name (optional): The name of the resource
uri (required): The unique identifier for the resource (must be unique)
mimeType (optional): The MIME type of the resource
title (optional): A human-readable title
description (optional): A description of the resource
size (optional): The size of the resource in bytes

Resource Handler

The handle method returns the content of the resource. You can use response.text() for text content or response.blob() for binary content:

async handle({ response }: ResourceContext) {
  const content = await fs.readFile('path/to/file.txt', 'utf-8')
  this.size = content.length
  return response.text(content)
}

URI Templates

Resources support URI templates (RFC 6570) to create dynamic resources. This allows you to define resources with variable parts in their URIs:

import type { ResourceContext } from '@jrmc/adonis-mcp/types/context'
import { Resource } from '@jrmc/adonis-mcp'

type Args = {
  name: string
}

export default class RobotsResource extends Resource<Args> {
  name = 'robots.txt'
  uri = 'file:///{name}.txt'
  mimeType = 'text/plain'
  title = 'Robots file'
  description = 'Dynamic robots.txt file'

  async handle({ args, response }: ResourceContext<Args>) {
    this.size = 1000
    return response.text(`Hello World ${args?.name}`)
  }
}

When a client requests file:///robots.txt, the template file:///{name}.txt will match and extract name: "robots" as an argument, which will be available in the handle method via args.name.

URI templates support various operators:

{name} - Simple variable substitution
{/name} - Path segment
{?name} - Query parameter
{&name} - Additional query parameter
{#name} - Fragment identifier
{+name} - Reserved characters allowed
{.name} - Dot-prefixed segment

For more information, see RFC 6570.

Creating a Prompt

To create a new prompt, use the Ace command:

node ace make:mcp-prompt my_prompt

This command will create a file in app/mcp/prompts/my_prompt.ts with a base template:

import type { PromptContext } from '@jrmc/adonis-mcp/types/context'
import type { BaseSchema } from '@jrmc/adonis-mcp/types/method'

import { Prompt } from '@jrmc/adonis-mcp'

type Schema = BaseSchema<{
  text: { type: "string" }
}>

export default class MyPromptPrompt extends Prompt<Schema> {
  name = 'my_prompt'
  title = 'Prompt title'
  description = 'Prompt description'

  async handle({ args, response }: PromptContext<Schema>) {
    return [
      response.text('Hello, world!')
    ]
  }

  schema() {
    return {
      type: "object",
      properties: {
        text: {
          type: "string",
          description: "Description text argument"
        },
      },
      required: ["text"]
    } as Schema
  }
}

Prompt Schema

Prompts use the same schema definition system as tools, following the JSON Schema specification. You can also use Zod to define your schema:

import * as z from 'zod'

const zodSchema = z.object({
  code: z.string(),
  language: z.string().optional()
})

schema() {
  return z.toJSONSchema(
    zodSchema,
    { io: "input" }
  ) as Schema
}

Prompt Handler

The handle method for prompts returns an array of content objects. This allows you to return multiple pieces of content, including embedded resources:

async handle({ args, response }: PromptContext<Schema>) {
  return [
    response.text(`Please review this code:\n\n${args.code}`),
    response.embeddedResource('file:///example.txt')
  ]
}

Prompt Response Methods

For prompts, you can use the same response methods as tools, but you must return an array:

response.text(text: string): Return plain text content
response.image(data: string, mimeType: string): Return image content (base64 encoded)
response.audio(data: string, mimeType: string): Return audio content (base64 encoded)
response.embeddedResource(uri: string): Embed another resource in the prompt response

All response methods also support the withMeta() method to add metadata:

async handle({ args, response }: PromptContext<Schema>) {
  return [
    response.text('Here is the code to review:').withMeta({ 
      language: args.language 
    }),
    response.embeddedResource('file:///code.py'),
    response.text('Please provide feedback.')
  ]
}

Complete Prompt Example

Here is a complete example of a prompt for code review:

import type { PromptContext } from '@jrmc/adonis-mcp/types/context'
import type { BaseSchema } from '@jrmc/adonis-mcp/types/method'

import { Prompt } from '@jrmc/adonis-mcp'

type Schema = BaseSchema<{
  code: { type: "string" }
  language: { type: "string" }
}>

export default class CodeReviewPrompt extends Prompt<Schema> {
  name = 'code_review'
  title = 'Code Review'
  description = 'Review code and provide feedback'

  async handle({ args, response }: PromptContext<Schema>) {
    return [
      response.text(`Please review this ${args.language} code:\n\n${args.code}`),
      response.text('Provide feedback on code quality, potential bugs, and improvements.')
    ]
  }

  schema() {
    return {
      type: "object",
      properties: {
        code: {
          type: "string",
          description: "The code to review"
        },
        language: {
          type: "string",
          description: "Programming language"
        }
      },
      required: ["code", "language"]
    } as Schema
  }
}

Completions

Completions provide argument suggestions for prompts and resources, helping users fill in parameters interactively. This feature must be enabled in your configuration and can be implemented for both prompts and resources.

Enabling Completions

First, enable completions in your config/mcp.ts:

import { defineConfig } from '@jrmc/adonis-mcp'

export default defineConfig({
  name: 'adonis-mcp-server',
  version: '1.0.0',
  completions: true, // Enable completions
})

Implementing Completions in Prompts

Add a complete() method to your prompt to provide argument suggestions:

import type { PromptContext, CompleteContext } from '@jrmc/adonis-mcp/types/context'
import type { BaseSchema } from '@jrmc/adonis-mcp/types/method'

import { Prompt } from '@jrmc/adonis-mcp'

type Schema = BaseSchema<{
  language: { type: "string" }
  code: { type: "string" }
}>

export default class CodeReviewPrompt extends Prompt<Schema> {
  name = 'code_review'
  title = 'Code Review'
  description = 'Review code and provide feedback'

  async handle({ args, response }: PromptContext<Schema>) {
    return [
      response.text(`Please review this ${args.language} code:\n\n${args.code}`)
    ]
  }

  async complete({ args, response }: CompleteContext<Schema>) {
    // Provide language suggestions when the user types
    if (args?.language !== undefined) {
      return response.complete({
        values: ['python', 'javascript', 'typescript', 'java', 'go', 'rust']
      })
    }
    
    return response.complete({ values: [] })
  }

  schema() {
    return {
      type: "object",
      properties: {
        language: {
          type: "string",
          description: "Programming language"
        },
        code: {
          type: "string",
          description: "Code to review"
        }
      },
      required: ["language", "code"]
    } as Schema
  }
}

Implementing Completions in Resources

Resources with URI templates can also provide completions for their path parameters:

import type { ResourceContext, CompleteContext } from '@jrmc/adonis-mcp/types/context'
import { Resource } from '@jrmc/adonis-mcp'

type Args = {
  directory: string
  name: string
}

export default class ConfigFileResource extends Resource<Args> {
  name = 'config_file'
  uri = 'file://{directory}/{name}.txt'
  mimeType = 'text/plain'
  title = 'Configuration File'
  description = 'Access configuration files'

  async handle({ args, response }: ResourceContext<Args>) {
    const content = await readConfigFile(args.directory, args.name)
    return response.text(content)
  }

  async complete({ args, response }: CompleteContext<Args>) {
    // Provide suggestions based on available directories and files
    if (args?.name !== undefined) {
      return response.complete({
        values: ['config', 'settings', 'environment', 'database']
      })
    }
    
    if (args?.directory !== undefined) {
      return response.complete({
        values: ['production', 'staging', 'development']
      })
    }
    
    return response.complete({ values: [] })
  }
}

Completion Context

The complete() method receives a CompleteContext that includes:

args: The current argument values (partial or complete)
response: The response object with a complete() method

The response format includes:

response.complete({
  values: string[],     // Array of suggested values
  hasMore?: boolean,    // Optional: indicates if more values are available
  total?: number        // Optional: total number of available values
})

Transports

The package supports multiple transport mechanisms:

HTTP Transport: Default transport for HTTP-based MCP servers (used when accessing via HTTP routes)
Stdio Transport: For command-line MCP servers that communicate via standard input/output
Fake Transport: For testing purposes, allows you to capture and inspect MCP messages

Pagination

The tools/list and resources/list methods support cursor-based pagination to handle large numbers of tools and resources efficiently. This is particularly useful when you have many tools or resources registered in your application. More information

Testing & Debugging

MCP Inspector

The MCP Inspector is a powerful tool for debugging and testing your MCP server. It provides a graphical interface to interact with your tools, resources, and prompts.

To open the MCP Inspector, use the following command:

node ace mcp:inspector

By default, this command uses HTTP transport. You can specify a different transport type:

# Use HTTP transport (default)
node ace mcp:inspector http

# Use stdio transport
node ace mcp:inspector stdio

Important notes:

The inspector can only be used in development environment (not in production)
For HTTP transport, make sure your server is running and the MCP route is configured
The inspector will automatically connect to your MCP server and allow you to:
- List and test all available tools
- Browse and read resources
- Execute prompts with different arguments
- Inspect request/response payloads
- Debug any issues with your MCP implementation

Support

For any questions or issues, please open an issue on the GitHub repository.

Inspiration

This package is inspired by laravel/mcp.

adonis-mcp