MCP TypeScript SDK (V2)
    Preparing search index...

    Module index

    Namespaces

    StandardSchemaWithJSON

    Enumerations

    OAuthErrorCode
    ProtocolErrorCode
    SdkErrorCode

    Classes

    AjvJsonSchemaValidator
    InMemoryTaskMessageQueue
    InMemoryTaskStore
    OAuthError
    ProtocolError
    ReadBuffer
    SdkError
    UriTemplate
    UrlElicitationRequiredError

    Interfaces

    AuthInfo
    BaseQueuedMessage
    BaseResponseMessage
    CreateMessageRequestParamsWithTools
    CreateTaskOptions
    ErrorMessage
    InternalError
    InvalidParamsError
    InvalidRequestError
    jsonSchemaValidator
    MessageExtraInfo
    MethodNotFoundError
    ParseError
    QueuedError
    QueuedNotification
    QueuedRequest
    QueuedResponse
    RequestTaskStore
    ResultMessage
    StandardSchemaWithJSON
    TaskCreatedMessage
    TaskMessageQueue
    TaskStatusMessage
    TaskStore
    Transport

    Type Aliases

    Annotations
    AudioContent
    AuthorizationServerMetadata
    BaseContext
    BaseMetadata
    BlobResourceContents
    BooleanSchema
    CallToolRequest
    CallToolRequestParams
    CallToolResult
    CancelledNotification
    CancelledNotificationParams
    CancelTaskRequest
    CancelTaskResult
    CfWorkerSchemaDraft
    ClientCapabilities
    ClientContext
    ClientNotification
    ClientRequest
    ClientResult
    CompatibilityCallToolResult
    CompleteRequest
    CompleteRequestParams
    CompleteRequestPrompt
    CompleteRequestResourceTemplate
    CompleteResult
    ContentBlock
    CreateMessageRequest
    CreateMessageRequestParams
    CreateMessageRequestParamsBase
    CreateMessageResult
    CreateMessageResultWithTools
    CreateTaskResult
    CreateTaskServerContext
    Cursor
    ElicitationCompleteNotification
    ElicitationCompleteNotificationParams
    ElicitRequest
    ElicitRequestFormParams
    ElicitRequestParams
    ElicitRequestURLParams
    ElicitResult
    EmbeddedResource
    EmptyResult
    EnumSchema
    FetchLike
    GetPromptRequest
    GetPromptRequestParams
    GetPromptResult
    GetTaskPayloadRequest
    GetTaskPayloadResult
    GetTaskRequest
    GetTaskResult
    Icon
    Icons
    ImageContent
    Implementation
    InitializedNotification
    InitializeRequest
    InitializeRequestParams
    InitializeResult
    JSONArray
    JSONObject
    JSONRPCErrorResponse
    JSONRPCMessage
    JSONRPCNotification
    JSONRPCRequest
    JSONRPCResponse
    JSONRPCResultResponse
    JsonSchemaType
    JsonSchemaValidator
    JsonSchemaValidatorResult
    JSONValue
    LegacyTitledEnumSchema
    ListChangedCallback
    ListChangedHandlers
    ListChangedOptions
    ListPromptsRequest
    ListPromptsResult
    ListResourcesRequest
    ListResourcesResult
    ListResourceTemplatesRequest
    ListResourceTemplatesResult
    ListRootsRequest
    ListRootsResult
    ListTasksRequest
    ListTasksResult
    ListToolsRequest
    ListToolsResult
    LoggingLevel
    LoggingMessageNotification
    LoggingMessageNotificationParams
    MetaObject
    ModelHint
    ModelPreferences
    MultiSelectEnumSchema
    Notification
    NotificationMethod
    NotificationOptions
    NotificationParams
    NotificationTypeMap
    NumberSchema
    OAuthClientInformation
    OAuthClientInformationFull
    OAuthClientInformationMixed
    OAuthClientMetadata
    OAuthClientRegistrationError
    OAuthErrorResponse
    OAuthMetadata
    OAuthProtectedResourceMetadata
    OAuthTokenRevocationRequest
    OAuthTokens
    OpenIdProviderDiscoveryMetadata
    OpenIdProviderMetadata
    PaginatedRequest
    PaginatedRequestParams
    PaginatedResult
    PingRequest
    PrimitiveSchemaDefinition
    Progress
    ProgressCallback
    ProgressNotification
    ProgressNotificationParams
    ProgressToken
    Prompt
    PromptArgument
    PromptListChangedNotification
    PromptMessage
    PromptReference
    ProtocolOptions
    QueuedMessage
    ReadResourceRequest
    ReadResourceRequestParams
    ReadResourceResult
    RelatedTaskMetadata
    Request
    RequestId
    RequestMeta
    RequestMetaObject
    RequestMethod
    RequestOptions
    RequestParams
    RequestTypeMap
    Resource
    ResourceContents
    ResourceListChangedNotification
    ResourceRequestParams
    ResourceTemplateReference
    ResourceTemplateType
    ResourceUpdatedNotification
    ResourceUpdatedNotificationParams
    ResponseMessage
    Result
    ResultTypeMap
    Role
    Root
    RootsListChangedNotification
    SamplingContent
    SamplingMessage
    SamplingMessageContentBlock
    ServerCapabilities
    ServerContext
    ServerNotification
    ServerRequest
    ServerResult
    SetLevelRequest
    SetLevelRequestParams
    SingleSelectEnumSchema
    StringSchema
    SubscribeRequest
    SubscribeRequestParams
    Task
    TaskAugmentedRequestParams
    TaskContext
    TaskCreationParams
    TaskManagerOptions
    TaskMetadata
    TaskRequestOptions
    TaskServerContext
    TaskStatus
    TaskStatusNotification
    TaskStatusNotificationParams
    TaskToolExecution
    TextContent
    TextResourceContents
    TitledMultiSelectEnumSchema
    TitledSingleSelectEnumSchema
    Tool
    ToolAnnotations
    ToolChoice
    ToolExecution
    ToolListChangedNotification
    ToolResultContent
    ToolUseContent
    TransportSendOptions
    UnsubscribeRequest
    UnsubscribeRequestParams
    UntitledMultiSelectEnumSchema
    UntitledSingleSelectEnumSchema
    Variables

    Variables

    DEFAULT_NEGOTIATED_PROTOCOL_VERSION
    DEFAULT_REQUEST_TIMEOUT_MSEC
    INTERNAL_ERROR
    INVALID_PARAMS
    INVALID_REQUEST
    JSONRPC_VERSION
    LATEST_PROTOCOL_VERSION
    METHOD_NOT_FOUND
    PARSE_ERROR
    SUPPORTED_PROTOCOL_VERSIONS

    Functions

    assertClientRequestTaskCapability
    assertCompleteRequestPrompt
    assertCompleteRequestResourceTemplate
    assertToolsCallTaskCapability
    checkResourceAllowed
    createFetchWithInit
    deserializeMessage
    getDisplayName
    isCallToolResult
    isInitializedNotification
    isInitializeRequest
    isJSONRPCErrorResponse
    isJSONRPCNotification
    isJSONRPCRequest
    isJSONRPCResponse
    isJSONRPCResultResponse
    isTaskAugmentedRequestParams
    isTerminal
    parseJSONRPCMessage
    resourceUrlFromServerUrl
    serializeMessage
    takeResult
    toArrayAsync

    References

    AddClientAuthentication → AddClientAuthentication
    applyMiddlewares → applyMiddlewares
    AssertionCallback → AssertionCallback
    auth → auth
    AuthProvider → AuthProvider
    AuthResult → AuthResult
    buildDiscoveryUrls → buildDiscoveryUrls
    Client → Client
    ClientAuthMethod → ClientAuthMethod
    ClientCredentialsProvider → ClientCredentialsProvider
    ClientCredentialsProviderOptions → ClientCredentialsProviderOptions
    ClientOptions → ClientOptions
    createMiddleware → createMiddleware
    createPrivateKeyJwtAuth → createPrivateKeyJwtAuth
    CrossAppAccessContext → CrossAppAccessContext
    CrossAppAccessProvider → CrossAppAccessProvider
    CrossAppAccessProviderOptions → CrossAppAccessProviderOptions
    DEFAULT_INHERITED_ENV_VARS → DEFAULT_INHERITED_ENV_VARS
    discoverAndRequestJwtAuthGrant → discoverAndRequestJwtAuthGrant
    DiscoverAndRequestJwtAuthGrantOptions → DiscoverAndRequestJwtAuthGrantOptions
    discoverAuthorizationServerMetadata → discoverAuthorizationServerMetadata
    discoverOAuthMetadata → discoverOAuthMetadata
    discoverOAuthProtectedResourceMetadata → discoverOAuthProtectedResourceMetadata
    discoverOAuthServerInfo → discoverOAuthServerInfo
    exchangeAuthorization → exchangeAuthorization
    exchangeJwtAuthGrant → exchangeJwtAuthGrant
    ExperimentalClientTasks → ExperimentalClientTasks
    extractResourceMetadataUrl → extractResourceMetadataUrl
    extractWWWAuthenticateParams → extractWWWAuthenticateParams
    fetchToken → fetchToken
    fromJsonSchema → fromJsonSchema
    getDefaultEnvironment → getDefaultEnvironment
    getSupportedElicitationModes → getSupportedElicitationModes
    isHttpsUrl → isHttpsUrl
    JwtAuthGrantResult → JwtAuthGrantResult
    LoggingOptions → LoggingOptions
    Middleware → Middleware
    OAuthClientProvider → OAuthClientProvider
    OAuthDiscoveryState → OAuthDiscoveryState
    OAuthServerInfo → OAuthServerInfo
    parseErrorResponse → parseErrorResponse
    prepareAuthorizationCodeRequest → prepareAuthorizationCodeRequest
    PrivateKeyJwtProvider → PrivateKeyJwtProvider
    PrivateKeyJwtProviderOptions → PrivateKeyJwtProviderOptions
    ReconnectionScheduler → ReconnectionScheduler
    refreshAuthorization → refreshAuthorization
    registerClient → registerClient
    RequestJwtAuthGrantOptions → RequestJwtAuthGrantOptions
    requestJwtAuthorizationGrant → requestJwtAuthorizationGrant
    RequestLogger → RequestLogger
    selectClientAuthMethod → selectClientAuthMethod
    selectResourceURL → selectResourceURL
    SSEClientTransport → SSEClientTransport
    SSEClientTransportOptions → SSEClientTransportOptions
    SseError → SseError
    startAuthorization → startAuthorization
    StartSSEOptions → StartSSEOptions
    StaticPrivateKeyJwtProvider → StaticPrivateKeyJwtProvider
    StaticPrivateKeyJwtProviderOptions → StaticPrivateKeyJwtProviderOptions
    StdioClientTransport → StdioClientTransport
    StdioServerParameters → StdioServerParameters
    StreamableHTTPClientTransport → StreamableHTTPClientTransport
    StreamableHTTPClientTransportOptions → StreamableHTTPClientTransportOptions
    StreamableHTTPReconnectionOptions → StreamableHTTPReconnectionOptions
    UnauthorizedError → UnauthorizedError
    withLogging → withLogging
    withOAuth → withOAuth

    Settings

    Member Visibility

    On This Page

    Namespaces
    Enumerations
    Classes
    Interfaces
    Type Aliases
    AnnotationsAudioContentAuthorizationServerMetadataBaseContextBaseMetadataBlobResourceContentsBooleanSchemaCallToolRequestCallToolRequestParamsCallToolResultCancelledNotificationCancelledNotificationParamsCancelTaskRequestCancelTaskResultCfWorkerSchemaDraftClientCapabilitiesClientContextClientNotificationClientRequestClientResultCompatibilityCallToolResultCompleteRequestCompleteRequestParamsCompleteRequestPromptCompleteRequestResourceTemplateCompleteResultContentBlockCreateMessageRequestCreateMessageRequestParamsCreateMessageRequestParamsBaseCreateMessageResultCreateMessageResultWithToolsCreateTaskResultCreateTaskServerContextCursorElicitationCompleteNotificationElicitationCompleteNotificationParamsElicitRequestElicitRequestFormParamsElicitRequestParamsElicitRequestURLParamsElicitResultEmbeddedResourceEmptyResultEnumSchemaFetchLikeGetPromptRequestGetPromptRequestParamsGetPromptResultGetTaskPayloadRequestGetTaskPayloadResultGetTaskRequestGetTaskResultIconIconsImageContentImplementationInitializedNotificationInitializeRequestInitializeRequestParamsInitializeResultJSONArrayJSONObjectJSONRPCErrorResponseJSONRPCMessageJSONRPCNotificationJSONRPCRequestJSONRPCResponseJSONRPCResultResponseJsonSchemaTypeJsonSchemaValidatorJsonSchemaValidatorResultJSONValueLegacyTitledEnumSchemaListChangedCallbackListChangedHandlersListChangedOptionsListPromptsRequestListPromptsResultListResourcesRequestListResourcesResultListResourceTemplatesRequestListResourceTemplatesResultListRootsRequestListRootsResultListTasksRequestListTasksResultListToolsRequestListToolsResultLoggingLevelLoggingMessageNotificationLoggingMessageNotificationParamsMetaObjectModelHintModelPreferencesMultiSelectEnumSchemaNotificationNotificationMethodNotificationOptionsNotificationParamsNotificationTypeMapNumberSchemaOAuthClientInformationOAuthClientInformationFullOAuthClientInformationMixedOAuthClientMetadataOAuthClientRegistrationErrorOAuthErrorResponseOAuthMetadataOAuthProtectedResourceMetadataOAuthTokenRevocationRequestOAuthTokensOpenIdProviderDiscoveryMetadataOpenIdProviderMetadataPaginatedRequestPaginatedRequestParamsPaginatedResultPingRequestPrimitiveSchemaDefinitionProgressProgressCallbackProgressNotificationProgressNotificationParamsProgressTokenPromptPromptArgumentPromptListChangedNotificationPromptMessagePromptReferenceProtocolOptionsQueuedMessageReadResourceRequestReadResourceRequestParamsReadResourceResultRelatedTaskMetadataRequestRequestIdRequestMetaRequestMetaObjectRequestMethodRequestOptionsRequestParamsRequestTypeMapResourceResourceContentsResourceLinkResourceListChangedNotificationResourceRequestParamsResourceTemplateReferenceResourceTemplateTypeResourceUpdatedNotificationResourceUpdatedNotificationParamsResponseMessageResultResultTypeMapRoleRootRootsListChangedNotificationSamplingContentSamplingMessageSamplingMessageContentBlockServerCapabilitiesServerContextServerNotificationServerRequestServerResultSetLevelRequestSetLevelRequestParamsSingleSelectEnumSchemaStringSchemaSubscribeRequestSubscribeRequestParamsTaskTaskAugmentedRequestParamsTaskContextTaskCreationParamsTaskManagerOptionsTaskMetadataTaskRequestOptionsTaskServerContextTaskStatusTaskStatusNotificationTaskStatusNotificationParamsTaskToolExecutionTextContentTextResourceContentsTitledMultiSelectEnumSchemaTitledSingleSelectEnumSchemaToolToolAnnotationsToolChoiceToolExecutionToolListChangedNotificationToolResultContentToolUseContentTransportSendOptionsUnsubscribeRequestUnsubscribeRequestParamsUntitledMultiSelectEnumSchemaUntitledSingleSelectEnumSchemaVariables
    Variables
    Functions
    References
    AddClientAuthenticationapplyMiddlewaresAssertionCallbackauthAuthProviderAuthResultbuildDiscoveryUrlsClientClientAuthMethodClientCredentialsProviderClientCredentialsProviderOptionsClientOptionscreateMiddlewarecreatePrivateKeyJwtAuthCrossAppAccessContextCrossAppAccessProviderCrossAppAccessProviderOptionsDEFAULT_INHERITED_ENV_VARSdiscoverAndRequestJwtAuthGrantDiscoverAndRequestJwtAuthGrantOptionsdiscoverAuthorizationServerMetadatadiscoverOAuthMetadatadiscoverOAuthProtectedResourceMetadatadiscoverOAuthServerInfoexchangeAuthorizationexchangeJwtAuthGrantExperimentalClientTasksextractResourceMetadataUrlextractWWWAuthenticateParamsfetchTokenfromJsonSchemagetDefaultEnvironmentgetSupportedElicitationModesisHttpsUrlJwtAuthGrantResultLoggingOptionsMiddlewareOAuthClientProviderOAuthDiscoveryStateOAuthServerInfoparseErrorResponseprepareAuthorizationCodeRequestPrivateKeyJwtProviderPrivateKeyJwtProviderOptionsReconnectionSchedulerrefreshAuthorizationregisterClientRequestJwtAuthGrantOptionsrequestJwtAuthorizationGrantRequestLoggerselectClientAuthMethodselectResourceURLSSEClientTransportSSEClientTransportOptionsSseErrorstartAuthorizationStartSSEOptionsStaticPrivateKeyJwtProviderStaticPrivateKeyJwtProviderOptionsStdioClientTransportStdioServerParametersStreamableHTTPClientTransportStreamableHTTPClientTransportOptionsStreamableHTTPReconnectionOptionsUnauthorizedErrorwithLoggingwithOAuth