Skip to content

armgit / dify

Public Imported from GitHub
0

Build Agentic workflows, RAG pipelines, with rich AI model and tool support on one collaborative workspace. Deploy on cloud, VPC, or self-hosted, so teams move from prototype to production without rebuilding the stack.

refactor: reduce ambiguity in mcp queries (#42395)

Yunlu Wendbeebfc15d17
diff --git a/api/controllers/console/workspace/tool_providers.py b/api/controllers/console/workspace/tool_providers.py
index c35f2b88de8..34b89d5e767 100644
--- a/api/controllers/console/workspace/tool_providers.py
+++ b/api/controllers/console/workspace/tool_providers.py
@@ -1417,11 +1417,11 @@ class ToolProviderMCPApi(Resource):
# Update just-created provider with authed/tools in a new short transaction
with session_factory.create_session() as session, session.begin():
service = MCPToolManageService(session=session)
- db_provider = service.get_provider(provider_id=result.id, tenant_id=tenant_id)
+ db_provider = service.get_provider_by_id(provider_id=result.id, tenant_id=tenant_id)
db_provider.authed = reconnect.authed
db_provider.tools = reconnect.tools
- result = ToolTransformService.mcp_provider_to_user_provider(db_provider, for_list=True)
+ result = ToolTransformService.mcp_provider_to_user_provider(db_provider)
except Exception:
# Best-effort: if initial fetch fails (e.g., auth required), return created provider as-is
logger.warning("Failed to fetch MCP tools after creation", exc_info=True)
@@ -1462,7 +1462,7 @@ class ToolProviderMCPApi(Resource):
# Resolve "leave unchanged" (None) against the stored value, and gate
# the result on the Enterprise edition — both are API-layer concerns, so
# the service receives a concrete IdentityMode.
- existing = service.get_provider(provider_id=req_data.provider_id, tenant_id=current_tenant_id)
+ existing = service.get_provider_by_id(provider_id=req_data.provider_id, tenant_id=current_tenant_id)
identity_mode = _resolve_identity_mode(req_data.identity_mode, current=IdentityMode(existing.identity_mode))
service.update_provider(
tenant_id=current_tenant_id,
@@ -1513,7 +1513,7 @@ class ToolMCPAuthApi(Resource):
with sessionmaker(db.engine).begin() as session:
service = MCPToolManageService(session=session)
- db_provider = service.get_provider(provider_id=provider_id, tenant_id=tenant_id)
+ db_provider = service.get_provider_by_id(provider_id=provider_id, tenant_id=tenant_id)
if not db_provider:
raise ValueError("provider not found")
@@ -1587,10 +1587,8 @@ class ToolMCPDetailApi(Resource):
def get(self, tenant_id: str, provider_id: str):
with sessionmaker(db.engine).begin() as session:
service = MCPToolManageService(session=session)
- provider = service.get_provider(provider_id=provider_id, tenant_id=tenant_id)
- return _dump_tool_provider_payload(
- ToolTransformService.mcp_provider_to_user_provider(provider, for_list=True).to_dict()
- )
+ provider = service.get_provider_by_id(provider_id=provider_id, tenant_id=tenant_id)
+ return _dump_tool_provider_payload(ToolTransformService.mcp_provider_to_user_provider(provider).to_dict())
@console_ns.route("/workspaces/current/tools/mcp")
diff --git a/api/core/entities/mcp_provider.py b/api/core/entities/mcp_provider.py
index 026022db1fb..d28f93816cc 100644
--- a/api/core/entities/mcp_provider.py
+++ b/api/core/entities/mcp_provider.py
@@ -59,7 +59,7 @@ class MCPProviderEntity(BaseModel):
# Basic identification
id: str
- provider_id: str # server_identifier
+ server_identifier: str
name: str
tenant_id: str
user_id: str
@@ -91,7 +91,7 @@ class MCPProviderEntity(BaseModel):
return cls(
id=db_provider.id,
- provider_id=db_provider.server_identifier,
+ server_identifier=db_provider.server_identifier,
name=db_provider.name,
tenant_id=db_provider.tenant_id,
user_id=db_provider.user_id,
@@ -176,7 +176,7 @@ class MCPProviderEntity(BaseModel):
"type": ToolProviderType.MCP.value,
"is_team_authorization": self.authed,
"server_url": self.masked_server_url(),
- "server_identifier": self.provider_id,
+ "server_identifier": self.server_identifier,
"updated_at": int(self.updated_at.timestamp()),
"label": I18nObject(en_US=self.name, zh_Hans=self.name).to_dict(),
"description": I18nObject(en_US="", zh_Hans="").to_dict(),
diff --git a/api/core/mcp/auth_client.py b/api/core/mcp/auth_client.py
index ff9db2472cf..999c636c12b 100644
--- a/api/core/mcp/auth_client.py
+++ b/api/core/mcp/auth_client.py
@@ -39,7 +39,6 @@ class MCPClientWithAuthRetry(MCPClient):
sse_read_timeout: float | None = None,
provider_entity: MCPProviderEntity | None = None,
authorization_code: str | None = None,
- by_server_id: bool = False,
forward_identity_active: bool = False,
):
"""
@@ -52,7 +51,6 @@ class MCPClientWithAuthRetry(MCPClient):
sse_read_timeout: SSE read timeout
provider_entity: Provider entity for authentication
authorization_code: Optional authorization code for initial auth
- by_server_id: Whether to look up provider by server ID
forward_identity_active: If True, suppress the static-OAuth retry
on 401 — the forwarded identity must propagate as-is.
"""
@@ -60,7 +58,6 @@ class MCPClientWithAuthRetry(MCPClient):
self.provider_entity = provider_entity
self.authorization_code = authorization_code
- self.by_server_id = by_server_id
self.forward_identity_active = forward_identity_active
self._has_retried = False
@@ -105,8 +102,8 @@ class MCPClientWithAuthRetry(MCPClient):
)
# Retrieve new tokens
- self.provider_entity = mcp_service.get_provider_entity(
- self.provider_entity.id, self.provider_entity.tenant_id, by_server_id=self.by_server_id
+ self.provider_entity = mcp_service.get_provider_entity_by_server_identifier(
+ server_identifier=self.provider_entity.server_identifier, tenant_id=self.provider_entity.tenant_id
)
# Session is closed here, before we update headers
diff --git a/api/core/tools/mcp_tool/provider.py b/api/core/tools/mcp_tool/provider.py
index 86486121720..5a88f6643c3 100644
--- a/api/core/tools/mcp_tool/provider.py
+++ b/api/core/tools/mcp_tool/provider.py
@@ -22,7 +22,7 @@ class MCPToolProviderController(ToolProviderController[ToolProviderEntityWithPlu
def __init__(
self,
entity: ToolProviderEntityWithPlugin,
- provider_id: str,
+ server_identifier: str,
tenant_id: str,
server_url: str,
headers: dict[str, str] | None = None,
@@ -33,7 +33,7 @@ class MCPToolProviderController(ToolProviderController[ToolProviderEntityWithPlu
super().__init__(entity)
self.entity: ToolProviderEntityWithPlugin = entity
self.tenant_id = tenant_id
- self.provider_id = provider_id
+ self.server_identifier = server_identifier
self.server_url = server_url
self.headers = headers or {}
self.timeout = timeout
@@ -72,7 +72,7 @@ class MCPToolProviderController(ToolProviderController[ToolProviderEntityWithPlu
author="Anonymous", # Tool level author is not stored
name=remote_mcp_tool.name,
label=I18nObject(en_US=remote_mcp_tool.name, zh_Hans=remote_mcp_tool.name),
- provider=entity.provider_id,
+ provider=entity.server_identifier,
icon=entity.icon if isinstance(entity.icon, str) else "",
),
parameters=ToolTransformService.convert_mcp_schema_to_parameter(remote_mcp_tool.inputSchema),
@@ -102,7 +102,7 @@ class MCPToolProviderController(ToolProviderController[ToolProviderEntityWithPlu
credentials_schema=[],
tools=tools,
),
- provider_id=entity.provider_id,
+ server_identifier=entity.server_identifier,
tenant_id=entity.tenant_id,
server_url=entity.server_url,
headers=entity.headers,
@@ -135,7 +135,7 @@ class MCPToolProviderController(ToolProviderController[ToolProviderEntityWithPlu
tenant_id=self.tenant_id,
icon=self.entity.identity.icon,
server_url=self.server_url,
- provider_id=self.provider_id,
+ server_identifier=self.server_identifier,
headers=self.headers,
timeout=self.timeout,
sse_read_timeout=self.sse_read_timeout,
@@ -153,7 +153,7 @@ class MCPToolProviderController(ToolProviderController[ToolProviderEntityWithPlu
tenant_id=self.tenant_id,
icon=self.entity.identity.icon,
server_url=self.server_url,
- provider_id=self.provider_id,
+ server_identifier=self.server_identifier,
headers=self.headers,
timeout=self.timeout,
sse_read_timeout=self.sse_read_timeout,
diff --git a/api/core/tools/mcp_tool/tool.py b/api/core/tools/mcp_tool/tool.py
index 899ffe56e6b..84235403d61 100644
--- a/api/core/tools/mcp_tool/tool.py
+++ b/api/core/tools/mcp_tool/tool.py
@@ -44,7 +44,7 @@ class MCPTool(Tool):
tenant_id: str,
icon: str,
server_url: str,
- provider_id: str,
+ server_identifier: str,
headers: dict[str, str] | None = None,
timeout: float | None = None,
sse_read_timeout: float | None = None,
@@ -54,7 +54,7 @@ class MCPTool(Tool):
self.tenant_id = tenant_id
self.icon = icon
self.server_url = server_url
- self.provider_id = provider_id
+ self.server_identifier = server_identifier
self.headers = headers or {}
self.timeout = timeout
self.sse_read_timeout = sse_read_timeout
@@ -250,7 +250,7 @@ class MCPTool(Tool):
tenant_id=self.tenant_id,
icon=self.icon,
server_url=self.server_url,
- provider_id=self.provider_id,
+ server_identifier=self.server_identifier,
headers=self.headers,
timeout=self.timeout,
sse_read_timeout=self.sse_read_timeout,
@@ -299,7 +299,9 @@ class MCPTool(Tool):
# This minimizes database connection hold time
with Session(db.engine, expire_on_commit=False) as session:
mcp_service = MCPToolManageService(session=session)
- provider_entity = mcp_service.get_provider_entity(self.provider_id, self.tenant_id, by_server_id=True)
+ provider_entity = mcp_service.get_provider_entity_by_server_identifier(
+ server_identifier=self.server_identifier, tenant_id=self.tenant_id
+ )
# Decrypt and prepare all credentials before closing session
server_url = provider_entity.decrypt_server_url()
diff --git a/api/core/tools/tool_manager.py b/api/core/tools/tool_manager.py
index f3c61630a08..e928386e502 100644
--- a/api/core/tools/tool_manager.py
+++ b/api/core/tools/tool_manager.py
@@ -819,7 +819,7 @@ class ToolManager:
if "mcp" in filters:
mcp_service = MCPToolManageService(session=session)
- mcp_providers = mcp_service.list_providers(tenant_id=tenant_id, for_list=True)
+ mcp_providers = mcp_service.list_providers(tenant_id=tenant_id)
for mcp_provider in mcp_providers:
result_providers[f"mcp_provider.{mcp_provider.name}"] = mcp_provider
@@ -871,14 +871,18 @@ class ToolManager:
get the api provider
:param tenant_id: the id of the tenant
- :param provider_id: the id of the provider
+ :param provider_id: the persisted reference of the provider, normally its
+ server identifier, or the primary key for graphs written before that
+ convention
:return: the provider controller, the credentials
"""
with Session(db.engine) as session:
mcp_service = MCPToolManageService(session=session)
try:
- provider = mcp_service.get_provider(server_identifier=provider_id, tenant_id=tenant_id)
+ provider = mcp_service.get_provider_by_persisted_reference(
+ id_or_server_identifier=provider_id, tenant_id=tenant_id
+ )
except ValueError:
raise ToolProviderNotFoundError(f"mcp provider {provider_id} not found")
@@ -1028,8 +1032,8 @@ class ToolManager:
with Session(db.engine) as session:
mcp_service = MCPToolManageService(session=session)
try:
- mcp_provider = mcp_service.get_provider_entity(
- provider_id=provider_id, tenant_id=tenant_id, by_server_id=True
+ mcp_provider = mcp_service.get_provider_entity_by_persisted_reference(
+ id_or_server_identifier=provider_id, tenant_id=tenant_id
)
return cast(EmojiIconDict | str, mcp_provider.provider_icon)
except ValueError:
diff --git a/api/core/workflow/nodes/agent_v2/dify_tools_builder.py b/api/core/workflow/nodes/agent_v2/dify_tools_builder.py
index 31896bf3f8b..95274618d34 100644
--- a/api/core/workflow/nodes/agent_v2/dify_tools_builder.py
+++ b/api/core/workflow/nodes/agent_v2/dify_tools_builder.py
@@ -138,15 +138,14 @@ def _list_provider_tool_names(
def _resolve_mcp_provider_id(*, tenant_id: str, provider_id: str) -> str:
- """Normalize MCP provider ids to the runtime-facing server identifier."""
+ """Normalize a persisted MCP provider reference to the runtime-facing server identifier."""
service = MCPToolManageService(session=db.session())
try:
- return service.get_provider_entity(provider_id, tenant_id, by_server_id=True).provider_id
- except ValueError:
- try:
- return service.get_provider_entity(provider_id, tenant_id, by_server_id=False).provider_id
- except ValueError as exc:
- raise ToolProviderNotFoundError(f"mcp provider {provider_id} not found") from exc
+ return service.get_provider_entity_by_persisted_reference(
+ id_or_server_identifier=provider_id, tenant_id=tenant_id
+ ).server_identifier
+ except ValueError as exc:
+ raise ToolProviderNotFoundError(f"mcp provider {provider_id} not found") from exc
class WorkflowAgentDifyToolsBuilder:
diff --git a/api/services/data_migration/export_service.py b/api/services/data_migration/export_service.py
index c0233006690..4afb15b51f4 100644
--- a/api/services/data_migration/export_service.py
+++ b/api/services/data_migration/export_service.py
@@ -2,7 +2,6 @@ from __future__ import annotations
from collections.abc import Iterable
from typing import Any
-from uuid import UUID
import sqlalchemy as sa
import yaml
@@ -27,6 +26,7 @@ from services.data_migration.entities import (
ResourceType,
)
from services.data_migration.package_service import MigrationPackageService
+from services.tools.mcp_tools_manage_service import MCPToolManageService
from services.tools.workflow_tools_manage_service import WorkflowToolManageService
SUPPORTED_APP_MODES = {"workflow", "advanced-chat"}
@@ -370,22 +370,12 @@ class MigrationExportService:
)
def _get_mcp_provider(self, tenant_id: str, provider_id: str, *, session: Session) -> MCPToolProvider:
- predicates = [MCPToolProvider.server_identifier == provider_id]
- if self._is_uuid_string(provider_id):
- predicates.append(MCPToolProvider.id == provider_id)
- provider = session.scalar(
- sa.select(MCPToolProvider).where(MCPToolProvider.tenant_id == tenant_id, sa.or_(*predicates))
- )
- if provider is None:
- raise MigrationDataError(f"MCP provider not found: {provider_id}")
- return provider
-
- def _is_uuid_string(self, value: str) -> bool:
try:
- UUID(value)
- except ValueError:
- return False
- return True
+ return MCPToolManageService(session=session).get_provider_by_persisted_reference(
+ id_or_server_identifier=provider_id, tenant_id=tenant_id
+ )
+ except ValueError as exc:
+ raise MigrationDataError(f"MCP provider not found: {provider_id}") from exc
def _serialize_mcp_provider(self, provider: MCPToolProvider) -> dict[str, Any]:
provider_entity = provider.to_entity()
diff --git a/api/services/tools/mcp_tools_manage_service.py b/api/services/tools/mcp_tools_manage_service.py
index b49ad93904b..75ce176a96c 100644
--- a/api/services/tools/mcp_tools_manage_service.py
+++ b/api/services/tools/mcp_tools_manage_service.py
@@ -1,6 +1,7 @@
import hashlib
import json
import logging
+import uuid
from collections.abc import Mapping
from datetime import datetime
from enum import StrEnum
@@ -8,7 +9,7 @@ from typing import Any
from urllib.parse import urlparse
from pydantic import BaseModel, Field
-from sqlalchemy import or_, select
+from sqlalchemy import Select, or_, select
from sqlalchemy.exc import IntegrityError
from sqlalchemy.orm import Session
@@ -83,15 +84,35 @@ class MCPToolManageService:
# ========== Provider CRUD Operations ==========
- def get_provider(
- self, *, provider_id: str | None = None, server_identifier: str | None = None, tenant_id: str
- ) -> MCPToolProvider:
+ def get_provider_by_id(self, *, provider_id: str, tenant_id: str) -> MCPToolProvider:
"""
- Get MCP provider by ID or server identifier.
+ Get MCP provider by its primary key.
Args:
- provider_id: Provider ID (UUID)
- server_identifier: Server identifier
+ provider_id: Provider primary key (UUID). Server identifiers are not
+ accepted here — use get_provider_by_server_identifier instead.
+ tenant_id: Tenant ID
+
+ Returns:
+ MCPToolProvider instance
+
+ Raises:
+ ValueError: If provider_id is not a UUID, or the provider does not exist
+ """
+ try:
+ uuid.UUID(provider_id)
+ except (AttributeError, TypeError, ValueError):
+ raise ValueError("expected a valid UUID, but got: " + provider_id)
+
+ stmt = select(MCPToolProvider).where(MCPToolProvider.tenant_id == tenant_id, MCPToolProvider.id == provider_id)
+ return self._scalar_one_provider(stmt)
+
+ def get_provider_by_server_identifier(self, *, server_identifier: str, tenant_id: str) -> MCPToolProvider:
+ """
+ Get MCP provider by its tenant-scoped server identifier.
+
+ Args:
+ server_identifier: Server identifier (the runtime-facing reference)
tenant_id: Tenant ID
Returns:
@@ -100,27 +121,66 @@ class MCPToolManageService:
Raises:
ValueError: If provider not found
"""
- if server_identifier:
- stmt = select(MCPToolProvider).where(
- MCPToolProvider.tenant_id == tenant_id, MCPToolProvider.server_identifier == server_identifier
- )
- else:
- stmt = select(MCPToolProvider).where(
- MCPToolProvider.tenant_id == tenant_id, MCPToolProvider.id == provider_id
- )
+ stmt = select(MCPToolProvider).where(
+ MCPToolProvider.tenant_id == tenant_id, MCPToolProvider.server_identifier == server_identifier
+ )
+ return self._scalar_one_provider(stmt)
+ def _scalar_one_provider(self, stmt: Select[tuple[MCPToolProvider]]) -> MCPToolProvider:
provider = self._session.scalar(stmt)
if not provider:
raise ValueError("MCP tool not found")
return provider
- def get_provider_entity(self, provider_id: str, tenant_id: str, by_server_id: bool = False) -> MCPProviderEntity:
- """Get provider entity by ID or server identifier."""
- if by_server_id:
- db_provider = self.get_provider(server_identifier=provider_id, tenant_id=tenant_id)
- else:
- db_provider = self.get_provider(provider_id=provider_id, tenant_id=tenant_id)
- return db_provider.to_entity()
+ def get_provider_entity_by_id(self, *, provider_id: str, tenant_id: str) -> MCPProviderEntity:
+ """Get provider entity by primary key."""
+ return self.get_provider_by_id(provider_id=provider_id, tenant_id=tenant_id).to_entity()
+
+ def get_provider_entity_by_server_identifier(self, *, server_identifier: str, tenant_id: str) -> MCPProviderEntity:
+ """Get provider entity by server identifier."""
+ return self.get_provider_by_server_identifier(
+ server_identifier=server_identifier, tenant_id=tenant_id
+ ).to_entity()
+
+ def get_provider_by_persisted_reference(self, *, id_or_server_identifier: str, tenant_id: str) -> MCPToolProvider:
+ """
+ Resolve an MCP provider from a reference persisted in a graph or agent config.
+
+ For backward compatibility. Previously, the id returned by the
+ server is non-deterministic, depending on the query parameter,
+ so we accept both primary key (id) and server identifier for any existing DSLs
+
+ Raises:
+ ValueError: If no provider matches the reference
+ """
+ try:
+ uuid.UUID(id_or_server_identifier)
+ except (AttributeError, TypeError, ValueError):
+ # Not uuid-shaped, so it can only ever be a server identifier. Skipping
+ # the primary-key lookup also keeps its "expected a valid UUID" error,
+ # which would misdescribe a legitimate reference, out of this path.
+ return self.get_provider_by_server_identifier(
+ server_identifier=id_or_server_identifier, tenant_id=tenant_id
+ )
+
+ try:
+ return self.get_provider_by_id(provider_id=id_or_server_identifier, tenant_id=tenant_id)
+ except ValueError:
+ # A server identifier is free text, so it may itself look like a uuid.
+ return self.get_provider_by_server_identifier(
+ server_identifier=id_or_server_identifier, tenant_id=tenant_id
+ )
+
+ def get_provider_entity_by_persisted_reference(
+ self, *, id_or_server_identifier: str, tenant_id: str
+ ) -> MCPProviderEntity:
+ """Resolve a provider entity from a persisted graph or agent config reference.
+
+ Accepts both meanings — see get_provider_by_persisted_reference.
+ """
+ return self.get_provider_by_persisted_reference(
+ id_or_server_identifier=id_or_server_identifier, tenant_id=tenant_id
+ ).to_entity()
def create_provider(
self,
@@ -178,7 +238,7 @@ class MCPToolManageService:
self._session.add(mcp_tool)
self._session.flush()
- mcp_providers = ToolTransformService.mcp_provider_to_user_provider(mcp_tool, for_list=True)
+ mcp_providers = ToolTransformService.mcp_provider_to_user_provider(mcp_tool)
return mcp_providers
def update_provider(
@@ -206,7 +266,7 @@ class MCPToolManageService:
If provided and contains reconnect_result, it will be used
instead of performing network operations.
"""
- mcp_provider = self.get_provider(provider_id=provider_id, tenant_id=tenant_id)
+ mcp_provider = self.get_provider_by_id(provider_id=provider_id, tenant_id=tenant_id)
# Check for duplicate name (excluding current provider)
if name != mcp_provider.name:
@@ -271,17 +331,14 @@ class MCPToolManageService:
def delete_provider(self, *, tenant_id: str, provider_id: str) -> None:
"""Delete an MCP provider."""
- mcp_tool = self.get_provider(provider_id=provider_id, tenant_id=tenant_id)
+ mcp_tool = self.get_provider_by_id(provider_id=provider_id, tenant_id=tenant_id)
self._session.delete(mcp_tool)
- def list_providers(
- self, *, tenant_id: str, for_list: bool = False, include_sensitive: bool = True
- ) -> list[ToolProviderApiEntity]:
+ def list_providers(self, *, tenant_id: str, include_sensitive: bool = True) -> list[ToolProviderApiEntity]:
"""List all MCP providers for a tenant.
Args:
tenant_id: Tenant ID
- for_list: If True, return provider ID; if False, return server identifier
include_sensitive: If False, skip expensive decryption operations (default: True for backward compatibility)
"""
from models.account import Account
@@ -300,7 +357,6 @@ class MCPToolManageService:
return [
ToolTransformService.mcp_provider_to_user_provider(
provider,
- for_list=for_list,
user_name=user_name_map.get(provider.user_id),
include_sensitive=include_sensitive,
)
@@ -312,7 +368,7 @@ class MCPToolManageService:
def list_provider_tools(self, *, tenant_id: str, provider_id: str) -> ToolProviderApiEntity:
"""List tools from remote MCP server."""
# Load provider and convert to entity
- db_provider = self.get_provider(provider_id=provider_id, tenant_id=tenant_id)
+ db_provider = self.get_provider_by_id(provider_id=provider_id, tenant_id=tenant_id)
provider_entity = db_provider.to_entity()
# Verify authentication
@@ -361,7 +417,7 @@ class MCPToolManageService:
from core.tools.mcp_tool.provider import MCPToolProviderController
# Get provider from current session
- provider = self.get_provider(provider_id=provider_id, tenant_id=tenant_id)
+ provider = self.get_provider_by_id(provider_id=provider_id, tenant_id=tenant_id)
# Encrypt new credentials
provider_controller = MCPToolProviderController.from_db(provider)
@@ -413,7 +469,7 @@ class MCPToolManageService:
tenant_id: Tenant ID
"""
# Get provider from current session
- provider = self.get_provider(provider_id=provider_id, tenant_id=tenant_id)
+ provider = self.get_provider_by_id(provider_id=provider_id, tenant_id=tenant_id)
provider.tools = EMPTY_TOOLS_JSON
provider.encrypted_credentials = EMPTY_CREDENTIALS_JSON
@@ -568,7 +624,7 @@ class MCPToolManageService:
Returns:
ProviderUrlValidationData: Data needed for standalone URL validation
"""
- provider = self.get_provider(provider_id=provider_id, tenant_id=tenant_id)
+ provider = self.get_provider_by_id(provider_id=provider_id, tenant_id=tenant_id)
provider_entity = provider.to_entity()
return ProviderUrlValidationData(
current_server_url_hash=provider.server_url_hash,
@@ -698,7 +754,7 @@ class MCPToolManageService:
user_name=user_name,
)
response["tools"] = ToolTransformService.mcp_tool_to_user_tool(db_provider, tools, user_name=user_name)
- response["plugin_unique_identifier"] = provider_entity.provider_id
+ response["plugin_unique_identifier"] = provider_entity.server_identifier
return ToolProviderApiEntity(**response)
def _handle_integrity_error(
diff --git a/api/services/tools/tools_transform_service.py b/api/services/tools/tools_transform_service.py
index 807c4482ada..33d72e9009c 100644
--- a/api/services/tools/tools_transform_service.py
+++ b/api/services/tools/tools_transform_service.py
@@ -246,7 +246,6 @@ class ToolTransformService:
@staticmethod
def mcp_provider_to_user_provider(
db_provider: MCPToolProvider,
- for_list: bool = False,
user_name: str | None = None,
include_sensitive: bool = True,
) -> ToolProviderApiEntity:
@@ -266,7 +265,7 @@ class ToolTransformService:
except (ValidationError, ValueError):
mcp_tools = []
# Add additional fields specific to the transform
- response["id"] = db_provider.server_identifier if not for_list else db_provider.id
+ response["id"] = db_provider.id
response["tools"] = ToolTransformService.mcp_tool_to_user_tool(db_provider, mcp_tools, user_name=user_name)
response["server_identifier"] = db_provider.server_identifier
diff --git a/api/tests/test_containers_integration_tests/services/tools/test_mcp_tools_manage_service.py b/api/tests/test_containers_integration_tests/services/tools/test_mcp_tools_manage_service.py
index 0f2e3980afe..ca44c5b72d5 100644
--- a/api/tests/test_containers_integration_tests/services/tools/test_mcp_tools_manage_service.py
+++ b/api/tests/test_containers_integration_tests/services/tools/test_mcp_tools_manage_service.py
@@ -152,7 +152,7 @@ class TestMCPToolManageService:
# Act: Execute the method under test
service = MCPToolManageService(db_session_with_containers)
- result = service.get_provider(provider_id=mcp_provider.id, tenant_id=tenant.id)
+ result = service.get_provider_by_id(provider_id=mcp_provider.id, tenant_id=tenant.id)
# Assert: Verify the expected outcomes
assert result is not None
@@ -189,7 +189,7 @@ class TestMCPToolManageService:
service = MCPToolManageService(db_session_with_containers)
with pytest.raises(ValueError, match="MCP tool not found"):
- service.get_provider(provider_id=non_existent_id, tenant_id=tenant.id)
+ service.get_provider_by_id(provider_id=non_existent_id, tenant_id=tenant.id)
def test_get_mcp_provider_by_provider_id_tenant_isolation(
self, db_session_with_containers: Session, mock_external_service_dependencies
@@ -221,7 +221,7 @@ class TestMCPToolManageService:
service = MCPToolManageService(db_session_with_containers)
with pytest.raises(ValueError, match="MCP tool not found"):
- service.get_provider(provider_id=mcp_provider1.id, tenant_id=tenant2.id)
+ service.get_provider_by_id(provider_id=mcp_provider1.id, tenant_id=tenant2.id)
def test_get_mcp_provider_by_server_identifier_success(
self, db_session_with_containers: Session, mock_external_service_dependencies
@@ -247,7 +247,9 @@ class TestMCPToolManageService:
# Act: Execute the method under test
service = MCPToolManageService(db_session_with_containers)
- result = service.get_provider(server_identifier=mcp_provider.server_identifier, tenant_id=tenant.id)
+ result = service.get_provider_by_server_identifier(
+ server_identifier=mcp_provider.server_identifier, tenant_id=tenant.id
+ )
# Assert: Verify the expected outcomes
assert result is not None
@@ -284,7 +286,7 @@ class TestMCPToolManageService:
service = MCPToolManageService(db_session_with_containers)
with pytest.raises(ValueError, match="MCP tool not found"):
- service.get_provider(server_identifier=non_existent_identifier, tenant_id=tenant.id)
+ service.get_provider_by_server_identifier(server_identifier=non_existent_identifier, tenant_id=tenant.id)
def test_get_mcp_provider_by_server_identifier_tenant_isolation(
self, db_session_with_containers: Session, mock_external_service_dependencies
@@ -316,7 +318,9 @@ class TestMCPToolManageService:
service = MCPToolManageService(db_session_with_containers)
with pytest.raises(ValueError, match="MCP tool not found"):
- service.get_provider(server_identifier=mcp_provider1.server_identifier, tenant_id=tenant2.id)
+ service.get_provider_by_server_identifier(
+ server_identifier=mcp_provider1.server_identifier, tenant_id=tenant2.id
+ )
def test_create_mcp_provider_success(self, db_session_with_containers: Session, mock_external_service_dependencies):
"""
@@ -635,7 +639,7 @@ class TestMCPToolManageService:
# Act: Execute the method under test
service = MCPToolManageService(db_session_with_containers)
- result = service.list_providers(tenant_id=tenant.id, for_list=True)
+ result = service.list_providers(tenant_id=tenant.id)
# Assert: Verify the expected outcomes
assert result is not None
@@ -673,7 +677,7 @@ class TestMCPToolManageService:
# Act: Execute the method under test
service = MCPToolManageService(db_session_with_containers)
- result = service.list_providers(tenant_id=tenant.id, for_list=False)
+ result = service.list_providers(tenant_id=tenant.id)
# Assert: Verify the expected outcomes
assert result is not None
@@ -746,8 +750,8 @@ class TestMCPToolManageService:
# Act: Execute the method under test for both tenants
service = MCPToolManageService(db_session_with_containers)
- result1 = service.list_providers(tenant_id=tenant1.id, for_list=True)
- result2 = service.list_providers(tenant_id=tenant2.id, for_list=True)
+ result1 = service.list_providers(tenant_id=tenant1.id)
+ result2 = service.list_providers(tenant_id=tenant2.id)
# Assert: Verify tenant isolation
assert len(result1) == 1
diff --git a/api/tests/unit_tests/core/entities/test_entities_mcp_provider.py b/api/tests/unit_tests/core/entities/test_entities_mcp_provider.py
index cc48adfb5b0..f7a4ac7e37e 100644
--- a/api/tests/unit_tests/core/entities/test_entities_mcp_provider.py
+++ b/api/tests/unit_tests/core/entities/test_entities_mcp_provider.py
@@ -16,7 +16,7 @@ def _build_mcp_provider_entity() -> MCPProviderEntity:
now = datetime(2025, 1, 1, tzinfo=UTC)
return MCPProviderEntity(
id="provider-1",
- provider_id="server-1",
+ server_identifier="server-1",
name="Example MCP",
tenant_id="tenant-1",
user_id="user-1",
@@ -60,7 +60,7 @@ def test_from_db_model_maps_fields() -> None:
entity = MCPProviderEntity.from_db_model(db_provider)
# Assert
- assert entity.provider_id == "server-1"
+ assert entity.server_identifier == "server-1"
assert entity.tools == [{"name": "search"}]
assert entity.icon == ""
diff --git a/api/tests/unit_tests/core/mcp/test_mcp_client.py b/api/tests/unit_tests/core/mcp/test_mcp_client.py
index 4f9c9291d00..fa8bc7979da 100644
--- a/api/tests/unit_tests/core/mcp/test_mcp_client.py
+++ b/api/tests/unit_tests/core/mcp/test_mcp_client.py
@@ -494,6 +494,7 @@ class TestMCPClientWithAuthRetry:
def mock_provider(self):
provider = MagicMock(spec=MCPProviderEntity)
provider.id = "test-provider-id"
+ provider.server_identifier = "test-server-identifier"
provider.tenant_id = "test-tenant-id"
provider.retrieve_tokens.return_value = OAuthTokens(
access_token="new-token",
@@ -510,7 +511,6 @@ class TestMCPClientWithAuthRetry:
headers={"Authorization": "Bearer old-token"},
provider_entity=mock_provider,
authorization_code="test-code",
- by_server_id=True,
)
return client
@@ -522,7 +522,6 @@ class TestMCPClientWithAuthRetry:
timeout=30.0,
provider_entity=mock_provider,
authorization_code="initial-code",
- by_server_id=True,
)
assert client.server_url == "http://test.example.com"
@@ -530,7 +529,6 @@ class TestMCPClientWithAuthRetry:
assert client.timeout == 30.0
assert client.provider_entity == mock_provider
assert client.authorization_code == "initial-code"
- assert client.by_server_id is True
assert client._has_retried is False
@patch("core.mcp.auth_client.db")
@@ -550,7 +548,7 @@ class TestMCPClientWithAuthRetry:
expires_in=3600,
refresh_token="new-refresh-token",
)
- mock_service.get_provider_entity.return_value = new_provider
+ mock_service.get_provider_entity_by_server_identifier.return_value = new_provider
# MCPAuthError parses resource_metadata and scope from www_authenticate_header
www_auth = 'Bearer resource_metadata="http://meta", scope="read"'
@@ -565,8 +563,8 @@ class TestMCPClientWithAuthRetry:
resource_metadata_url="http://meta",
scope_hint="read",
)
- mock_service.get_provider_entity.assert_called_once_with(
- mock_provider.id, mock_provider.tenant_id, by_server_id=True
+ mock_service.get_provider_entity_by_server_identifier.assert_called_once_with(
+ server_identifier=mock_provider.server_identifier, tenant_id=mock_provider.tenant_id
)
# Verify client updates
@@ -607,7 +605,7 @@ class TestMCPClientWithAuthRetry:
new_provider = MagicMock(spec=MCPProviderEntity)
new_provider.retrieve_tokens.return_value = None
- mock_service.get_provider_entity.return_value = new_provider
+ mock_service.get_provider_entity_by_server_identifier.return_value = new_provider
error = MCPAuthError("Auth failed")
diff --git a/api/tests/unit_tests/core/tools/test_mcp_tool.py b/api/tests/unit_tests/core/tools/test_mcp_tool.py
index d5a8be5e58d..2944c378a43 100644
--- a/api/tests/unit_tests/core/tools/test_mcp_tool.py
+++ b/api/tests/unit_tests/core/tools/test_mcp_tool.py
@@ -42,7 +42,7 @@ def _build_mcp_tool(*, with_output_schema: bool = True) -> MCPTool:
tenant_id="tenant-1",
icon="icon.svg",
server_url="https://mcp.example.com",
- provider_id="provider-id",
+ server_identifier="mcp_server",
headers={"x-auth": "token"},
)
@@ -54,7 +54,7 @@ def test_mcp_tool_provider_type_and_fork_runtime():
forked = tool.fork_tool_runtime(ToolRuntime(tenant_id="tenant-2"))
assert isinstance(forked, MCPTool)
assert forked.runtime.tenant_id == "tenant-2"
- assert forked.provider_id == "provider-id"
+ assert forked.server_identifier == "mcp_server"
def test_mcp_tool_text_and_json_processing_helpers():
@@ -177,7 +177,7 @@ def _build_forwarding_tool(*, mode: str = "idp_token") -> MCPTool:
tenant_id="tenant-1",
icon="icon.svg",
server_url="https://mcp.example.com/mcp/",
- provider_id="provider-id",
+ server_identifier="mcp_server",
identity_mode=mode,
)
diff --git a/api/tests/unit_tests/core/tools/test_mcp_tool_provider.py b/api/tests/unit_tests/core/tools/test_mcp_tool_provider.py
index 1060d19ab14..4707c25ce6d 100644
--- a/api/tests/unit_tests/core/tools/test_mcp_tool_provider.py
+++ b/api/tests/unit_tests/core/tools/test_mcp_tool_provider.py
@@ -15,7 +15,7 @@ def _build_mcp_entity(*, icon: str = "icon.svg") -> MCPProviderEntity:
now = datetime.now()
return MCPProviderEntity(
id="db-id",
- provider_id="provider-id",
+ server_identifier="mcp_server",
name="MCP Provider",
tenant_id="tenant-1",
user_id="user-1",
@@ -48,6 +48,8 @@ def test_mcp_tool_provider_controller_from_entity_and_get_tools():
tool = controller.get_tool("remote-tool")
assert isinstance(tool, MCPTool)
assert tool.tenant_id == "tenant-1"
+ # The runtime reference is the server identifier, never the primary key.
+ assert tool.server_identifier == "mcp_server"
tools = controller.get_tools()
assert len(tools) == 1
diff --git a/api/tests/unit_tests/core/tools/test_tool_manager.py b/api/tests/unit_tests/core/tools/test_tool_manager.py
index a2e4e2f1526..515a9d2dacc 100644
--- a/api/tests/unit_tests/core/tools/test_tool_manager.py
+++ b/api/tests/unit_tests/core/tools/test_tool_manager.py
@@ -1043,7 +1043,7 @@ def test_get_mcp_provider_controller_returns_controller(monkeypatch: pytest.Monk
monkeypatch.setattr("core.tools.tool_manager.db", tool_database)
with patch("core.tools.tool_manager.MCPToolManageService") as mock_service_cls:
mock_service = mock_service_cls.return_value
- mock_service.get_provider.return_value = provider_entity
+ mock_service.get_provider_by_persisted_reference.return_value = provider_entity
with patch("core.tools.tool_manager.MCPToolProviderController.from_db", return_value=controller):
built = ToolManager.get_mcp_provider_controller("tenant-1", "mcp-1")
assert built is controller
@@ -1057,7 +1057,7 @@ def test_generate_mcp_tool_icon_url_returns_provider_icon(
monkeypatch.setattr("core.tools.tool_manager.db", tool_database)
with patch("core.tools.tool_manager.MCPToolManageService") as mock_service_cls:
mock_service = mock_service_cls.return_value
- mock_service.get_provider_entity.return_value = provider_entity
+ mock_service.get_provider_entity_by_persisted_reference.return_value = provider_entity
assert ToolManager.generate_mcp_tool_icon_url("tenant-1", "mcp-1") == provider_entity.provider_icon
assert isinstance(mock_service_cls.call_args.kwargs["session"], Session)
@@ -1065,7 +1065,7 @@ def test_generate_mcp_tool_icon_url_returns_provider_icon(
def test_get_mcp_provider_controller_missing_raises(monkeypatch: pytest.MonkeyPatch, tool_database: _ToolDatabase):
monkeypatch.setattr("core.tools.tool_manager.db", tool_database)
with patch("core.tools.tool_manager.MCPToolManageService") as mock_service_cls:
- mock_service_cls.return_value.get_provider.side_effect = ValueError("missing")
+ mock_service_cls.return_value.get_provider_by_persisted_reference.side_effect = ValueError("missing")
with pytest.raises(ToolProviderNotFoundError, match="mcp provider mcp-1 not found"):
ToolManager.get_mcp_provider_controller("tenant-1", "mcp-1")
diff --git a/api/tests/unit_tests/services/tools/test_mcp_tools_manage_service_lookup.py b/api/tests/unit_tests/services/tools/test_mcp_tools_manage_service_lookup.py
new file mode 100644
index 00000000000..ef073a6bda5
--- /dev/null
+++ b/api/tests/unit_tests/services/tools/test_mcp_tools_manage_service_lookup.py
@@ -0,0 +1,141 @@
+"""Test cases for MCP provider lookups.
+
+The two lookups are deliberately separate: `provider_id` always means the
+primary key and `server_identifier` always means the tenant-scoped identifier,
+so a value can never silently resolve through the wrong column.
+"""
+
+from unittest.mock import Mock
+
+import pytest
+
+from models.tools import MCPToolProvider
+from services.tools.mcp_tools_manage_service import MCPToolManageService
+
+PROVIDER_UUID = "0b2bd1e4-3a7d-4a0b-9f2a-9b2d6f3c1e55"
+SERVER_IDENTIFIER = "monday_mcp"
+TENANT_ID = "3f0a1c4e-1f3d-4a4e-9a1f-2a6f8c5d0b11"
+
+
+def _provider() -> MCPToolProvider:
+ return MCPToolProvider(
+ name="Monday",
+ server_identifier=SERVER_IDENTIFIER,
+ server_url="https://example.com/mcp",
+ server_url_hash="hash",
+ icon="icon",
+ tenant_id=TENANT_ID,
+ user_id="user-id",
+ )
+
+
+def session() -> Mock:
+ return Mock()
+
+
+def service(session: Mock) -> MCPToolManageService:
+ return MCPToolManageService(session=session)
+
+
+def test_get_provider_by_id_queries_primary_key(service: MCPToolManageService, session: Mock) -> None:
+ provider = _provider()
+ session.scalar.return_value = provider
+
+ assert service.get_provider_by_id(provider_id=PROVIDER_UUID, tenant_id=TENANT_ID) is provider
+
+ where = str(session.scalar.call_args.args[0].whereclause)
+ assert "tool_mcp_providers.id = " in where
+ assert "server_identifier" not in where
+
+
+def test_get_provider_by_id_rejects_server_identifier(service: MCPToolManageService, session: Mock) -> None:
+ """A server identifier in the provider_id slot must not reach the uuid column."""
+ with pytest.raises(ValueError, match="expected a valid UUID"):
+ service.get_provider_by_id(provider_id=SERVER_IDENTIFIER, tenant_id=TENANT_ID)
+
+ session.scalar.assert_not_called()
+
+
+def test_get_provider_by_id_not_found(service: MCPToolManageService, session: Mock) -> None:
+ session.scalar.return_value = None
+
+ with pytest.raises(ValueError, match="MCP tool not found"):
+ service.get_provider_by_id(provider_id=PROVIDER_UUID, tenant_id=TENANT_ID)
+
+
+def test_get_provider_by_server_identifier_queries_identifier(service: MCPToolManageService, session: Mock) -> None:
+ provider = _provider()
+ session.scalar.return_value = provider
+
+ result = service.get_provider_by_server_identifier(server_identifier=SERVER_IDENTIFIER, tenant_id=TENANT_ID)
+
+ assert result is provider
+ assert "tool_mcp_providers.server_identifier = " in str(session.scalar.call_args.args[0].whereclause)
+
+
+def test_get_provider_by_server_identifier_not_found(service: MCPToolManageService, session: Mock) -> None:
+ session.scalar.return_value = None
+
+ with pytest.raises(ValueError, match="MCP tool not found"):
+ service.get_provider_by_server_identifier(server_identifier=SERVER_IDENTIFIER, tenant_id=TENANT_ID)
+
+
+def test_persisted_reference_non_uuid_queries_identifier_only(service: MCPToolManageService, session: Mock) -> None:
+ provider = _provider()
+ session.scalar.return_value = provider
+
+ assert (
+ service.get_provider_by_persisted_reference(id_or_server_identifier=SERVER_IDENTIFIER, tenant_id=TENANT_ID)
+ is provider
+ )
+
+ # A non-uuid reference can only be a server identifier, so the primary-key
+ # lookup is never attempted.
+ assert session.scalar.call_count == 1
+ assert "tool_mcp_providers.server_identifier = " in str(session.scalar.call_args.args[0].whereclause)
+
+
+def test_persisted_reference_uuid_prefers_primary_key(service: MCPToolManageService, session: Mock) -> None:
+ """Graphs written before the server-identifier convention still carry the primary key."""
+ provider = _provider()
+ session.scalar.return_value = provider
+
+ assert (
+ service.get_provider_by_persisted_reference(id_or_server_identifier=PROVIDER_UUID, tenant_id=TENANT_ID)
+ is provider
+ )
+
+ assert session.scalar.call_count == 1
+ assert "tool_mcp_providers.id = " in str(session.scalar.call_args.args[0].whereclause)
+
+
+def test_persisted_reference_uuid_falls_back_to_identifier(service: MCPToolManageService, session: Mock) -> None:
+ """A server identifier is free text, so it may itself look like a uuid."""
+ provider = _provider()
+ session.scalar.side_effect = [None, provider]
+
+ assert (
+ service.get_provider_by_persisted_reference(id_or_server_identifier=PROVIDER_UUID, tenant_id=TENANT_ID)
+ is provider
+ )
+
+ assert session.scalar.call_count == 2
+ assert "tool_mcp_providers.server_identifier = " in str(session.scalar.call_args.args[0].whereclause)
+
+
+def test_persisted_reference_not_found(service: MCPToolManageService, session: Mock) -> None:
+ session.scalar.return_value = None
+
+ # Never the primary-key lookup's "expected a valid UUID", which would
+ # misdescribe a legitimate reference.
+ with pytest.raises(ValueError, match="MCP tool not found"):
+ service.get_provider_by_persisted_reference(id_or_server_identifier=SERVER_IDENTIFIER, tenant_id=TENANT_ID)
+
+
+def test_persisted_reference_uuid_not_found(service: MCPToolManageService, session: Mock) -> None:
+ session.scalar.return_value = None
+
+ with pytest.raises(ValueError, match="MCP tool not found"):
+ service.get_provider_by_persisted_reference(id_or_server_identifier=PROVIDER_UUID, tenant_id=TENANT_ID)
diff --git a/api/tests/unit_tests/services/tools/test_mcp_tools_transform.py b/api/tests/unit_tests/services/tools/test_mcp_tools_transform.py
index 2379a9fa92b..3e6950f49ee 100644
--- a/api/tests/unit_tests/services/tools/test_mcp_tools_transform.py
+++ b/api/tests/unit_tests/services/tools/test_mcp_tools_transform.py
@@ -328,8 +328,8 @@ class TestMCPToolTransform:
assert result[0].type == ToolParameter.ToolParameterType.STRING
assert result[0].input_schema is None
- def test_mcp_provider_to_user_provider_for_list(self, mock_provider_full, mocker: MockerFixture):
- """Test mcp_provider_to_user_provider with for_list=True."""
+ def test_mcp_provider_to_user_provider_minimal_response(self, mock_provider_full, mocker: MockerFixture):
+ """Test mcp_provider_to_user_provider with a response that omits optional fields."""
# Set tools data with null description
mock_provider_full.tools = '[{"name": "tool1", "description": null, "inputSchema": {}}]'
@@ -352,12 +352,11 @@ class TestMCPToolTransform:
}
mocker.patch.object(mock_provider_full, "to_entity", return_value=mock_entity)
- # Call the method with for_list=True
- result = ToolTransformService.mcp_provider_to_user_provider(mock_provider_full, for_list=True)
+ result = ToolTransformService.mcp_provider_to_user_provider(mock_provider_full)
# Verify the result
assert isinstance(result, ToolProviderApiEntity)
- assert result.id == "provider-id-123" # Should use provider.id when for_list=True
+ assert result.id == "provider-id-123"
assert result.name == "Test MCP Provider"
assert result.type == ToolProviderType.MCP
assert result.is_team_authorization is True
@@ -365,8 +364,8 @@ class TestMCPToolTransform:
assert len(result.tools) == 1
assert result.tools[0].description.en_US == "" # Should handle None description
- def test_mcp_provider_to_user_provider_not_for_list(self, mock_provider_full, mocker: MockerFixture):
- """Test mcp_provider_to_user_provider with for_list=False."""
+ def test_mcp_provider_to_user_provider_full_response(self, mock_provider_full, mocker: MockerFixture):
+ """Test mcp_provider_to_user_provider with configuration and sensitive fields."""
# Set tools data with description
mock_provider_full.tools = '[{"name": "tool1", "description": "Tool description", "inputSchema": {}}]'
@@ -391,12 +390,11 @@ class TestMCPToolTransform:
}
mocker.patch.object(mock_provider_full, "to_entity", return_value=mock_entity)
- # Call the method with for_list=False
- result = ToolTransformService.mcp_provider_to_user_provider(mock_provider_full, for_list=False)
+ result = ToolTransformService.mcp_provider_to_user_provider(mock_provider_full)
# Verify the result
assert isinstance(result, ToolProviderApiEntity)
- assert result.id == "server-identifier-456" # Should use server_identifier when for_list=False
+ assert result.id == "provider-id-123"
assert result.server_identifier == "server-identifier-456"
assert result.configuration is not None
assert result.configuration.timeout == 30
diff --git a/api/tests/unit_tests/tools/test_mcp_tool.py b/api/tests/unit_tests/tools/test_mcp_tool.py
index 00a84f71f7f..0b6f80edcb4 100644
--- a/api/tests/unit_tests/tools/test_mcp_tool.py
+++ b/api/tests/unit_tests/tools/test_mcp_tool.py
@@ -47,7 +47,7 @@ def _make_mcp_tool(output_schema: dict[str, Any] | None = None) -> MCPTool:
tenant_id="test_tenant",
icon="",
server_url="https://server.invalid",
- provider_id="provider_1",
+ server_identifier="provider_1",
headers={},
)
diff --git a/web/app/components/app/configuration/config/agent/agent-tools/index.tsx b/web/app/components/app/configuration/config/agent/agent-tools/index.tsx
index 1fdd9fb1424..6efe0f31e88 100644
--- a/web/app/components/app/configuration/config/agent/agent-tools/index.tsx
+++ b/web/app/components/app/configuration/config/agent/agent-tools/index.tsx
@@ -37,8 +37,8 @@ import {
useAllMCPTools,
useAllWorkflowTools,
} from '@/service/use-tools'
-import { canFindTool } from '@/utils'
import { writeTextToClipboard } from '@/utils/clipboard'
+import { matchesProviderReference } from '@/utils/provider-reference'
import { useFormattingChangedDispatcher } from '../../../debug/hooks'
import SettingBuiltInTool from './setting-built-in-tool'
@@ -67,7 +67,8 @@ const AgentTools: FC = () => {
const tools = ((modelConfig?.agentConfig?.tools as AgentTool[]) || []).map((item) => {
const collection = collectionList.find(
(collection) =>
- canFindTool(collection.id, item.provider_id) && collection.type === item.provider_type,
+ matchesProviderReference(collection, item.provider_id) &&
+ collection.type === item.provider_type,
)
const icon = collection?.icon
return {
@@ -80,7 +81,7 @@ const AgentTools: FC = () => {
const newModelConfig = produce(modelConfig, (draft) => {
const tool = draft.agentConfig.tools.find(
(item: any) =>
- item.provider_id === currentTool?.collection?.id &&
+ item.provider_id === currentTool?.provider_id &&
item.tool_name === currentTool?.tool_name,
)
if (tool) (tool as AgentTool).tool_parameters = value
@@ -94,7 +95,9 @@ const AgentTools: FC = () => {
const getDeleteToolLabel = (tool: AgentTool) =>
`${t(($) => $['operation.delete'], { ns: 'common' })} ${tool.tool_label || tool.tool_name}`
const getToolValue = (tool: ToolDefaultValue) => {
- const currToolInCollections = collectionList.find((c) => c.id === tool.provider_id)
+ const currToolInCollections = collectionList.find((c) =>
+ matchesProviderReference(c, tool.provider_id),
+ )
const currToolWithConfigs = currToolInCollections?.tools.find((t) => t.name === tool.tool_name)
const formSchemas = currToolWithConfigs
? toolParametersToFormSchemas(currToolWithConfigs.parameters)
diff --git a/web/app/components/app/configuration/debug/debug-with-multiple-model/chat-item.tsx b/web/app/components/app/configuration/debug/debug-with-multiple-model/chat-item.tsx
index 09a68780389..a942cb0bc98 100644
--- a/web/app/components/app/configuration/debug/debug-with-multiple-model/chat-item.tsx
+++ b/web/app/components/app/configuration/debug/debug-with-multiple-model/chat-item.tsx
@@ -23,7 +23,7 @@ import {
fetchSuggestedQuestions,
stopChatMessageResponding,
} from '@/service/debug'
-import { canFindTool } from '@/utils'
+import { matchesProviderReference } from '@/utils/provider-reference'
import { useConfigFromDebugContext, useFormattingChangedSubscription } from '../hooks'
import { APP_CHAT_WITH_MULTIPLE_MODEL, APP_CHAT_WITH_MULTIPLE_MODEL_RESTART } from '../types'
@@ -145,7 +145,7 @@ const ChatItem: FC<ChatItemProps> = ({ modelAndParameter }) => {
const icons: Record<string, any> = {}
modelConfig.agentConfig.tools?.forEach((item: any) => {
icons[item.tool_name] = collectionList.find((collection: any) =>
- canFindTool(collection.id, item.provider_id),
+ matchesProviderReference(collection, item.provider_id),
)?.icon
})
return icons
diff --git a/web/app/components/app/configuration/debug/debug-with-single-model/index.tsx b/web/app/components/app/configuration/debug/debug-with-single-model/index.tsx
index 8c47ed04099..a7debb5360c 100644
--- a/web/app/components/app/configuration/debug/debug-with-single-model/index.tsx
+++ b/web/app/components/app/configuration/debug/debug-with-single-model/index.tsx
@@ -17,7 +17,7 @@ import {
fetchSuggestedQuestions,
stopChatMessageResponding,
} from '@/service/debug'
-import { canFindTool } from '@/utils'
+import { matchesProviderReference } from '@/utils/provider-reference'
import { useConfigFromDebugContext, useFormattingChangedSubscription } from '../hooks'
type DebugWithSingleModelProps = {
@@ -161,7 +161,7 @@ const DebugWithSingleModel = ({
const icons: Record<string, any> = {}
modelConfig.agentConfig.tools?.forEach((item: any) => {
icons[item.tool_name] = collectionList.find((collection: any) =>
- canFindTool(collection.id, item.provider_id),
+ matchesProviderReference(collection, item.provider_id),
)?.icon
})
return icons
diff --git a/web/app/components/app/configuration/hooks/configuration-lifecycle/published-config.ts b/web/app/components/app/configuration/hooks/configuration-lifecycle/published-config.ts
index 08499a91a25..7aa5ce4bd02 100644
--- a/web/app/components/app/configuration/hooks/configuration-lifecycle/published-config.ts
+++ b/web/app/components/app/configuration/hooks/configuration-lifecycle/published-config.ts
@@ -8,6 +8,7 @@ import { PromptMode } from '@/models/debug'
import { AgentStrategy, AppModeEnum } from '@/types/app'
import { correctModelProvider, correctToolProvider } from '@/utils'
import { userInputsFormToPromptVariables } from '@/utils/model-config'
+import { matchesProviderReference } from '@/utils/provider-reference'
import { normalizeChatPromptConfig, normalizeCompletionPromptConfig } from './prompt-config'
type BackendAgentTool = ModelConfig['agentConfig']['tools'][number] & {
@@ -99,8 +100,8 @@ function buildPublishedModelConfig({
tools: agentModeTools
.filter((tool) => !tool.dataset)
.map((tool) => {
- const toolInCollectionList = collectionList.find(
- (collection) => collection.id === tool.provider_id,
+ const toolInCollectionList = collectionList.find((collection) =>
+ matchesProviderReference(collection, tool.provider_id),
)
return {
...tool,
diff --git a/web/app/components/explore/try-app/preview/basic-app-preview.tsx b/web/app/components/explore/try-app/preview/basic-app-preview.tsx
index 7ad787ea41c..2317f4549d1 100644
--- a/web/app/components/explore/try-app/preview/basic-app-preview.tsx
+++ b/web/app/components/explore/try-app/preview/basic-app-preview.tsx
@@ -31,6 +31,7 @@ import { useGetTryAppDataSets, useGetTryAppInfo } from '@/service/use-try-app'
import { AgentStrategy, ModelModeType, Resolution, TransferMethod, TtsAutoPlay } from '@/types/app'
import { correctModelProvider, correctToolProvider } from '@/utils'
import { userInputsFormToPromptVariables } from '@/utils/model-config'
+import { matchesProviderReference } from '@/utils/provider-reference'
import { basePath } from '@/utils/var'
import { useTextGenerationCurrentProviderAndModelAndModelList } from '../../../header/account-setting/model-provider-page/hooks'
@@ -299,7 +300,7 @@ const normalizeAgentTool = (
const providerName = getString(tool.provider_name)
const providerType = normalizeCollectionType(tool.provider_type)
const toolName = getString(tool.tool_name)
- const toolInCollectionList = collectionList?.find((c) => providerId === c.id)
+ const toolInCollectionList = collectionList?.find((c) => matchesProviderReference(c, providerId))
return {
...tool,
diff --git a/web/app/components/plugins/plugin-detail-panel/tool-selector/hooks/use-tool-selector.ts b/web/app/components/plugins/plugin-detail-panel/tool-selector/hooks/use-tool-selector.ts
index 418cf633cd0..973c670a76f 100644
--- a/web/app/components/plugins/plugin-detail-panel/tool-selector/hooks/use-tool-selector.ts
+++ b/web/app/components/plugins/plugin-detail-panel/tool-selector/hooks/use-tool-selector.ts
@@ -21,6 +21,7 @@ import {
useInvalidateAllBuiltInTools,
} from '@/service/use-tools'
import { getIconFromMarketPlace } from '@/utils/get-icon'
+import { matchesProviderReference } from '@/utils/provider-reference'
import { usePluginInstalledCheck } from './use-plugin-installed-check'
export type TabType = 'settings' | 'params'
@@ -54,7 +55,10 @@ export function useToolSelector({ value, onSelect, onSelectMultiple }: UseToolSe
...(workflowTools || []),
...(mcpTools || []),
]
- return mergedTools.find((toolWithProvider) => toolWithProvider.id === value?.provider_name)
+ // Historical shape: ``provider_name`` stores the provider reference, not a name.
+ return mergedTools.find((toolWithProvider) =>
+ matchesProviderReference(toolWithProvider, value?.provider_name),
+ )
}, [value, buildInTools, customTools, workflowTools, mcpTools])
const areToolProvidersSettled = [
buildInToolsQuery,
diff --git a/web/app/components/workflow/block-selector/tool/action-item.tsx b/web/app/components/workflow/block-selector/tool/action-item.tsx
index 14be2ecd3a4..7636da5617a 100644
--- a/web/app/components/workflow/block-selector/tool/action-item.tsx
+++ b/web/app/components/workflow/block-selector/tool/action-item.tsx
@@ -14,6 +14,7 @@ import { trackEvent } from '@/app/components/base/amplitude'
import { useGetLanguage } from '@/context/i18n'
import useTheme from '@/hooks/use-theme'
import { Theme } from '@/types/app'
+import { getProviderReference } from '@/utils/provider-reference'
import { basePath } from '@/utils/var'
import BlockIcon from '../../block-icon'
import { BlockEnum } from '../../types'
@@ -90,7 +91,7 @@ const ToolItem: FC<Props> = ({
})
}
onSelect(BlockEnum.Tool, {
- provider_id: provider.id,
+ provider_id: getProviderReference(provider),
provider_type: provider.type,
provider_name: provider.name,
provider_show_name: provider.label[language],
diff --git a/web/app/components/workflow/block-selector/tool/tool.tsx b/web/app/components/workflow/block-selector/tool/tool.tsx
index fafdf190897..fc271cc9a2e 100644
--- a/web/app/components/workflow/block-selector/tool/tool.tsx
+++ b/web/app/components/workflow/block-selector/tool/tool.tsx
@@ -13,6 +13,7 @@ import { useMCPToolAvailability } from '@/app/components/workflow/nodes/_base/co
import { useGetLanguage } from '@/context/i18n'
import useTheme from '@/hooks/use-theme'
import { Theme } from '@/types/app'
+import { getProviderReference, matchesProviderReference } from '@/utils/provider-reference'
import { basePath } from '@/utils/var'
import { CollectionType } from '../../../tools/types'
import BlockIcon from '../../block-icon'
@@ -86,11 +87,11 @@ function Tool({
return selectedTools.some(
(selectedTool) =>
(selectedTool.provider_name === payload.name ||
- selectedTool.provider_name === payload.id) &&
+ matchesProviderReference(payload, selectedTool.provider_name)) &&
selectedTool.tool_name === tool.name,
)
},
- [payload.id, payload.name, selectedTools],
+ [payload, selectedTools],
)
const totalToolsNum = actions.length
@@ -153,7 +154,7 @@ function Tool({
params[item.name] = ''
})
return {
- provider_id: payload.id,
+ provider_id: getProviderReference(payload),
provider_type: payload.type,
provider_name: payload.name,
provider_show_name: payload.label[language],
@@ -180,7 +181,7 @@ function Tool({
params[item.name] = ''
})
onSelect(BlockEnum.Tool, {
- provider_id: payload.id,
+ provider_id: getProviderReference(payload),
provider_type: payload.type,
provider_name: payload.name,
provider_show_name: payload.label[language],
diff --git a/web/app/components/workflow/hooks/use-nodes-meta-data.ts b/web/app/components/workflow/hooks/use-nodes-meta-data.ts
index b48cfd41fed..989c1c5170e 100644
--- a/web/app/components/workflow/hooks/use-nodes-meta-data.ts
+++ b/web/app/components/workflow/hooks/use-nodes-meta-data.ts
@@ -8,7 +8,7 @@ import { BlockEnum } from '@/app/components/workflow/types'
import { getNodeCatalogType } from '@/app/components/workflow/utils/node'
import { useGetLanguage } from '@/context/i18n'
import { useAllBuiltInTools, useAllCustomTools, useAllWorkflowTools } from '@/service/use-tools'
-import { canFindTool } from '@/utils'
+import { matchesProviderReference } from '@/utils/provider-reference'
export const useNodesMetaData = () => {
const availableNodesMetaData = useHooksStore((s) => s.availableNodesMetaData)
@@ -37,13 +37,15 @@ export const useNodeMetaData = (node: Node) => {
if (data.type === BlockEnum.Tool) {
if (data.provider_type === CollectionType.builtIn)
return buildInTools?.find((toolWithProvider) =>
- canFindTool(toolWithProvider.id, data.provider_id),
+ matchesProviderReference(toolWithProvider, data.provider_id),
)?.author
if (data.provider_type === CollectionType.workflow)
- return workflowTools?.find((toolWithProvider) => toolWithProvider.id === data.provider_id)
- ?.author
- return customTools?.find((toolWithProvider) => toolWithProvider.id === data.provider_id)
- ?.author
+ return workflowTools?.find((toolWithProvider) =>
+ matchesProviderReference(toolWithProvider, data.provider_id),
+ )?.author
+ return customTools?.find((toolWithProvider) =>
+ matchesProviderReference(toolWithProvider, data.provider_id),
+ )?.author
}
return nodeMetaData?.metaData.author
}, [data, buildInTools, customTools, workflowTools, nodeMetaData, dataSourceList])
@@ -55,13 +57,15 @@ export const useNodeMetaData = (node: Node) => {
if (data.type === BlockEnum.Tool) {
if (data.provider_type === CollectionType.builtIn)
return buildInTools?.find((toolWithProvider) =>
- canFindTool(toolWithProvider.id, data.provider_id),
+ matchesProviderReference(toolWithProvider, data.provider_id),
)?.description[language]
if (data.provider_type === CollectionType.workflow)
- return workflowTools?.find((toolWithProvider) => toolWithProvider.id === data.provider_id)
- ?.description[language]
- return customTools?.find((toolWithProvider) => toolWithProvider.id === data.provider_id)
- ?.description[language]
+ return workflowTools?.find((toolWithProvider) =>
+ matchesProviderReference(toolWithProvider, data.provider_id),
+ )?.description[language]
+ return customTools?.find((toolWithProvider) =>
+ matchesProviderReference(toolWithProvider, data.provider_id),
+ )?.description[language]
}
return nodeMetaData?.metaData.description
}, [data, buildInTools, customTools, workflowTools, nodeMetaData, dataSourceList, language])
diff --git a/web/app/components/workflow/hooks/use-tool-icon.ts b/web/app/components/workflow/hooks/use-tool-icon.ts
index fd01ecd0377..75417386ff7 100644
--- a/web/app/components/workflow/hooks/use-tool-icon.ts
+++ b/web/app/components/workflow/hooks/use-tool-icon.ts
@@ -14,6 +14,7 @@ import {
} from '@/service/use-tools'
import { useAllTriggerPlugins } from '@/service/use-triggers'
import { canFindTool } from '@/utils'
+import { matchesProviderReference } from '@/utils/provider-reference'
import { useStore, useWorkflowStore } from '../store'
import { BlockEnum } from '../types'
@@ -99,7 +100,7 @@ const findToolInCollections = (
seen.add(collection)
const matched = collection.find((toolWithProvider) => {
- if (canFindTool(toolWithProvider.id, data.provider_id)) return true
+ if (matchesProviderReference(toolWithProvider, data.provider_id)) return true
if (data.plugin_id && toolWithProvider.plugin_id === data.plugin_id) return true
return data.provider_name === toolWithProvider.name
})
diff --git a/web/app/components/workflow/hooks/use-workflow-search.tsx b/web/app/components/workflow/hooks/use-workflow-search.tsx
index 71ef3afc388..fa7e7cb9b5a 100644
--- a/web/app/components/workflow/hooks/use-workflow-search.tsx
+++ b/web/app/components/workflow/hooks/use-workflow-search.tsx
@@ -14,7 +14,7 @@ import {
useAllMCPTools,
useAllWorkflowTools,
} from '@/service/use-tools'
-import { canFindTool } from '@/utils'
+import { matchesProviderReference } from '@/utils/provider-reference'
import { BlockEnum } from '../types'
import { setupNodeSelectionListener } from '../utils/node-navigation'
import { useNodesInteractions } from './use-nodes-interactions'
@@ -45,7 +45,8 @@ export const useWorkflowSearch = () => {
const targetTools =
(nodeData.provider_type && toolCollections[nodeData.provider_type]) || workflowTools
- return targetTools?.find((tool: any) => canFindTool(tool.id, nodeData.provider_id))?.icon
+ return targetTools?.find((tool: any) => matchesProviderReference(tool, nodeData.provider_id))
+ ?.icon
},
[buildInTools, customTools, workflowTools, mcpTools],
)
diff --git a/web/app/components/workflow/node-actions-menu/use-node-actions-menu-model.ts b/web/app/components/workflow/node-actions-menu/use-node-actions-menu-model.ts
index a0c46f95440..f3652a4b6c3 100644
--- a/web/app/components/workflow/node-actions-menu/use-node-actions-menu-model.ts
+++ b/web/app/components/workflow/node-actions-menu/use-node-actions-menu-model.ts
@@ -7,7 +7,7 @@ import { useWorkflowStore } from '@/app/components/workflow/store'
import { BlockEnum, NodeRunningStatus } from '@/app/components/workflow/types'
import { canRunBySingle } from '@/app/components/workflow/utils'
import { useAllWorkflowTools } from '@/service/use-tools'
-import { canFindTool } from '@/utils'
+import { matchesProviderReference } from '@/utils/provider-reference'
import { useNodesInteractions } from '../hooks/use-nodes-interactions'
import { useNodeMetaData } from '../hooks/use-nodes-meta-data'
import { useNodesReadOnly } from '../hooks/use-workflow'
@@ -47,7 +47,9 @@ export function useNodeActionsMenuModel({
data.type === BlockEnum.Tool && data.provider_type === CollectionType.workflow
if (!isWorkflowTool || !workflowTools || !data.provider_id) return undefined
- const workflowTool = workflowTools.find((item) => canFindTool(item.id, data.provider_id))
+ const workflowTool = workflowTools.find((item) =>
+ matchesProviderReference(item, data.provider_id),
+ )
if (!workflowTool?.workflow_app_id) return undefined
return `/app/${workflowTool.workflow_app_id}/workflow`
diff --git a/web/app/components/workflow/nodes/_base/components/workflow-panel/helpers.tsx b/web/app/components/workflow/nodes/_base/components/workflow-panel/helpers.tsx
index 46a3f5a38e1..31df4af0bd4 100644
--- a/web/app/components/workflow/nodes/_base/components/workflow-panel/helpers.tsx
+++ b/web/app/components/workflow/nodes/_base/components/workflow-panel/helpers.tsx
@@ -5,7 +5,7 @@ import type { Node, ToolWithProvider } from '@/app/components/workflow/types'
import DataSourceBeforeRunForm from '@/app/components/workflow/nodes/data-source/before-run-form'
import { DataSourceClassification } from '@/app/components/workflow/nodes/data-source/types'
import { BlockEnum } from '@/app/components/workflow/types'
-import { canFindTool } from '@/utils'
+import { matchesProviderReference } from '@/utils/provider-reference'
const MIN_NODE_PANEL_WIDTH = 400
const DEFAULT_MAX_NODE_PANEL_WIDTH = 720
@@ -58,7 +58,7 @@ export const getCurrentToolCollection = (
providerId?: string,
) => {
const candidates = buildInTools ?? storeBuildInTools
- return candidates?.find((item) => canFindTool(item.id, providerId))
+ return candidates?.find((item) => matchesProviderReference(item, providerId))
}
export const getCurrentDataSource = (
diff --git a/web/app/components/workflow/nodes/agent/components/tool-icon.tsx b/web/app/components/workflow/nodes/agent/components/tool-icon.tsx
index 08e6b1e4a88..8a7636da60f 100644
--- a/web/app/components/workflow/nodes/agent/components/tool-icon.tsx
+++ b/web/app/components/workflow/nodes/agent/components/tool-icon.tsx
@@ -13,6 +13,7 @@ import {
useAllWorkflowTools,
} from '@/service/use-tools'
import { getIconFromMarketPlace } from '@/utils/get-icon'
+import { matchesProviderReference } from '@/utils/provider-reference'
type Status = 'not-installed' | 'not-authorized' | undefined
@@ -36,7 +37,10 @@ export const ToolIcon = memo(({ providerName }: ToolIconProps) => {
...(mcpTools || []),
]
return mergedTools.find((toolWithProvider) => {
- return toolWithProvider.name === providerName || toolWithProvider.id === providerName
+ return (
+ toolWithProvider.name === providerName ||
+ matchesProviderReference(toolWithProvider, providerName)
+ )
})
}, [buildInTools, customTools, providerName, workflowTools, mcpTools])
diff --git a/web/app/components/workflow/nodes/parameter-extractor/components/extract-parameter/import-from-tool.tsx b/web/app/components/workflow/nodes/parameter-extractor/components/extract-parameter/import-from-tool.tsx
index 0334d73a4d8..7a4a21ff5f5 100644
--- a/web/app/components/workflow/nodes/parameter-extractor/components/extract-parameter/import-from-tool.tsx
+++ b/web/app/components/workflow/nodes/parameter-extractor/components/extract-parameter/import-from-tool.tsx
@@ -13,7 +13,7 @@ import { useTranslation } from 'react-i18next'
import { useLanguage } from '@/app/components/header/account-setting/model-provider-page/hooks'
import { CollectionType } from '@/app/components/tools/types'
import { useAllBuiltInTools, useAllCustomTools, useAllWorkflowTools } from '@/service/use-tools'
-import { canFindTool } from '@/utils'
+import { matchesProviderReference } from '@/utils/provider-reference'
import BlockSelector from '../../../../block-selector'
import { TabType } from '../../../../block-selector/types'
@@ -59,7 +59,9 @@ const ImportFromTool: FC<Props> = ({ onImport }) => {
return []
}
})()
- const currCollection = currentTools.find((item) => canFindTool(item.id, provider_id))
+ const currCollection = currentTools.find((item) =>
+ matchesProviderReference(item, provider_id),
+ )
const currTool = currCollection?.tools.find((tool) => tool.name === tool_name)
const toExactParams = (currTool?.parameters || []).filter((item) => item.form === 'llm')
const formattedParams = toParmExactParams(toExactParams, language)
diff --git a/web/app/components/workflow/nodes/tool/default.ts b/web/app/components/workflow/nodes/tool/default.ts
index 3287ee2c144..96880fe5860 100644
--- a/web/app/components/workflow/nodes/tool/default.ts
+++ b/web/app/components/workflow/nodes/tool/default.ts
@@ -5,7 +5,7 @@ import { CollectionType } from '@/app/components/tools/types'
import { VarType as VarKindType } from '@/app/components/workflow/nodes/tool/types'
import { BlockEnum } from '@/app/components/workflow/types'
import { genNodeMetaData } from '@/app/components/workflow/utils'
-import { canFindTool } from '@/utils'
+import { matchesProviderReference } from '@/utils/provider-reference'
import { TOOL_OUTPUT_STRUCT } from '../../constants'
import { Type } from '../llm/types'
import { resolveVarType } from './output-schema-utils'
@@ -130,7 +130,7 @@ const nodeDefault: NodeDefault<ToolNodeType> = {
default:
currentTools = []
}
- const currCollection = currentTools.find((item) => canFindTool(item.id, provider_id))
+ const currCollection = currentTools.find((item) => matchesProviderReference(item, provider_id))
const currTool = currCollection?.tools.find((tool) => tool.name === payload.tool_name)
const output_schema = currTool?.output_schema
let res: Var[] = []
diff --git a/web/app/components/workflow/nodes/tool/hooks/use-current-tool-collection.ts b/web/app/components/workflow/nodes/tool/hooks/use-current-tool-collection.ts
index 0d05bff4ed0..87199877414 100644
--- a/web/app/components/workflow/nodes/tool/hooks/use-current-tool-collection.ts
+++ b/web/app/components/workflow/nodes/tool/hooks/use-current-tool-collection.ts
@@ -8,7 +8,7 @@ import {
useAllMCPTools,
useAllWorkflowTools,
} from '@/service/use-tools'
-import { canFindTool } from '@/utils'
+import { matchesProviderReference } from '@/utils/provider-reference'
const useCurrentToolCollection = (
providerType: ToolNodeType['provider_type'],
@@ -35,7 +35,7 @@ const useCurrentToolCollection = (
}, [buildInTools, customTools, mcpTools, providerType, workflowTools])
const currCollection = useMemo(() => {
- return currentTools.find((item) => canFindTool(item.id, providerId))
+ return currentTools.find((item) => matchesProviderReference(item, providerId))
}, [currentTools, providerId])
return {
diff --git a/web/app/components/workflow/utils/plugin-install-check.ts b/web/app/components/workflow/utils/plugin-install-check.ts
index ac40cc4f276..ab15d56e145 100644
--- a/web/app/components/workflow/utils/plugin-install-check.ts
+++ b/web/app/components/workflow/utils/plugin-install-check.ts
@@ -4,7 +4,7 @@ import type { ToolNodeType } from '../nodes/tool/types'
import type { PluginTriggerNodeType } from '../nodes/trigger-plugin/types'
import type { CommonNodeType, ToolWithProvider } from '../types'
import { CollectionType } from '@/app/components/tools/types'
-import { canFindTool } from '@/utils'
+import { matchesProviderReference } from '@/utils/provider-reference'
import { BlockEnum } from '../types'
export function matchToolInCollection(
@@ -14,7 +14,7 @@ export function matchToolInCollection(
return collection.find(
(tool) =>
(data.plugin_id && tool.plugin_id === data.plugin_id) ||
- canFindTool(tool.id, data.provider_id) ||
+ matchesProviderReference(tool, data.provider_id) ||
tool.name === data.provider_name,
)
}
diff --git a/web/app/components/workflow/utils/tool.ts b/web/app/components/workflow/utils/tool.ts
index d5768e66ef1..e7b76a1cdc0 100644
--- a/web/app/components/workflow/utils/tool.ts
+++ b/web/app/components/workflow/utils/tool.ts
@@ -5,7 +5,7 @@ import { CollectionType } from '@/app/components/tools/types'
import { toolParametersToFormSchemas } from '@/app/components/tools/utils/to-form-schema'
import { Type } from '@/app/components/workflow/nodes/llm/types'
import { isToolAuthorizationRequired } from '@/app/components/workflow/nodes/tool/auth'
-import { canFindTool } from '@/utils'
+import { matchesProviderReference } from '@/utils/provider-reference'
export const getToolCheckParams = (
toolData: ToolNodeType,
@@ -21,7 +21,7 @@ export const getToolCheckParams = (
: provider_type === CollectionType.custom
? customTools
: workflowTools
- const currCollection = currentTools.find((item) => canFindTool(item.id, provider_id))
+ const currCollection = currentTools.find((item) => matchesProviderReference(item, provider_id))
const currTool = currCollection?.tools.find((tool) => tool.name === tool_name)
const formSchemas = currTool ? toolParametersToFormSchemas(currTool.parameters) : []
const toolInputVarSchema = formSchemas.filter((item) => item.form === 'llm')
diff --git a/web/features/agent-v2/agent-detail/configure/components/__tests__/agent-prompt-editor.spec.tsx b/web/features/agent-v2/agent-detail/configure/components/__tests__/agent-prompt-editor.spec.tsx
index ff477edfc54..4af06c183f8 100644
--- a/web/features/agent-v2/agent-detail/configure/components/__tests__/agent-prompt-editor.spec.tsx
+++ b/web/features/agent-v2/agent-detail/configure/components/__tests__/agent-prompt-editor.spec.tsx
@@ -109,6 +109,36 @@ const mockBuiltInTools = vi.hoisted(() => [
},
])
+const mockMCPTools = vi.hoisted(() => ({
+ current: [] as Array<Record<string, unknown>>,
+}))
+const mondayMCPProvider = {
+ id: '1e9b5c9c-0a3f-4a2b-8f6f-2f7a0d3c4b51',
+ server_identifier: 'monday_mcp',
+ name: 'Monday MCP',
+ author: 'Dify',
+ description: { en_US: 'Monday MCP server' },
+ icon: 'monday.svg',
+ label: { en_US: 'Monday MCP' },
+ type: 'mcp',
+ team_credentials: {},
+ is_team_authorization: true,
+ allow_delete: true,
+ labels: [],
+ meta: {},
+ tools: [
+ {
+ name: 'list_boards',
+ author: 'Dify',
+ label: { en_US: 'List Boards' },
+ description: { en_US: 'List all boards.' },
+ parameters: [],
+ labels: [],
+ output_schema: {},
+ },
+ ],
+}
+
const wikipediaProvider = {
id: 'wikipedia',
name: 'Wikipedia',
@@ -209,7 +239,7 @@ vi.mock('@/service/use-tools', () => ({
useAllBuiltInTools: () => ({ data: mockBuiltInTools }),
useAllCustomTools: () => ({ data: [] }),
useAllWorkflowTools: () => ({ data: [] }),
- useAllMCPTools: () => ({ data: [] }),
+ useAllMCPTools: () => ({ data: mockMCPTools.current }),
}))
vi.mock('@/hooks/use-theme', () => ({
@@ -305,6 +335,7 @@ describe('AgentPromptEditor', () => {
vi.clearAllMocks()
window.getSelection()?.removeAllRanges()
mockConfigFiles.current = []
+ mockMCPTools.current = []
mockLexical.selection = null
mockLexical.rootChildren = []
mockLexical.rootSelectEnd.mockClear()
@@ -1011,6 +1042,76 @@ describe('AgentPromptEditor', () => {
])
})
+ it('should reference MCP tools by the same server identifier the configuration stores', async () => {
+ mockMCPTools.current = [mondayMCPProvider]
+ const { store, setPromptValue } = renderAgentPromptEditor('Research /', { tools: [] })
+
+ await openSlashMenuFromEditor()
+ fireEvent.click(screen.getByRole('button', { name: /agentDetail\.configure\.tools\.label/i }))
+ fireEvent.click(screen.getByRole('button', { name: 'Monday MCP' }))
+ fireEvent.click(screen.getByRole('button', { name: /List Boards/i }))
+
+ expect(store.get(agentComposerPromptAtom)).toBe(
+ 'Research [§tool:monday_mcp/list_boards:List Boards§] ',
+ )
+ expect(store.get(agentComposerDraftAtom).tools).toEqual([
+ expect.objectContaining({ id: 'monday_mcp' }),
+ ])
+
+ setPromptValue('Research /')
+ await openSlashMenuFromEditor()
+ fireEvent.click(screen.getByRole('button', { name: /agentDetail\.configure\.tools\.label/i }))
+ fireEvent.click(
+ screen.getByRole('button', {
+ name: /Monday MCP.*agentDetail\.configure\.tools\.toolTabs\.mcp/i,
+ }),
+ )
+
+ expect(store.get(agentComposerPromptAtom)).toBe('Research [§tool:monday_mcp/*:Monday MCP§] ')
+ })
+
+ it('should render reference icons for MCP tools saved before the provider was renamed', () => {
+ mockMCPTools.current = [mondayMCPProvider]
+ renderAgentPromptEditor('Run tools', {
+ tools: [
+ {
+ id: 'monday_mcp',
+ name: 'Monday Boards',
+ kind: 'provider',
+ iconClassName: 'i-custom-public-other-default-tool-icon',
+ providerType: 'mcp',
+ credentialVariant: 'authorized',
+ actions: [
+ {
+ id: 'monday_mcp-list_boards',
+ name: 'List Boards',
+ toolName: 'list_boards',
+ description: 'List all boards.',
+ },
+ ],
+ },
+ ],
+ })
+
+ const promptEditorProps = mockPromptEditor.mock.calls.at(-1)?.[0] as PromptEditorProps
+ const { container } = render(
+ <>
+ {promptEditorProps.rosterReferenceBlock?.renderIcon?.({
+ kind: 'tool',
+ id: 'monday_mcp/list_boards',
+ label: 'List Boards',
+ })}
+ </>,
+ )
+
+ const providerIcon = Array.from(container.querySelectorAll<HTMLElement>('[style]')).find(
+ (element) => element.style.backgroundImage,
+ )
+ expect(providerIcon).toHaveStyle({
+ backgroundImage: `url(${API_PREFIX}/workspaces/current/plugin/icon?tenant_id=workspace-123&filename=monday.svg)`,
+ })
+ })
+
it('should show configured providers and actions before other available tools', () => {
mockBuiltInTools.unshift(wikipediaProvider)
const configuredDuckDuckGoTranslateTool: AgentTool = {
diff --git a/web/features/agent-v2/agent-detail/configure/components/orchestrate/prompt-editor/hooks.ts b/web/features/agent-v2/agent-detail/configure/components/orchestrate/prompt-editor/hooks.ts
index 1be033ec265..6023f67cea1 100644
--- a/web/features/agent-v2/agent-detail/configure/components/orchestrate/prompt-editor/hooks.ts
+++ b/web/features/agent-v2/agent-detail/configure/components/orchestrate/prompt-editor/hooks.ts
@@ -14,6 +14,7 @@ import {
useAllWorkflowTools,
} from '@/service/use-tools'
import { Theme } from '@/types/app'
+import { getProviderReference } from '@/utils/provider-reference'
import { basePath } from '@/utils/var'
type ProviderTool = Extract<AgentTool, { kind: 'provider' }>
@@ -45,6 +46,9 @@ function createProviderMap(providers: ToolWithProvider[]) {
providers.forEach((provider) => {
providerById.set(provider.id, provider)
+ // Configured tools persist the provider reference, which is the server identifier
+ // for MCP providers. Keep the primary key too so older configs still resolve.
+ providerById.set(getProviderReference(provider), provider)
providerById.set(provider.name, provider)
if (provider.plugin_id) {
providerById.set(provider.plugin_id, provider)
diff --git a/web/features/agent-v2/agent-detail/configure/components/orchestrate/prompt-editor/slash.tsx b/web/features/agent-v2/agent-detail/configure/components/orchestrate/prompt-editor/slash.tsx
index 38c0c3341a5..c8f71a19dbf 100644
--- a/web/features/agent-v2/agent-detail/configure/components/orchestrate/prompt-editor/slash.tsx
+++ b/web/features/agent-v2/agent-detail/configure/components/orchestrate/prompt-editor/slash.tsx
@@ -32,6 +32,7 @@ import {
useAllMCPTools,
useAllWorkflowTools,
} from '@/service/use-tools'
+import { getProviderReference, matchesProviderReference } from '@/utils/provider-reference'
import { useAgentPromptToolIconResolver } from './hooks'
export type SlashMenuView = 'main' | 'skills' | 'files' | 'tools' | 'knowledge'
@@ -422,7 +423,11 @@ function AgentPromptToolRows({
provider.tools.map((tool) => toToolDefaultValue(provider, tool, language, icon, iconDark)),
)
onInsertToken(
- createReferenceToken('tool', `${provider.id}/*`, getProviderLabel(provider, language)),
+ createReferenceToken(
+ 'tool',
+ `${getProviderReference(provider)}/*`,
+ getProviderLabel(provider, language),
+ ),
)
}
@@ -431,7 +436,11 @@ function AgentPromptToolRows({
const selectedTool = toToolDefaultValue(provider, tool, language, icon, iconDark)
selectTools([selectedTool])
onInsertToken(
- createReferenceToken('tool', `${provider.id}/${tool.name}`, selectedTool.tool_label),
+ createReferenceToken(
+ 'tool',
+ `${getProviderReference(provider)}/${tool.name}`,
+ selectedTool.tool_label,
+ ),
)
}
@@ -549,7 +558,7 @@ function toToolDefaultValue(
const providerLabel = getLocalizedText(provider.label, language) || provider.name
return {
- provider_id: provider.id,
+ provider_id: getProviderReference(provider),
provider_type: parseToolProviderType(provider.type),
provider_name: provider.name,
provider_show_name: providerLabel,
@@ -574,7 +583,7 @@ function isToolSelected(selectedTools: ToolValue[], provider: ToolWithProvider,
return selectedTools.some(
(selectedTool) =>
(selectedTool.provider_name === provider.name ||
- selectedTool.provider_name === provider.id) &&
+ matchesProviderReference(provider, selectedTool.provider_name)) &&
selectedTool.tool_name === tool.name,
)
}
diff --git a/web/features/agent-v2/agent-detail/configure/tool-provider-catalog.ts b/web/features/agent-v2/agent-detail/configure/tool-provider-catalog.ts
index 38b0cf38132..d7e38d368a9 100644
--- a/web/features/agent-v2/agent-detail/configure/tool-provider-catalog.ts
+++ b/web/features/agent-v2/agent-detail/configure/tool-provider-catalog.ts
@@ -13,6 +13,7 @@ import {
useAllMCPTools,
useAllWorkflowTools,
} from '@/service/use-tools'
+import { getProviderReference } from '@/utils/provider-reference'
type AgentToolPresentationProvider = Pick<
AgentProviderTool,
@@ -54,6 +55,9 @@ export function createAgentToolProviderCatalog({
allProviders.forEach((provider) => {
providers.set(provider.id, provider)
+ // Redundant for every type except MCP, which the saved config references by
+ // server identifier.
+ providers.set(getProviderReference(provider), provider)
providers.set(provider.name, provider)
if (provider.plugin_id) {
providers.set(provider.plugin_id, provider)
diff --git a/web/utils/__tests__/provider-reference.spec.ts b/web/utils/__tests__/provider-reference.spec.ts
new file mode 100644
index 00000000000..cb9993c45b0
--- /dev/null
+++ b/web/utils/__tests__/provider-reference.spec.ts
@@ -0,0 +1,58 @@
+import { describe, expect, it } from 'vite-plus/test'
+import { CollectionType } from '@/app/components/tools/types'
+import { getProviderReference, matchesProviderReference } from '../provider-reference'
+
+const mcpProvider = {
+ id: '0b2bd1e4-3a7d-4a0b-9f2a-9b2d6f3c1e55',
+ type: CollectionType.mcp,
+ server_identifier: 'monday_mcp',
+}
+const builtInProvider = {
+ id: 'langgenius/google/google',
+ type: CollectionType.builtIn,
+}
+
+describe('getProviderReference', () => {
+ it('uses the server identifier for MCP providers', () => {
+ expect(getProviderReference(mcpProvider)).toBe('monday_mcp')
+ })
+
+ it('falls back to the id when an MCP provider has no server identifier', () => {
+ expect(getProviderReference({ ...mcpProvider, server_identifier: undefined })).toBe(
+ mcpProvider.id,
+ )
+ })
+
+ it('uses the id for every other provider type', () => {
+ expect(getProviderReference(builtInProvider)).toBe('langgenius/google/google')
+ })
+})
+
+describe('matchesProviderReference', () => {
+ it('matches an MCP provider by server identifier', () => {
+ expect(matchesProviderReference(mcpProvider, 'monday_mcp')).toBe(true)
+ })
+
+ it('matches an MCP provider by its primary key for references written before the convention', () => {
+ expect(matchesProviderReference(mcpProvider, mcpProvider.id)).toBe(true)
+ })
+
+ it('does not match an unrelated reference', () => {
+ expect(matchesProviderReference(mcpProvider, 'other_mcp')).toBe(false)
+ })
+
+ it('does not match an empty reference', () => {
+ expect(matchesProviderReference(mcpProvider, undefined)).toBe(false)
+ expect(matchesProviderReference(mcpProvider, '')).toBe(false)
+ })
+
+ it('keeps the legacy built-in provider id shorthands working', () => {
+ expect(matchesProviderReference(builtInProvider, 'google')).toBe(true)
+ expect(
+ matchesProviderReference(
+ { id: 'langgenius/jina_tool/jina', type: CollectionType.builtIn },
+ 'jina',
+ ),
+ ).toBe(true)
+ })
+})
diff --git a/web/utils/provider-reference.ts b/web/utils/provider-reference.ts
new file mode 100644
index 00000000000..c6ef5bafbb9
--- /dev/null
+++ b/web/utils/provider-reference.ts
@@ -0,0 +1,28 @@
+import type { Collection } from '@/app/components/tools/types'
+import { CollectionType } from '@/app/components/tools/types'
+import { canFindTool } from './index'
+
+type ProviderLike = Pick<Collection, 'id' | 'type'> & { server_identifier?: string }
+
+/**
+ * The identifier to persist when a node, agent config or prompt mention points at a
+ * provider. MCP providers are resolved by `server_identifier` at runtime because it
+ * survives a DSL export/import into another workspace; the primary key does not.
+ */
+export const getProviderReference = (provider: ProviderLike) => {
+ if (provider.type === CollectionType.mcp && provider.server_identifier)
+ return provider.server_identifier
+ return provider.id
+}
+
+/**
+ * Whether a persisted reference points at this provider.
+ * Use idOrServerIdentifier for backward compatibility. Previous id content could be non-deterministic,
+ * we will support both primary key or server_identifier as reference
+ */
+export const matchesProviderReference = (provider: ProviderLike, idOrServerIdentifier?: string) => {
+ if (!idOrServerIdentifier) return false
+ if (provider.type === CollectionType.mcp && provider.server_identifier === idOrServerIdentifier)
+ return true
+ return canFindTool(provider.id, idOrServerIdentifier)
+}