Compartilhar via

McpToolRegistrationService class

Pacote:
@microsoft/agents-a365-tooling-extensions-openai

Descubra servidores MCP e ferramentas de lista formatadas para o SDK de Agentes do OpenAI. Usa listToolServers para buscar configurações de servidor.

Construtores

McpToolRegistrationService(IConfigurationProvider<OpenAIToolingConfiguration>)

Construa um McpToolRegistrationService.

Métodos

addToolServersToAgent(Agent<unknown, "text">, Authorization, string, TurnContext, string)

Registra os servidores de ferramentas MCP e atualiza as opções do agente com ferramentas descobertas e configurações de servidor. Chame isso para habilitar o acesso dinâmico à ferramenta OpenAI com base no ambiente MCP atual.
sendChatHistoryAsync(TurnContext, OpenAIConversationsSession, number, ToolOptions)

Envia o histórico de chat de uma Sessão OpenAI para a plataforma MCP para proteção contra ameaças em tempo real.

Esse método extrai mensagens da Sessão OpenAI fornecida usando getItems(), converte-as no ChatHistoryMessage formato e as envia para a plataforma MCP.

Exemplo

const session = new OpenAIConversationsSession(sessionOptions);
const result = await service.sendChatHistoryAsync(turnContext, session, 50);
if (result.succeeded) {
  console.log('Chat history sent successfully');
} else {
  console.error('Failed to send chat history:', result.errors);
}
sendChatHistoryMessagesAsync(TurnContext, AgentInputItem[], ToolOptions)

Envia uma lista de mensagens OpenAI para a plataforma MCP para proteção contra ameaças em tempo real.

Esse método converte as mensagens do AgentInputItem fornecidas para ChatHistoryMessage formatar e as envia para a plataforma MCP.

Exemplo

const items = await session.getItems();
const result = await service.sendChatHistoryMessagesAsync(turnContext, items);

Detalhes do construtor

McpToolRegistrationService(IConfigurationProvider<OpenAIToolingConfiguration>)

Construa um McpToolRegistrationService.

new McpToolRegistrationService(configProvider?: IConfigurationProvider<OpenAIToolingConfiguration>)

Parâmetros

configProvider

IConfigurationProvider<OpenAIToolingConfiguration>

Provedor de configuração opcional. O padrão é defaultOpenAIToolingConfigurationProvider se não for especificado.

Detalhes do método

addToolServersToAgent(Agent<unknown, "text">, Authorization, string, TurnContext, string)

Registra os servidores de ferramentas MCP e atualiza as opções do agente com ferramentas descobertas e configurações de servidor. Chame isso para habilitar o acesso dinâmico à ferramenta OpenAI com base no ambiente MCP atual.

function addToolServersToAgent(agent: Agent<unknown, "text">, authorization: Authorization, authHandlerName: string, turnContext: TurnContext, authToken: string): Promise<Agent<unknown, "text">>

Parâmetros

agent

Agent<unknown, "text">

A instância do OpenAI Agent à qual os servidores MCP serão adicionados.

authorization
Authorization

Objeto de autorização para troca de token.

authHandlerName

string

O nome do manipulador de autenticação a ser usado para troca de tokens.

turnContext
TurnContext

O TurnContext da solicitação atual.

authToken

string

Token de portador opcional para acesso ao servidor MCP.

Retornos

Promise<Agent<unknown, "text">>

A instância do Agente atualizada com servidores MCP registrados.

sendChatHistoryAsync(TurnContext, OpenAIConversationsSession, number, ToolOptions)

Envia o histórico de chat de uma Sessão OpenAI para a plataforma MCP para proteção contra ameaças em tempo real.

Esse método extrai mensagens da Sessão OpenAI fornecida usando getItems(), converte-as no ChatHistoryMessage formato e as envia para a plataforma MCP.

Exemplo

const session = new OpenAIConversationsSession(sessionOptions);
const result = await service.sendChatHistoryAsync(turnContext, session, 50);
if (result.succeeded) {
  console.log('Chat history sent successfully');
} else {
  console.error('Failed to send chat history:', result.errors);
}

function sendChatHistoryAsync(turnContext: TurnContext, session: OpenAIConversationsSession, limit?: number, toolOptions?: ToolOptions): Promise<OperationResult>

Parâmetros

turnContext
TurnContext

O contexto de turno que contém informações de conversa.

session
OpenAIConversationsSession

A instância de Sessão OpenAI da qual extrair mensagens.

limit

number

Limite opcional no número de mensagens a serem recuperadas da sessão.

toolOptions
ToolOptions

Opções de ferramenta opcionais para personalização.

Retornos

Promise<OperationResult>

Uma promessa de resolução para um OperationResult que indica êxito ou falha.

sendChatHistoryMessagesAsync(TurnContext, AgentInputItem[], ToolOptions)

Envia uma lista de mensagens OpenAI para a plataforma MCP para proteção contra ameaças em tempo real.

Esse método converte as mensagens do AgentInputItem fornecidas para ChatHistoryMessage formatar e as envia para a plataforma MCP.

Exemplo

const items = await session.getItems();
const result = await service.sendChatHistoryMessagesAsync(turnContext, items);

function sendChatHistoryMessagesAsync(turnContext: TurnContext, messages: AgentInputItem[], toolOptions?: ToolOptions): Promise<OperationResult>

Parâmetros

turnContext
TurnContext

O contexto de turno que contém informações de conversa.

messages

AgentInputItem[]

Matriz de mensagens AgentInputItem a serem enviadas.

toolOptions
ToolOptions

ToolOptions opcionais para personalização.

Retornos

Promise<OperationResult>

Uma promessa de resolução para um OperationResult que indica êxito ou falha.