Skip to content

OpenAIMcpToolOptions

Namespace: Vercel.AI.OpenAI

public sealed class OpenAIMcpToolOptions

Options of Mcp(OpenAIMcpToolOptions). One of ServerUrl or ConnectorId must be set.

Inheritance: object

View source

public IReadOnlyList<string>? AllowedToolNames { get; set; }

Allowed tool names.

Value: IReadOnlyList<string>

View source

public bool? AllowedToolsReadOnly { get; set; }

Allow only read-only tools.

Value: bool?

View source

public string? Authorization { get; set; }

OAuth access token for the MCP server or connector.

Value: string

View source

public string? ConnectorId { get; set; }

Identifier of a service connector.

Value: string

View source

public IReadOnlyDictionary<string, string>? Headers { get; set; }

HTTP headers to send to the MCP server.

Value: IReadOnlyDictionary<string, string>

View source

public IReadOnlyList<string>? NeverRequireApprovalToolNames { get; set; }

Tool names that never require approval.

Value: IReadOnlyList<string>

View source

public string? RequireApproval { get; set; }

Approval policy: always or never.

Value: string

View source

public string? ServerDescription { get; set; }

Description of the server.

Value: string

View source

public string ServerLabel { get; set; }

A label for this MCP server, used to identify it in tool calls.

Value: string

View source

public string? ServerUrl { get; set; }

URL of the MCP server.

Value: string

View source

Apache-2.0 · Copyright 2023 Vercel, Inc. · unofficial community port, not an official Vercel product