xinyin025/LangBot
1
0
Fork 0
mirror of https://github.com/langbot-app/LangBot.git synced 2026-10-29 20:05:25 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: add tools API, tools-selector config type, and OpenAPI tools endpoints

Browse Source 
- Plugin SDK APIs: list_tools, get_tool_detail, call_tool (zh/en/ja)
- Config type: tools-selector for multi-select tool picker (zh/en/ja)
- OpenAPI: GET /api/v1/tools, GET /api/v1/tools/{tool_name} (zh/en/ja)
This commit is contained in:
RockChinQ
2026-04-03 17:25:16 +08:00
parent f8ec71299e
commit 47ae62c8bf
9 changed files with 1945 additions and 335 deletions
Download Patch File Download Diff File Expand all files Collapse all files
openapi/service-api-en.json
+147
View File
@@ -2750,6 +2750,113 @@
}
}
}
},
"/api/v1/tools": {
"get": {
"tags": [
"Tools"
],
"summary": "List all available tools",
"description": "List all available tools in the current LangBot instance, including plugin tools and MCP tools.",
"operationId": "listTools",
"security": [
{
"BearerAuth": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 0
},
"msg": {
"type": "string",
"example": "ok"
},
"data": {
"type": "object",
"properties": {
"tools": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ToolSummary"
}
}
}
}
}
}
}
}
}
}
}
},
"/api/v1/tools/{tool_name}": {
"get": {
"tags": [
"Tools"
],
"summary": "Get tool detail",
"description": "Get detailed information about a specific tool.",
"operationId": "getToolDetail",
"security": [
{
"BearerAuth": []
}
],
"parameters": [
{
"name": "tool_name",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "Tool name"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 0
},
"msg": {
"type": "string",
"example": "ok"
},
"data": {
"type": "object",
"properties": {
"tool": {
"$ref": "#/components/schemas/ToolSummary"
}
}
}
}
}
}
}
},
"404": {
"description": "Tool not found"
}
}
}
}
},
"components": {
@@ -3175,6 +3282,46 @@
"type": "string"
}
}
},
"ToolSummary": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Tool name"
},
"label": {
"type": "object",
"description": "Display label (i18n)",
"additionalProperties": {
"type": "string"
}
},
"description": {
"type": "object",
"description": "Tool description (i18n)",
"additionalProperties": {
"type": "string"
}
},
"icon": {
"type": "string",
"description": "Tool icon"
},
"spec": {
"type": "object",
"description": "Tool specification",
"properties": {
"llm_prompt": {
"type": "string"
},
"parameters": {
"type": "object",
"description": "JSON Schema for tool parameters"
}
}
}
}
}
},
"responses": {