Skip to content

docs: README 應列出 issue-driven-dev 仰賴的外部 plugin / MCP server (依 source type) #26

Description

@kiki830621

Problem

Original text (user chat, /idd-issue, 2026-05-07):
「我覺得 readme 上要寫說仰賴哪些 plugin 吧?」

兩份 README 都沒列出 issue-driven-dev 實際用到的外部 plugin / MCP server,使用者裝完只看 README 不會知道哪些來源類型(.docx / Telegram / Apple Mail / Apple Notes)需要額外裝什麼才會 work。

grep 確認 idd-issue skill 直接呼叫以下 MCP tools:

MCP Plugin 用途 觸發時機
che-word-mcp 讀 .docx 文字 + 抽圖 (get_document_text / list_images / export_image) source 是 .docx / .doc
che-telegram-mcp (telegram-all) 讀 chat history (get_chat_history) source 是 Telegram chat range
che-apple-mail-mcp (mail) 讀 email + attachments (get_email) source 是 Apple Mail message
che-apple-notes-mcp (notes) 讀 note + 抽圖 (get_note) source 是 Apple Notes

頂層 README 也已列出 idd-route 為 sister plugin (coming soon),但沒說明它跟 issue-driven-dev 的依賴關係(它需要 idd-route-swift binary,且是被 issue-driven-dev 內部選擇性使用)。

Type

documentation

Expected

兩份 README 應該各有一段 "Dependencies" / "Optional integrations" / "Source-type adapters" 章節,清楚說明:

  1. 核心使用零依賴 — 純 chat / 直接貼文字 / .md 來源不需要任何外部 plugin
  2. 依來源類型可選裝(matrix 表格,key 在「為什麼裝這個」+「不裝會發生什麼事」):
    • .docx / .doc → che-word-mcp
    • Telegram → che-telegram-mcp (telegram-all server)
    • Apple Mail → che-apple-mail-mcp
    • Apple Notes → che-apple-notes-mcp
  3. Sister plugins(idd-route)說明它是 enrichment,非必要

Actual

  • 頂層 README.md:只寫 install 指令 + migration,沒提任何 dependency
  • plugins/issue-driven-dev/README.md(line 158 提到 idd-route install,但散落在內文,沒有統一 dependencies 章節)

Impact

  • Onboarding 卡點:新使用者拿 .docx 餵 /idd-issue 失敗(mcp__che-word-mcp__get_document_text 不存在),不知道要裝什麼
  • Discoverability:不知道 IDD 設計上支援多種 source type,以為只能貼純文字
  • 預設無聲降級:Source-type adapter Step 1 在 MCP 不存在時不會明確報錯,只會 fallback 到請使用者手動處理,使用者誤以為「IDD 不支援這格式」

Suggested fix (non-blocking)

兩份 README 加 "Plugin dependencies" / "Source-type adapters" 章節,用 matrix 呈現 + 註明 install 指令(claude plugin install <name>@<marketplace>)。

Scope (per /idd-issue clarification)

  • 頂層 README.md
  • plugins/issue-driven-dev/README.md

Priority: P2

Linked-Context Siblings Filed (v2.48.0+ #529)

Filed sibling issues: #27 (idd-issue Step 1 silent-degrade UX bug)

Current Status

Phase: closed
Last updated: 2026-05-07 by idd-close (auto via idd-update)

Key Decisions

Scope Changes

  • (none)

Blocking

  • (none — closed)

Commits (squashed via PR #30)

  • 78dbc15 docs: 擴充 plugin README ## Requirements (Required + Optional + Sister)
  • be4931b docs: 頂層 README 加 ## Requirements summary + link to plugin README
  • 6997e3f docs: 加 KEEP IN SYNC comment 防 source type adapter ↔ README matrix drift
  • 0e9bb99 docs: README 列出 issue-driven-dev 仰賴的外部 plugin / MCP server (docs: README 列出 issue-driven-dev 仰賴的外部 plugin / MCP server #30) — squash on main

PR

Sister Concerns

Follow-ups

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions