Add Provider Doc
Add bilingual provider usage docs, env-var reference, Docker and `.env.example` updates when wiring a new model provider into Lobe Chat.
Overview
add-provider-doc is an agent skill for the Build phase that adds bilingual Lobe Chat provider usage and self-hosting documentation following a fixed five-step checklist.
Install
npx skills add https://github.com/lobehub/lobe-chat --skill add-provider-docWhat is this skill?
- 5-step workflow: usage MDX (EN + zh-CN), env-var docs, Docker files, `.env.example`, and image assets
- Requires 5–6 screenshots plus a cover image with real dashboard URLs and pricing callouts—never real API keys
- `{PROVIDER}_API_KEY` and optional `{PROVIDER}_MODEL_LIST` env-var blocks with `+`/`-` model-list syntax
- Reference implementation pattern from `docs/usage/providers/fal.mdx`
- `disable-model-invocation: true`—run only when you explicitly invoke the skill with a provider name
- 5-step documentation workflow
- 5–6 screenshots required per provider page
Adoption & trust: 818 installs on skills.sh; 78.4k GitHub stars; 3/3 security scanners passed (skills.sh audits).
What problem does it solve?
You added a model provider to Lobe Chat but users and self-hosters lack matching EN/CN docs, env-var tables, Docker notes, and safe `.env` examples.
Who is it for?
Solo or small-team Lobe Chat contributors shipping a new vendor integration who already know the provider name and can capture dashboard screenshots.
Skip if: Teams that only need runtime provider code with no docs update, or non–Lobe Chat repos that do not use this `docs/usage/providers` layout.
When should I use this skill?
Adding documentation for a new AI provider in Lobe Chat; pass provider name as argument hint.
What do I get? / Deliverables
After the skill runs you have paired MDX usage guides, updated model-provider env documentation, Docker and `.env.example` entries, and screenshot assets ready to commit—without embedding live API keys.
- EN and zh-CN `docs/usage/providers/{provider}.mdx` pages
- Updated model-provider environment-variable MDX (EN + CN)
- Docker and `.env.example` provider entries plus image assets
Recommended Skills
Journey fit
Canonical shelf is Build → docs because the skill’s output is user-facing and self-hosting documentation artifacts, not runtime integration code. Every step targets MDX usage pages, environment-variable docs, and example config—classic documentation delivery inside the repo.
How it compares
Use this structured doc checklist instead of copying an old provider page by hand and missing Docker or zh-CN parity.
Common Questions / FAQ
Who is add-provider-doc for?
Lobe Chat maintainers and contributors who extend the provider catalog and must keep usage and self-hosting documentation accurate in English and Chinese.
When should I use add-provider-doc?
During Build when a new provider is ready to document—after integration work and before you announce or ship self-hosting support, so env vars, Docker, and screenshots align.
Is add-provider-doc safe to install?
It is editorial workflow guidance; review the Security Audits panel on this Prism page before installing any skill from the catalog and avoid pasting real API keys into generated docs.
SKILL.md
READMESKILL.md - Add Provider Doc
# Adding New AI Provider Documentation Complete workflow for adding documentation for a new AI provider. ## Overview 1. Create usage documentation (EN + CN) 2. Add environment variable documentation (EN + CN) 3. Update Docker configuration files 4. Update .env.example 5. Prepare image resources ## Step 1: Create Provider Usage Documentation ### Required Files - `docs/usage/providers/{provider-name}.mdx` (English) - `docs/usage/providers/{provider-name}.zh-CN.mdx` (Chinese) ### Key Requirements - 5-6 screenshots showing the process - Cover image for the provider - Real registration and dashboard URLs - Pricing information callout - **Never include real API keys** - use placeholders Reference: `docs/usage/providers/fal.mdx` ## Step 2: Update Environment Variables Documentation ### Files to Update - `docs/self-hosting/environment-variables/model-provider.mdx` (EN) - `docs/self-hosting/environment-variables/model-provider.zh-CN.mdx` (CN) ### Content Format ```markdown ### `{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` ``` ## Step 3: Update Docker Files Update all Dockerfiles at the **end** of ENV section: - `Dockerfile` - `Dockerfile.database` - `Dockerfile.pglite` ```dockerfile # {New Provider} {PROVIDER}_API_KEY="" {PROVIDER}_MODEL_LIST="" ``` ## Step 4: Update .env.example ```bash ### {Provider Name} ### # {PROVIDER}_API_KEY={prefix}-xxxxxxxx ``` ## Step 5: Image Resources - Cover image - 3-4 API dashboard screenshots - 2-3 LobeHub configuration screenshots - Host on LobeHub CDN: `hub-apac-1.lobeobjects.space` ## Checklist - [ ] EN + CN usage docs - [ ] EN + CN env var docs - [ ] All 3 Dockerfiles updated - [ ] .env.example updated - [ ] All images prepared - [ ] No real API keys in docs