mcpField
O
outline

outline

github.com/sanjay3290生産性447384 回インストール7 週間前に更新
リポジトリ

outline について

Outline Wiki インスタンスの文書を検索、読み取り、作成、管理するスキルです。Agent Skills Standard 対応の AI クライアント向けで、API URL の設定によりセルフホスト型インスタンスにも接続できます。

主な機能

  1. 01文書の検索
  2. 02文書の読み取りと Markdown 形式でのエクスポート
  3. 03コレクションと文書の一覧表示
  4. 04文書の作成と更新
  5. 05機械可読な JSON 出力

活用シーン

  1. 01キーワードで Wiki のガイドを探す
  2. 02文書の読み取りやエクスポート
  3. 03Wiki コンテンツの作成や改訂
  4. 04コレクションと文書の確認

インストール

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

$npx skills add https://github.com/sanjay3290/ai-skills --skill outline

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

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

.env.example
.gitignore
README.md
requirements.txt
scripts/
outline.py

詳細

Outline Wiki スキル

Outline wiki インスタンス内のドキュメントを検索、閲覧、作成、管理できます。Agent Skills Standard に対応するすべての AI クライアントで動作します。

要件

  • Python 3.8+
  • 依存関係：pip install -r requirements.txt

セットアップ

  1. Outline wiki から API キーを取得します：

    • Settings > API Tokens に移動します
    • 適切な権限を付与した新しいトークンを作成します

  2. 環境を設定します：

    cp .env.example .env
# Edit .env with your API key

  3. 環境変数を設定します：

    export OUTLINE_API_KEY=your-api-key-here
# Optional: for self-hosted instances
export OUTLINE_API_URL=https://your-wiki.example.com/api

使い方

ドキュメントを検索する
python3 scripts/outline.py search "deployment guide"
python3 scripts/outline.py search "API documentation" --limit 10
python3 scripts/outline.py search "onboarding" --collection-id <id>
ドキュメントを読む
python3 scripts/outline.py read <document-id>
python3 scripts/outline.py read <document-id> --json
コレクションを一覧表示する
python3 scripts/outline.py list-collections
python3 scripts/outline.py list-collections --limit 50
コレクション内のドキュメントを一覧表示する
python3 scripts/outline.py list-documents --collection-id <id>
コレクションの詳細を取得する
python3 scripts/outline.py get-collection <collection-id>
ドキュメントを作成する
python3 scripts/outline.py create --title "New Guide" --collection-id <id>
python3 scripts/outline.py create --title "Guide" --collection-id <id> --text "# Content here"
python3 scripts/outline.py create --title "Draft" --collection-id <id> --draft
ドキュメントを更新する
python3 scripts/outline.py update <document-id> --title "Updated Title"
python3 scripts/outline.py update <document-id> --text "New content"
python3 scripts/outline.py update <document-id> --publish
ドキュメントを Markdown としてエクスポートする
python3 scripts/outline.py export <document-id>
python3 scripts/outline.py export <document-id> --output doc.md
認証をテストする
python3 scripts/outline.py auth-info

JSON 出力

任意のコマンドに --json フラグを追加すると、機械可読な出力が得られます：

python3 scripts/outline.py search "query" --json
python3 scripts/outline.py read <id> --json

操作リファレンス

コマンド説明必須の引数
search全文検索query
readドキュメントの内容を取得document_id
list-collectionsすべてのコレクションを一覧表示-
list-documentsドキュメントを一覧表示（コレクション内に限定可能）-
get-collectionコレクションの詳細を取得collection_id
create新しいドキュメントを作成--title, --collection-id
update既存のドキュメントを更新document_id
exportMarkdown としてエクスポートdocument_id
auth-infoAPI 接続をテスト-

環境変数

変数必須デフォルト説明
OUTLINE_API_KEYはい-Outline API トークン
OUTLINE_API_URLいいえhttps://app.getoutline.com/apiAPI URL
OUTLINE_TIMEOUTいいえ30リクエストのタイムアウト（秒）
OUTLINE_VERIFY_SSLいいえtrueSSL 検証をスキップするには false に設定します（自己署名証明書を使用するセルフホストインスタンス向け）

トラブルシューティング

エラー解決方法
API キーが設定されていないOUTLINE_API_KEY 環境変数を設定します
認証に失敗したAPI キーが有効で、期限切れでないことを確認します
接続がタイムアウトしたOUTLINE_API_URL とネットワーク接続を確認します
SSL 証明書エラー自己署名証明書の場合は OUTLINE_VERIFY_SSL=false に設定します
ドキュメントが見つからないドキュメント ID が正しいことを確認します
権限が拒否されたAPI トークンに必要な権限があることを確認します

終了コード

  • 0：成功
  • 1：エラー（認証失敗、見つからない、無効なリクエスト）

ワークフロー

  1. auth-info を実行して接続を確認します
  2. list-collections を実行して利用可能なコレクションを確認します
  3. search または list-documents を実行してコンテンツを探します
  4. read を実行してドキュメントの全文を取得します
  5. create／update を使用して wiki のコンテンツを変更します

コメント

Markdown 対応