Adonis MCP Documentation Server
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@Adonis MCP Documentation Server search the docs for 'resource template'"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
Adonis MCP Documentation Server
MCP (Model Context Protocol) server to access adonis-mcp documentation.
📋 Resources
file:///{name}.md - Documentation Markdown File
Resource template to retrieve markdown documentation files from the GitHub repository.
Available files:
inspector- MCP Inspector tool documentationinstallation- Installation guideintroduction- Introduction to MCPprompts- Prompts documentationresources- Resources documentationsessions- Session managementtools- Tools documentationunit-tests- Unit testing
Usage example:
file:///resources.md
file:///tools.mdRelated MCP server: GitHub MCP Server
🛠️ Tools
1. list_documentation
Lists all available documentation files with their descriptions.
Parameters: None
Returns: Structured list of all available documentation files
Annotations:
@isReadOnly()- Read-only@isIdempotent()- Can be called multiple times without side effects
2. search_in_docs
Search for a keyword or phrase across all documentation files.
Parameters:
query(string, required) - The keyword or phrase to search forcaseSensitive(boolean, optional) - Case-sensitive search (default: false)
Returns: List of matches with context (2 lines before/after)
Annotations:
@isReadOnly()- Read-only@isOpenWorld()- Accesses external resources (GitHub)@isIdempotent()- Can be called multiple times without side effects
Example:
{
"query": "Resource templates",
"caseSensitive": false
}3. extract_code_examples
Extracts all code blocks from a documentation file with their languages and line numbers.
Parameters:
filename(string, required) - File name (without .md extension)
Returns: Structured list of all code blocks with their language, content, and line number
Annotations:
@isReadOnly()- Read-only@isOpenWorld()- Accesses external resources (GitHub)@isIdempotent()- Can be called multiple times without side effects
Example:
{
"filename": "resources"
}🎯 Prompts
explain_feature
Guide to get a detailed explanation of an adonis-mcp feature with code examples.
Parameters:
feature(string, required) - The feature to explainlevel(string, optional) - Audience level: "beginner", "intermediate", "advanced" (default: "intermediate")
Suggested features:
resources
tools
prompts
resource templates
tool annotations
completions
authentication
authorization
sessions
unit testing
inspector
middleware
Example:
{
"feature": "resource templates",
"level": "intermediate"
}🚀 Usage
Installation
Install globally via npm:
npm install -g adonis-mcp-docsOr use with npx (no installation required):
npx adonis-mcp-docsTesting locally before publishing
Build the project:
npm run buildTest with npx locally:
cd build
node bin/mcp.jsStart the MCP server
adonis-mcp-docsOr with npx:
npx adonis-mcp-docsConfiguration for MCP Clients
Add to your Claude Desktop or Cursor MCP configuration:
{
"mcpServers": {
"adonis-mcp-docs": {
"command": "npx",
"args": ["adonis-mcp-docs"]
}
}
}📦 Services
DocumentationService
Manages retrieval of remote markdown files from GitHub.
Methods:
fetchMarkdownFile(name: string)- Fetches a markdown filefileExists(name: string)- Checks if a file existsgetFileSize(name: string)- Gets the size of a file
ResourceCompletionService
Provides completion suggestions for documentation file names.
Methods:
getCompletions(prefix?: string)- Returns files matching the prefixgetAllNames()- Returns all available file names
🔍 Combined Usage Examples
Search then read
Use
search_in_docsto find where a concept is documentedUse the
file:///{name}.mdresource to read the complete content
Extract and analyze
Use
extract_code_examplesto get all examplesAnalyze the code with a custom prompt
Explore then explain
Use
list_documentationto see what's availableUse the
explain_featureprompt to get a detailed explanation
📝 Technical Notes
Base URL:
https://raw.githubusercontent.com/batosai/adonis-mcp/main/docsFormat: Markdown (
.md)Search: Case-insensitive by default with 2 lines of context
Parsing: Code block extraction with automatic language detection
🎨 Advanced Features
✅ Completions enabled for all templates
✅ Tool annotations to guide AI
✅ Robust error handling
✅ Search with context
✅ Automatic extraction of all code blocks with language detection
Available Tools
3 toolsextract_code_examplesExtract Code ExamplesARead-onlyIdempotent
Extracts all code blocks from a documentation file with their language and line numbers
Inputs: filename (required).
list_documentationList Documentation FilesARead-onlyIdempotent
Lists all available documentation markdown files with their names and descriptions
Inputs: no named parameters.
search_in_docsSearch in DocumentationARead-onlyIdempotent
Search for a keyword or phrase across all documentation files and return matching sections
Inputs: query (required), caseSensitive.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 3 tools
Each tool targets a distinct operation: discovering files, searching content, and extracting code examples. There is no meaningful overlap or ambiguity between them.
All tool names use a consistent lowercase snake_case verb-first pattern: list_documentation, search_in_docs, extract_code_examples. The naming style is predictable and easy to follow.
Three tools is a reasonable, focused count for a documentation helper, and each tool serves a clear purpose. It is slightly on the low side because a direct full-document retrieval tool would round out the set.
The set supports listing, searching, and extracting code blocks, but lacks a direct 'read/get documentation file' tool. Agents cannot retrieve full document content, which is a significant gap for a documentation server and will cause failures when complete text is needed.
Maintenance
Related MCP Connectors
MCP server for accessing curated awesome list documentation
An MCP server that gives your AI access to the source code and docs of all public github repos
MCP server for opencode documentation, generated by doc2mcp.
Augments MCP Server - A comprehensive framework documentation provider for Claude Code
Related MCP Servers
- FlicenseNot gradedqualityDmaintenanceMCP server that syncs Markdown docs from a GitHub repository and provides search, reading, and listing capabilities for AI agents.-
- AlicenseNot gradedqualityDmaintenanceMCP server for accessing GitHub documentation via API, allowing users to fetch repositories, documentation files, and search across documentation with base64 decoding support.MIT
- AlicenseNot gradedqualityCmaintenanceMCP server for Astro/Starlight docs sites, providing search, get, and list tools for documentation content.586 npm13MIT
- AlicenseAqualityDmaintenanceVersion-aware AdonisJS documentation MCP server that detects your project's AdonisJS version and provides search and retrieval of relevant docs including core, Lucid ORM, Edge, VineJS, and Japa.313 npmMIT