Adonis Docs Mcp

adonis-docs-mcp

AI エージェントが 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

これにより、この MCP サーバーを使用するよう設定された .cursorrules、CLAUDE.md、または .github/copilot-instructions.md ファイルが自動的に作成されます。

利用可能なツール

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	キャッシュの有効期間（秒）（デフォルト：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 リリースを作成します（タグ形式：v0.1.0）
4. 公開ワークフローによって、PyPI へのビルドとアップロードが自動的に行われます

ライセンス

MIT