Skip to content

Commit 9ce955c

Browse files
authored
fix: replace custom tools endpoints with MCP note, add checkBinary (EN+VI+ZH) (#53)
Custom tools REST endpoints are not implemented; replace with note directing users to MCP servers and skills. Add new /v1/cli-credentials/checkBinary endpoint.
1 parent 48d2ba8 commit 9ce955c

3 files changed

Lines changed: 6 additions & 33 deletions

File tree

reference/rest-api.md

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -496,17 +496,7 @@ Set `"dryRun": true` to return tool schema without execution.
496496
| `PUT` | `/v1/tools/builtin/{name}/tenant-config` | Set per-tenant override (admin) |
497497
| `DELETE` | `/v1/tools/builtin/{name}/tenant-config` | Remove per-tenant override (admin) |
498498

499-
### Custom Tools
500-
501-
| Method | Path | Description |
502-
|--------|------|-------------|
503-
| `GET` | `/v1/tools/custom` | List custom tools (paginated) |
504-
| `POST` | `/v1/tools/custom` | Create custom tool |
505-
| `GET` | `/v1/tools/custom/{id}` | Get tool details |
506-
| `PUT` | `/v1/tools/custom/{id}` | Update tool |
507-
| `DELETE` | `/v1/tools/custom/{id}` | Delete tool |
508-
509-
Query parameters for list: `agent_id`, `search`, `limit`, `offset`
499+
> **Note:** Custom tools via REST API are not currently implemented. MCP servers and skills provide the recommended extension mechanism.
510500
511501
---
512502

@@ -1044,6 +1034,7 @@ Requires **admin role** (full gateway token or empty gateway token in dev/single
10441034
| `DELETE` | `/v1/cli-credentials/{id}` | Delete credential |
10451035
| `GET` | `/v1/cli-credentials/presets` | Get preset credential templates |
10461036
| `POST` | `/v1/cli-credentials/{id}/test` | Test credential connection (dry-run) |
1037+
| `POST` | `/v1/cli-credentials/check-binary` | Validate a binary path for CLI credential use |
10471038

10481039
### Per-User CLI Credentials
10491040

vi/reference/rest-api.md

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -495,17 +495,7 @@ POST /v1/tools/invoke
495495
| `PUT` | `/v1/tools/builtin/{name}/tenant-config` | Đặt cấu hình ghi đè theo tenant (admin) |
496496
| `DELETE` | `/v1/tools/builtin/{name}/tenant-config` | Xóa cấu hình ghi đè theo tenant (admin) |
497497

498-
### Custom Tools
499-
500-
| Method | Path | Mô tả |
501-
|--------|------|-------|
502-
| `GET` | `/v1/tools/custom` | Liệt kê custom tool (có phân trang) |
503-
| `POST` | `/v1/tools/custom` | Tạo custom tool |
504-
| `GET` | `/v1/tools/custom/{id}` | Lấy chi tiết tool |
505-
| `PUT` | `/v1/tools/custom/{id}` | Cập nhật tool |
506-
| `DELETE` | `/v1/tools/custom/{id}` | Xóa tool |
507-
508-
Query param cho list: `agent_id`, `search`, `limit`, `offset`
498+
> **Lưu ý:** Custom tools qua REST API hiện chưa được triển khai. MCP servers và skills là cơ chế mở rộng được khuyến nghị.
509499
510500
---
511501

@@ -992,6 +982,7 @@ Yêu cầu **admin role** (full gateway token hoặc gateway token rỗng ở ch
992982
| `DELETE` | `/v1/cli-credentials/{id}` | Xóa credential |
993983
| `GET` | `/v1/cli-credentials/presets` | Lấy preset credential template |
994984
| `POST` | `/v1/cli-credentials/{id}/test` | Test kết nối credential (dry-run) |
985+
| `POST` | `/v1/cli-credentials/check-binary` | Xác thực đường dẫn binary cho CLI credential |
995986

996987
### Per-User CLI Credentials
997988

zh/reference/rest-api.md

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -463,17 +463,7 @@ POST /v1/tools/invoke
463463
| `PUT` | `/v1/tools/builtin/{name}/tenant-config` | 设置租户级覆盖(管理员)|
464464
| `DELETE` | `/v1/tools/builtin/{name}/tenant-config` | 移除租户级覆盖(管理员)|
465465

466-
### 自定义工具
467-
468-
| 方法 | 路径 | 说明 |
469-
|--------|------|-------------|
470-
| `GET` | `/v1/tools/custom` | 列出自定义工具(分页)|
471-
| `POST` | `/v1/tools/custom` | 创建自定义工具 |
472-
| `GET` | `/v1/tools/custom/{id}` | 获取工具详情 |
473-
| `PUT` | `/v1/tools/custom/{id}` | 更新工具 |
474-
| `DELETE` | `/v1/tools/custom/{id}` | 删除工具 |
475-
476-
列表查询参数:`agent_id``search``limit``offset`
466+
> **注意:** REST API 的自定义工具端点当前未实现。推荐使用 MCP servers 和 skills 作为扩展机制。
477467
478468
---
479469

@@ -960,6 +950,7 @@ agents/{agent_key}/workspace/ — 每个 agent 的工作区文件
960950
| `DELETE` | `/v1/cli-credentials/{id}` | 删除凭证 |
961951
| `GET` | `/v1/cli-credentials/presets` | 获取预设凭证模板 |
962952
| `POST` | `/v1/cli-credentials/{id}/test` | 测试凭证连接(演习)|
953+
| `POST` | `/v1/cli-credentials/check-binary` | 验证 CLI 凭证的二进制路径 |
963954

964955
### 按用户 CLI 凭证
965956

0 commit comments

Comments
 (0)