maestro/docs/tools/listappdocs.md
oss-sync b857c33ef6
Some checks failed
CI / build-and-test (push) Has been cancelled
sync: update from private repo (f6d625db)
2026-06-26 03:35:45 +00:00

1.7 KiB
Raw Blame History

ListAppDocs

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

引数

なし。

出力3 カテゴリの Markdown

セクション 内容 読み込み形式
Piece 一覧 pieces/*.yaml の名前+ description 1 行 piece/<name>
ドキュメント docs/ 配下の .md(後述の除外を除く) docs/<path>
ツール参照 docs/tools/*.md 全件 tool/<name>ReadToolDoc と同等)
ListAppDocs()
→
# Piece 一覧 (`piece/<name>` で読み込み)
- `piece/chat` — 雑多な依頼に答える汎用ピース
...
# ドキュメント (`docs/<path>` で読み込み)
- `docs/mcp` — MCP 連携の概要
...
# ツール参照 (`tool/<name>` で読み込み — ReadToolDoc と同等)
- `tool/browseweb` — ヘッドレスブラウザで…

一覧から除外されるもの

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

  • docs/design/
  • docs/maintenance-checklist

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

制約

  • description は各ファイルの frontmatter を飛ばした最初の見出し/段落から最大 140 字を自動抽出。
  • 合計エントリが 150 件を超えると、末尾に「個別取得を促す注記」が付く。

関連

個別の doc を読むには ReadAppDoc