Action
    Preparing search index...

    Class McpEndpoint

    An endpoint for a single MCP (Model Context Protocol) server configured for the current session, returned by Spotfire.Dxp.Framework.Ai.Mcp.McpService.GetMcpEndpoints. It exposes the MCP server's identifying metadata and a Spotfire.Dxp.Framework.Ai.Mcp.McpEndpoint.GetTools method that returns its tools as Spotfire.Dxp.Framework.Ai.AiTool instances to pass into a chat completion call.

    2.6

    Hierarchy (View Summary)

    Index

    Methods

    Cast Equals GetHashCode ToString TryCast Equals

    Extended capability 'AI'

    Description Id Name ServerUrl GetTools

    Methods

    • Casts this object to the specified type. Throws error on failure.

      Type Parameters

      • T1

        The target type of the cast.

      • T2

        The type of the object to cast.

      Parameters

      Returns T1

    • Determines whether the specified object is equal to the current object.

      Parameters

      • obj: any

        The object to compare with the current object.

      Returns boolean

      true if the specified object is equal to the current object; otherwise, false.

    • Serves as the default hash function.

      Returns number

      A hash code for the current object.

    • Returns a string that represents the current object.

      Returns string

      A string that represents the current object.

    • Casts this object to the specified type. Returns null on failure.

      Type Parameters

      • T1

        The target type of the cast.

      • T2

        The type of the object to cast.

      Parameters

      Returns T1 | null

    • Determines whether the specified object instances are considered equal.

      Parameters

      • objA: any

        The first object to compare.

      • objB: any

        The second object to compare.

      Returns boolean

      true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

    Extended capability 'AI'

    • get Description(): string | null

      Gets the optional human-readable description of the MCP endpoint, or null when it has none.

      Returns string | null

      2.6

    • get Name(): string

      Gets the human-readable display name of the MCP endpoint.

      Returns string

      2.6

    • get ServerUrl(): System.Uri | null

      Gets the URL of the MCP endpoint, or null when it is not known.

      Returns System.Uri | null

      2.6

    Settings

    Member Visibility

    On This Page

    Methods
    Extended capability 'AI'