AI 支援開発
ErisPulse は、AI が最新のフレームワーク仕様に基づいてコードを生成できるようにする、2つの補完的な AI 支援開発の方法を提供します:
- マテリアルドキュメント:1つの大きな Markdown で、コンテキストを一括投入します。プロジェクト全体の開発に適しています
- MCP サーバー:AI が必要に応じて公式ドキュメントを検索できるようにします。日常のコード補完や API 参照に適しています
| マテリアルドキュメント | MCP サーバー | |
|---|---|---|
| 形式 | 1つの大きな Markdown、一括投入 | AI によるオンデマンド検索 |
| コンテキストコスト | 高い(token を消費) | 低い(関連部分のみ取得) |
| 鮮度 | バージョンリリースに合わせて更新 | リアルタイム(GitHub から取得 + キャッシュ) |
| 適する場面 | コンテキストウィンドウが大きい、プロジェクト全体の開発 | 日常のコード補完、API 参照 |
| クライアント | あらゆる AI ツール | MCP 対応クライアントのみ |
両者は矛盾しません:大規模プロジェクトの開発では同時に使用できます——マテリアルドキュメントを土台とし、MCP で抜け漏れを補完します。
マテリアルドキュメント
マテリアルドキュメントは prompts/ ディレクトリ内にあり、開発シナリオに応じて3種類に分かれています。
| ドキュメント | シナリオ | 説明 |
|---|---|---|
| ErisPulse-ModuleDev.md | モジュール開発 | イベント処理、ルーティング、ライフサイクルなど、モジュール開発の全プロセスをカバー |
| ErisPulse-AdapterDev.md | アダプタ開発 | モジュール開発に加え、アダプタのコア概念、SendDSL、プラットフォーム対応ガイドを含む |
| ErisPulse-Full.md | フルスタックリファレンス | 上記すべて + 完全なユーザーガイドとAPIリファレンスの集約 |
入手方法:docs-generated ブランチ の prompts/ ディレクトリから入手(ドキュメントと同期して更新される)。または、公式サイトの「AI補助開発」ページからダウンロード。
使用方法
- 目的に応じてドキュメントを選択(モジュール →
ModuleDev、アダプタ →AdapterDev、複雑な要件 →Full) - AIにドキュメント内容を上下文として提供する:IDE内にワークスペースとして読み込む、対話形式では直接貼り付ける、API呼び出しではsystem messageとして注入する
- 下記テンプレートに従って要望を記述。具体的に記述するほど、生成品質が向上する
要望記述テンプレート
モジュール:
ErisPulse モジュール開発規格に基づき、[モジュール名] モジュールの完全なコードを生成してください。
機能説明:[コア機能]
監視するイベント:[メッセージ / コマンド / 通知 / リクエスト]、処理ロジック:[操作]
必要な設定項目:[キー名]:[用途]([必須/任意]、デフォルト値:[値])
その他の要件:[追加の制約]
アダプタ:
ErisPulse アダプタ開発規格に基づき、[アダプタ名] アダプタの完全なコードを生成してください。
プラットフォーム情報:[名称]、通信プロトコル:[WebSocket / WebHook / HTTPポーリング]、APIドキュメント:[アドレス]
イベント変換:プラットフォームイベント [タイプ] → OneBot12 へのマッピング [関係]
実装する送信メソッド:[テキスト / 画像 / 音声 ...]
設定項目:[キー名]:[用途]([必須/任意])
ドキュメント全集パッケージ
skills.zip は、この言語のすべてのドキュメントの原文を、統合や改変を行わず圧縮したものです。ルートディレクトリには、README総索引が付属しており、ディレクトリごとにグループ分けされ、各ドキュメントの「いつ読む必要があるか」が明記されています。AIはこの索引に従って、必要なドキュメントのみを読み込むことができます。
マテリアルドキュメントとの違い
| マテリアルドキュメント | ドキュメント全集パッケージ | |
|---|---|---|
| 形態 | 単一の .md に統合されたもの |
全てのドキュメントの原文 + 索引付きREADME |
| 使用方法 | 一括してコンテキストに投入 | 解凍してワークスペースに配置し、AIが必要に応じてドキュメントを読み込む |
| 適用対象 | コンテキストウィンドウが十分な場合、プロジェクト全体の開発 | ワークスペースに長期的に滞在し、必要に応じて検索する場合 |
これらは同一のドキュメント群から生成され、同期して更新されます。
取得方法
公式サイトの「AI支援開発」ページからダウンロードするか、または docs-generated ブランチ の docs/ja/ai-support/skills.zip を直接取得してください。
MCP サーバー
ErisPulse はドキュメント検索用の MCP Server を提供しており、AI コーディングアシスタント(MCP 対応であればどれでも)がコードを書く際に直接 ErisPulse 公式ドキュメントを検索・閲覧できるようになります。
接続方法は2つあります:ローカルプロセス(推奨)または公式オンラインエンドポイントです。ツールセットは共通です:
| ツール | パラメータ | 説明 |
|---|---|---|
search_docs |
query (必須), top_k?=5, lang?=zh-CN |
BM25 キーワード検索。複数のキーワードを一度に渡せます |
read_document |
doc_path (必須), lang?=zh-CN |
単一ドキュメントの完全な Markdown を読み取る |
list_documents |
lang?=zh-CN |
現在の言語のすべてのドキュメントのタイトル、パス、カテゴリを一覧表示 |
list_languages |
— | ドキュメントがサポートするすべての言語とドキュメント数を一覧表示 |
サポート言語:zh-CN / en / zh-TW / ja / ru。検索のコツ:文章全体ではなく複数のキーワードを使用します。たとえば コマンド登録 イベントリッスン は コマンドを1つ登録する方法 よりも良い結果が得られます。
方法1:ローカルプロセス(推奨)
インストール後、ローカルで直接起動します:
npm i -g @erisdev/mcp-server # グローバルインストール → epsdk-mcp コマンドが使用可能に
epsdk-mcp --server # MCP サービスを起動;初回実行時にドキュメントを ~/.cache/erispulse-mcp/docs へ自動取得
グローバルインストールしなくても、npx で直接実行できます(インストール不要):
npx @erisdev/mcp-server --server
ローカルにドキュメントディレクトリがある場合はそれを指定します(オフライン):
ERISPULSE_DOCS_DIR=/path/to/erispulse/docs epsdk-mcp --server
MCP クライアントでは stdio トランスポートで設定します。標準的なキー値(command + args で上記の起動方法を指定;具体的な設定場所と形式は各クライアント自身の MCP 接続ドキュメントを参照):
{
"command": "epsdk-mcp",
"args": ["--server"]
}
または
{
"command": "npx",
"args": ["@erisdev/mcp-server", "--server"]
}
方法2:公式オンラインエンドポイント
ローカルでプロセスを起動したくない場合は、公式ホスティングの mcp.erisdev.com に接続します。MCP クライアントでは HTTP トランスポートで設定します:
{
"url": "https://mcp.erisdev.com/"
}
サービスはデフォルトで公開されており、Token は不要ですが、IP レート制限があります(IP ごとに毎分 60 回)。公式エンドポイントはいつでも停止される可能性があるため、本番ワークフローでは方法1(ローカルプロセス)またはセルフホスティングを推奨します。
よくある質問
生成されたコードが期待どおりでない場合は? 完全なドキュメントが提供されているか確認します;要件に入出力例や境界条件などの詳細を追加します;AI に段階的に生成させます(まずスケルトンを作り、その後機能を補完);examples/ ディレクトリのサンプルを補足コンテキストとして参考にします。
MCP 接続後に AI が search_docs を呼び出さない場合は?
クライアントがその server をロードしているか確認します(クライアントを再起動するとツールが有効になっているのが確認できます);一部のクライアントでは、prompt に「ErisPulse ドキュメントツールを使って API を確認する」ことを明示的に指示する必要があります。