Adonis Docs Mcp

adonis-docs-mcp

为 AI Agent 提供快速访问 AdonisJS 文档（v5、v6、v7）和 Edge.js 模板引擎文档的 MCP 服务。

直接从官方 GitHub 仓库获取原始 Markdown，并在本地缓存以提升速度。

快速开始

# Run with uvx (no install needed)
uvx adonis-docs-mcp

集成

Claude Desktop / Claude Code

添加到 MCP 设置中：

{
  "mcpServers": {
    "adonis-docs": {
      "command": "uvx",
      "args": ["adonis-docs-mcp"]
    }
  }
}

VS Code / GitHub Copilot

添加到 .vscode/mcp.json：

{
  "servers": {
    "adonis-docs": {
      "command": "uvx",
      "args": ["adonis-docs-mcp"]
    }
  }
}

Cursor

添加到 MCP 配置中：

{
  "mcpServers": {
    "adonis-docs": {
      "command": "uvx",
      "args": ["adonis-docs-mcp"]
    }
  }
}

与 Agentfish 搭配使用

与其手动复制这些说明，我们强烈建议使用 Agentfish，将 AdonisJS v7 项目所需的确切规则、指南和上下文自动安装到代码库中。

uvx agentfish add pimentelleo/adonisjs7-agent

这会自动创建必要的 .cursorrules、CLAUDE.md 或 .github/copilot-instructions.md 文件，并配置为使用此 MCP 服务。

可用工具

AdonisJS

工具	描述
list_versions	列出所有可用的 AdonisJS 文档版本（v5、v6、v7）
list_sections	浏览某个版本的文档结构
get_doc	获取特定页面的完整 Markdown 内容
search_docs	按关键词搜索文档标题和内容
clear_cache	清除本地文档缓存

Edge.js 模板

工具	描述
edge_list_sections	浏览 Edge.js 文档结构
edge_get_doc	获取 Edge.js 文档页面的完整 Markdown 内容
edge_search_docs	按关键词搜索 Edge.js 文档

Lucid ORM

工具	描述
lucid_list_sections	浏览 Lucid ORM 文档结构
lucid_get_doc	获取 Lucid ORM 文档页面的完整 Markdown 内容
lucid_search_docs	按关键词搜索 Lucid ORM 文档

软件包注册表

工具	描述
packages_list	列出所有 AdonisJS 软件包，可按类别筛选
packages_search	按关键词搜索软件包（名称、描述、类别）
packages_get	获取特定软件包的完整详情和 README

示例

# List what's available
list_versions()

# Browse v7 docs structure
list_sections(version="v7")

# Read the routing guide
get_doc(permalink="guides/basics/routing", version="v7")

# Search for authentication docs
search_docs(query="authentication", version="v7")

# Search across all versions
search_docs(query="middleware", version="all")

# Browse Edge.js template docs
edge_list_sections()

# Read Edge.js components docs
edge_get_doc(permalink="components/introduction")

# Search Edge.js docs
edge_search_docs(query="slots")

# Browse Lucid ORM docs
lucid_list_sections()

# Read Lucid relationships docs
lucid_get_doc(permalink="relationships")

# Search Lucid ORM docs
lucid_search_docs(query="migrations")

# List all packages
packages_list()

# List authentication packages
packages_list(category="Authentication")

# Search for a package
packages_search(query="jwt")

# Get full details and README for a package
packages_get(name="adonisjs-jwt")

配置

环境变量	默认值	描述
ADONIS_DOCS_CACHE_TTL	3600	缓存 TTL（秒，默认：1 小时）
ADONIS_DOCS_CACHE_DIR	~/.cache/adonis-docs-mcp	缓存目录路径

文档来源

版本	GitHub 仓库	状态
v7	adonisjs/v7-docs	最新（默认）
v6	adonisjs/v6-docs	稳定版
v5	adonisjs/v5-docs	旧版
Edge.js	edge-js/edgejs.dev	模板引擎
Lucid ORM	adonisjs/lucid.adonisjs.com	SQL ORM
软件包	adonisjs-community/adonis-packages	社区注册表

开发

# Clone and install
git clone https://github.com/pimentelleo/adonis-docs-mcp.git
cd adonis-docs-mcp
uv sync

# Run locally
uv run adonis-docs-mcp

# Test with MCP Inspector
npx @modelcontextprotocol/inspector uv run adonis-docs-mcp

发布（维护者）

本项目通过 GitHub Actions 使用 PyPI Trusted Publishing。

一次性设置

1. 前往 https://pypi.org/manage/account/publishing/
2. 添加新的待处理发布者：
   • 项目名称： adonis-docs-mcp
   • 所有者： pimentelleo
   • 仓库： adonis-docs-mcp
   • 工作流名称： publish.yml
   • 环境名称： pypi
3. 保存

发布新版本

1. 更新 pyproject.toml 和 src/adonis_docs_mcp/__init__.py 中的 version
2. 提交并推送
3. 创建 GitHub release（标签格式：v0.1.0）
4. 发布工作流会自动构建并上传到 PyPI

许可证

MIT