mcpField
A
add-provider-doc

add-provider-doc

github.com/lobehub開発83.6k3.9k 回インストール今日更新
リポジトリ

add-provider-doc について

add-provider-docは、LobeHubに新しいAIプロバイダーのドキュメントを追加するワークフローガイドです。英語・中国語の利用説明と環境変数の文書、Dockerや.env.exampleの更新、画像の準備を扱います。

主な機能

  1. 01英語・中国語の利用ドキュメント作成
  2. 02環境変数ドキュメントの更新
  3. 03更新対象となる3つのDockerfileの提示
  4. 04.env.exampleへのプロバイダー設定追加
  5. 05プロバイダー画像の要件提示

活用シーン

  1. 01新しいAIプロバイダーの文書化
  2. 02セルフホスト設定説明の更新
  3. 03プロバイダー文書用素材の準備

インストール

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

$npx skills add https://github.com/lobehub/lobehub --skill add-provider-doc

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

同梱ファイルagents/openai.yaml

詳細

新しい AI プロバイダーのドキュメント追加

新しい AI プロバイダーのドキュメントを追加する一連の手順です。

概要

  1. 使用方法のドキュメントを作成する(EN + CN)
  2. 環境変数のドキュメントを追加する(EN + CN)
  3. Docker 設定ファイルを更新する
  4. .env.example を更新する
  5. 画像リソースを準備する

ステップ 1:プロバイダーの使用方法ドキュメントを作成する

必要なファイル
  • docs/usage/providers/{provider-name}.mdx(英語)
  • docs/usage/providers/{provider-name}.zh-CN.mdx(中国語)
主な要件
  • 手順を示すスクリーンショットを 5~6 枚
  • プロバイダーのカバー画像
  • 実際の登録ページとダッシュボードの URL
  • 料金情報のコールアウト
  • 実際の API キーは絶対に記載しないでください — プレースホルダーを使用してください

参考:docs/usage/providers/fal.mdx

ステップ 2:環境変数のドキュメントを更新する

更新するファイル
  • docs/self-hosting/environment-variables/model-provider.mdx(EN)
  • docs/self-hosting/environment-variables/model-provider.zh-CN.mdx(CN)
コンテンツ形式
### `{PROVIDER}_API_KEY`

- Type: Required
- Description: API key from {Provider Name}
- Example: `{api-key-format}`

### `{PROVIDER}_MODEL_LIST`

- Type: Optional
- Description: Control model list. Use `+` to add, `-` to hide
- Example: `-all,+model-1,+model-2=Display Name`

ステップ 3:Docker ファイルを更新する

以下のすべての Dockerfile で、ENV セクションの末尾を更新します。

  • Dockerfile
  • Dockerfile.database
  • Dockerfile.pglite
# {New Provider}
{PROVIDER}_API_KEY="" {PROVIDER}_MODEL_LIST=""

ステップ 4:.env.example を更新する

### {Provider Name} ###
# {PROVIDER}_API_KEY={prefix}-xxxxxxxx

ステップ 5:画像リソース

  • カバー画像
  • API ダッシュボードのスクリーンショット 3~4 枚
  • LobeHub の設定画面のスクリーンショット 2~3 枚
  • LobeHub CDN でホストする:hub-apac-1.lobeobjects.space

チェックリスト

  • 使用方法ドキュメント(EN + CN)
  • 環境変数ドキュメント(EN + CN)
  • 3 つすべての Dockerfile を更新済み
  • .env.example を更新済み
  • すべての画像を準備済み
  • ドキュメントに実際の API キーが含まれていない

コメント