ErisPulse ErisPulse
在互動式文檔中心打開 →
本頁章節
本文為靜態鏡像,內容以互動版為準 在互動式文檔中心打開 →

AI 輔助開發

ErisPulse 提供兩種互補的 AI 輔助開發方式,讓 AI 能基於最新框架規範生成程式碼:

  • 物料文件:一份大 Markdown,一次性灌入上下文,適合整項目開發
  • MCP 伺服器:讓 AI 按需檢索官方文件,適合日常程式碼補全和查 API
物料文件 MCP 伺服器
形式 一份大 Markdown,一次性灌入 AI 按需檢索
上下文成本 高(佔 token) 低(只取相關片段)
即時性 隨版本發布更新 即時(GitHub 拉取 + 快取)
適合 上下文視窗大、做整項目開發 日常程式碼補全、查 API
客戶端 任何 AI 工具 僅支援 MCP 的客戶端

兩者並不衝突:開發大型項目時可以同時使用——物料文件打底,MCP 兜底查漏。

物料文件

物料文件位於 prompts/ 目錄下,按開發場景分為三種:

文件 場景 說明
ErisPulse-ModuleDev.md 模組開發 涵蓋模組開發全流程(事件處理、路由、生命週期等)
ErisPulse-AdapterDev.md 轉接器開發 在模組開發基礎上,外加轉接器核心概念、SendDSL、平台適配指南
ErisPulse-Full.md 全端參考 上述全部內容 + 完整使用者指南與 API 參考合集

取得方式:從 docs-generated 分支 的 prompts/ 目錄取得(與文件同步更新),或經官網「AI 輔助開發」頁下載。

使用方式

  1. 根據目標選擇文件(模組 → ModuleDev,轉接器 → AdapterDev,複雜需求 → Full)
  2. 將文件內容作為上下文提供給 AI:IDE 內放入工作區,對話類直接貼上,API 呼叫作為 system message 注入
  3. 用下方範本描述需求,越具體生成品質越高

需求描述範本

模組:

請基於 ErisPulse 模組開發規範,生成一個 [模組名稱] 模組的完整程式碼。

功能描述:[核心功能]
需要監聽的事件:[訊息 / 命令 / 通知 / 請求],處理邏輯:[操作]
需要的設定項目:[鍵名]:[用途]([必填/可選],預設值:[值])
其他要求:[額外約束]

轉接器:

請基於 ErisPulse 轉接器開發規範,生成一個 [轉接器名稱] 轉接器的完整程式碼。

平台資訊:[名稱],通訊協定:[WebSocket / WebHook / HTTP 輪詢],API 文件:[地址]
事件轉換:平台事件 [類型] → OneBot12 映射 [關係]
需要實作的傳送方法:[Text / Image / Voice ...]
設定項目:[鍵名]:[用途]([必填/可選])

文件全集包

skills.zip 將該語言全部文件原文打包(不合併、不改寫),根目錄附一份 README 總索引:按目錄分組,逐篇標註「什麼時候需要讀這篇」。AI 可以按索引只載入需要的文件。

與物料文件的區別

物料文件 文件全集包
形態 單個 .md 合併稿 全部文件原文 + 索引 README
使用方式 整段灌入上下文 解壓縮放進工作區,AI 按需挑文件讀
適用 上下文視窗充足、整專案開發 長期駐留工作區、按需檢索

兩者由同一批文件生成、同步更新。

取得

官網「AI 輔助開發」頁下載,或直接取 docs-generated 分支 的 docs/zh-TW/ai-support/skills.zip。

MCP 伺服器

ErisPulse 提供一個文件檢索 MCP 伺服器,讓 AI 編碼助手(支援 MCP 的均可)在你寫程式碼時直接檢索、查閱 ErisPulse 官方文件。

接入方式有兩種:本地程序(推薦)或官方線上端點。工具集一致:

工具 參數 說明
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。檢索技巧:用多個關鍵字而不是整句,例如 命令註冊 事件監聽 比 怎麼註冊一個命令 更好。

方式一:本地程序(推薦)

安裝後直接本地啟動:

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"]
}

方式二:官方線上端點

不想本地起程序時,連官方托管的 mcp.erisdev.com。MCP 客戶端按 HTTP 傳輸配置:

{
  "url": "https://mcp.erisdev.com/"
}

服務預設公開、無需 Token,有 IP 限流(每 IP 每分鐘 60 次)。官方端點可隨時停用,生產工作流程建議用方式一(本地程序)或自托管。

常見問題

產生的程式碼不符合預期?
檢查是否提供了完整的文件;在需求中補充更多細節(輸入輸出範例、邊界條件);讓 AI 分步生成(先骨架再補功能);參考 examples/ 目錄中的範例作為額外的上下文。

MCP 接入後 AI 沒有呼叫 search_docs?
確認客戶端已載入該 server(重新啟動客戶端後即可看到工具已生效);部分客戶端需要在 prompt 中明確提示「使用 ErisPulse 文件工具查證 API」。

下一步