MCPTool interface

Пакет:
@azure/ai-projects

Предоставьте модели доступ к дополнительным инструментам через удаленные серверы протокола контекста модели (MCP). Learn больше о MCP.

Extends
Tool

Свойства

allowed_callers

Звонящие, которые могут использовать этот инструмент.
allowed_tools

Список разрешённых имён инструментов для сервера MCP.
authorization

Токен доступа OAuth, который можно использовать с удалённым MCP-сервером, либо с пользовательским URL сервера MCP, либо с сервисным коннектором. Ваше приложение должно обрабатывать процесс авторизации OAuth и предоставлять токен здесь.
connector_id

Идентификатор для сервисных разъёмов, подобных тем, что доступны в ChatGPT. Один из server_url, connector_id, или tunnel_id должен быть предоставлен. Узнайте больше о сервисных разъёмах здесь. В настоящее время поддерживаемые connector_id значения:

  • Dropbox: connector_dropbox
  • Gmail: connector_gmail
  • Google Календарь: connector_googlecalendar
  • Google Диск: connector_googledrive
  • Microsoft Teams:connector_microsoftteams
  • Outlook Календарь: connector_outlookcalendar
  • Outlook Электронная почта: connector_outlookemail
  • SharePoint:connector_sharepoint
defer_loading

Можно ли отложить и обнаружить этот инструмент MCP через поиск инструментов.
headers

Пользовательские заголовки для включения в запросы к серверу MCP.
project_connection_id

Идентификатор подключения в project сервера MCP. В подключении хранятся данные аутентификации и другие сведения о подключении, необходимые для подключения к серверу MCP.
require_approval

Требования к одобрению инструмента MCP.
server_description

Необязательное описание сервера MCP, используемое для получения дополнительного контекста.
server_label

Метка для этого сервера MCP, используемая для идентификации его в вызовах инструментов.
server_url

URL-адрес сервера MCP. Один из server_url, connector_id, или tunnel_id должен быть предоставлен.
tool_configs

Устарело. Это свойство устарело и будет удалено в будущей версии.
tunnel_id

Использовать Secure MCP Tunnel ID вместо прямого URL сервера. Один из server_url, connector_id, или tunnel_id должен быть предоставлен.
type

Тип средства MCP. Всегда mcp.

Сведения о свойстве

allowed_callers

Звонящие, которые могут использовать этот инструмент.

allowed_callers?: CallableToolAllowedCaller[]

Значение свойства

CallableToolAllowedCaller[]

allowed_tools

Список разрешённых имён инструментов для сервера MCP.

allowed_tools?: string[] | MCPToolFilter

Значение свойства

string[] | MCPToolFilter

authorization

Токен доступа OAuth, который можно использовать с удалённым MCP-сервером, либо с пользовательским URL сервера MCP, либо с сервисным коннектором. Ваше приложение должно обрабатывать процесс авторизации OAuth и предоставлять токен здесь.

authorization?: string

Значение свойства

string

connector_id

Идентификатор для сервисных разъёмов, подобных тем, что доступны в ChatGPT. Один из server_url, connector_id, или tunnel_id должен быть предоставлен. Узнайте больше о сервисных разъёмах здесь. В настоящее время поддерживаемые connector_id значения:

  • Dropbox: connector_dropbox
  • Gmail: connector_gmail
  • Google Календарь: connector_googlecalendar
  • Google Диск: connector_googledrive
  • Microsoft Teams:connector_microsoftteams
  • Outlook Календарь: connector_outlookcalendar
  • Outlook Электронная почта: connector_outlookemail
  • SharePoint:connector_sharepoint
connector_id?: "connector_dropbox" | "connector_gmail" | "connector_googlecalendar" | "connector_googledrive" | "connector_microsoftteams" | "connector_outlookcalendar" | "connector_outlookemail" | "connector_sharepoint"

Значение свойства

"connector_dropbox" | "connector_gmail" | "connector_googlecalendar" | "connector_googledrive" | "connector_microsoftteams" | "connector_outlookcalendar" | "connector_outlookemail" | "connector_sharepoint"

defer_loading

Можно ли отложить и обнаружить этот инструмент MCP через поиск инструментов.

defer_loading?: boolean

Значение свойства

boolean

headers

Пользовательские заголовки для включения в запросы к серверу MCP.

headers?: Record<string, string>

Значение свойства

Record<string, string>

project_connection_id

Идентификатор подключения в project сервера MCP. В подключении хранятся данные аутентификации и другие сведения о подключении, необходимые для подключения к серверу MCP.

project_connection_id?: string

Значение свойства

string

require_approval

Требования к одобрению инструмента MCP.

require_approval?: MCPToolRequireApproval | "always" | "never"

Значение свойства

MCPToolRequireApproval | "always" | "never"

server_description

Необязательное описание сервера MCP, используемое для получения дополнительного контекста.

server_description?: string

Значение свойства

string

server_label

Метка для этого сервера MCP, используемая для идентификации его в вызовах инструментов.

server_label: string

Значение свойства

string

server_url

URL-адрес сервера MCP. Один из server_url, connector_id, или tunnel_id должен быть предоставлен.

server_url?: string

Значение свойства

string

tool_configs

Устарело. Это свойство устарело и будет удалено в будущей версии.

tool_configs?: Record<string, ToolConfig>

Значение свойства

Record<string, ToolConfig>

tunnel_id

Использовать Secure MCP Tunnel ID вместо прямого URL сервера. Один из server_url, connector_id, или tunnel_id должен быть предоставлен.

tunnel_id?: string

Значение свойства

string

type

Тип средства MCP. Всегда mcp.

type: "mcp"

Значение свойства

"mcp"