open-webui-mcp
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@open-webui-mcp list all users"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
open-webui-mcp
A vendored fork of stephanschielke/open-webui-mcp-server packaged for container deployment, with a SHA-pinned upstream snapshot, a published ghcr.io image, and a small drift-detection helper.
Vendored at upstream commit 85d88af6e3dd34183a5a0eefb85d474f3e3c2b54 (2026-04-07). The wrapper source under src/openwebui_mcp/ is byte-identical to upstream — see NOTICE for full attribution.
What it does
Exposes OpenWebUI's admin REST API as a Model Context Protocol (MCP) server. Tool definitions are generated from a bundled snapshot of OpenWebUI's OpenAPI spec via FastMCP; 317 tools survive the upstream RouteMap filter (after excluding /ollama/*, /openai/*, /api/v1/{analytics,evaluations,terminals,pipelines}/*, and any non-/api/v1/ paths).
This image is intended to run behind an authenticating MCP gateway (e.g. LiteLLM, an mTLS proxy, or anything that fronts streamable-HTTP MCP). It exposes the full OpenWebUI admin surface — including mutating and destructive operations — by design. Do not expose port 7999 to untrusted networks; always front it with bearer auth or equivalent.
Related MCP server: litellm-mcp
Deployment
services:
open-webui-mcp:
image: ghcr.io/tetra-2023/open-webui-mcp:stable
environment:
WEBUI_URL: http://open-webui:8080 # base URL of your OpenWebUI
WEBUI_API_KEY: ${WEBUI_API_KEY} # admin token sourced from your secrets store
MCP_TRANSPORT: http
MCP_HTTP_HOST: 0.0.0.0
MCP_HTTP_PORT: "7999"
MCP_HTTP_PATH: /mcp
depends_on: [open-webui]Pin to a specific tag (:0.2.2) or digest in production. :stable floats with the most recent release tag; :latest floats with main.
Local run (debug)
docker run --rm -p 7999:7999 \
-e WEBUI_URL=http://host.docker.internal:8080 \
-e WEBUI_API_KEY=$WEBUI_API_KEY \
-e MCP_TRANSPORT=http \
-e MCP_HTTP_HOST=0.0.0.0 \
ghcr.io/tetra-2023/open-webui-mcp:stableSpec drift check
When upgrading OpenWebUI, run the drift check before bumping this wrapper. The bundled OpenAPI snapshot drives tool generation, so a mismatch between the snapshot and live OWUI causes the wrapper to advertise tool schemas that no longer match the running endpoints.
WEBUI_API_KEY=... ./scripts/check-spec-drift.sh https://owui.example.comReports added / removed / renamed operations between the bundled snapshot and the live OWUI's /openapi.json. See CONTRIBUTING.md for the full bump procedure.
Tags published on ghcr.io
Tag | When | Source |
| every push to | CI |
| every | Release Image workflow |
| every | Release Image workflow |
License
MIT — see LICENSE (verbatim from upstream) and NOTICE (fork attribution + modifications).
Refs
Upstream source: https://github.com/stephanschielke/open-webui-mcp-server
Original fork: https://github.com/troylar/open-webui-mcp-server
OpenWebUI upstream RFE for a first-party admin MCP: https://github.com/open-webui/open-webui/discussions/16891
Available Tools
317 toolsadd_files_to_knowledge_batch_api_v1_knowledgeC
Add multiple files to a knowledge base
Inputs: id (required), form_data (required). Returns: result
add_file_to_knowledge_by_id_api_v1_knowledgeC
Add File To Knowledge By Id
Inputs: id (required), file_id (required). Returns: result
add_members_by_id_api_v1_channelsC
Add Members By Id
Inputs: id (required), group_ids, user_ids.
add_memory_api_v1_memories_add_postC
Add Memory
Inputs: content (required). Returns: result
add_reaction_to_message_api_v1_channelsD
Add Reaction To Message
Inputs: id (required), message_id (required), name (required). Returns: result
add_tag_by_id_and_tag_name_api_v1_chatsD
Add Tag By Id And Tag Name
Inputs: id (required), name (required). Returns: result
add_user_api_v1_auths_add_postD
Add User
Inputs: email (required), name (required), password (required), profile_image_url, +1 more. Returns: email, id, name, profile_image_url, +3 more
add_user_to_group_api_v1_groups_idD
Add User To Group
Inputs: id (required), user_ids. Returns: result
archive_all_chats_api_v1_chats_archive_all_postB
Archive All Chats
Inputs: no named parameters. Returns: result
archive_chat_by_id_api_v1_chatsC
Archive Chat By Id
Inputs: id (required). Returns: result
chat_completion_api_v1_chat_completions_postD
Chat Completion
Inputs: form_data (required).
check_active_chats_api_v1_tasks_active_chats_postC
Check which chat IDs have active tasks.
Inputs: chat_ids (required).
clone_chat_by_id_api_v1_chatsC
Clone Chat By Id
Inputs: id (required), title. Returns: result
create_channel_webhook_api_v1_channelsC
Create Channel Webhook
Inputs: id (required), name (required), profile_image_url. Returns: channel_id, created_at, id, last_used_at, +5 more
create_folder_api_v1_foldersC
Create Folder
Inputs: name (required), data, meta, parent_id.
create_new_channel_api_v1_channels_create_postD
Create New Channel
Inputs: access_grants, data, description, group_ids, +5 more. Returns: result
create_new_chat_api_v1_chats_new_postD
Create New Chat
Inputs: chat (required), folder_id. Returns: result
create_new_function_api_v1_functions_create_postD
Create New Function
Inputs: content (required), id (required), meta (required), name (required). Returns: result
create_new_group_api_v1_groups_create_postD
Create New Group
Inputs: description (required), name (required), data, permissions. Returns: result
create_new_knowledge_api_v1_knowledge_create_postD
Create New Knowledge
Inputs: description (required), name (required), access_grants. Returns: result
create_new_model_api_v1_models_create_postC
Create New Model
Inputs: id (required), meta (required), name (required), params (required), +3 more. Returns: result
create_new_note_api_v1_notes_create_postD
Create New Note
Inputs: title (required), access_grants, data, meta. Returns: result
create_new_prompt_api_v1_prompts_create_postC
Create New Prompt
Inputs: command (required), content (required), name (required), access_grants, +6 more. Returns: result
create_new_skill_api_v1_skills_create_postC
Create New Skill
Inputs: content (required), id (required), name (required), access_grants, +3 more. Returns: result
create_new_tools_api_v1_tools_create_postD
Create New Tools
Inputs: content (required), id (required), meta (required), name (required), +1 more. Returns: result
delete_all_files_api_v1_files_all_deleteC
Delete All Files
Inputs: no named parameters.
delete_all_models_api_v1_models_delete_all_deleteC
Delete All Models
Inputs: no named parameters. Returns: result
delete_all_tags_by_id_api_v1_chatsD
Delete All Tags By Id
Inputs: id (required). Returns: result
delete_all_user_chats_api_v1_chatsB
Delete All User Chats
Inputs: no named parameters. Returns: result
delete_api_key_api_v1_auths_api_key_deleteC
Delete Api Key
Inputs: no named parameters. Returns: result
delete_channel_by_id_api_v1_channelsD
Delete Channel By Id
Inputs: id (required). Returns: result
delete_channel_webhook_api_v1_channelsC
Delete Channel Webhook
Inputs: id (required), webhook_id (required). Returns: result
delete_chat_by_id_api_v1_chatsC
Delete Chat By Id
Inputs: id (required). Returns: result
delete_entries_from_collection_api_v1_retrieval_delete_pD
Delete Entries From Collection
Inputs: collection_name (required), file_id (required).
delete_file_by_id_api_v1_filesC
Delete File By Id
Inputs: id (required).
delete_folder_by_id_api_v1_foldersC
Delete Folder By Id
Inputs: id (required), delete_contents.
delete_function_by_id_api_v1_functions_idC
Delete Function By Id
Inputs: id (required). Returns: result
delete_group_by_id_api_v1_groups_idC
Delete Group By Id
Inputs: id (required). Returns: result
delete_knowledge_by_id_api_v1_knowledgeC
Delete Knowledge By Id
Inputs: id (required). Returns: result
delete_memory_by_id_api_v1_memoriesC
Delete Memory By Id
Inputs: memory_id (required). Returns: result
delete_memory_by_user_id_api_v1_memories_delete_user_delD
Delete Memory By User Id
Inputs: no named parameters. Returns: result
delete_message_by_id_api_v1_channelsD
Delete Message By Id
Inputs: id (required), message_id (required). Returns: result
delete_model_by_id_api_v1_models_model_delete_postD
Delete Model By Id
Inputs: id (required). Returns: result
delete_note_by_id_api_v1_notesD
Delete Note By Id
Inputs: id (required). Returns: result
delete_prompt_by_id_api_v1_prompts_idD
Delete Prompt By Id
Inputs: prompt_id (required). Returns: result
delete_prompt_history_entry_api_v1_prompts_idA
Delete a history entry. Cannot delete the active production version.
Inputs: prompt_id (required), history_id (required). Returns: result
delete_skill_by_id_api_v1_skills_idC
Delete Skill By Id
Inputs: id (required). Returns: result
delete_tag_by_id_and_tag_name_api_v1_chatsD
Delete Tag By Id And Tag Name
Inputs: id (required), name (required). Returns: result
delete_tools_by_id_api_v1_tools_idC
Delete Tools By Id
Inputs: id (required). Returns: result
delete_user_by_id_api_v1_usersD
Delete User By Id
Inputs: user_id (required). Returns: result
download_chat_as_pdf_api_v1_utils_pdf_postD
Download Chat As Pdf
Inputs: messages (required), title (required).
download_db_api_v1_utils_db_download_getD
Download Db
Inputs: no named parameters.
embeddings_api_v1_embeddings_postA
OpenAI-compatible embeddings endpoint.
This handler:
Performs user/model checks and dispatches to the correct backend.
Supports OpenAI, Ollama, arena models, pipelines, and any compatible provider.
Args: request (Request): Request context. form_data (dict): OpenAI-like payload (e.g., {"model": "...", "input": [...]}) user (UserModel): Authenticated user.
Returns: dict: OpenAI-compatible embeddings response.
Inputs: form_data (required).
execute_code_api_v1_utils_code_execute_postC
Execute Code
Inputs: code (required).
export_chat_stats_api_v1_chats_stats_export_getD
Export Chat Stats
Inputs: updated_at, page, stream. Returns: items, page, total, type
export_config_api_v1_configs_export_getC
Export Config
Inputs: no named parameters. Returns: object
export_group_by_id_api_v1_groups_idC
Export Group By Id
Inputs: id (required). Returns: result
export_knowledge_by_id_api_v1_knowledgeC
Export a knowledge base as a zip file containing .txt files. Admin only.
Inputs: id (required).
export_models_api_v1_models_export_getC
Export Models
Inputs: no named parameters. Returns: result
export_single_chat_stats_api_v1_chats_stats_exportA
Export stats for exactly one chat by ID. Returns ChatStatsExport for the specified chat.
Inputs: chat_id (required). Returns: result
export_skills_api_v1_skills_export_getC
Export Skills
Inputs: no named parameters. Returns: result
export_tools_api_v1_tools_export_getD
Export Tools
Inputs: no named parameters. Returns: result
format_code_api_v1_utils_code_format_postC
Format Code
Inputs: code (required).
generate_api_key_api_v1_auths_api_key_postC
Generate Api Key
Inputs: no named parameters. Returns: api_key
generate_autocompletion_api_v1_tasks_auto_completions_poD
Generate Autocompletion
Inputs: form_data (required).
generate_chat_tags_api_v1_tasks_tags_completions_postC
Generate Chat Tags
Inputs: form_data (required).
generate_emoji_api_v1_tasks_emoji_completions_postC
Generate Emoji
Inputs: form_data (required).
generate_follow_ups_api_v1_tasks_follow_up_completions_pD
Generate Follow Ups
Inputs: form_data (required).
generate_image_prompt_api_v1_tasks_image_prompt_completiD
Generate Image Prompt
Inputs: form_data (required).
generate_images_api_v1_images_generations_postD
Generate Images
Inputs: prompt (required), model, n, negative_prompt, +2 more.
generate_messages_api_v1_messages_postB
Anthropic Messages API compatible endpoint.
Accepts the Anthropic Messages API format, converts internally to OpenAI Chat Completions format, routes through the existing chat completion pipeline, then converts the response back to Anthropic Messages format.
Supports both streaming and non-streaming requests. All models configured in Open WebUI are accessible via this endpoint.
Authentication: Supports both standard Authorization header and Anthropic's x-api-key header (via middleware translation).
Inputs: form_data (required).
generate_moa_response_api_v1_tasks_moa_completions_postD
Generate Moa Response
Inputs: form_data (required).
generate_queries_api_v1_tasks_queries_completions_postD
Generate Queries
Inputs: form_data (required).
generate_title_api_v1_tasks_title_completions_postD
Generate Title
Inputs: form_data (required).
get_admin_config_api_v1_auths_admin_config_getC
Get Admin Config
Inputs: no named parameters.
get_admin_details_api_v1_auths_admin_details_getC
Get Admin Details
Inputs: no named parameters.
get_all_channels_api_v1_channels_list_getC
Get All Channels
Inputs: no named parameters. Returns: result
get_all_user_chats_in_db_api_v1_chats_all_db_getB
Get All User Chats In Db
Inputs: no named parameters. Returns: result
get_all_users_api_v1_users_all_getC
Get All Users
Inputs: no named parameters. Returns: total, users
get_all_user_tags_api_v1_chats_all_tags_getC
Get All User Tags
Inputs: no named parameters. Returns: result
get_api_key_api_v1_auths_api_key_getC
Get Api Key
Inputs: no named parameters. Returns: api_key
get_archived_session_user_chat_list_api_v1_chats_archiveC
Get Archived Session User Chat List
Inputs: page, query, order_by, direction. Returns: result
get_audio_config_api_v1_audio_config_getB
Get Audio Config
Inputs: no named parameters.
get_banners_api_v1_configs_banners_getC
Get Banners
Inputs: no named parameters. Returns: result
get_base_models_api_v1_models_base_getC
Get Base Models
Inputs: no named parameters. Returns: result
get_channel_by_id_api_v1_channelsC
Get Channel By Id
Inputs: id (required). Returns: result
get_channel_members_by_id_api_v1_channelsC
Get Channel Members By Id
Inputs: id (required), query, order_by, direction, +1 more. Returns: total, users
get_channel_message_api_v1_channelsD
Get Channel Message
Inputs: id (required), message_id (required). Returns: result
get_channel_message_data_api_v1_channelsC
Get Channel Message Data
Inputs: id (required), message_id (required). Returns: result
get_channel_messages_api_v1_channelsD
Get Channel Messages
Inputs: id (required), skip, limit. Returns: result
get_channels_api_v1_channelsD
Get Channels
Inputs: no named parameters. Returns: result
get_channel_thread_messages_api_v1_channelsC
Get Channel Thread Messages
Inputs: id (required), message_id (required), skip, limit. Returns: result
get_channel_webhooks_api_v1_channelsC
Get Channel Webhooks
Inputs: id (required). Returns: result
get_chat_by_id_api_v1_chatsC
Get Chat By Id
Inputs: id (required). Returns: result
get_chat_list_by_folder_id_api_v1_chats_folderC
Get Chat List By Folder Id
Inputs: folder_id (required), page.
get_chats_by_folder_id_api_v1_chats_folderD
Get Chats By Folder Id
Inputs: folder_id (required). Returns: result
get_chat_tags_by_id_api_v1_chatsC
Get Chat Tags By Id
Inputs: id (required). Returns: result
get_code_execution_config_api_v1_configs_code_execution_B
Get Code Execution Config
Inputs: no named parameters. Returns: CODE_EXECUTION_ENGINE, CODE_EXECUTION_JUPYTER_AUTH, CODE_EXECUTION_JUPYTER_AUTH…
get_config_api_v1_images_config_getC
Get Config
Inputs: no named parameters. Returns: AUTOMATIC1111_API_AUTH, AUTOMATIC1111_BASE_URL, AUTOMATIC1111_PARAMS, COMFYUI_A…
get_connections_config_api_v1_configs_connections_getC
Get Connections Config
Inputs: no named parameters. Returns: ENABLE_BASE_MODELS_CACHE, ENABLE_DIRECT_CONNECTIONS
get_default_user_permissions_api_v1_users_default_permisC
Get Default User Permissions
Inputs: no named parameters. Returns: access_grants, chat, features, settings, +2 more
get_dm_channel_by_user_id_api_v1_channels_usersD
Get Dm Channel By User Id
Inputs: user_id (required). Returns: result
get_embedding_config_api_v1_retrieval_embedding_getB
Get Embedding Config
Inputs: no named parameters.
get_embeddings_api_v1_retrieval_efD
Get Embeddings
Inputs: text (required).
get_file_by_id_api_v1_filesD
Get File By Id
Inputs: id (required). Returns: result
get_file_content_by_id_api_v1_filesD
Get File Content By Id
Inputs: id (required), attachment.
get_file_content_by_id_api_v1_files_2C
Get File Content By Id
Inputs: id (required).
get_file_data_content_by_id_api_v1_filesC
Get File Data Content By Id
Inputs: id (required).
get_file_process_status_api_v1_filesC
Get File Process Status
Inputs: id (required), stream.
get_folder_by_id_api_v1_foldersC
Get Folder By Id
Inputs: id (required). Returns: result
get_folders_api_v1_foldersC
Get Folders
Inputs: no named parameters. Returns: result
get_function_by_id_api_v1_functions_idD
Get Function By Id
Inputs: id (required). Returns: result
get_function_list_api_v1_functions_list_getB
Get Function List
Inputs: no named parameters. Returns: result
get_functions_api_v1_functionsC
Get Functions
Inputs: no named parameters. Returns: result
get_functions_api_v1_functions_export_getD
Get Functions
Inputs: include_valves. Returns: result
get_function_user_valves_by_id_api_v1_functions_idD
Get Function User Valves By Id
Inputs: id (required). Returns: result
get_function_user_valves_spec_by_id_api_v1_functions_idC
Get Function User Valves Spec By Id
Inputs: id (required). Returns: result
get_function_valves_by_id_api_v1_functions_idC
Get Function Valves By Id
Inputs: id (required). Returns: result
get_function_valves_spec_by_id_api_v1_functions_idC
Get Function Valves Spec By Id
Inputs: id (required). Returns: result
get_gravatar_api_v1_utils_gravatar_getD
Get Gravatar
Inputs: email (required).
get_group_by_id_api_v1_groups_idC
Get Group By Id
Inputs: id (required). Returns: result
get_group_info_by_id_api_v1_groups_idC
Get Group Info By Id
Inputs: id (required). Returns: result
get_groups_api_v1_groupsD
Get Groups
Inputs: share. Returns: result
get_html_file_content_by_id_api_v1_filesC
Get Html File Content By Id
Inputs: id (required).
get_html_from_markdown_api_v1_utils_markdown_postC
Get Html From Markdown
Inputs: md (required).
get_knowledge_bases_api_v1_knowledgeD
Get Knowledge Bases
Inputs: page. Returns: items, total
get_knowledge_by_id_api_v1_knowledgeD
Get Knowledge By Id
Inputs: id (required). Returns: result
get_knowledge_files_by_id_api_v1_knowledgeC
Get Knowledge Files By Id
Inputs: id (required), query, view_option, order_by, +2 more. Returns: items, total
get_ldap_config_api_v1_auths_admin_config_ldap_getC
Get Ldap Config
Inputs: no named parameters.
get_ldap_server_api_v1_auths_admin_config_ldap_server_geC
Get Ldap Server
Inputs: no named parameters. Returns: app_dn, app_dn_password, attribute_for_mail, attribute_for_username, +9 more
get_manifest_json_manifest_json_getC
Get Manifest Json
Inputs: no named parameters.
get_memories_api_v1_memoriesC
Get Memories
Inputs: no named parameters. Returns: result
get_model_by_id_api_v1_models_model_getC
Get Model By Id
Inputs: id (required). Returns: result
get_model_profile_image_api_v1_models_model_profile_imagC
Get Model Profile Image
Inputs: id (required).
get_models_api_v1_audio_models_getD
Get Models
Inputs: no named parameters.
get_models_api_v1_images_models_getC
Get Models
Inputs: no named parameters.
get_models_api_v1_models_getD
Get Models
Inputs: refresh.
get_models_api_v1_models_list_getC
Get Models
Inputs: query, view_option, tag, order_by, +2 more. Returns: items, total
get_models_config_api_v1_configs_models_getC
Get Models Config
Inputs: no named parameters. Returns: DEFAULT_MODELS, DEFAULT_MODEL_METADATA, DEFAULT_MODEL_PARAMS, DEFAULT_PINNED_MO…
get_model_tags_api_v1_models_tags_getC
Get Model Tags
Inputs: no named parameters. Returns: result
get_note_by_id_api_v1_notesD
Get Note By Id
Inputs: id (required). Returns: result
get_notes_api_v1_notesD
Get Notes
Inputs: page. Returns: result
get_opensearch_xml_opensearch_xml_getC
Get Opensearch Xml
Inputs: no named parameters.
get_pinned_channel_messages_api_v1_channelsC
Get Pinned Channel Messages
Inputs: id (required), page. Returns: result
get_pinned_status_by_id_api_v1_chatsC
Get Pinned Status By Id
Inputs: id (required). Returns: result
get_prompt_by_command_api_v1_prompts_commandD
Get Prompt By Command
Inputs: command (required). Returns: result
get_prompt_by_id_api_v1_prompts_idC
Get Prompt By Id
Inputs: prompt_id (required). Returns: result
get_prompt_diff_api_v1_prompts_idC
Get diff between two versions.
Inputs: prompt_id (required), from_id (required), to_id (required).
get_prompt_history_api_v1_prompts_idC
Get version history for a prompt.
Inputs: prompt_id (required), page. Returns: result
get_prompt_history_entry_api_v1_prompts_idC
Get a specific version from history.
Inputs: prompt_id (required), history_id (required). Returns: commit_message, created_at, id, parent_id, +3 more
get_prompt_list_api_v1_prompts_list_getD
Get Prompt List
Inputs: query, view_option, tag, order_by, +2 more. Returns: items, total
get_prompts_api_v1_promptsC
Get Prompts
Inputs: no named parameters. Returns: result
get_prompt_tags_api_v1_prompts_tags_getC
Get Prompt Tags
Inputs: no named parameters. Returns: result
get_rag_config_api_v1_retrieval_config_getC
Get Rag Config
Inputs: no named parameters.
get_session_user_api_v1_authsD
Get Session User
Inputs: no named parameters. Returns: bio, date_of_birth, email, expires_at, +11 more
get_session_user_chat_list_api_v1_chatsC
Get Session User Chat List
Inputs: page, include_pinned, include_folders. Returns: result
get_session_user_chat_list_api_v1_chats_list_getC
Get Session User Chat List
Inputs: page, include_pinned, include_folders. Returns: result
get_session_user_chat_usage_stats_api_v1_chats_stats_usaC
Get Session User Chat Usage Stats
Inputs: items_per_page, page. Returns: items, total
get_skill_by_id_api_v1_skills_idD
Get Skill By Id
Inputs: id (required). Returns: result
get_skill_list_api_v1_skills_list_getC
Get Skill List
Inputs: query, view_option, page. Returns: items, total
get_skills_api_v1_skillsC
Get Skills
Inputs: no named parameters. Returns: result
get_status_api_v1_retrievalC
Get Status
Inputs: no named parameters.
get_task_config_api_v1_tasks_config_getC
Get Task Config
Inputs: no named parameters.
get_terminal_servers_config_api_v1_configs_terminal_servC
Get Terminal Servers Config
Inputs: no named parameters.
get_tool_list_api_v1_tools_list_getC
Get Tool List
Inputs: no named parameters. Returns: result
get_tools_api_v1_toolsD
Get Tools
Inputs: no named parameters. Returns: result
get_tools_by_id_api_v1_tools_idC
Get Tools By Id
Inputs: id (required). Returns: result
get_tool_servers_config_api_v1_configs_tool_servers_getC
Get Tool Servers Config
Inputs: no named parameters. Returns: TOOL_SERVER_CONNECTIONS
get_tools_user_valves_by_id_api_v1_tools_idD
Get Tools User Valves By Id
Inputs: id (required). Returns: result
get_tools_user_valves_spec_by_id_api_v1_tools_idD
Get Tools User Valves Spec By Id
Inputs: id (required). Returns: result
get_tools_valves_by_id_api_v1_tools_idC
Get Tools Valves By Id
Inputs: id (required). Returns: result
get_tools_valves_spec_by_id_api_v1_tools_idD
Get Tools Valves Spec By Id
Inputs: id (required). Returns: result
get_user_active_status_by_id_api_v1_usersC
Get User Active Status By Id
Inputs: user_id (required). Returns: object
get_user_archived_chats_api_v1_chats_all_archived_getB
Get User Archived Chats
Inputs: no named parameters. Returns: result
get_user_by_id_api_v1_usersC
Get User By Id
Inputs: user_id (required). Returns: groups, is_active, name, profile_image_url, +3 more
get_user_chat_list_by_tag_name_api_v1_chats_tags_postD
Get User Chat List By Tag Name
Inputs: name (required), limit, skip. Returns: result
get_user_chat_list_by_user_id_api_v1_chats_list_userD
Get User Chat List By User Id
Inputs: user_id (required), page, query, order_by, +1 more. Returns: result
get_user_chats_api_v1_chats_all_getC
Get User Chats
Inputs: no named parameters. Returns: result
get_user_groups_api_v1_users_groups_getC
Get User Groups
Inputs: no named parameters.
get_user_groups_by_id_api_v1_usersC
Get User Groups By Id
Inputs: user_id (required).
get_user_info_by_id_api_v1_usersC
Get User Info By Id
Inputs: user_id (required). Returns: bio, email, groups, id, +6 more
get_user_info_by_session_user_api_v1_users_user_info_getC
Get User Info By Session User
Inputs: no named parameters. Returns: result
get_user_oauth_sessions_by_id_api_v1_usersC
Get User Oauth Sessions By Id
Inputs: user_id (required).
get_user_permissisions_api_v1_users_permissions_getC
Get User Permissisions
Inputs: no named parameters.
get_user_pinned_chats_api_v1_chats_pinned_getA
Get User Pinned Chats
Inputs: no named parameters. Returns: result
get_user_profile_image_by_id_api_v1_usersC
Get User Profile Image By Id
Inputs: user_id (required).
get_users_api_v1_usersD
Get Users
Inputs: query, order_by, direction, page. Returns: total, users
get_user_settings_by_session_user_api_v1_users_user_settC
Get User Settings By Session User
Inputs: no named parameters. Returns: result
get_users_in_group_api_v1_groups_idD
Get Users In Group
Inputs: id (required). Returns: result
get_user_status_by_session_user_api_v1_users_user_statusC
Get User Status By Session User
Inputs: no named parameters.
get_voices_api_v1_audio_voices_getD
Get Voices
Inputs: no named parameters.
get_webhook_profile_image_api_v1_channels_webhooksC
Get webhook profile image by webhook ID.
Inputs: webhook_id (required).
healthcheck_health_getC
Healthcheck
Inputs: no named parameters.
healthcheck_with_db_health_db_getC
Healthcheck With Db
Inputs: no named parameters.
image_edits_api_v1_images_edit_postD
Image Edits
Inputs: form_data (required), metadata.
import_chats_api_v1_chats_import_postD
Import Chats
Inputs: chats (required). Returns: result
import_config_api_v1_configs_import_postD
Import Config
Inputs: config (required). Returns: object
import_models_api_v1_models_import_postC
Import Models
Inputs: models (required). Returns: result
ldap_auth_api_v1_auths_ldap_postD
Ldap Auth
Inputs: password (required), user (required). Returns: email, expires_at, id, name, +5 more
list_files_api_v1_filesC
List Files
Inputs: content. Returns: result
load_function_from_url_api_v1_functions_load_url_postD
Load Function From Url
Inputs: url (required). Returns: result
load_tool_from_url_api_v1_tools_load_url_postD
Load Tool From Url
Inputs: url (required). Returns: result
oauth_client_authorize_oauth_clientsD
Oauth Client Authorize
Inputs: client_id (required).
oauth_client_callback_oauth_clientsD
Oauth Client Callback
Inputs: client_id (required).
oauth_login_callback_oauthD
Oauth Login Callback
Inputs: provider (required).
oauth_login_callback_oauth_2D
Oauth Login Callback
Inputs: provider (required).
oauth_login_oauthD
Oauth Login
Inputs: provider (required).
pin_channel_message_api_v1_channelsC
Pin Channel Message
Inputs: id (required), message_id (required), is_pinned (required). Returns: result
pin_chat_by_id_api_v1_chatsD
Pin Chat By Id
Inputs: id (required). Returns: result
post_new_message_api_v1_channelsC
Post New Message
Inputs: id (required), content (required), data, meta, +3 more. Returns: result
post_webhook_message_api_v1_channels_webhooksB
Public endpoint to post messages via webhook. No authentication required.
Inputs: webhook_id (required), token (required), content (required).
process_file_api_v1_retrieval_process_file_postB
Process a file and save its content to the vector database. Process a file and save its content to the vector database. Note: granular session management is used to prevent connection pool exhaustion. The session is committed before external API calls, and updates use a fresh session.
Inputs: file_id (required), collection_name, content.
process_files_batch_api_v1_retrieval_process_files_batchB
Process a batch of files and save them to the vector database.
NOTE: We intentionally do NOT use Depends(get_session) here. The save_docs_to_vector_db() call makes external embedding API calls which can take 5-60+ seconds for batch operations. Database operations after embedding (Files.update_file_by_id) manage their own short-lived sessions.
Inputs: collection_name (required), files (required). Returns: errors, results
process_text_api_v1_retrieval_process_text_postD
Process Text
Inputs: content (required), name (required), collection_name.
process_web_api_v1_retrieval_process_web_postD
Process Web
Inputs: url (required), process, overwrite, collection_name.
process_web_api_v1_retrieval_process_youtube_postD
Process Web
Inputs: url (required), process, overwrite, collection_name.
process_web_search_api_v1_retrieval_process_web_search_pD
Process Web Search
Inputs: queries (required).
query_collection_handler_api_v1_retrieval_query_collectiD
Query Collection Handler
Inputs: collection_names (required), query (required), enable_enriched_texts, hybrid, +4 more.
query_doc_handler_api_v1_retrieval_query_doc_postD
Query Doc Handler
Inputs: collection_name (required), query (required), hybrid, k, +2 more.
query_memory_api_v1_memories_query_postD
Query Memory
Inputs: content (required), k.
register_oauth_client_api_v1_configs_oauth_clients_regisC
Register Oauth Client
Inputs: client_id (required), url (required), type, client_name.
reindex_knowledge_base_metadata_embeddings_api_v1_knowleA
Batch embed all existing knowledge bases. Admin only.
NOTE: We intentionally do NOT use Depends(get_session) here. This endpoint loops through ALL knowledge bases and calls embed_knowledge_base_metadata() for each one, making N external embedding API calls. Holding a session during this entire operation would exhaust the connection pool.
Inputs: no named parameters. Returns: object
reindex_knowledge_files_api_v1_knowledge_reindex_postC
Reindex Knowledge Files
Inputs: no named parameters. Returns: result
remove_file_from_knowledge_by_id_api_v1_knowledgeD
Remove File From Knowledge By Id
Inputs: id (required), file_id (required), delete_file. Returns: result
remove_members_by_id_api_v1_channelsD
Remove Members By Id
Inputs: id (required), user_ids.
remove_reaction_by_id_and_user_id_and_name_api_v1_channeD
Remove Reaction By Id And User Id And Name
Inputs: id (required), message_id (required), name (required). Returns: result
remove_users_from_group_api_v1_groups_idC
Remove Users From Group
Inputs: id (required), user_ids. Returns: result
reset_knowledge_by_id_api_v1_knowledgeD
Reset Knowledge By Id
Inputs: id (required). Returns: result
reset_memory_from_vector_db_api_v1_memories_reset_postA
Reset user's memory vector embeddings.
CRITICAL: We intentionally do NOT use Depends(get_session) here. This endpoint generates embeddings for ALL user memories in parallel using asyncio.gather(). A user with 100 memories would trigger 100 embedding API calls simultaneously. With a session held, this could block a connection for MINUTES, completely exhausting the connection pool.
Inputs: no named parameters. Returns: result
reset_upload_dir_api_v1_retrieval_reset_uploads_postD
Reset Upload Dir
Inputs: no named parameters. Returns: result
reset_vector_db_api_v1_retrieval_reset_db_postB
Reset Vector Db
Inputs: no named parameters.
search_files_api_v1_files_search_getA
Search for files by filename with support for wildcard patterns. Uses SQL-based filtering with pagination for better performance.
Inputs: filename (required), content, skip, limit. Returns: result
search_knowledge_bases_api_v1_knowledge_search_getC
Search Knowledge Bases
Inputs: query, view_option, page. Returns: items, total
search_knowledge_files_api_v1_knowledge_search_files_getC
Search Knowledge Files
Inputs: query, page. Returns: items, total
search_notes_api_v1_notes_search_getD
Search Notes
Inputs: query, view_option, permission, order_by, +2 more. Returns: items, total
search_user_chats_api_v1_chats_search_getD
Search User Chats
Inputs: text (required), page. Returns: result
search_users_api_v1_users_search_getC
Search Users
Inputs: query, order_by, direction, page. Returns: total, users
send_chat_message_event_by_id_api_v1_chatsD
Send Chat Message Event By Id
Inputs: id (required), message_id (required), data (required), type (required). Returns: result
serve_cache_file_cacheD
Serve Cache File
Inputs: path (required).
set_banners_api_v1_configs_banners_postD
Set Banners
Inputs: banners (required). Returns: result
set_code_execution_config_api_v1_configs_code_execution_C
Set Code Execution Config
Inputs: CODE_EXECUTION_ENGINE (required), CODE_EXECUTION_JUPYTER_AUTH (required), CODE_EXECUTION_JUPYTER_AUTH_PASSWORD (required)… Returns: CODE_EXECUTION_ENGINE, CODE_EXECUTION_JUPYTER_AUTH, CODE_EXECUTION_JUPYTER_AUTH…
set_connections_config_api_v1_configs_connections_postD
Set Connections Config
Inputs: ENABLE_BASE_MODELS_CACHE (required), ENABLE_DIRECT_CONNECTIONS (required). Returns: ENABLE_BASE_MODELS_CACHE, ENABLE_DIRECT_CONNECTIONS
set_default_suggestions_api_v1_configs_suggestions_postD
Set Default Suggestions
Inputs: suggestions (required). Returns: result
set_models_config_api_v1_configs_models_postD
Set Models Config
Inputs: DEFAULT_MODELS (required), DEFAULT_PINNED_MODELS (required), MODEL_ORDER_LIST (required), DEFAULT_MODEL_METADATA, +1 more. Returns: DEFAULT_MODELS, DEFAULT_MODEL_METADATA, DEFAULT_MODEL_PARAMS, DEFAULT_PINNED_MO…
set_prompt_version_api_v1_prompts_idC
Set Prompt Version
Inputs: prompt_id (required), version_id (required). Returns: result
set_terminal_servers_config_api_v1_configs_terminal_servD
Set Terminal Servers Config
Inputs: TERMINAL_SERVER_CONNECTIONS (required).
set_tool_servers_config_api_v1_configs_tool_servers_postC
Set Tool Servers Config
Inputs: TOOL_SERVER_CONNECTIONS (required). Returns: TOOL_SERVER_CONNECTIONS
signin_api_v1_auths_signin_postD
Signin
Inputs: email (required), password (required). Returns: email, expires_at, id, name, +5 more
signout_api_v1_auths_signout_getD
Signout
Inputs: no named parameters.
signup_api_v1_auths_signup_postD
Signup
Inputs: email (required), name (required), password (required), profile_image_url. Returns: email, expires_at, id, name, +5 more
speech_api_v1_audio_speech_postD
Speech
Inputs: no named parameters.
sync_functions_api_v1_functions_sync_postD
Sync Functions
Inputs: functions. Returns: result
sync_models_api_v1_models_sync_postD
Sync Models
Inputs: models. Returns: result
toggle_function_by_id_api_v1_functions_idD
Toggle Function By Id
Inputs: id (required). Returns: result
toggle_global_by_id_api_v1_functions_idD
Toggle Global By Id
Inputs: id (required). Returns: result
toggle_model_by_id_api_v1_models_model_toggle_postD
Toggle Model By Id
Inputs: id (required). Returns: result
toggle_prompt_active_api_v1_prompts_idD
Toggle Prompt Active
Inputs: prompt_id (required). Returns: result
toggle_skill_by_id_api_v1_skills_idD
Toggle Skill By Id
Inputs: id (required). Returns: result
token_exchange_api_v1_auths_oauthB
Exchange an external OAuth provider token for an OpenWebUI JWT. This endpoint is disabled by default. Set ENABLE_OAUTH_TOKEN_EXCHANGE=True to enable.
Inputs: provider (required), token (required). Returns: email, expires_at, id, name, +5 more
transcription_api_v1_audio_transcriptions_postD
Transcription
Inputs: file (required), language.
unarchive_all_chats_api_v1_chats_unarchive_all_postC
Unarchive All Chats
Inputs: no named parameters. Returns: result
update_admin_config_api_v1_auths_admin_config_postC
Update Admin Config
Inputs: API_KEYS_ALLOWED_ENDPOINTS (required), DEFAULT_GROUP_ID (required), DEFAULT_USER_ROLE (required), ENABLE_API_KEYS (required), +18 more.
update_audio_config_api_v1_audio_config_update_postC
Update Audio Config
Inputs: stt (required), tts (required).
update_channel_by_id_api_v1_channelsC
Update Channel By Id
Inputs: id (required), access_grants, data, description, +5 more. Returns: result
update_channel_webhook_api_v1_channelsC
Update Channel Webhook
Inputs: id (required), webhook_id (required), name (required), profile_image_url. Returns: channel_id, created_at, id, last_used_at, +5 more
update_chat_by_id_api_v1_chatsD
Update Chat By Id
Inputs: id (required), chat (required), folder_id. Returns: result
update_chat_folder_id_by_id_api_v1_chatsD
Update Chat Folder Id By Id
Inputs: id (required), folder_id. Returns: result
update_chat_message_by_id_api_v1_chatsC
Update Chat Message By Id
Inputs: id (required), message_id (required), content (required). Returns: result
update_config_api_v1_images_config_update_postD
Update Config
Inputs: AUTOMATIC1111_API_AUTH (required), AUTOMATIC1111_BASE_URL (required), AUTOMATIC1111_PARAMS (required), COMFYUI_API_KEY (required), +29 more.
update_default_user_permissions_api_v1_users_default_perC
Update Default User Permissions
Inputs: access_grants (required), chat (required), features (required), settings (required), +2 more.
update_embedding_config_api_v1_retrieval_embedding_updatD
Update Embedding Config
Inputs: RAG_EMBEDDING_ENGINE (required), RAG_EMBEDDING_MODEL (required), ENABLE_ASYNC_EMBEDDING, RAG_EMBEDDING_BATCH_SIZE, +4 more.
update_file_data_content_by_id_api_v1_filesC
Update File Data Content By Id
Inputs: id (required), content (required).
update_file_from_knowledge_by_id_api_v1_knowledgeC
Update File From Knowledge By Id
Inputs: id (required), file_id (required). Returns: result
update_folder_is_expanded_by_id_api_v1_foldersD
Update Folder Is Expanded By Id
Inputs: id (required), is_expanded (required).
update_folder_name_by_id_api_v1_foldersC
Update Folder Name By Id
Inputs: id (required), data, meta, name.
update_folder_parent_id_by_id_api_v1_foldersC
Update Folder Parent Id By Id
Inputs: id (required), parent_id.
update_function_by_id_api_v1_functions_idD
Update Function By Id
Inputs: id__path (required), content (required), id (required), meta (required), +1 more. Returns: result
update_function_user_valves_by_id_api_v1_functions_idD
Update Function User Valves By Id
Inputs: id (required), form_data (required). Returns: result
update_function_valves_by_id_api_v1_functions_idC
Update Function Valves By Id
Inputs: id (required), form_data (required). Returns: result
update_group_by_id_api_v1_groups_idD
Update Group By Id
Inputs: id (required), description (required), name (required), data, +1 more. Returns: result
update_is_active_member_by_id_and_user_id_api_v1_channelD
Update Is Active Member By Id And User Id
Inputs: id (required), is_active (required). Returns: result
update_knowledge_access_by_id_api_v1_knowledgeD
Update Knowledge Access By Id
Inputs: id (required), access_grants (required). Returns: result
update_knowledge_by_id_api_v1_knowledgeD
Update Knowledge By Id
Inputs: id (required), description (required), name (required), access_grants. Returns: result
update_ldap_config_api_v1_auths_admin_config_ldap_postD
Update Ldap Config
Inputs: enable_ldap.
update_ldap_server_api_v1_auths_admin_config_ldap_serverD
Update Ldap Server
Inputs: app_dn (required), app_dn_password (required), host (required), label (required), +9 more.
update_memory_by_id_api_v1_memoriesC
Update Memory By Id
Inputs: memory_id (required), content. Returns: result
update_message_by_id_api_v1_channelsC
Update Message By Id
Inputs: id (required), message_id (required), content (required), data, +4 more. Returns: result
update_model_access_by_id_api_v1_models_model_access_updC
Update Model Access By Id
Inputs: access_grants (required), id (required), name. Returns: result
update_model_by_id_api_v1_models_model_update_postD
Update Model By Id
Inputs: id (required), meta (required), name (required), params (required), +3 more. Returns: result
update_note_access_by_id_api_v1_notesC
Update Note Access By Id
Inputs: id (required), access_grants (required). Returns: result
update_note_by_id_api_v1_notesD
Update Note By Id
Inputs: id (required), title (required), access_grants, data, +1 more. Returns: result
update_password_api_v1_auths_update_password_postC
Update Password
Inputs: new_password (required), password (required). Returns: result
update_profile_api_v1_auths_update_profile_postD
Update Profile
Inputs: name (required), profile_image_url (required), bio, date_of_birth, +1 more. Returns: email, id, name, profile_image_url, +1 more
update_prompt_access_by_id_api_v1_prompts_idD
Update Prompt Access By Id
Inputs: prompt_id (required), access_grants (required). Returns: result
update_prompt_by_id_api_v1_prompts_idD
Update Prompt By Id
Inputs: prompt_id (required), command (required), content (required), name (required), +7 more. Returns: result
update_prompt_metadata_api_v1_prompts_idA
Update prompt name and command only (no history created).
Inputs: prompt_id (required), command (required), name (required), tags. Returns: result
update_rag_config_api_v1_retrieval_config_update_postD
Update Rag Config
Inputs: ALLOWED_FILE_EXTENSIONS, BYPASS_EMBEDDING_AND_RETRIEVAL, CHUNK_MIN_SIZE_TARGET, CHUNK_OVERLAP, +53 more.
update_skill_access_by_id_api_v1_skills_idC
Update Skill Access By Id
Inputs: id (required), access_grants (required). Returns: result
update_skill_by_id_api_v1_skills_idC
Update Skill By Id
Inputs: id__path (required), content (required), id (required), name (required), +4 more. Returns: result
update_task_config_api_v1_tasks_config_update_postC
Update Task Config
Inputs: AUTOCOMPLETE_GENERATION_INPUT_MAX_LENGTH (required), ENABLE_AUTOCOMPLETE_GENERATION (required), ENABLE_FOLLOW_UP_GENERATION (required), ENABLE_RETRIEVAL_QUERY_GENERATION (required), +12 more.
update_timezone_api_v1_auths_update_timezone_postC
Update Timezone
Inputs: timezone (required).
update_tool_access_by_id_api_v1_tools_idD
Update Tool Access By Id
Inputs: id (required), access_grants (required). Returns: result
update_tools_by_id_api_v1_tools_idD
Update Tools By Id
Inputs: id__path (required), content (required), id (required), meta (required), +2 more. Returns: result
update_tools_user_valves_by_id_api_v1_tools_idC
Update Tools User Valves By Id
Inputs: id (required), form_data (required). Returns: result
update_tools_valves_by_id_api_v1_tools_idC
Update Tools Valves By Id
Inputs: id (required), form_data (required). Returns: result
update_user_by_id_api_v1_usersD
Update User By Id
Inputs: user_id (required), email (required), name (required), profile_image_url (required), +2 more. Returns: result
update_user_info_by_session_user_api_v1_users_user_info_D
Update User Info By Session User
Inputs: form_data (required). Returns: result
update_user_settings_by_session_user_api_v1_users_user_sC
Update User Settings By Session User
Inputs: ui. Returns: ui
update_user_status_by_session_user_api_v1_users_user_staC
Update User Status By Session User
Inputs: status_emoji, status_expires_at, status_message.
upload_file_api_v1_filesD
Upload File
Inputs: file (required), process, process_in_background, metadata. Returns: created_at, data, filename, hash, +4 more
verify_tool_servers_config_api_v1_configs_tool_servers_vC
Verify the connection to the tool server.
Inputs: auth_type (required), config (required), key (required), path (required), +3 more.
verify_url_api_v1_images_config_url_verify_getD
Verify Url
Inputs: no named parameters.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 317 tools
Many tools have overlapping purposes, such as multiple 'Get Models' and 'Process Web' endpoints with indistinguishable descriptions. The vast number of similar tools makes it nearly impossible for an agent to consistently select the correct one.
While there is a general pattern of verb_noun_api_v1_resource_action, the naming is highly inconsistent: duplicate tool names, missing action suffixes, and extremely long names make it confusing. The pattern breaks down frequently.
At 317 tools, the count is far too high for a coherent surface. This suggests a lack of abstraction and many tools that could be combined or parameterized. It overwhelms any agent trying to use this server.
Despite the excessive count, the tools cover a wide range of Open WebUI functionality, including CRUD for many resources, authentication, file operations, and retrieval. However, there are some gaps (e.g., update missing for some resources) and redundant tools.
Maintenance
Related MCP Connectors
MCP server for OpenAI API (chat completions, image generation, embeddings) via AceDataCloud
An MCP server that provides an API to LLMs to manage their JumpCloud resources.
MCP server that lets AI assistants use all OneSchema features exposed via the public API.
MCP server exposing the Backtest360 engine API as tools for AI agents.
Related MCP Servers
- AlicenseBqualityBmaintenanceMCP server for OpenHAB v5+ that exposes the entire REST API as tools for AI models, enabling complete control over items, things, rules, persistence, and semantic model.257MIT
- AlicenseNot gradedqualityDmaintenanceMCP server that provides tools to interact with the LiteLLM proxy API, enabling LLM completions, embeddings, image generation, and admin operations.MIT
- FlicenseNot gradedqualityDmaintenanceA local MCP server exposing the OpenAI platform REST API as tools for file management, fine-tuning, inference, images, audio, batch processing, and organization usage/costs.-
- AlicenseAqualityBmaintenanceMCP server for the LiteLLM proxy, enabling agents to administer resources like keys, teams, users, models, and proxy settings through risk-graded meta-tools.6MIT