MCPTool interface

Pakket:

@azure/ai-projects

Geef het model toegang tot aanvullende tools via externe MCP-servers (Model Context Protocol). Meer informatie over MCP.

Uitbreiding

Tool

Eigenschappen

allowed_callers	De bellers die dit hulpmiddel kunnen inroepen.
allowed_tools	De lijst met toegestane toolnamen voor de MCP-server.
authorization	Een OAuth-toegangstoken dat gebruikt kan worden met een externe MCP-server, hetzij met een aangepaste MCP-server-URL of een serviceconnector. Je applicatie moet de OAuth-autorisatiestroom afhandelen en het token hier aanleveren.
connector_id	Identifier voor serviceconnectors, zoals die beschikbaar zijn in ChatGPT. Eén van server_url, connector_id, of tunnel_id moet worden aangeleverd. Lees hier meer over serviceconnectoren. Momenteel ondersteunde connector_id waarden zijn: Dropbox: connector_dropbox Gmail: connector_gmail Google Kalender: connector_googlecalendar Google Drive: connector_googledrive Microsoft Teams:connector_microsoftteams Outlook Kalender: connector_outlookcalendar Outlook E-mail: connector_outlookemail Sharepoint: connector_sharepoint
defer_loading	Of deze MCP-tool wordt uitgesteld en ontdekt via toolzoek.
headers	Aangepaste headers om op te nemen in verzoeken naar de MCP-server.
project_connection_id	De verbindings-id in de project voor de MCP-server. De verbinding slaat verificatie en andere verbindingsgegevens op die nodig zijn om verbinding te maken met de MCP-server.
require_approval	De goedkeuringsvereisten voor het MCP-instrument.
server_description	Optionele beschrijving van de MCP-server, gebruikt om meer context te bieden.
server_label	Een label voor deze MCP-server, dat wordt gebruikt om het te identificeren in hulpprogramma-aanroepen.
server_url	De URL voor de MCP-server. Eén van server_url, connector_id, of tunnel_id moet worden aangeleverd.
tool_configs	Deprecated. Deze eigenschap is verouderd en zal in een toekomstige versie worden verwijderd.
tunnel_id	De Secure MCP Tunnel ID om te gebruiken in plaats van een directe server-URL. Eén van server_url, connector_id, of tunnel_id moet worden aangeleverd.
type	Het type van de MCP-tool. Altijd mcp.

Eigenschapdetails

allowed_callers

De bellers die dit hulpmiddel kunnen inroepen.

allowed_callers?: CallableToolAllowedCaller[]

Waarde van eigenschap

CallableToolAllowedCaller[]

allowed_tools

De lijst met toegestane toolnamen voor de MCP-server.

allowed_tools?: string[] | MCPToolFilter

Waarde van eigenschap

string[] | MCPToolFilter

authorization

Een OAuth-toegangstoken dat gebruikt kan worden met een externe MCP-server, hetzij met een aangepaste MCP-server-URL of een serviceconnector. Je applicatie moet de OAuth-autorisatiestroom afhandelen en het token hier aanleveren.

authorization?: string

Waarde van eigenschap

string

connector_id

Identifier voor serviceconnectors, zoals die beschikbaar zijn in ChatGPT. Eén van server_url, connector_id, of tunnel_id moet worden aangeleverd. Lees hier meer over serviceconnectoren. Momenteel ondersteunde connector_id waarden zijn:

• Dropbox: connector_dropbox
• Gmail: connector_gmail
• Google Kalender: connector_googlecalendar
• Google Drive: connector_googledrive
• Microsoft Teams:connector_microsoftteams
• Outlook Kalender: connector_outlookcalendar
• Outlook E-mail: connector_outlookemail
• Sharepoint: connector_sharepoint

connector_id?: "connector_dropbox" | "connector_gmail" | "connector_googlecalendar" | "connector_googledrive" | "connector_microsoftteams" | "connector_outlookcalendar" | "connector_outlookemail" | "connector_sharepoint"

Waarde van eigenschap

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

defer_loading

Of deze MCP-tool wordt uitgesteld en ontdekt via toolzoek.

defer_loading?: boolean

Waarde van eigenschap

boolean

headers

Aangepaste headers om op te nemen in verzoeken naar de MCP-server.

headers?: Record<string, string>

Waarde van eigenschap

Record<string, string>

project_connection_id

De verbindings-id in de project voor de MCP-server. De verbinding slaat verificatie en andere verbindingsgegevens op die nodig zijn om verbinding te maken met de MCP-server.

project_connection_id?: string

Waarde van eigenschap

string

require_approval

De goedkeuringsvereisten voor het MCP-instrument.

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

Waarde van eigenschap

MCPToolRequireApproval | "always" | "never"

server_description

Optionele beschrijving van de MCP-server, gebruikt om meer context te bieden.

server_description?: string

Waarde van eigenschap

string

server_label

Een label voor deze MCP-server, dat wordt gebruikt om het te identificeren in hulpprogramma-aanroepen.

server_label: string

Waarde van eigenschap

string

server_url

De URL voor de MCP-server. Eén van server_url, connector_id, of tunnel_id moet worden aangeleverd.

server_url?: string

Waarde van eigenschap

string

tool_configs

Deprecated. Deze eigenschap is verouderd en zal in een toekomstige versie worden verwijderd.

tool_configs?: Record<string, ToolConfig>

Waarde van eigenschap

Record<string, ToolConfig>

tunnel_id

De Secure MCP Tunnel ID om te gebruiken in plaats van een directe server-URL. Eén van server_url, connector_id, of tunnel_id moet worden aangeleverd.

tunnel_id?: string

Waarde van eigenschap

string

type

Het type van de MCP-tool. Altijd mcp.

type: "mcp"

Waarde van eigenschap

"mcp"