Interface Mcp

Give the model access to additional tools via remote Model Context Protocol (MCP) servers. Learn more about MCP.

interface Mcp {
    allowed_tools?: null | string[] | McpAllowedToolsFilter;
    headers?: null | {
        [key: string]: string;
    };
    require_approval?:
        | null
        | "never"
        | McpToolApprovalFilter
        | "always";
    server_description?: string;
    server_label: string;
    server_url: string;
    type: "mcp";
}

Properties

allowed_tools? headers? require_approval? server_description? server_label server_url type

Properties

Optionalallowed_tools

allowed_tools?: null | string[] | McpAllowedToolsFilter

List of allowed tool names or a filter object.

Optionalheaders

headers?: null | {
    [key: string]: string;
}

Optional HTTP headers to send to the MCP server. Use for authentication or other purposes.

Optionalrequire_approval

require_approval?:
    | null
    | "never"
    | McpToolApprovalFilter
    | "always"

Specify which of the MCP server's tools require approval.

Optionalserver_description

server_description?: string

Optional description of the MCP server, used to provide more context.

server_label

server_label: string

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

server_url

server_url: string

The URL for the MCP server.

type

type: "mcp"

The type of the MCP tool. Always mcp.

Settings

Member Visibility

On This Page

Properties