Adonis MCP
About
An AdonisJS package for building remote MCP servers
Details
- Author
- 7nohe
- GitHub stars
- 10
- Downloads
- 257
- Categories
- Other
Jump to
- Integrates MCP support directly into AdonisJS.
- Uses Server-Sent Events (SSE) for remote transport.
- Allows defining resources, tools, and prompts via registerRoutes.
- Provides configuration for custom SSE and messages paths.
- Supports debugging with MCP Inspector and client config files.
Setting up with Highlight
This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:
- Download and install Highlight from highlightai.com/download
- Navigate to the plugins tab and select "Add Custom Plugin"
-
Configure the plugin with the settings below
Plugin Name
Adonis MCPCommand (node, npx, python, etc.)Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.
- Enable "Start Automatically" if you want the plugin to start when Highlight launches
From the repository
Install via node ace add @7nohe/adonis-mcp. Configure by editing the generated config/mcp.ts file. Register routes (tools, resources, prompts) in start/routes.ts using the registerRoutes method, then start the server with npm run dev. Debug via a configuration file (e.g., for Claude Desktop) or the MCP Inspector.
Claude Desktop / Cursor
Paste into your MCP client config file to install this server.
{
"mcpServers": {
"adonis mcp": {
"adonis-mcp": {
"command": "node",
"args": [
"ace",
"add",
"@7nohe/adonis-mcp"
]
}
}
}
}McpServers
{
"adonis-mcp": {
"command": "node",
"args": [
"ace",
"add",
"@7nohe/adonis-mcp"
]
}
}Adonis MCP
Adonis MCP is a package designed for the AdonisJS framework that provides support for the Model Context Protocol (MCP). With this package, you can easily build remote MCP servers using Server-Sent Events (SSE).
Installation
Run the following command to install the package:
node ace add @7nohe/adonis-mcp
Configuration
After installation, a config/mcp.ts file will be generated. Edit this file to customize the MCP server settings.
Example:
import { defineConfig } from '@7nohe/adonis-mcp'
export default defineConfig({
ssePath: '/sse',
messagesPath: '/messages',
serverOptions: {
name: 'mymcp',
version: '0.0.1',
},
})
Usage
Registering Routes
You can use the registerRoutes method in start/routes.ts to define tools and prompts. Below is an example:
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},
},
},
],
}))
})
Starting the Server
After defining the routes, start the MCP server by running the following command:
npm run dev
Debugging
Using Configuration File
To debug, edit the MCP server configuration file (e.g., for Claude Desktop or Cursor) as follows:
{
"mcpServers": {
"mymcp": {
"url": "http://localhost:3333/sse"
}
}
}
Using Inspector
Another debugging method is to use the Inspector. Start it with the following command:
npx @modelcontextprotocol/inspector
1. Set the Transport Type to SSE.
2. Enter the URL http://localhost:3333/sse.
3. Click the Connect button.
4. Confirm that the status changes to Connected.
For more details, refer to the Inspector Documentation.
License
This project is provided under the MIT License.
Sign in to leave a review
Use Google, GitHub, or an email account so ratings stay tied to real people.
No reviews posted yet.
