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列出需更新的三个 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 文件

在 ENV 部分的末尾更新所有 Dockerfile：

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

步骤 4：更新 .env.example

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

步骤 5：图片资源

  • 封面图片
  • 3-4 张 API 仪表板截图
  • 2-3 张 LobeHub 配置截图
  • 托管在 LobeHub CDN：hub-apac-1.lobeobjects.space

检查清单

  • EN + CN 使用文档
  • EN + CN 环境变量文档
  • 更新全部 3 个 Dockerfile
  • 更新 .env.example
  • 准备好所有图片
  • 文档中不包含真实 API 密钥

评论

支持 Markdown