add-provider-doc

Creates bilingual documentation, environment variable docs, and Docker configuration for new AI providers.

74|11|Updated Jul 4, 2024
One-click install
npx skills add https://github.com/OpenSourceAGI/qwksearch-research-agent --skill add-provider-doc-opensourceagi
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: add-provider-doc
Source: https://github.com/OpenSourceAGI/qwksearch-research-agent/tree/main/apps/qwk-in-lobe/.agents/skills/add-provider-doc
Command: npx skills add https://github.com/OpenSourceAGI/qwksearch-research-agent --skill add-provider-doc-opensourceagi

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Adding a new AI provider to a project requires updating many scattered files—usage docs, environment variable references, Dockerfiles, and .env examples—and missing any of them causes inconsistent or broken documentation. ## Core Features & Use Cases - Bilingual Usage Docs: Generates English and Chinese MDX provider guides with screenshots, pricing callouts, and placeholder API keys. - Configuration Updates: Updates environment variable documentation, all three Dockerfiles, and .env.example with the new provider's variables. - Use Case: When integrating a new model provider like a new LLM vendor, run this workflow to produce the complete documentation set and config updates in one pass, ending with a verification checklist. ## Quick Start Add documentation for the new AI provider named anthropic following the provider documentation workflow.

Frequently Asked Questions about add-provider-doc

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I add documentation for a new AI provider?

Create usage docs in English and Chinese MDX files, update the environment variable documentation, add the provider's variables to all three Dockerfiles and .env.example, then prepare cover and screenshot images hosted on the CDN.

What files need updating when adding a new model provider?

You must update the provider usage MDX docs (EN and CN), the model-provider environment variable docs (EN and CN), Dockerfile, Dockerfile.database, Dockerfile.pglite, and .env.example.

Can I include real API keys in provider documentation examples?

No, never include real API keys in documentation. Always use placeholders following the provider's key format, such as a prefix followed by masked characters.

How should environment variables be documented for a new provider?

Document the API key variable as required with a description and example format, and the model list variable as optional, explaining the plus/minus syntax for adding or hiding models.

What screenshots are needed for provider usage documentation?

You need a cover image, three to four API dashboard screenshots from the provider, and two to three configuration screenshots, all hosted on the LobeHub CDN.