utility 模块

为工具组件提供实用工具函数。

函数

build_mcp_server_url

使用基 URL 和服务器名称构造完整的 MCP 服务器 URL。

build_mcp_server_url(server_name: str) -> str

参数

名称 说明
server_name
必需
str

MCP 服务器名称。

返回

类型 说明
str

完整的 MCP 服务器 URL。

get_chat_history_endpoint

获取用于将聊天历史记录发送到 MCP 平台的聊天历史记录终结点 URL。

get_chat_history_endpoint() -> str

返回

类型 说明
str

聊天历史记录终结点 URL。

get_mcp_base_url

获取 MCP 服务器的基 URL。

get_mcp_base_url() -> str

返回

类型 说明
str

MCP 服务器的基 URL。

get_mcp_platform_authentication_scope

获取 MCP 平台身份验证范围。

get_mcp_platform_authentication_scope() -> list[str]

返回

类型 说明

包含相应的 MCP 平台身份验证范围的列表。

get_tooling_gateway_for_digital_worker

获取指定数字辅助角色的工具网关 URL。

get_tooling_gateway_for_digital_worker(agentic_app_id: str) -> str

参数

名称 说明
agentic_app_id
必需
str

数字辅助角色的代理应用标识符。

返回

类型 说明
str

数字工作者的工具网关 URL。

is_development_environment

如果当前环境配置为开发,则返回 True。

解析顺序(第一个非空值获胜):

  1. PYTHON_ENVIRONMENT — 当前示例中使用的显式 Python SDK 变量。
  2. ENVIRONMENT — 旧版 Python SDK 变量(向后兼容性)。
  3. ASPNETCORE_ENVIRONMENT — Azure 托管约定。
  4. DOTNET_ENVIRONMENT — 泛型主机约定。
  5. 默认为 "Development" 未设置上述任何内容的情况。

PYTHON_ENVIRONMENTENVIRONMENT首先进行检查,以便在主机进程也设置ASPNETCORE_ENVIRONMENT的情况下,显式设置ENVIRONMENT=Production的代理不会受到影响。

is_development_environment() -> bool

返回

类型 说明

当已解决的环境为“开发”(不区分大小写时),则为 True。

resolve_token_scope_for_server

解析 OAuth 范围以请求给定 MCP 服务器。

V2 服务器在 audience 字段中携带自己的受众(裸 GUID 或 api:// URI 表单)。 提供显式 scope 时(例如 "Tools.ListInvoke.All"),范围为 {audience}/{scope}。 如果缺少范围, {audience}/.default 则使用(依赖于预先同意的范围)。 V1 服务器(受众不等于裸 GUID 或 api:// URI 形式的共享 ATG AppId)始终回退到共享 ATG /.default 范围。

resolve_token_scope_for_server(server: MCPServerConfig) -> str

参数

名称 说明
server
必需

用于解析其范围的 MCP 服务器配置。

返回

类型 说明
str

OAuth 范围字符串,例如 "<guid>/Tools.ListInvoke.All""api://<guid>/.default"或共享 ATG "<atg-guid>/.default"