For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Platform docsVideosCommunitySign up
CapabilitiesGetting startedVoice AI OrchestrationVoxEngine PlatformAPI ReferenceFAQ
CapabilitiesGetting startedVoice AI OrchestrationVoxEngine PlatformAPI ReferenceFAQ
      • Overview
        • Cartesia
        • Deepgram
        • ElevenLabs
        • Gemini
        • Grok
        • Inworld
        • OpenAI
        • Pipecat
        • Ultravox
        • Yandex
          • Overview
          • Client
          • ServerEvents
  • Management API
    • Reference
    • Authorization
    • Errors
  • Web SDK
    • Overview
  • Android SDK
    • Overview
  • Android SDK v3
    • Overview
  • iOS SDK
    • Overview
  • React Native SDK
    • Overview
  • Flutter SDK
    • Overview
LogoLogo
Platform docsVideosCommunitySign up
On this page
  • Classes
  • Enums
  • Functions
  • createClient
  • Types
  • ClientParameters
  • Inherited fields
  • MCPServerConnectionConfig
VoxEngineVoice AIMCP

MCP

||View as Markdown|
Was this page helpful?
Edit this page
Previous

Yandex

Next

Client

Built with

Classes

  • Client — Note that the MCP.Client using the Model Context Protocol Go SDK v1.5.0.

Enums

  • ServerEvents

Functions

createClient

Creates a new MCP.Client instance.

1createClient(parameters: ClientParameters): Promise<Client>

Parameters

parameters
ClientParametersRequired

Types

ClientParameters

Extends: _VoiceAIClientParameters

MCP.Client parameters. Can be passed as arguments to the MCP.createClient method.

mcpServerConnectionConfig
MCPServerConnectionConfig

The MCP server connection configuration.

Inherited fields

onWebSocketClose
(event: _WebSocketCloseEvent) => void

_optional, inherited from VoiceAIClientParameters

Optional. A callback function that is called when the WebSocket connection is closed.

privacy
boolean

_optional, inherited from WebSocketBasedClientParameters

Optional. Whether to enable the privacy functionality.

If privacy is enabled, the logging for the WebSocket connection is disabled.

NOTE: the default value is false.

statistics
boolean

_optional, inherited from WebSocketBasedClientParameters

Optional. Enables statistics functionality.

trace
boolean

_optional, inherited from WebSocketBasedClientParameters

Optional. Whether to enable the tracing functionality.

If tracing is enabled, a URL to the trace file appears in the ‘websocket.created’ message. The file contains all sent and received WebSocket messages in the plain text format. The file is uploaded to the S3 storage.

NOTE: enable this only for diagnostic purposes. You can provide the trace file to our support team to help investigating issues.

MCPServerConnectionConfig

MCP server connection configuration.

clientName
string

ClientName and ClientVersion identify this MCP client in the protocol handshake.

clientVersion
string

ClientVersion identify this MCP client in the protocol handshake.

endpoint
string

Endpoint is the server URL for “http” or “sse” transport.

headers
Object

Headers to send to the MCP server on HTTP/SSE requests (e.g. Authorization, API keys). You can use it to pass authentication headers to the MCP server.

transport
string

Transport is “http”, or “sse”.