add-provider-doc
Add documentation for a new AI provider — usage docs, env vars, Docker config, image resources.
Security Assessment
About add-provider-doc
add-provider-doc is a documentation-workflow skill for the LobeHub project that walks an agent through adding complete documentation for a new AI model provider. It solves the repetitive, easy-to-miss task of wiring up all the places a new provider must be documented and configured, ensuring consistency across LobeHub's bilingual docs and Docker configuration.
The skill defines a five-step checklist: creating English and Chinese usage docs under `docs/usage/providers/`, adding environment-variable documentation for the provider's API key and model list, updating all three Dockerfiles (`Dockerfile`, `Dockerfile.database`, `Dockerfile.pglite`) at the end of their ENV section, updating `.env.example`, and preparing image resources (cover image and dashboard/configuration screenshots hosted on the LobeHub CDN). It provides exact file paths, a markdown content format for env vars, and a final checklist. Notably, it explicitly instructs authors to never include real API keys and to use placeholders instead — a security-conscious convention.
It targets LobeHub maintainers and contributors adding provider support, and technical writers who need to keep provider docs consistent. It is a benign, read-and-write documentation helper: it edits repo docs and config templates and hosts images on a CDN, with no code execution, network exfiltration, or destructive operations. Its guidance to avoid committing real credentials makes it security-positive rather than risky.
FAQ
What does this skill produce?
Bilingual (English + Chinese) provider usage docs, environment-variable documentation, updates to three Dockerfiles and .env.example, and prepared image resources, all following LobeHub conventions.
Does it handle API keys?
It documents API-key environment variables as placeholders and explicitly instructs authors to never include real API keys in the docs.
Which files does it touch?
Provider mdx files under docs/usage/providers/, model-provider env docs, Dockerfile / Dockerfile.database / Dockerfile.pglite, and .env.example, plus CDN-hosted images.
Is it meant to be auto-invoked?
No. Its frontmatter sets disable-model-invocation: true and takes a provider-name argument, so it is intended as a user-invoked workflow.
Install add-provider-doc
Quick Setup:
- Copy the skill folder to
.claude/skills/ - Claude will automatically detect and use the skill
Repository
lobehub/lobehub