mcpField
R
readme

readme

github.com/statelyai開発4871 回インストール24 週間前に更新
リポジトリ

readme について

Markdown内のHTMLコメントを、ソースコード上の事実や整合性要件へのシンボリック参照として扱うスキルです。リポジトリ内のファイルを走査し、論理的なコード構造やパスから参照を解決する方法を示します。

主な機能

  1. 01Markdownのシンボリックコメントを識別
  2. 02パス指定と論理参照を解決
  3. 03無視対象外のMarkdownを走査
  4. 04安定した論理参照を優先

活用シーン

  1. 01APIドキュメントとソースの整合性を保つ
  2. 02リポジトリ変更時に参照コメントを探す
  3. 03プロジェクト内の各パッケージの文書を確認

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/statelyai/skills --skill readme

インストール後、Claude Code で/readmeを入力して読み込まれたか確認します。

同梱ファイルagents/openai.yaml

詳細

シンボリック README 参照

Markdown ファイル内の HTML コメントは、コードベースに対する宣言的なクエリとして機能します。つまり、周囲のコンテンツが何を反映すべきかを記述します。例：

## API



| Function | Description |
| --- | --- |
| `createMachine(config)` | Creates a state machine |

## Installation



`npm install xstate`

コメントがシンボリック参照に該当するのは、ソースから導出できるコンテンツを記述している場合です。ファイル／モジュール、パッケージのメタデータ、コード構造への参照や、一貫性に関する制約（consistent with、matching、derived from）が該当します。純粋に編集上のコメント（``）はシンボリック参照ではありません。

参照には、パス指定（exported functions from src/index.ts）と論理指定（all exported creator functions、public API of the state module、supported config options）があります。論理指定の参照は、その説明に合致する構造をコードベース内で検索して解決してください。ファイル名を必須にしないでください。

リポジトリを変更するとき

  1. スキャン：Git で無視されていないすべての Markdown ファイルを対象に、シンボリックコメントを検索します。rg -l ' または （ ではありません）を使い、1 つの概念に絞り、行番号ではなく論理的な構造を参照してください。対象が複数のファイルにまたがる場合や、移動する可能性がある場合は、論理的な記述を優先してください。

対象範囲

プロジェクトツリー内の、Git で無視されていないすべての Markdown ファイルが対象です。README.md、packages/*/README.md、src/**/README.md、docs/**/*.md、CONTRIBUTING.md などが含まれます。

コメント

Markdown 対応