Tool 模板与包 API
项目内创建、预览、安装、提交、发布和删除 Tool 模板 / Tool 包及其版本。
基础信息
- 基础路径：
/projects/:projectId/tool-templates - 认证方式：JWT Bearer Token 或 API Key（combinedAuth）。写入、发布、提交和删除需要项目写权限。
端点
补充端点
本节补充 plans/need-update-api.md 中尚未覆盖到 docs-site 的接口。端点标题保持严格的 METHOD /path 格式，便于后台文档覆盖率服务识别。
GET /projects/:projectId/package-installs
列出项目已安装的 Tool 包。
认证：JWT Bearer Token 或 API Key（combinedAuth）。写入、发布、提交和删除需要项目写权限。 路径参数
| 参数 | 说明 |
|---|---|
projectId | 项目 ID |
请求：无请求体。Query 参数用于分页、过滤、搜索或状态筛选；未传时按后端默认排序与分页返回。
响应：成功时返回目标资源详情、状态或配置对象。
常见错误：400 参数非法，401 未认证，403 权限不足，404 资源不存在；服务端或上游异常返回 500。
POST /projects/:projectId/package-installs
安装 Tool 包到当前项目。
认证：JWT Bearer Token 或 API Key（combinedAuth）。写入、发布、提交和删除需要项目写权限。 路径参数
| 参数 | 说明 |
|---|---|
projectId | 项目 ID |
请求：请求体为 JSON，包含创建、提交、安装、发布或业务动作所需字段。
响应：成功时返回创建或更新后的资源对象，或 { "success": true }。
常见错误：400 参数非法，401 未认证，403 权限不足，404 资源不存在；服务端或上游异常返回 500。
PATCH /projects/:projectId/package-installs/:installId
升级、降级或调整已安装 Tool 包。
认证：JWT Bearer Token 或 API Key（combinedAuth）。写入、发布、提交和删除需要项目写权限。 路径参数
| 参数 | 说明 |
|---|---|
projectId | 项目 ID |
installId | 安装记录 ID |
请求：请求体为 JSON，传入需要变更的字段；未传字段保持不变。
响应：成功时返回创建或更新后的资源对象，或 { "success": true }。
常见错误：400 参数非法，401 未认证，403 权限不足，404 资源不存在；服务端或上游异常返回 500。
DELETE /projects/:projectId/package-installs/:installId
从项目卸载 Tool 包。
认证：JWT Bearer Token 或 API Key（combinedAuth）。写入、发布、提交和删除需要项目写权限。 路径参数
| 参数 | 说明 |
|---|---|
projectId | 项目 ID |
installId | 安装记录 ID |
请求：通常无请求体；删除类接口通过路径参数定位资源，部分接口会执行软删除、释放绑定或撤回流程。
响应：成功时返回 { "success": true } 或等价删除结果；资源不存在、无权限或存在依赖时返回 4xx。
常见错误：400 参数非法，401 未认证，403 权限不足，404 资源不存在；服务端或上游异常返回 500。
GET /projects/:projectId/package-installs/:installId/files/:fileId/summary
读取已安装 Tool 包中文件的摘要信息。
认证：JWT Bearer Token 或 API Key（combinedAuth）。写入、发布、提交和删除需要项目写权限。 路径参数
| 参数 | 说明 |
|---|---|
projectId | 项目 ID |
installId | 安装记录 ID |
fileId | 文件 ID |
请求：无请求体。Query 参数用于分页、过滤、搜索或状态筛选；未传时按后端默认排序与分页返回。
响应：成功时返回目标资源详情、状态或配置对象。
常见错误：400 参数非法，401 未认证，403 权限不足，404 资源不存在；服务端或上游异常返回 500。
GET /projects/:projectId/tool-installs
已安装 Tool 列表
认证：JWT Bearer Token 或 API Key（combinedAuth）。写入、发布、提交和删除需要项目写权限。 路径参数
| 参数 | 说明 |
|---|---|
projectId | 项目 ID |
请求：无请求体。Query 参数用于分页、过滤、搜索或状态筛选；未传时按后端默认排序与分页返回。
响应：成功时返回列表数据，通常包含 items / data / rows 与分页或统计字段。
常见错误：400 参数非法，401 未认证，403 权限不足，404 资源不存在；服务端或上游异常返回 500。
POST /projects/:projectId/tool-installs
安装 Tool 模板
认证：JWT Bearer Token 或 API Key（combinedAuth）。写入、发布、提交和删除需要项目写权限。 权限：project:write
路径参数
| 参数 | 说明 |
|---|---|
projectId | 项目 ID |
请求：请求体为 JSON，包含创建、提交、安装、发布或业务动作所需字段。
响应：成功时返回创建或更新后的资源对象，或 { "success": true }。
常见错误：400 参数非法，401 未认证，403 权限不足，404 资源不存在；服务端或上游异常返回 500。
PATCH /projects/:projectId/tool-installs/:installId
升级/回退 Tool 版本
认证：JWT Bearer Token 或 API Key（combinedAuth）。写入、发布、提交和删除需要项目写权限。 权限：project:write
路径参数
| 参数 | 说明 |
|---|---|
projectId | 项目 ID |
installId | 安装记录 ID |
请求：请求体为 JSON，传入需要变更的字段；未传字段保持不变。
响应：成功时返回创建或更新后的资源对象，或 { "success": true }。
常见错误：400 参数非法，401 未认证，403 权限不足，404 资源不存在；服务端或上游异常返回 500。
DELETE /projects/:projectId/tool-installs/:installId
卸载 Tool 模板
认证：JWT Bearer Token 或 API Key（combinedAuth）。写入、发布、提交和删除需要项目写权限。 权限：project:write
路径参数
| 参数 | 说明 |
|---|---|
projectId | 项目 ID |
installId | 安装记录 ID |
请求：通常无请求体；删除类接口通过路径参数定位资源，部分接口会执行软删除、释放绑定或撤回流程。
响应：成功时返回 { "success": true } 或等价删除结果；资源不存在、无权限或存在依赖时返回 4xx。
常见错误：400 参数非法，401 未认证，403 权限不足，404 资源不存在；服务端或上游异常返回 500。
POST /projects/:projectId/tool-packages
创建项目 Tool 包。
认证：JWT Bearer Token 或 API Key（combinedAuth）。写入、发布、提交和删除需要项目写权限。 路径参数
| 参数 | 说明 |
|---|---|
projectId | 项目 ID |
请求：请求体为 JSON，包含创建、提交、安装、发布或业务动作所需字段。
响应：成功时返回创建或更新后的资源对象，或 { "success": true }。
常见错误：400 参数非法，401 未认证，403 权限不足，404 资源不存在；服务端或上游异常返回 500。
PATCH /projects/:projectId/tool-packages/:id
编辑项目 Tool 包。
认证：JWT Bearer Token 或 API Key（combinedAuth）。写入、发布、提交和删除需要项目写权限。 路径参数
| 参数 | 说明 |
|---|---|
projectId | 项目 ID |
id | 资源 ID |
请求：请求体为 JSON，传入需要变更的字段；未传字段保持不变。
响应：成功时返回创建或更新后的资源对象，或 { "success": true }。
常见错误：400 参数非法，401 未认证，403 权限不足，404 资源不存在；服务端或上游异常返回 500。
DELETE /projects/:projectId/tool-packages/:id
删除项目 Tool 包。
认证：JWT Bearer Token 或 API Key（combinedAuth）。写入、发布、提交和删除需要项目写权限。 路径参数
| 参数 | 说明 |
|---|---|
projectId | 项目 ID |
id | 资源 ID |
请求：通常无请求体；删除类接口通过路径参数定位资源，部分接口会执行软删除、释放绑定或撤回流程。
响应：成功时返回 { "success": true } 或等价删除结果；资源不存在、无权限或存在依赖时返回 4xx。
常见错误：400 参数非法，401 未认证，403 权限不足，404 资源不存在；服务端或上游异常返回 500。
POST /projects/:projectId/tool-packages/:id/publish
直接发布 Tool 包。
认证：JWT Bearer Token 或 API Key（combinedAuth）。写入、发布、提交和删除需要项目写权限。 路径参数
| 参数 | 说明 |
|---|---|
projectId | 项目 ID |
id | 资源 ID |
请求：请求体为 JSON，包含创建、提交、安装、发布或业务动作所需字段。
响应：成功时返回创建或更新后的资源对象，或 { "success": true }。
常见错误：400 参数非法，401 未认证，403 权限不足，404 资源不存在；服务端或上游异常返回 500。
POST /projects/:projectId/tool-packages/:id/submit
提交 Tool 包审核。
认证：JWT Bearer Token 或 API Key（combinedAuth）。写入、发布、提交和删除需要项目写权限。 路径参数
| 参数 | 说明 |
|---|---|
projectId | 项目 ID |
id | 资源 ID |
请求：请求体为 JSON，包含创建、提交、安装、发布或业务动作所需字段。
响应：成功时返回创建或更新后的资源对象，或 { "success": true }。
常见错误：400 参数非法，401 未认证，403 权限不足，404 资源不存在；服务端或上游异常返回 500。
POST /projects/:projectId/tool-packages/:id/versions
列出文档历史版本，用于回溯、对比或选择回滚目标。
认证：JWT Bearer Token 或 API Key（combinedAuth）。写入、发布、提交和删除需要项目写权限。 路径参数
| 参数 | 说明 |
|---|---|
projectId | 项目 ID |
id | 资源 ID |
请求：请求体为 JSON，包含创建、提交、安装、发布或业务动作所需字段。
响应：成功时返回创建或更新后的资源对象，或 { "success": true }。
常见错误：400 参数非法，401 未认证，403 权限不足，404 资源不存在；服务端或上游异常返回 500。
DELETE /projects/:projectId/tool-packages/:id/versions/:versionId
删除 Tool 包版本。
认证：JWT Bearer Token 或 API Key（combinedAuth）。写入、发布、提交和删除需要项目写权限。 路径参数
| 参数 | 说明 |
|---|---|
projectId | 项目 ID |
id | 资源 ID |
versionId | 版本 ID |
请求：通常无请求体；删除类接口通过路径参数定位资源，部分接口会执行软删除、释放绑定或撤回流程。
响应：成功时返回 { "success": true } 或等价删除结果；资源不存在、无权限或存在依赖时返回 4xx。
常见错误：400 参数非法，401 未认证，403 权限不足，404 资源不存在；服务端或上游异常返回 500。
POST /projects/:projectId/tool-packages/:id/versions/:versionId/submit
提交 Tool 包版本审核。
认证：JWT Bearer Token 或 API Key（combinedAuth）。写入、发布、提交和删除需要项目写权限。 路径参数
| 参数 | 说明 |
|---|---|
projectId | 项目 ID |
id | 资源 ID |
versionId | 版本 ID |
请求：请求体为 JSON，包含创建、提交、安装、发布或业务动作所需字段。
响应：成功时返回创建或更新后的资源对象，或 { "success": true }。
常见错误：400 参数非法，401 未认证，403 权限不足，404 资源不存在；服务端或上游异常返回 500。
POST /projects/:projectId/tool-packages/:id/versions/:versionId/withdraw
撤回 Tool 包版本审核。
认证：JWT Bearer Token 或 API Key（combinedAuth）。写入、发布、提交和删除需要项目写权限。 路径参数
| 参数 | 说明 |
|---|---|
projectId | 项目 ID |
id | 资源 ID |
versionId | 版本 ID |
请求：请求体为 JSON，包含创建、提交、安装、发布或业务动作所需字段。
响应：成功时返回创建或更新后的资源对象，或 { "success": true }。
常见错误：400 参数非法，401 未认证，403 权限不足，404 资源不存在；服务端或上游异常返回 500。
POST /projects/:projectId/tool-packages/:id/withdraw
撤回 Tool 包审核。
认证：JWT Bearer Token 或 API Key（combinedAuth）。写入、发布、提交和删除需要项目写权限。 路径参数
| 参数 | 说明 |
|---|---|
projectId | 项目 ID |
id | 资源 ID |
请求：请求体为 JSON，包含创建、提交、安装、发布或业务动作所需字段。
响应：成功时返回创建或更新后的资源对象，或 { "success": true }。
常见错误：400 参数非法，401 未认证，403 权限不足，404 资源不存在；服务端或上游异常返回 500。
GET /projects/:projectId/tool-packages/available
列出当前项目可安装的 Tool 包。
认证：JWT Bearer Token 或 API Key（combinedAuth）。写入、发布、提交和删除需要项目写权限。 路径参数
| 参数 | 说明 |
|---|---|
projectId | 项目 ID |
请求：无请求体。Query 参数用于分页、过滤、搜索或状态筛选；未传时按后端默认排序与分页返回。
响应：成功时返回列表数据，通常包含 items / data / rows 与分页或统计字段。
常见错误：400 参数非法，401 未认证，403 权限不足，404 资源不存在；服务端或上游异常返回 500。
GET /projects/:projectId/tool-packages/mine
列出当前用户在项目中维护的 Tool 包。
认证：JWT Bearer Token 或 API Key（combinedAuth）。写入、发布、提交和删除需要项目写权限。 路径参数
| 参数 | 说明 |
|---|---|
projectId | 项目 ID |
请求：无请求体。Query 参数用于分页、过滤、搜索或状态筛选；未传时按后端默认排序与分页返回。
响应：成功时返回列表数据，通常包含 items / data / rows 与分页或统计字段。
常见错误：400 参数非法，401 未认证，403 权限不足，404 资源不存在；服务端或上游异常返回 500。
POST /projects/:projectId/tool-packages/preview-from-folder
从项目文件夹预览可发布的 Tool 包元数据。
认证：JWT Bearer Token 或 API Key（combinedAuth）。写入、发布、提交和删除需要项目写权限。 路径参数
| 参数 | 说明 |
|---|---|
projectId | 项目 ID |
请求：请求体为 JSON，包含创建、提交、安装、发布或业务动作所需字段。
响应：成功时返回创建或更新后的资源对象，或 { "success": true }。
常见错误：400 参数非法，401 未认证，403 权限不足，404 资源不存在；服务端或上游异常返回 500。
POST /projects/:projectId/tool-templates
创建 Tool 模板
认证：JWT Bearer Token 或 API Key（combinedAuth）。写入、发布、提交和删除需要项目写权限。 权限：project:write
路径参数
| 参数 | 说明 |
|---|---|
projectId | 项目 ID |
请求：请求体为 JSON，包含创建、提交、安装、发布或业务动作所需字段。
响应：成功时返回创建或更新后的资源对象，或 { "success": true }。
常见错误：400 参数非法，401 未认证，403 权限不足，404 资源不存在；服务端或上游异常返回 500。
PATCH /projects/:projectId/tool-templates/:id
编辑我的 Tool 模板
认证：JWT Bearer Token 或 API Key（combinedAuth）。写入、发布、提交和删除需要项目写权限。 权限：project:write
路径参数
| 参数 | 说明 |
|---|---|
projectId | 项目 ID |
id | 资源 ID |
请求：请求体为 JSON，传入需要变更的字段；未传字段保持不变。
响应：成功时返回创建或更新后的资源对象，或 { "success": true }。
常见错误：400 参数非法，401 未认证，403 权限不足，404 资源不存在；服务端或上游异常返回 500。
DELETE /projects/:projectId/tool-templates/:id
删除我的 Tool 模板
认证：JWT Bearer Token 或 API Key（combinedAuth）。写入、发布、提交和删除需要项目写权限。 权限：project:write
路径参数
| 参数 | 说明 |
|---|---|
projectId | 项目 ID |
id | 资源 ID |
请求：通常无请求体；删除类接口通过路径参数定位资源，部分接口会执行软删除、释放绑定或撤回流程。
响应：成功时返回 { "success": true } 或等价删除结果；资源不存在、无权限或存在依赖时返回 4xx。
常见错误：400 参数非法，401 未认证，403 权限不足，404 资源不存在；服务端或上游异常返回 500。
POST /projects/:projectId/tool-templates/:id/publish
直接发布 Tool 模板
认证：JWT Bearer Token 或 API Key（combinedAuth）。写入、发布、提交和删除需要项目写权限。 权限：project:write
路径参数
| 参数 | 说明 |
|---|---|
projectId | 项目 ID |
id | 资源 ID |
请求：请求体为 JSON，包含创建、提交、安装、发布或业务动作所需字段。
响应：成功时返回创建或更新后的资源对象，或 { "success": true }。
常见错误：400 参数非法，401 未认证，403 权限不足，404 资源不存在；服务端或上游异常返回 500。
POST /projects/:projectId/tool-templates/:id/submit
提交 Tool 模板审核
认证：JWT Bearer Token 或 API Key（combinedAuth）。写入、发布、提交和删除需要项目写权限。 权限：project:write
路径参数
| 参数 | 说明 |
|---|---|
projectId | 项目 ID |
id | 资源 ID |
请求：请求体为 JSON，包含创建、提交、安装、发布或业务动作所需字段。
响应：成功时返回创建或更新后的资源对象，或 { "success": true }。
常见错误：400 参数非法，401 未认证，403 权限不足，404 资源不存在；服务端或上游异常返回 500。
POST /projects/:projectId/tool-templates/:id/versions
添加 Tool 模板版本
认证：JWT Bearer Token 或 API Key（combinedAuth）。写入、发布、提交和删除需要项目写权限。 权限：project:write
路径参数
| 参数 | 说明 |
|---|---|
projectId | 项目 ID |
id | 资源 ID |
请求：请求体为 JSON，包含创建、提交、安装、发布或业务动作所需字段。
响应：成功时返回创建或更新后的资源对象，或 { "success": true }。
常见错误：400 参数非法，401 未认证，403 权限不足，404 资源不存在；服务端或上游异常返回 500。
DELETE /projects/:projectId/tool-templates/:id/versions/:versionId
删除 Tool 模板版本
认证：JWT Bearer Token 或 API Key（combinedAuth）。写入、发布、提交和删除需要项目写权限。 权限：project:write
路径参数
| 参数 | 说明 |
|---|---|
projectId | 项目 ID |
id | 资源 ID |
versionId | 版本 ID |
请求：通常无请求体；删除类接口通过路径参数定位资源，部分接口会执行软删除、释放绑定或撤回流程。
响应：成功时返回 { "success": true } 或等价删除结果；资源不存在、无权限或存在依赖时返回 4xx。
常见错误：400 参数非法，401 未认证，403 权限不足，404 资源不存在；服务端或上游异常返回 500。
POST /projects/:projectId/tool-templates/:id/versions/:versionId/submit
提交 Tool 模板版本审核
认证：JWT Bearer Token 或 API Key（combinedAuth）。写入、发布、提交和删除需要项目写权限。 权限：project:write
路径参数
| 参数 | 说明 |
|---|---|
projectId | 项目 ID |
id | 资源 ID |
versionId | 版本 ID |
请求：请求体为 JSON，包含创建、提交、安装、发布或业务动作所需字段。
响应：成功时返回创建或更新后的资源对象，或 { "success": true }。
常见错误：400 参数非法，401 未认证，403 权限不足，404 资源不存在；服务端或上游异常返回 500。
POST /projects/:projectId/tool-templates/:id/versions/:versionId/withdraw
撤回 Tool 模板版本审核
认证：JWT Bearer Token 或 API Key（combinedAuth）。写入、发布、提交和删除需要项目写权限。 权限：project:write
路径参数
| 参数 | 说明 |
|---|---|
projectId | 项目 ID |
id | 资源 ID |
versionId | 版本 ID |
请求：请求体为 JSON，包含创建、提交、安装、发布或业务动作所需字段。
响应：成功时返回创建或更新后的资源对象，或 { "success": true }。
常见错误：400 参数非法，401 未认证，403 权限不足，404 资源不存在；服务端或上游异常返回 500。
POST /projects/:projectId/tool-templates/:id/withdraw
撤回 Tool 模板审核
认证：JWT Bearer Token 或 API Key（combinedAuth）。写入、发布、提交和删除需要项目写权限。 权限：project:write
路径参数
| 参数 | 说明 |
|---|---|
projectId | 项目 ID |
id | 资源 ID |
请求：请求体为 JSON，包含创建、提交、安装、发布或业务动作所需字段。
响应：成功时返回创建或更新后的资源对象，或 { "success": true }。
常见错误：400 参数非法，401 未认证，403 权限不足，404 资源不存在；服务端或上游异常返回 500。
GET /projects/:projectId/tool-templates/available
可安装 Tool 模板列表
认证：JWT Bearer Token 或 API Key（combinedAuth）。写入、发布、提交和删除需要项目写权限。 路径参数
| 参数 | 说明 |
|---|---|
projectId | 项目 ID |
请求：无请求体。Query 参数用于分页、过滤、搜索或状态筛选；未传时按后端默认排序与分页返回。
响应：成功时返回列表数据，通常包含 items / data / rows 与分页或统计字段。
常见错误：400 参数非法，401 未认证，403 权限不足，404 资源不存在；服务端或上游异常返回 500。
GET /projects/:projectId/tool-templates/mine
我的 Tool 模板列表
认证：JWT Bearer Token 或 API Key（combinedAuth）。写入、发布、提交和删除需要项目写权限。 路径参数
| 参数 | 说明 |
|---|---|
projectId | 项目 ID |
请求：无请求体。Query 参数用于分页、过滤、搜索或状态筛选；未传时按后端默认排序与分页返回。
响应：成功时返回列表数据，通常包含 items / data / rows 与分页或统计字段。
常见错误：400 参数非法，401 未认证，403 权限不足，404 资源不存在；服务端或上游异常返回 500。
POST /projects/:projectId/tool-templates/preview-from-document
从文档预览 Tool 模板
认证：JWT Bearer Token 或 API Key（combinedAuth）。写入、发布、提交和删除需要项目写权限。 权限：project:write
路径参数
| 参数 | 说明 |
|---|---|
projectId | 项目 ID |
请求：请求体为 JSON，包含创建、提交、安装、发布或业务动作所需字段。
响应：成功时返回创建或更新后的资源对象，或 { "success": true }。
常见错误：400 参数非法，401 未认证，403 权限不足，404 资源不存在；服务端或上游异常返回 500。