Files
maestro/docs/tools/listappdocs.md
T
oss-sync 57702b4f34
CI / build-and-test (push) Canceled after 0s
sync: update from private repo (2336949a)
2026-09-17 11:29:31 +00:00

2.4 KiB
Raw Blame History

ListAppDocs

MAESTRO のプロジェクト内ドキュメントを カテゴリ別に一覧するメタツール(常時利用可能、引数なし)。質問に答える前に、関連 doc を探すために使う。各エントリの symbolic name は ReadAppDoc にそのまま渡せる。

引数

なし。

出力(4 カテゴリの Markdown)

セクション 内容 読み込み形式
利用者向けヘルプ ui/src/content/help/*.md の frontmatter title help/<name>
Piece 一覧 pieces/*.yaml の名前+ description 1 行 piece/<name>
ドキュメント docs/ 配下の .md(後述の除外を除く) docs/<path>
ツール参照 docs/tools/*.md 全件 tool/<name>(ReadToolDoc と同等)

実際の出力から抜粋(各行は 1 件ずつ、見出しの直後に空行が入る):

ListAppDocs()
→
# 利用者向けヘルプ (`help/<name>` で読み込み — アプリ内ヘルプと同じ内容)

- `help/06-schedules` — 自動実行を設定する
...
# Piece 一覧 (`piece/<name>` で読み込み)

- `piece/chat` — 汎用デフォルト piece。質問・調査・コード生成・文書作成・データ処理など、
...
# ドキュメント (`docs/<path>` で読み込み)

- `docs/mcp` — The orchestrator can call tools hosted on external **MCP servers** (OAuth-secured
...
# ツール参照 (`tool/<name>` で読み込み — ReadToolDoc と同等)

- `tool/browseweb` — ヘッドレスブラウザで Web ページを操作するツール。同一ジョブ内ではブラウザコンテキスト(Cookie・ログイン状態)が永続化される。

一覧から除外されるもの

内部向け・履歴的な doc はノイズになるため docs/ セクションから除外される:

  • docs/design/
  • docs/maintenance-checklist

これらは ReadAppDoc でも基本的に読めない(block 対象)。

制約

  • description は各ファイルの frontmatter を飛ばした最初の見出し/段落から最大 140 字を自動抽出。利用者向けヘルプだけは frontmatter の title を使う(無ければファイル名)。
  • 合計エントリが 150 件を超えると、末尾に「個別取得を促す注記」が付く。

関連

個別の doc を読むには ReadAppDoc。