WeaveFox 是一个 AI 应用创作和分享平台,提供开放能力以便其它工具(比如 各种 AI 智能体工具)连接 WeaveFox 实现协同完成任务。
用户在 WeaveFox 平台上对话创建应用后,通过 MCP 可以让其它 AI 智能体工具连接到 WeaveFox,实现发送消息迭代应用、更新应用信息等。
该功能面向用户本地研发场景,在本地开发应用并进行预构建(通常是执行 build 脚本命令)获取生产环境产物,通过上传 zip 包或单 HTML 文件来托管预构建的站点应用。该类型应用不支持在 WeaveFox 平台上进行对话迭代,仅支持预览和发布。
流程:
token。artifactZipUrl。artifactZipUrl 创建应用版本,仅接受 upload_artifact_zip 返回的站内地址。也支持通过 GitHub Action 自动部署,适合 CI/CD 场景。
WeaveFox Pages 将产物托管在云存储子路径下。如果构建产物的 index.html 中使用了绝对路径引用资源(如 /assets/index.js),这些路径会解析到存储根目录而非子路径,导致 404 Not Found。
请在构建时将资源路径配置为相对路径,常见构建工具配置方式:
vite.config.ts 中设置 base: './'next.config.js 中设置 assetPrefix: './'output.publicPath: './'nuxt.config.ts 中设置 app.baseURL: './'base/publicPath/assetPrefix 配置项,设为 ./配置后 index.html 中的引用将从 /assets/... 变为 ./assets/...,确保在任何子路径下都能正确加载。
提示:查询应用列表时传入 agentType: "external" 可筛选 WeaveFox Pages 应用。
使用以下接入方式前,请先在 WeaveFox 平台的 API Key 页面 创建密钥。
通过 MCP 协议连接,AI 智能体工具可自动感知工具列表。适合 Cursor、Claude Desktop 等 MCP 客户端。
配置示例(替换 YOUR_API_KEY 为你的 API Key):
{
"mcpServers": {
"WeaveFox MCP": {
"url": "https://www.weavefox.cn/mcp",
"transport": "sse",
"headers": {
"Authorization": "Bearer <YOUR_API_KEY>"
}
}
}
}
通过安装 Agent Skill 插件连接 WeaveFox,适合 Claude Code、Codex 等 AI 编码工具。
安装命令:
npx skills add https://github.com/weavefox/weavefox-cli --skill weavefox
或复制以下提示词到 AI 工具中执行:
运行 `npx skills use "https://github.com/weavefox/weavefox-cli" --skill "weavefox"` 并立即按照生成的 Skill 说明执行。读取完整输出,必要时先将输出重定向到临时文件。从其提供的 supporting-files 目录解析相对路径。
通过 HTTP REST 接口调用,需要 API Key 鉴权。适合脚本、CI/CD、自定义集成等场景。
https://www.weavefox.cn/api/open/v1Authorization: Bearer YOUR_API_KEY(除 readme 和 docs 外所有接口均需鉴权){ "code": 0, "data": ... },失败 { "code": number, "message": string }多个接口复用以下对象结构,在各接口的「响应」表格中以名称引用。
| 字段 | 类型 | 说明 |
|---|---|---|
| publicId | string | 应用公开 ID |
| name | string | 应用名称 |
| description | string 或 null | 应用描述 |
| thumbnailUrl | string | 缩略图 URL,配置了自定义封面时为自定义封面地址 |
| tag | string 或 null | 应用标签 |
| agentType | string | 应用类型,如 external |
| source | string 或 null | 应用来源,历史应用为空 |
| appConfig | object | 应用配置:hideProductLogo、customThumbnailUrl、faviconUrl |
| metadata | object 或 null | 元数据,当前仅含 serviceVersion |
| isPublic | number | 访问权限:0=私有(仅作者/协作者可访问),1=公开(任何人可通过 publicId 访问) |
| isVisible | number | 是否在公开应用列表/广场展示:0=不展示(仍可通过 publicId 访问),1=展示 |
| isFeatured | number | 是否精选 |
| currentVersionId | string 或 null | 当前发布版本 ID |
| isPublished | number | 是否已发布:0=未发布,1=已发布 |
| previewUrl | string | 预览地址 |
| shareUrl | string | 分享地址 |
| author | object 或 null | 作者:userId、username、avatarUrl、description |
| viewCount | number | 浏览次数 |
| likeCount | number | 点赞次数 |
| forkCount | number | Fork 次数 |
| shareCount | number | 分享次数 |
| lastVisitedAt | string 或 null | 最后一次访问时间 |
| createdAt | string | 创建时间 |
| updatedAt | string | 更新时间 |
| 字段 | 类型 | 说明 |
|---|---|---|
| version | string | 版本号,如 v1 |
| versionName | string 或 null | 版本名称 |
| releaseNotes | string 或 null | 版本说明(changelog) |
| releasedAt | string 或 null | 发布时间,null 表示尚未部署发布 |
| previewImg | string 或 null | 预览图 URL |
| metadata | object 或 null | 版本元数据 |
| createdAt | string | 创建时间 |
| isCurrentRelease | boolean | 是否为当前发布版本 |
| 字段 | 类型 | 说明 |
|---|---|---|
| id | string | 消息 ID |
| role | string | user 或 assistant |
| createdAt | string | 创建时间 |
| content | string 或 null | 解析后的文本内容,无内容时为 null |
| contentStructured | object | 可选,结构化数据:user 消息含 files([{ mediaType, url }]);assistant 消息为 tool 调用信息:type、toolName、input、output |
获取 WeaveFox 开放能力说明文档(本文件)。
参数:无
响应
HTML 渲染的本说明文档(Content-Type: text/html),非 JSON。
获取 WeaveFox 产品文档信息。
参数:无
响应
HTML 渲染的文档页面(Content-Type: text/html),非 JSON。
获取当前鉴权用户信息。
参数:无
响应
| 字段 | 类型 | 说明 |
|---|---|---|
| code | number | 0 表示成功 |
| data | object | 用户信息 |
| data.userId | string | 用户 ID |
| data.username | string | 用户名 |
| data.avatarUrl | string 或 null | 头像 URL |
| data.description | string 或 null | 个人描述 |
创建 WeaveFox Pages 应用。
参数
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| name | body | string | 是 | 应用名称,1-100 字符 |
| description | body | string | 否 | 应用描述,最多 500 字符 |
| agentType | body | string | 是 | 固定为 external |
响应
| 字段 | 类型 | 说明 |
|---|---|---|
| code | number | 0 表示成功 |
| data | AppDTO | 新创建的应用对象,结构见「应用对象 AppDTO」 |
分页查询应用列表。
参数
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| page | query | number | 否 | 页码,默认 1 |
| pageSize | query | number | 否 | 每页条数,最大 100,默认 10 |
| keyword | query | string | 否 | 名称/描述模糊搜索 |
| publicId | query | string | 否 | 按 publicId 精确匹配 |
| agentType | query | string | 否 | 筛选类型,如 external |
响应
| 字段 | 类型 | 说明 |
|---|---|---|
| code | number | 0 表示成功 |
| data | object | 分页数据 |
| data.list | AppDTO[] | 应用列表,结构见「应用对象 AppDTO」 |
| data.total | number | 总条数 |
| data.page | number | 当前页码 |
| data.pageSize | number | 每页条数 |
更新应用信息。
参数
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| publicId | path | string | 是 | 应用 ID |
| name | body | string | 否 | 应用名称,1-100 字符 |
| description | body | string | 否 | 应用描述,最多 500 字符 |
| tag | body | number | 否 | 应用标签,0-21 |
| isPublic | body | number | 否 | 访问权限:0=私有(仅作者/协作者可访问),1=公开(任何人可通过 publicId 访问) |
| isVisible | body | number | 否 | 是否在公开应用列表/广场展示:0=不展示(仍可通过 publicId 访问),1=展示 |
| customThumbnailUrl | body | string | 否 | 自定义封面图 URL,传 null 重置为默认 |
| faviconUrl | body | string | 否 | 站点图标 URL,传 null 时清除配置恢复默认 |
| newPublicId | body | string | 否 | 新的 publicId,6-36 字符,仅字母/数字/连字符 |
响应
| 字段 | 类型 | 说明 |
|---|---|---|
| code | number | 0 表示成功 |
| data | AppDTO | 更新后的应用对象,结构见「应用对象 AppDTO」 |
发送消息给应用智能体,异步执行。
参数
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| publicId | path | string | 是 | 应用 ID |
| message | body | string | 是 | 发送的消息内容 |
响应
| 字段 | 类型 | 说明 |
|---|---|---|
| code | number | 0 表示成功 |
| data | object | 投递结果 |
| data.accepted | boolean | 是否受理,受理后智能体异步执行 |
受理即返回,不等待执行结果;若当前已有会话在执行,本次请求会被拒绝,请稍后重试。执行状态与结果通过 GET /apps/:publicId/message 轮询获取。
获取应用智能体消息状态。
参数
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| publicId | path | string | 是 | 应用 ID |
响应
| 字段 | 类型 | 说明 |
|---|---|---|
| code | number | 0 表示成功 |
| data | object | 消息状态 |
| data.status | string | running=正在处理,idle=空闲 |
| data.content | string 或 null | 最近一次 assistant 输出文本,无内容时为 null |
| data.contentStructured | object | 可选,最近一次输出的结构化数据(tool 调用时附带):type、toolName、input、output |
分页查询应用消息列表。
参数
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| publicId | path | string | 是 | 应用 ID |
| page | query | number | 否 | 页码,默认 1 |
| pageSize | query | number | 否 | 每页条数,最大 20,默认 20 |
响应
| 字段 | 类型 | 说明 |
|---|---|---|
| code | number | 0 表示成功 |
| data | object | 分页数据 |
| data.list | MessageDTO[] | 消息列表,按时间倒序(最新在前),结构见「消息对象 MessageDTO」 |
| data.total | number | 总条数 |
| data.page | number | 当前页码 |
| data.pageSize | number | 每页条数 |
停止应用智能体运行流。
参数
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| publicId | path | string | 是 | 应用 ID |
响应
| 字段 | 类型 | 说明 |
|---|---|---|
| code | number | 0 表示成功 |
| message | string | 状态说明 |
获取一次性临时上传凭证(10 分钟有效)。
参数
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| publicId | path | string | 是 | 应用 ID |
响应
| 字段 | 类型 | 说明 |
|---|---|---|
| code | number | 0 表示成功 |
| data | object | 上传凭证 |
| data.token | string | 一次性临时 token,作为上传接口的 Bearer Token |
上传产物 zip 包,返回可访问的 URL。
鉴权:upload-token 返回的 token 作为 Bearer Token。
参数
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| publicId | path | string | 是 | 应用 ID |
| file | form-data | file | 是 | zip 文件,最大 5MB |
响应
| 字段 | 类型 | 说明 |
|---|---|---|
| code | number | 0 表示成功 |
| data | object | 上传结果 |
| data.artifactZipUrl | string | 上传后的 zip 可访问 URL |
示例:
curl -X POST \
-H "Authorization: Bearer TEMP_TOKEN" \
-F "file=@/path/to/dist.zip" \
https://www.weavefox.cn/api/open/v1/apps/YOUR_PUBLIC_ID/upload-artifact-zip
从 zip URL 创建应用版本。
参数
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| publicId | path | string | 是 | 应用 ID |
| artifactZipUrl | body | string | 是 | 产物 zip 的 URL,必须为 upload_artifact_zip 返回的站内地址,其他地址返回 400 |
| changelog | body | string | 是 | 版本更新日志,1-2000 字符 |
| previewImg | body | string | 否 | 预览截图 URL |
响应
| 字段 | 类型 | 说明 |
|---|---|---|
| code | number | 0 表示成功 |
| data | object | 版本创建结果 |
| data.version | string | 新创建的版本号,如 v1 |
| data.fileCount | number | 产物文件数 |
| data.totalSize | number | 产物总大小(字节) |
分页查询应用版本列表。
参数
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| publicId | path | string | 是 | 应用 ID |
| page | query | number | 否 | 页码,默认 1 |
| pageSize | query | number | 否 | 每页条数,最大 100,默认 20 |
响应
| 字段 | 类型 | 说明 |
|---|---|---|
| code | number | 0 表示成功 |
| data | object | 分页数据 |
| data.versions | AppVersionDTO[] | 版本列表,结构见「版本对象 AppVersionDTO」 |
| data.hasMore | boolean | 是否还有下一页 |
| data.total | number | 总条数 |
部署指定版本为当前线上版本。
参数
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| publicId | path | string | 是 | 应用 ID |
| version | path | string | 是 | 版本号,如 v1 |
| securityCheckId | body | string | 否 | 安全检查 ID,仅在确认安全风险后重新部署时需要 |
响应
| 字段 | 类型 | 说明 |
|---|---|---|
| code | number | 0 表示成功 |
| data | object | 部署结果 |
| data.success | boolean | 是否部署成功 |
| data.securityCheck | object | 可选,安全检测发现风险时返回 |
| data.securityCheck.id | string | 安全检查 ID,确认安全后作为 securityCheckId 重新部署 |
| data.securityCheck.issues | object[] | 风险项列表 |
| data.securityCheck.issues[].severity | string | 风险等级(low/medium/high) |
| data.securityCheck.issues[].title | string | 风险标题 |
| data.securityCheck.issues[].description | string | 风险描述 |
| data.securityCheck.issues[].recommendation | string | 修复建议 |
| data.securityCheck.issues[].resource | object | 风险涉及的资源定位(如 filePath、lineNumber 等) |