aiToolsListSystemTools
aiToolsListSystemTools_200_response aiToolsListSystemTools(entityId)
GET /api/2.0/ai/tools/list-system-tools
List system tools
Lists every tool the scope can offer the model, as a map of server type to tool group. The answer merges two sources - the host-configured system servers and the live tools of the scope's registered custom MCP servers - and names the system ones separately in system, so a client can tell the two apart. errors carries the reason a registered server delivered no tools, which is the text to show on a permission card, because the browser cannot reach a server-executed MCP server to find out for itself. The connections are opened server-side, so one request is enough and the client never speaks MCP itself; the portal's own built-in server is left out because it is always enabled.
Parameters
| Name | In | Type | Description | Notes |
|---|---|---|---|---|
| entityId | query | String | The DocSpace entity the request is scoped to - the room, folder or agent workspace the chat is invoked from. Omit for the portal-wide scope. | [optional] [example: 1234] |
Responses
| Status code | Description | Type | Response headers |
|---|---|---|---|
| 200 | The scope's tools grouped by server type, the system group keys named in system, and the reason a registered server delivered none in errors. | aiToolsListSystemTools_200_response | - |
| 401 | Missing asc_auth_key cookie or Authorization header. | AiErrorResponse | - |
| 403 | AI is disabled for this portal, the caller is a guest, or the room named by entityId is one the caller cannot open. Relayed from the DocSpace AI service or the Files API. | AiErrorResponse | - |
| 500 | Unhandled failure. The reason is logged server-side and never echoed back. | AiErrorResponse | - |
Return type
aiToolsListSystemTools_200_response
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json