mcpField
O
openai-docs-skill

openai-docs-skill

github.com/am-will開発1.0k1.2k 回インストール15 週間前に更新
リポジトリ

openai-docs-skill について

openai-docs-skillは、コマンドラインからOpenAI開発者ドキュメントを参照するスキルです。OpenAI API、SDK、Apps、Codexを扱う開発者が最新の資料を検索・取得し、回答にURLを記載できます。

主な機能

  1. 01ドキュメント索引の検索
  2. 02ドキュメント一覧の閲覧
  3. 03ページやアンカー付き節の取得
  4. 04MCPサーバーのツールと機能の確認
  5. 05OpenAPIスキーマとサンプルの取得

活用シーン

  1. 01最新のOpenAI APIガイダンスの確認
  2. 02SDKやCodexの資料の検索
  3. 03技術回答での公式資料の引用

MCP 対応

シェル用CLIラッパーからOpenAI開発者ドキュメントのMCPサーバーに問い合わせます。検索、一覧表示、取得、機能確認に対応します。

インストール

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

$npx skills add https://github.com/am-will/codex-skills --skill openai-docs-skill

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

同梱ファイルscripts/openai-docs-mcp.sh

詳細

OpenAI Docs MCP スキル

概要

シェルから OpenAI 開発者向けドキュメントの MCP サーバーを使用して、信頼できる公式ドキュメントを検索・取得します。OpenAI プラットフォームの作業では、記憶や非公式の情報源に頼らず、必ずこの方法を使用してください。

基本ルール

  • OpenAI API/SDK/Apps/Codex に関する質問、または正確で最新のドキュメントが必要な場合は、必ずこのスキルを使用してください。
  • scripts/openai-docs-mcp.sh の CLI ラッパーを介して MCP サーバーにクエリを送信してください(Codex の MCP ツールには頼らないでください)。
  • search または list を使用して最適なドキュメントページを見つけてから、正確な記述を確認するためにページ(またはアンカー)を fetch してください。
  • 情報源が明確になるよう、回答には使用したドキュメントの URL を記載してください。

クイックスタート

scripts/openai-docs-mcp.sh search "Responses API" 5
scripts/openai-docs-mcp.sh fetch https://platform.openai.com/docs/guides/migrate-to-responses

ワークフロー

  1. 検索:焦点を絞ったクエリで search を実行します。迷った場合は、list で閲覧します。
  2. 読み込み:最も関連性の高い URL を fetch します(必要に応じてアンカーを追加します)。
  3. 適用:関連するセクションを要約または引用し、URL を記載します。

スクリプトのリファレンス

CLI ラッパーは scripts/openai-docs-mcp.sh にあり、curl と jq を使用して https://developers.openai.com/mcp にアクセスします。

サブコマンド:

  • init:サーバーの機能を初期化して確認します。
  • tools:MCP サーバーで利用できるツールを一覧表示します。
  • search <query> [limit] [cursor]:ドキュメントインデックスから JSON 形式の検索結果を返します。
  • list [limit] [cursor]:ドキュメントインデックスを閲覧します。
  • fetch <url> [anchor]:ドキュメントページまたはセクションの Markdown を返します。
  • endpoints:OpenAPI エンドポイントを一覧表示します。
  • openapi <endpoint-url> [lang1,lang2] [code-only]:OpenAPI スキーマまたはコードサンプルを取得します。

環境変数:

  • MCP_URL:デフォルトの MCP エンドポイントを上書きします。

コメント