|
123 | 123 | } |
124 | 124 | } |
125 | 125 | }, |
| 126 | + "/v1/tools": { |
| 127 | + "get": { |
| 128 | + "tags": [ |
| 129 | + "tools" |
| 130 | + ], |
| 131 | + "summary": "Tools Endpoint Handler", |
| 132 | + "description": "Handle requests to the /tools endpoint.\n\nProcess GET requests to the /tools endpoint, returning a consolidated list of\navailable tools from all configured MCP servers.\n\nRaises:\n HTTPException: If unable to connect to the Llama Stack server or if\n tool retrieval fails for any reason.\n\nReturns:\n ToolsResponse: An object containing the consolidated list of available tools\n with metadata including tool name, description, parameters, and server source.", |
| 133 | + "operationId": "tools_endpoint_handler_v1_tools_get", |
| 134 | + "responses": { |
| 135 | + "200": { |
| 136 | + "description": "Successful Response", |
| 137 | + "content": { |
| 138 | + "application/json": { |
| 139 | + "schema": { |
| 140 | + "$ref": "#/components/schemas/ToolsResponse" |
| 141 | + }, |
| 142 | + "example": { |
| 143 | + "tools": [ |
| 144 | + { |
| 145 | + "identifier": "", |
| 146 | + "description": "", |
| 147 | + "parameters": [ |
| 148 | + { |
| 149 | + "name": "", |
| 150 | + "description": "", |
| 151 | + "parameter_type": "", |
| 152 | + "required": "True/False", |
| 153 | + "default": "null" |
| 154 | + } |
| 155 | + ], |
| 156 | + "provider_id": "", |
| 157 | + "toolgroup_id": "", |
| 158 | + "server_source": "", |
| 159 | + "type": "tool" |
| 160 | + } |
| 161 | + ] |
| 162 | + } |
| 163 | + } |
| 164 | + } |
| 165 | + }, |
| 166 | + "500": { |
| 167 | + "description": "Connection to Llama Stack is broken or MCP server error" |
| 168 | + } |
| 169 | + } |
| 170 | + } |
| 171 | + }, |
126 | 172 | "/v1/shields": { |
127 | 173 | "get": { |
128 | 174 | "tags": [ |
|
945 | 991 | } |
946 | 992 | } |
947 | 993 | } |
| 994 | + }, |
| 995 | + "put": { |
| 996 | + "tags": [ |
| 997 | + "conversations_v2" |
| 998 | + ], |
| 999 | + "summary": "Update Conversation Endpoint Handler", |
| 1000 | + "description": "Handle request to update a conversation topic summary by ID.", |
| 1001 | + "operationId": "update_conversation_endpoint_handler_v2_conversations__conversation_id__put", |
| 1002 | + "parameters": [ |
| 1003 | + { |
| 1004 | + "name": "conversation_id", |
| 1005 | + "in": "path", |
| 1006 | + "required": true, |
| 1007 | + "schema": { |
| 1008 | + "type": "string", |
| 1009 | + "title": "Conversation Id" |
| 1010 | + } |
| 1011 | + } |
| 1012 | + ], |
| 1013 | + "requestBody": { |
| 1014 | + "required": true, |
| 1015 | + "content": { |
| 1016 | + "application/json": { |
| 1017 | + "schema": { |
| 1018 | + "$ref": "#/components/schemas/ConversationUpdateRequest" |
| 1019 | + } |
| 1020 | + } |
| 1021 | + } |
| 1022 | + }, |
| 1023 | + "responses": { |
| 1024 | + "200": { |
| 1025 | + "description": "Successful Response", |
| 1026 | + "content": { |
| 1027 | + "application/json": { |
| 1028 | + "schema": { |
| 1029 | + "$ref": "#/components/schemas/ConversationUpdateResponse" |
| 1030 | + } |
| 1031 | + } |
| 1032 | + }, |
| 1033 | + "conversation_id": "123e4567-e89b-12d3-a456-426614174000", |
| 1034 | + "success": true, |
| 1035 | + "message": "Topic summary updated successfully", |
| 1036 | + "topic_summary": "Updated topic summary" |
| 1037 | + }, |
| 1038 | + "400": { |
| 1039 | + "description": "Missing or invalid credentials provided by client", |
| 1040 | + "content": { |
| 1041 | + "application/json": { |
| 1042 | + "schema": { |
| 1043 | + "$ref": "#/components/schemas/UnauthorizedResponse" |
| 1044 | + } |
| 1045 | + } |
| 1046 | + } |
| 1047 | + }, |
| 1048 | + "401": { |
| 1049 | + "description": "Unauthorized: Invalid or missing Bearer token", |
| 1050 | + "content": { |
| 1051 | + "application/json": { |
| 1052 | + "schema": { |
| 1053 | + "$ref": "#/components/schemas/UnauthorizedResponse" |
| 1054 | + } |
| 1055 | + } |
| 1056 | + } |
| 1057 | + }, |
| 1058 | + "404": { |
| 1059 | + "detail": { |
| 1060 | + "response": "Conversation not found", |
| 1061 | + "cause": "The specified conversation ID does not exist." |
| 1062 | + }, |
| 1063 | + "description": "Not Found" |
| 1064 | + }, |
| 1065 | + "422": { |
| 1066 | + "description": "Validation Error", |
| 1067 | + "content": { |
| 1068 | + "application/json": { |
| 1069 | + "schema": { |
| 1070 | + "$ref": "#/components/schemas/HTTPValidationError" |
| 1071 | + } |
| 1072 | + } |
| 1073 | + } |
| 1074 | + } |
| 1075 | + } |
948 | 1076 | } |
949 | 1077 | }, |
950 | 1078 | "/readiness": { |
|
1114 | 1242 | "get_conversation", |
1115 | 1243 | "list_conversations", |
1116 | 1244 | "delete_conversation", |
| 1245 | + "update_conversation", |
1117 | 1246 | "feedback", |
1118 | 1247 | "get_models", |
| 1248 | + "get_tools", |
1119 | 1249 | "get_shields", |
1120 | 1250 | "get_metrics", |
1121 | 1251 | "get_config", |
|
1693 | 1823 | } |
1694 | 1824 | ] |
1695 | 1825 | }, |
| 1826 | + "ConversationUpdateRequest": { |
| 1827 | + "properties": { |
| 1828 | + "topic_summary": { |
| 1829 | + "type": "string", |
| 1830 | + "maxLength": 1000, |
| 1831 | + "minLength": 1, |
| 1832 | + "title": "Topic Summary", |
| 1833 | + "description": "The new topic summary for the conversation", |
| 1834 | + "examples": [ |
| 1835 | + "Discussion about machine learning algorithms" |
| 1836 | + ] |
| 1837 | + } |
| 1838 | + }, |
| 1839 | + "additionalProperties": false, |
| 1840 | + "type": "object", |
| 1841 | + "required": [ |
| 1842 | + "topic_summary" |
| 1843 | + ], |
| 1844 | + "title": "ConversationUpdateRequest", |
| 1845 | + "description": "Model representing a request to update a conversation topic summary.\n\nAttributes:\n topic_summary: The new topic summary for the conversation.\n\nExample:\n ```python\n update_request = ConversationUpdateRequest(\n topic_summary=\"Discussion about machine learning algorithms\"\n )\n ```" |
| 1846 | + }, |
| 1847 | + "ConversationUpdateResponse": { |
| 1848 | + "properties": { |
| 1849 | + "conversation_id": { |
| 1850 | + "type": "string", |
| 1851 | + "title": "Conversation Id", |
| 1852 | + "description": "The conversation ID (UUID) that was updated", |
| 1853 | + "examples": [ |
| 1854 | + "123e4567-e89b-12d3-a456-426614174000" |
| 1855 | + ] |
| 1856 | + }, |
| 1857 | + "success": { |
| 1858 | + "type": "boolean", |
| 1859 | + "title": "Success", |
| 1860 | + "description": "Whether the update was successful", |
| 1861 | + "examples": [ |
| 1862 | + true |
| 1863 | + ] |
| 1864 | + }, |
| 1865 | + "message": { |
| 1866 | + "type": "string", |
| 1867 | + "title": "Message", |
| 1868 | + "description": "A message about the update result", |
| 1869 | + "examples": [ |
| 1870 | + "Topic summary updated successfully" |
| 1871 | + ] |
| 1872 | + } |
| 1873 | + }, |
| 1874 | + "type": "object", |
| 1875 | + "required": [ |
| 1876 | + "conversation_id", |
| 1877 | + "success", |
| 1878 | + "message" |
| 1879 | + ], |
| 1880 | + "title": "ConversationUpdateResponse", |
| 1881 | + "description": "Model representing a response for updating a conversation topic summary.\n\nAttributes:\n conversation_id: The conversation ID (UUID) that was updated.\n success: Whether the update was successful.\n message: A message about the update result.\n\nExample:\n ```python\n update_response = ConversationUpdateResponse(\n conversation_id=\"123e4567-e89b-12d3-a456-426614174000\",\n success=True,\n message=\"Topic summary updated successfully\",\n )\n ```" |
| 1882 | + }, |
1696 | 1883 | "ConversationsListResponse": { |
1697 | 1884 | "properties": { |
1698 | 1885 | "conversations": { |
|
3170 | 3357 | "title": "ToolCall", |
3171 | 3358 | "description": "Model representing a tool call made during response generation." |
3172 | 3359 | }, |
| 3360 | + "ToolsResponse": { |
| 3361 | + "properties": { |
| 3362 | + "tools": { |
| 3363 | + "items": { |
| 3364 | + "additionalProperties": true, |
| 3365 | + "type": "object" |
| 3366 | + }, |
| 3367 | + "type": "array", |
| 3368 | + "title": "Tools", |
| 3369 | + "description": "List of tools available from all configured MCP servers and built-in toolgroups", |
| 3370 | + "examples": [ |
| 3371 | + [ |
| 3372 | + { |
| 3373 | + "description": "Read contents of a file from the filesystem", |
| 3374 | + "identifier": "filesystem_read", |
| 3375 | + "parameters": [ |
| 3376 | + { |
| 3377 | + "description": "Path to the file to read", |
| 3378 | + "name": "path", |
| 3379 | + "parameter_type": "string", |
| 3380 | + "required": true |
| 3381 | + } |
| 3382 | + ], |
| 3383 | + "provider_id": "model-context-protocol", |
| 3384 | + "server_source": "http://localhost:3000", |
| 3385 | + "toolgroup_id": "filesystem-tools", |
| 3386 | + "type": "tool" |
| 3387 | + } |
| 3388 | + ] |
| 3389 | + ] |
| 3390 | + } |
| 3391 | + }, |
| 3392 | + "type": "object", |
| 3393 | + "required": [ |
| 3394 | + "tools" |
| 3395 | + ], |
| 3396 | + "title": "ToolsResponse", |
| 3397 | + "description": "Model representing a response to tools request." |
| 3398 | + }, |
3173 | 3399 | "UnauthorizedResponse": { |
3174 | 3400 | "properties": { |
3175 | 3401 | "detail": { |
|
0 commit comments