mirror of
https://github.com/langgenius/dify.git
synced 2025-07-25 18:39:19 +00:00
88 lines
3.5 KiB
Python
88 lines
3.5 KiB
Python
from datetime import datetime
|
|
from typing import Any, Literal, Optional
|
|
|
|
from pydantic import BaseModel, Field, field_validator
|
|
|
|
from core.model_runtime.utils.encoders import jsonable_encoder
|
|
from core.tools.__base.tool import ToolParameter
|
|
from core.tools.entities.common_entities import I18nObject
|
|
from core.tools.entities.tool_entities import ToolProviderType
|
|
|
|
|
|
class ToolApiEntity(BaseModel):
|
|
author: str
|
|
name: str # identifier
|
|
label: I18nObject # label
|
|
description: I18nObject
|
|
parameters: Optional[list[ToolParameter]] = None
|
|
labels: list[str] = Field(default_factory=list)
|
|
output_schema: Optional[dict] = None
|
|
|
|
|
|
ToolProviderTypeApiLiteral = Optional[Literal["builtin", "api", "workflow", "mcp"]]
|
|
|
|
|
|
class ToolProviderApiEntity(BaseModel):
|
|
id: str
|
|
author: str
|
|
name: str # identifier
|
|
description: I18nObject
|
|
icon: str | dict
|
|
label: I18nObject # label
|
|
type: ToolProviderType
|
|
masked_credentials: Optional[dict] = None
|
|
original_credentials: Optional[dict] = None
|
|
is_team_authorization: bool = False
|
|
allow_delete: bool = True
|
|
plugin_id: Optional[str] = Field(default="", description="The plugin id of the tool")
|
|
plugin_unique_identifier: Optional[str] = Field(default="", description="The unique identifier of the tool")
|
|
tools: list[ToolApiEntity] = Field(default_factory=list)
|
|
labels: list[str] = Field(default_factory=list)
|
|
# MCP
|
|
server_url: Optional[str] = Field(default="", description="The server url of the tool")
|
|
updated_at: int = Field(default_factory=lambda: int(datetime.now().timestamp()))
|
|
server_identifier: Optional[str] = Field(default="", description="The server identifier of the MCP tool")
|
|
|
|
@field_validator("tools", mode="before")
|
|
@classmethod
|
|
def convert_none_to_empty_list(cls, v):
|
|
return v if v is not None else []
|
|
|
|
def to_dict(self) -> dict:
|
|
# -------------
|
|
# overwrite tool parameter types for temp fix
|
|
tools = jsonable_encoder(self.tools)
|
|
for tool in tools:
|
|
if tool.get("parameters"):
|
|
for parameter in tool.get("parameters"):
|
|
if parameter.get("type") == ToolParameter.ToolParameterType.SYSTEM_FILES.value:
|
|
parameter["type"] = "files"
|
|
if parameter.get("input_schema") is None:
|
|
parameter.pop("input_schema", None)
|
|
# -------------
|
|
optional_fields = self.optional_field("server_url", self.server_url)
|
|
if self.type == ToolProviderType.MCP.value:
|
|
optional_fields.update(self.optional_field("updated_at", self.updated_at))
|
|
optional_fields.update(self.optional_field("server_identifier", self.server_identifier))
|
|
return {
|
|
"id": self.id,
|
|
"author": self.author,
|
|
"name": self.name,
|
|
"plugin_id": self.plugin_id,
|
|
"plugin_unique_identifier": self.plugin_unique_identifier,
|
|
"description": self.description.to_dict(),
|
|
"icon": self.icon,
|
|
"label": self.label.to_dict(),
|
|
"type": self.type.value,
|
|
"team_credentials": self.masked_credentials,
|
|
"is_team_authorization": self.is_team_authorization,
|
|
"allow_delete": self.allow_delete,
|
|
"tools": tools,
|
|
"labels": self.labels,
|
|
**optional_fields,
|
|
}
|
|
|
|
def optional_field(self, key: str, value: Any) -> dict:
|
|
"""Return dict with key-value if value is truthy, empty dict otherwise."""
|
|
return {key: value} if value else {}
|