AI補助開発

ErisPulse は、最新のフレームワーク仕様に基づいてコードを生成できる、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リファレンスのまとめ

入手方法：prompts/ ディレクトリから直接取得（ドキュメントと同期して更新される）、または GitHub Releases から対応するバージョンをダウンロード。

使用方法

目的に応じてドキュメントを選択（モジュール → ModuleDev、アダプター → AdapterDev、複雑な要件 → Full）
ドキュメントの内容をAIにコンテキストとして提供する：IDE内にワークスペースとして配置、対話形式では直接貼り付け、API呼び出しではsystem messageとして注入
下記のテンプレートを使用して要件を記述。記述が具体的であればあるほど、生成される品質も高くなる

要求記述テンプレート

モジュール：

ErisPulse モジュール開発規格に基づき、[モジュール名] モジュールの完全なコードを生成してください。

機能説明：[コア機能]
監視するイベント：[メッセージ / コマンド / 通知 / 要求]、処理ロジック：[操作]
必要な設定項目：[キー名]：[用途]（[必須/任意]、デフォルト値：[値]）
その他の要件：[追加の制約]

アダプター：

ErisPulse アダプター開発規格に基づき、[アダプター名] アダプターの完全なコードを生成してください。

プラットフォーム情報：[名称]、通信プロトコル：[WebSocket / WebHook / HTTP ポーリング]、APIドキュメント：[アドレス]
イベント変換：プラットフォームイベント [タイプ] → OneBot12 映射 [関係性]
実装する送信メソッド：[Text / Image / Voice ...]
設定項目：[キー名]：[用途]（[必須/任意]）

MCP サーバー

ErisPulse は、AIコードアシスタント（MCPをサポートするもの）がコードを書く際に、ErisPulse公式ドキュメントを直接検索・参照できるようにするドキュメント検索MCPサーバーを提供しています。

接続方法は2つあります：ローカルプロセス（推奨）または公式オンラインエンドポイント。両方ともツールセットは同じです：

ツール	パラメータ	説明
`search_docs`	`query` (必須), `top_k?=5`, `lang?=zh-CN`	BM25キーワード検索。複数のキーワードを一度に送信できます。
`read_document`	`doc_path` (必須), `lang?=zh-CN`	1つのドキュメントの完全なMarkdownを読み取ります。
`list_documents`	`lang?=zh-CN`	現在の言語で利用可能なすべてのドキュメントのタイトル、パス、カテゴリをリストアップします。
`list_languages`	—	ドキュメントがサポートするすべての言語とドキュメント数をリストアップします。

サポート言語：zh-CN / en / zh-TW / ja / ru。検索のコツ：整文ではなく、複数のキーワードを使用してください。たとえば、命令登録イベントリスナーはどうやって命令を登録するかよりも効果的です。

方法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制限（1IPあたり1分間に60回）が適用されています。公式エンドポイントはいつでも停止される可能性があるため、本番ワークフローでは方法1（ローカルプロセス）または自前ホストの使用を推奨します。

常見問題

生成されたコードが期待通りではない？
完全なドキュメントを提供しているか確認してください。要件に詳細を追加する（入出力の例、境界条件など）。AI にステップごとに生成させる（まず骨格を生成してから機能を補う）。examples/ ディレクトリの例を参考にして、コンテキストを補完してください。

MCP 接続後、AI が search_docs を呼び出していない？
クライアントが該当のサーバーをロードしているか確認してください（クライアントを再起動するとツールが有効になっていることが確認できます）。一部のクライアントでは、プロンプト内で「ErisPulse ドキュメントツールを使って API を確認する」と明示的に指示する必要があります。

次のステップ

モジュール開発の入門 -- モジュールの手動開発に関する完全なチュートリアル
アダプター開発の入門 -- アダプターの手動開発に関する完全なチュートリアル
サンプルコード -- 既存のモジュールおよびアダプター実装を参照
モジュールビルダー -- ブラウザ内で利用可能な視覚的なAIモジュール生成ツール